commit 2c3690c61a1c9abaeca5677c5260fb5b8025f650
parent eeda8ee20c0afeea81be9b77de4b820aed21b1dd
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 10 Feb 2026 11:55:25 +0100
Update the text formatting in the star-phor man page
Format the text according to the Linux manual page convention, i.e.,
bold the command name and options, and emphasize replaceable arguments.
Diffstat:
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/doc/star-phor.scd b/doc/star-phor.scd
@@ -26,10 +26,10 @@ star-phor(1) "UNIX"
# NAME
-star-phor - statistical solver for radiative transfer in photoreactors
+*star-phor* - statistical solver for radiative transfer in photoreactors
# SYNOPSIS
-star-phor [-fhv] [-n samples] [-o output] [-t threads] [file]
+*star-phor* [*-fhv*] [*-n* _samples_] [*-o* _output_] [*-t* _threads_] [_file_]
# DESCRIPTION
@@ -41,27 +41,27 @@ Options are as follows:
*-h*
Output short help and exit.
-*-n* samples_count
+*-n* _samples_count_
By default, the number of realisations is 10000.
-*-o* output
+*-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
+*-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.
+ 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.
+The *star-phor* utility exits 0 on success, and >0 if an error occurs.
# EXAMPLES
