commit 8c3cf4dd8bbce9f255888a039a0ad7c3bef8a42d
parent 6fe52fb5e5171088d647dabe6f13d66824a90817
Author: Eduardo Fontana Lazzari <edufonlaz@gmail.com>
Date: Tue, 24 Feb 2026 14:02:42 +0100
Add short description in the star-phor(1) man page
Add some general information about star-phor in its manual page
description section.
Diffstat:
1 file changed, 13 insertions(+), 0 deletions(-)
diff --git a/doc/star-phor.scd b/doc/star-phor.scd
@@ -33,6 +33,19 @@ star-phor(1) "UNIX"
# DESCRIPTION
+*star-phor* solves the radiative transfer equation in a photoreactive scene
+defined using the _star-phor-input_(5) configuration file specification.
+Currently, *star-phor* is capable of evaluating the mean volumetric rate of
+energy absorption (MVREA), as well as the total energy absorbed by a given
+surface, provided that the corresponding volume or surface is defined as a
+sensor in the configuration file. Results are written according to the
+_star-phor-output_(5) specification.
+
+*star-phor* employs state-of-the-art Monte Carlo techniques to compute these
+quantities, benefiting from the inherent advantages of the method, such as a
+computational cost independent of geometrical complexity, scale ratios, and
+phenomenological complexity. Parallelism is also implemented.
+
Options are as follows:
*-f*
