commit 06510eca3e87cb3f83ab86655736bda772c130a6
parent 16b610f08c6f8d74d044eaad6340cd08d79293f2
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 20 Sep 2022 09:52:12 +0200
Write the man page
Diffstat:
2 files changed, 70 insertions(+), 17 deletions(-)
diff --git a/cmake/CMakeLists.txt b/cmake/CMakeLists.txt
@@ -93,23 +93,23 @@ endif()
################################################################################
# Man page
###############################################################################
-#find_program(SCDOC NAMES scdoc)
-#if(NOT SCDOC)
-# message(WARNING
-# "The `scdoc' program is missing. "
-# "The Star-CK man page cannot be generated.")
-#else()
-# set(_src ${PROJECT_SOURCE_DIR}/../doc/rnfl.5.scd)
-# add_custom_command(
-# OUTPUT rnfl.5
-# COMMAND ${SCDOC} < ${_src} > rnfl.5
-# DEPENDS ${_src}
-# WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-# COMMENT "Buid ROFF man page rnfl.5"
-# VERBATIM)
-# add_custom_target(man-roff ALL DEPENDS rnfl.5)
-# install(FILES ${CMAKE_CURRENT_BINARY_DIR}/rnfl.5 DESTINATION share/man/man5)
-#endif()
+find_program(SCDOC NAMES scdoc)
+if(NOT SCDOC)
+ message(WARNING
+ "The `scdoc' program is missing. "
+ "The Rad-Net File List man page cannot be generated.")
+else()
+ set(_src ${PROJECT_SOURCE_DIR}/../doc/rnsl.5.scd)
+ add_custom_command(
+ OUTPUT rnsl.5
+ COMMAND ${SCDOC} < ${_src} > rnsl.5
+ DEPENDS ${_src}
+ WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+ COMMENT "Buid ROFF man page rnsl.5"
+ VERBATIM)
+ add_custom_target(man-roff ALL DEPENDS rnsl.5)
+ install(FILES ${CMAKE_CURRENT_BINARY_DIR}/rnsl.5 DESTINATION share/man/man5)
+endif()
################################################################################
# Define output & install directories
diff --git a/doc/rnsl.5.scd b/doc/rnsl.5.scd
@@ -0,0 +1,53 @@
+rnsl(5)
+
+; Copyright (C) 2022 Centre National de la Recherche Scientifique
+; Copyright (C) 2022 Institut de Physique du Globe de Paris
+; Copyright (C) 2022 |Méso|Star> (contact@meso-star.com)
+; Copyright (C) 2022 Université de Reims Champagne-Ardenne
+; Copyright (C) 2022 Université de Versaille Saint-Quentin
+; Copyright (C) 2022 Université Paul Sabatier (contact@laplace.univ-tlse.fr)
+;
+; This program is free software: you can redistribute it and/or modify
+; it under the terms of the GNU General Public License as published by
+; the Free Software Foundation, either version 3 of the License, or
+; (at your option) any later version.
+;
+; This program is distributed in the hope that it will be useful,
+; but WITHOUT ANY WARRANTY; without even the implied warranty of
+; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+; GNU General Public License for more details.
+;
+; You should have received a copy of the GNU General Public License
+; along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+# NAME
+
+rnsl - Rad-Net String List file format
+
+# DESCRIPTION
+
+*rnsl* is a text file format that lists strings. Each string is expanded
+and therefore can be composed of variables (e.g. _"${MY_PATH}/file.txt"_)
+
+Characters behind the hash mark (#) are considered comments and are therefore
+ignored, as well as empty lines, i.e. lines without characters or composed
+only of spaces and tabs.
+
+# GRAMMAR
+
+```
+<rnsl> ::= <strings-count>
+ STRING
+ [ STRING ... ]
+
+<strings-count> ::= INTGER
+```
+
+# EXEMPLE
+
+```
+3
+string0
+"string 1"
+"${MY_VARIABLE}/string 3"
+```
