commit 858c45cd037da2c1b6723299b233d9b6b51d7555
parent 135ebdaa25a96d573311cec6cdacd7941ae82836
Author: Eduardo Fontana Lazzari <edufonlaz@gmail.com>
Date: Tue, 1 Apr 2025 15:21:31 +0200
Improve documentation for sphin
Also, add sphin to the "see also" section in the doc of star-phor-input
Diffstat:
2 files changed, 19 insertions(+), 0 deletions(-)
diff --git a/doc/sphin.scd b/doc/sphin.scd
@@ -36,15 +36,32 @@ sphin - numerical consistency utility for photoreactive system description files
*sphin* is an utility that verifies the numerical consistency of a given
_star-phor-input_(5) file.
+The options are as follows:
+
+*-h*
+ Display short help and exit.
+
+*-v*
+ Make sphin verbose. Multiple -v options increase the verbosity.
+ The maximum is 3.
+
# EXAMPLES
Load a photoreactive system description from a local file:
+```
sphin photoreactive_description_file.txt
+```
Load a photoreactive system description from the standard input:
+```
cat photoreactive_description_file.txt | sphin
+```
+
+# ERRORS
+
+The sphin utility exits 0 on success, and >0 if an error occurs.
# SEE ALSO
_star-phor-input_(5)
diff --git a/doc/star-phor-input.scd b/doc/star-phor-input.scd
@@ -173,5 +173,7 @@ surface: "reflecting base"
# SEE ALSO
+_sphin_(1)
+
Marshall Burns, _The StL Format: Standard Data Format for Fabbers_,
https://www.fabbers.com/tech/STL_Format, 1993.
