commit a6ade286b862f74420b4bd841e8f9b446bd157df
parent e625a1389aae1bb33adadf5633b51c951182afda
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Thu, 6 Jun 2024 11:36:15 +0200
Fix some warnings in city_generator2(1) man page
Also change the man page's date
Diffstat:
1 file changed, 18 insertions(+), 17 deletions(-)
diff --git a/doc/city_generator2.1.in b/doc/city_generator2.1.in
@@ -16,9 +16,9 @@
.\"
.\" 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 June 5, 2024
+.Dd June 7, 2024
.Dt CITY_GENERATOR2 1
-.Os Linux
+.Os
.Sh NAME
.Nm city_generator2
.Nd generation of conformal 3D meshes of a city from a simple ascii description
@@ -62,10 +62,11 @@ Change the output format of the generated STL files to
@CG2_ARGS_STL_NON_DEFAULT_STR@ (default @CG2_ARGS_STL_DEFAULT_STR@).
.It Fl c Ar file_name
Read a catalog file which is a text file in yaml 1.1 format containing datasets
-for a given construction mode. All the datasets in a given file share the
-same construction mode. If the city map uses more than one construction mode,
-the different datasets must be provided in (at least) as many catalog files
-as there are construction modes involved.
+for a given construction mode.
+All the datasets in a given file share the same construction mode.
+If the city map uses more than one construction mode, the different datasets
+must be provided in (at least) as many catalog files as there are construction
+modes involved.
Please refer to
.Xr city_generator2-input 5
for more information on formats.
@@ -74,7 +75,7 @@ Dump the footprint of the building with the given name, if any.
Can be used more than once.
.It Fl F Ar level
Dump the footprint of some buildings, depending on
-.Ar level . Possible values are:
+.Ar level . Possible values are\&:
.Bl -tag -width Ds
.It Cm 1
Dump the footprint of any building not generated due to an error,
@@ -90,22 +91,23 @@ Output short help and exit.
Keep running on errors.
.It Fl m Ar file_name
Read a city map file which is a text file in yaml 1.1 format containing the
-description of the ground and a list of buildings. The description of an
-individual building includes its footprint and construction mode among other
-things.
+description of the ground and a list of buildings.
+The description of an individual building includes its footprint and
+construction mode among other things.
Please refer to
.Xr city_generator2-input 5
for more information on formats.
.It Fl s
-Force single threaded execution. By default use as many threads as available.
+Force single threaded execution.
+By default use as many threads as available.
Note however that only some parts of the processing is parallelized.
-Therefore, poor speedup when run multithreaded is not a bug and can even be expected.
+Therefore, poor speedup when run multithreaded is not a bug and can even be
+expected.
.It Fl v
Output version information and exit.
.It Fl V Ar level
Set the verbosity
-.Ar level
-. Possible values are:
+.Ar level. Possible values are\&:
.Bl -tag -width Ds
.It Cm 0
No message,
@@ -133,7 +135,6 @@ and
datafile:
.Pp
.Dl city_generator2 -m city.yaml -c catalog0.yaml -c catalog1.yaml
-.Pp
.Sh SEE ALSO
.Xr city_generator2-input 5 ,
.Xr city_generator2-output 5
@@ -166,5 +167,5 @@ datafile:
.Sh HISTORY
.Nm
has been initially developed as part of the
-.Li Readynov
-funding program of the Occitanie / Pyrénées-Méditerranée region.
+.Sy Readynov
+.No funding program of the Occitanie / Pyrénées-Méditerranée region.
