commit afaa3d054ff2f714dc6af62bb5f57041e3635e21
parent efcfe09e6e9255dfd6e9222170639eec104f51d9
Author: Eduardo Fontana Lazzari <edufonlaz@gmail.com>
Date: Mon, 12 Jan 2026 13:11:08 +0100
Add program options to the man page
Also add the correct reference to the French ANR project funding.
Diffstat:
1 file changed, 31 insertions(+), 2 deletions(-)
diff --git a/doc/star-phor.scd b/doc/star-phor.scd
@@ -29,11 +29,40 @@ star-phor(1) "UNIX"
star-phor - statistical solver for radiative transfer in photoreactors
# SYNOPSIS
+star-phor [-fhv] [-n samples] [-o output] [-t threads] [file]
# DESCRIPTION
+Options are as follows:
+
+*-f*
+ Force overwriting of the _output_ file if it already exists.
+
+*-h*
+ Output short help and exit.
+
+*-n* samples_count
+ By default, the number of realisations is 10000.
+
+*-o* output
+ File in which the simulation results will be written. If none is
+ specified, star-phor will write to the standard output.
+
+*-t* threads_count
+ Advice on the number of threads to use. By default, star-phor uses all
+ available threads.
+
+*-v*
+ Make star-phor verbose. Multiple -v options increase the verbosity. The
+ maximum is 3. Possible values are ‘0’ (no message), ‘1’ ('-v'; error
+ messages only), ‘2’ ('-vv'; error and warning messages), and ‘3’
+ ('-vvv'; error, warning and informative messages). All the messages are
+ written to standard error. Default is 0.
+
# EXIT STATUS
+The sphin utility exits 0 on success, and >0 if an error occurs.
+
# EXAMPLES
# SEE ALSO
@@ -41,5 +70,5 @@ _star-phor-input_(5), _sphin_(1)
# HISTORY
-*star-phor-input* has been developed as part of the *PEPR SPLEEN* Ecochem
-project.
+*star-phor* has been developed thanks to the funding of the ECOCHEM
+project (ProjetIA-22-PESP-0006) belonging to the *PEPR SPLEEN*.
