commit fcdb244ecea9a05d777d43e4074e64b8477a1471
parent 0861bc16a4cba9471856d02e86b71cf2679572f4
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 5 Nov 2020 16:37:55 +0100
Upd man pages
Diffstat:
3 files changed, 24 insertions(+), 11 deletions(-)
diff --git a/doc/htrdr-materials.5.txt b/doc/htrdr-materials.5.txt
@@ -26,11 +26,14 @@ DESCRIPTION
-----------
A *htrdr-materials* file lists the materials that can be used by the ground
geometry provided through a *htrdr-obj*(5) file to the *htrdr*(1) program.
-Each line of the file gives the name of the material and the path toward the
-*mrumtl*(5) file storing the spectral properties of its associated
-Bidirectional Reflectance Distribution Function. The material name can be
-composed of any characters excepted for spaces and tabulations. The path toward
-the *mrumtl*(5) file must be a valid path relative to the file system.
+Each line of the file gives the name of the material. For opaque materials the
+material name is followed by the path toward the *mrumtl*(5) file storing the
+spectral properties of its associated Bidirectional Reflectance Distribution
+Function. Furthermore, the temperature of the material must be defined too.
+
+The material name can be composed of any characters excepted for spaces and
+tabulations. The path toward the *mrumtl*(5) file must be a valid path
+relative to the file system.
Characters behind the hash mark (#) are considered as comments and are thus
ignored. Empty lines, i.e. lines without any characters or composed of spaces
@@ -43,22 +46,28 @@ GRAMMAR
-------
<htrdr-materials> ::= <material>
[ <material> ... ]
-<material> ::= <name> <mrumtl-path>
+<material> ::= <name> <properties>
<name> ::= STRING
+<properties> ::= none | <mrumtl-path> <temperature>
<mrumtl-path> ::= PATH
+<temperature> ::= REAL # In Kelvin
-------
EXAMPLE
-------
-The following file lists 2 materials. The first one named *grass* has its
+The following file lists 3 materials. The first one named *grass* has its
spectral BRDF defines in the *A001.mrumtl* file. The second one is named
-*sand* and has its spectral properties saved in the *B002.mrumtl* file.
+*sand* and has its spectral properties saved in the *B002.mrumtl* file. Both
+materials have a temperature of 300 Kelvin. The last material is a
+semi-transparent material named *air* with no additionnal properties defined
+in this file.
[verse]
-------
-grass /opt/materials/A001.mrumtl
-sand /opt/materials/B002.mrumtl
+grass /opt/materials/A001.mrumtl 300
+sand /opt/materials/B002.mrumtl 300
+air none
-------
SEE ALSO
diff --git a/doc/htrdr.1.txt.in b/doc/htrdr.1.txt.in
@@ -170,6 +170,10 @@ OPTIONS
*-m* _mie_::
Path toward a *htmie*(5) file defining the optical properties of water
droplets.
+
+*-n* _sky-mtl_::
+ Name of the material representing the sky in the *htrdr-materials*(5) file.
+ By default, _sky-mtl_ is @HTRDR_ARGS_DEFAULT_SKY_MTL_NAME@.
*-O* _cache_::
File used to cache the sky data. If the _cache_ file does not exists, it is
diff --git a/src/htrdr_args.c b/src/htrdr_args.c
@@ -107,7 +107,7 @@ print_help(const char* cmd)
"Copyright (C) 2018, 2019 CNRS, Université Paul Sabatier. htrdr is free\n"
"software released under the GNU GPL license, version 3 or later. You\n"
"are free to change or redistribute it under certain conditions\n"
-"<http://gnu.org/licenses/gpl.html>\n");
+"<http://gnu.org/licenses/gpl.html>.\n");
}
static INLINE res_T
