htrdr

Solving radiative transfer in heterogeneous media
git clone git://git.meso-star.fr/htrdr.git
Log | Files | Refs | README | LICENSE

commit 370d9a20d31c150d8b419e1f761129e01d114fc3
parent 37b08a755c80e1fd215f1d64cce2762399093a74
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Wed, 24 Jan 2024 17:50:50 +0100

man: updated ellipsis formatting

Ellipsis was formatted as an argument, which was incorrect.

Diffstat:
Mdoc/htrdr-atmosphere.1.in | 22+++++++++++-----------
Mdoc/htrdr-combustion.1.in | 30+++++++++++++++---------------
Mdoc/htrdr-planeto.1.in | 30+++++++++++++++---------------
3 files changed, 41 insertions(+), 41 deletions(-)

diff --git a/doc/htrdr-atmosphere.1.in b/doc/htrdr-atmosphere.1.in @@ -20,7 +20,7 @@ .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see <http://www.gnu.org/licenses/>. -.Dd October 4, 2023 +.Dd January 24, 2024 .Dt HTRDR-ATMOSPHERE 1 .Os .Sh NAME @@ -30,18 +30,18 @@ .Nm .Op Fl dfhRrv .Op Fl c Pa clouds -.Op Fl C Ar persp_camera_opt Ns Op : Ns Ar persp_camera_opt ... +.Op Fl C Ar persp_camera_opt Ns Op : Ns Ar persp_camera_opt No ... .Op Fl D Ar sun_azimuth , Ns Ar sun_elevation .Op Fl g Pa ground -.Op Fl i Ar image_opt Ns Op : Ns Ar image_opt ... +.Op Fl i Ar image_opt Ns Op : Ns Ar image_opt No ... .Op Fl M Pa materials .Op Fl m Pa mie .Op Fl n Ar sky_mtl .Op Fl O Pa cache .Op Fl o Pa output -.Op Fl P Ar ortho_camera_opt Ns Op : Ns Ar ortho_camera_opt ... -.Op Fl p Ar flux_sensor_opt Ns Op : Ns Ar flux_sensor_opt ... -.Op Fl s Ar spectral_opt Ns Op : Ns Ar spectral_opt ... +.Op Fl P Ar ortho_camera_opt Ns Op : Ns Ar ortho_camera_opt No ... +.Op Fl p Ar flux_sensor_opt Ns Op : Ns Ar flux_sensor_opt No ... +.Op Fl s Ar spectral_opt Ns Op : Ns Ar spectral_opt No ... .Op Fl T Ar optical_thickness .Op Fl t Ar threads_count .Op Fl V Ar x , Ns Ar y , Ns Ar z @@ -147,7 +147,7 @@ Optical properties of atmospheric gases saved in htgop format. Cloud properties saved in .Xr htcp 5 format. -.It Fl C Ar persp_camera_opt Ns Op : Ns Ar persp_camera_opt ... +.It Fl C Ar persp_camera_opt Ns Op : Ns Ar persp_camera_opt No ... Set up a pinhole or thin-lens perspective camera. .Pp The options for a perspective camera are as follows: @@ -239,7 +239,7 @@ Ground geometry saved in format. .It Fl h Display short help and exit. -.It Fl i Ar image_opt Ns Op : Ns Ar image_opt ... +.It Fl i Ar image_opt Ns Op : Ns Ar image_opt No ... Configure sensor image. .Pp The image options are as follows: @@ -310,7 +310,7 @@ ignores the options used to build acceleration structures .It Fl o Pa output Output file. If not defined, data is written to standard output. -.It Fl P Ar ortho_camera_opt Ns Op : Ns Ar ortho_camera_opt ... +.It Fl P Ar ortho_camera_opt Ns Op : Ns Ar ortho_camera_opt No ... Set up an orthographic camera. .Pp The options for an orthographic camera are as follows: @@ -330,7 +330,7 @@ Default is @HTRDR_ARGS_DEFAULT_CAMERA_TGT@. Upward vector that the top of the camera is pointing towards. Default is @HTRDR_ARGS_DEFAULT_CAMERA_UP@. .El -.It Fl p Ar flux_sensor_opt Ns Op : Ns Ar flux_sensor_opt ... +.It Fl p Ar flux_sensor_opt Ns Op : Ns Ar flux_sensor_opt No ... Set up a flux sensor. The flux is computed for the part of the sensor that is outside any geometry. @@ -350,7 +350,7 @@ Default is @HTRDR_ARGS_DEFAULT_RECTANGLE_UP@. Sensor size in meters. Default is @HTRDR_ARGS_DEFAULT_RECTANGLE_SZ@. .El -.It Fl s Ar spectral_opt Ns Op : Ns Ar spectral_opt ... +.It Fl s Ar spectral_opt Ns Op : Ns Ar spectral_opt No ... Configure spectral integration. .Pp The spectral integration options are as follows: diff --git a/doc/htrdr-combustion.1.in b/doc/htrdr-combustion.1.in @@ -20,7 +20,7 @@ .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see <http://www.gnu.org/licenses/>. -.Dd October 4, 2023 +.Dd January 24, 2024 .Dt HTRDR-COMBUSTION 1 .Os .Sh NAME @@ -29,17 +29,17 @@ .Sh SYNOPSIS .Nm .Op Fl fhINsv -.Op Fl C Ar persp_camera_opt Ns Op : Ns Ar persp_camera_opt ... +.Op Fl C Ar persp_camera_opt Ns Op : Ns Ar persp_camera_opt No ... .Op Fl D Ar laser_flux_density .Op Fl d Ar dump_type -.Op Fl F Ar rdgfa_opt Ns Op : Ns Ar rdgfa_opt ... -.Op Fl g Ar combustion_chamber_opt Ns Op : Ns Ar combustion_chamber_opt... -.Op Fl i Ar image_opt Ns Op : Ns Ar image_opt ... -.Op Fl l Ar laser_opt Ns Op : Ns Ar laser_opt ... +.Op Fl F Ar rdgfa_opt Ns Op : Ns Ar rdgfa_opt No ... +.Op Fl g Ar combustion_chamber_opt Ns Op : Ns Ar combustion_chamber_opt No ... +.Op Fl i Ar image_opt Ns Op : Ns Ar image_opt No ... +.Op Fl l Ar laser_opt Ns Op : Ns Ar laser_opt No ... .Op Fl O Pa cache .Op Fl o Pa output -.Op Fl P Ar ortho_camera_opt Ns Op : Ns Ar ortho_camera_opt ... -.Op Fl R Ar flux_sensor_opt Ns Op : Ns Ar flux_sensor_opt ... +.Op Fl P Ar ortho_camera_opt Ns Op : Ns Ar ortho_camera_opt No ... +.Op Fl R Ar flux_sensor_opt Ns Op : Ns Ar flux_sensor_opt No ... .Op Fl T Ar optical_thickness .Op Fl t Ar threads_count .Op Fl V Ar accel_struct_definition @@ -109,7 +109,7 @@ to distribute the calculation on several computers. .Pp The options are as follows: .Bl -tag -width Ds -.It Fl C Ar persp_camera_opt Ns Op : Ns Ar persp_camera_opt ... +.It Fl C Ar persp_camera_opt Ns Op : Ns Ar persp_camera_opt No ... Set up a pinhole or thin-lens perspective camera. .Pp The options for a perspective camera are as follows: @@ -171,7 +171,7 @@ Each leaf stores the minimum and maximum extinction coefficients of the tetrahedra it covers. Data are written in legacy VTK format. .El -.It Fl F Ar rdgfa_opt Ns Op : Ns Ar rdgfa_opt ... +.It Fl F Ar rdgfa_opt Ns Op : Ns Ar rdgfa_opt No ... RDG-FA phase function parameters. .Pp The parameters of the RDG-FA phase function are as follows: @@ -187,7 +187,7 @@ Default is @HTRDR_COMBUSTION_ARGS_DEFAULT_FRACTAL_PREFACTOR@. Force overwriting of .Pa output file. -.It Fl g Ar combustion_chamber_opt Ns Op : Ns Ar combustion_chamber_opt... +.It Fl g Ar combustion_chamber_opt Ns Op : Ns Ar combustion_chamber_opt No ... Define the combustion chamber. .Pp Note that the combustion chamber does not prevent the camera from seeing @@ -230,7 +230,7 @@ Display short help and exit. .It Fl I Use an isotropic phase function rather than the RDG-FA phase function .Pq option Fl F . -.It Fl i Ar image_opt Ns Op : Ns Ar image_opt ... +.It Fl i Ar image_opt Ns Op : Ns Ar image_opt No ... Configure sensor image. .Pp The image options are as follows: @@ -243,7 +243,7 @@ Default is Number of samples to solve the Monte Carlo estimation of each pixel. Default is @HTRDR_ARGS_DEFAULT_IMG_SPP@. .El -.It Fl l Ar laser_opt Ns Op : Ns Ar laser_opt ... +.It Fl l Ar laser_opt Ns Op : Ns Ar laser_opt No ... Laser emission surface. .Pp The laser options are as follows: @@ -298,7 +298,7 @@ avoiding the use of bad cached data. .It Fl o Pa output Output file. If not defined, data is written to standard output. -.It Fl P Ar ortho_camera_opt Ns Op : Ns Ar ortho_camera_opt ... +.It Fl P Ar ortho_camera_opt Ns Op : Ns Ar ortho_camera_opt No ... Set up an orthographic camera. .Pp The options for an orthographic camera are as follows: @@ -322,7 +322,7 @@ Default is @HTRDR_ARGS_DEFAULT_CAMERA_UP@. Thermodynamic properties of the combustion medium saved in .Xr atrtp 5 format. -.It Fl R Ar flux_sensor_opt Ns Op : Ns Ar flux_sensor_opt ... +.It Fl R Ar flux_sensor_opt Ns Op : Ns Ar flux_sensor_opt No ... Set up a flux sensor. .Pp The flux sensor options are as follow: diff --git a/doc/htrdr-planeto.1.in b/doc/htrdr-planeto.1.in @@ -20,7 +20,7 @@ .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see <http://www.gnu.org/licenses/>. -.Dd November 14, 2023 +.Dd January 24, 2024 .Dt HTRDR-PLANETO 1 .Os .Sh NAME @@ -29,18 +29,18 @@ .Sh SYNOPSIS .Nm .Op Fl dfhNv -.Op Fl a Ar aerosol_opt Ns Op : Ns Ar aerosol_opt ... -.Op Fl C Ar persp_camera_opt Ns Op : Ns Ar persp_camera_opt ... -.Op Fl G Ar ground_opt Ns Op : Ns Ar ground_opt ... -.Op Fl i Ar image_opt Ns Op : Ns Ar image_opt ... +.Op Fl a Ar aerosol_opt Ns Op : Ns Ar aerosol_opt No ... +.Op Fl C Ar persp_camera_opt Ns Op : Ns Ar persp_camera_opt No ... +.Op Fl G Ar ground_opt Ns Op : Ns Ar ground_opt No ... +.Op Fl i Ar image_opt Ns Op : Ns Ar image_opt No ... .Op Fl O Pa accel_struct_storage .Op Fl o Pa output -.Op Fl S Ar source_opt Ns Op : Ns Ar source_opt ... -.Op Fl s Ar spectral_opt Ns Op : Ns Ar spectral_opt ... +.Op Fl S Ar source_opt Ns Op : Ns Ar source_opt No ... +.Op Fl s Ar spectral_opt Ns Op : Ns Ar spectral_opt No ... .Op Fl T Ar optical_thickness .Op Fl t Ar threads_count .Op Fl V Ar accel_struct_definition -.Fl g Ar gas_opt Ns Op : Ns Ar gas_opt ... +.Fl g Ar gas_opt Ns Op : Ns Ar gas_opt No ... .Sh DESCRIPTION .Nm simulates the radiative transfer of a terrestrial planet in the visible @@ -107,7 +107,7 @@ to distribute the rendering on several computers. .Pp The options are as follows: .Bl -tag -width Ds -.It Fl a Ar aerosol_opt Ns Op : Ns Ar aerosol_opt ... +.It Fl a Ar aerosol_opt Ns Op : Ns Ar aerosol_opt No ... Define an aerosol. Use this option once per aerosol, and duplicate it as many times as necessary. @@ -151,7 +151,7 @@ Note that this file and the tetrahedral mesh must be consistent with each other, i.e. the nodes must be listed in the same order. .El -.It Fl C Ar persp_camera_opt Ns Op : Ns Ar persp_camera_opt ... +.It Fl C Ar persp_camera_opt Ns Op : Ns Ar persp_camera_opt No ... Set up a pinhole or thin-lens perspective camera. .Pp The options for a perspective camera are as follows: @@ -207,7 +207,7 @@ csplit -f octree -k output %^#\\ vtk% /^#\\ vtk/ \\ Force overwriting of .Pa output file. -.It Fl G Ar ground_opt Ns Op : Ns Ar ground_opt ... +.It Fl G Ar ground_opt Ns Op : Ns Ar ground_opt No ... The planet's ground. .Pp The ground options are as follows: @@ -237,7 +237,7 @@ Note that this file and the surface mesh must be consistent .Pq option Cm mesh , i.e. the triangles must be listed in the same order. .El -.It Fl g Ar gas_opt Ns Op : Ns Ar gas_opt ... +.It Fl g Ar gas_opt Ns Op : Ns Ar gas_opt No ... Gas mixture. .Pp The gas options are as follows: @@ -267,7 +267,7 @@ listed in the same order. .El .It Fl h Display short help and exit. -.It Fl i Ar image_opt Ns Op : Ns Ar image_opt ... +.It Fl i Ar image_opt Ns Op : Ns Ar image_opt No ... Configure sensor image. .Pp The image options are as follows: @@ -308,7 +308,7 @@ stopped, thus avoiding the use of incorrect acceleration structures. .It Fl o Pa output Output file. If not defined, data is written to standard output. -.It Fl S Ar source_opt Ns Op : Ns Ar source_opt ... +.It Fl S Ar source_opt Ns Op : Ns Ar source_opt No ... Define the external source. .Pp The source options are as follows: @@ -342,7 +342,7 @@ This option is not compatible with the .Cm rad option that explicitly defines the source radiance distribution. .El -.It Fl s Ar spectral_opt Ns Op : Ns Ar spectral_opt ... +.It Fl s Ar spectral_opt Ns Op : Ns Ar spectral_opt No ... Configure spectral integration. .Pp The spectral integration options are as follows: