commit e19d51516b9a1f5fb2063dd3544f6ad648db3157
parent c4298196eee9f26155534a950b777d1dda070134
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Mon, 10 Jun 2024 17:52:23 +0200
Fix some warnings in city_generator2(1) man page
Also change the man page's date
Diffstat:
2 files changed, 24 insertions(+), 15 deletions(-)
diff --git a/doc/city_generator2-input.5 b/doc/city_generator2-input.5
@@ -16,7 +16,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 June 7, 2024
+.Dd June 10, 2024
.Dt CITY_GENERATOR2-INTPUT 5
.Os
.Sh NAME
@@ -156,5 +156,5 @@ The catalog file format is as follows:
.Sh HISTORY
.Nm
has been initially developed as part of the
-.Sy Readynov
-.No 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.
diff --git a/doc/city_generator2.1.in b/doc/city_generator2.1.in
@@ -16,7 +16,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 June 7, 2024
+.Dd June 11, 2024
.Dt CITY_GENERATOR2 1
.Os
.Sh NAME
@@ -44,8 +44,7 @@ is a set of STL files, either in ascii or in binary format, that contain the
various meshes of the ground layers and building parts, along with all their
boundaries.
As expected for use by most solvers, including
-.Xr stardis 1
-, the output meshes are conformal.
+.Xr stardis 1 , the output meshes are conformal.
The various output files for buildings are named after the name of the building
they are part of, as well as the name of the part they mesh.
Please refer to
@@ -74,9 +73,10 @@ for more information on formats.
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\&:
-.Bl -tag -width Ds
+Dump the footprint of some buildings in OBJ format, depending on
+.Ar level .
+Possible values are\&:
+.Bl -tag -nested -width Ds
.It Cm 1
Dump the footprint of any building not generated due to an error,
.It Cm 2
@@ -107,8 +107,9 @@ expected.
Output version information and exit.
.It Fl V Ar level
Set the verbosity
-.Ar level. Possible values are\&:
-.Bl -tag -width Ds
+.Ar level .
+Possible values are\&:
+.Bl -tag -nested -width Ds
.It Cm 0
No message,
.It Cm 1
@@ -118,6 +119,7 @@ Error and warning messages,
.It Cm 3
Error, warning and informative messages.
.El
+.Pp
All the messages are written to standard error.
Default verbosity
.Ar level
@@ -140,8 +142,8 @@ datafile:
.Xr city_generator2-output 5
.Rs
.%A C. Geuzaine and J.-F. Remacle.
-.%T Gmsh: a three-dimensional finite element mesh generator with\
-.built-in pre- and post-processing facilities.
+.%T Gmsh: a three-dimensional finite element mesh generator with \
+built-in pre- and post-processing facilities.
.%J International Journal for Numerical Methods in Engineering
.%V 79
.%N 11
@@ -150,6 +152,13 @@ datafile:
.Re
.Sh STANDARDS
.Rs
+.%T Appendix B1 of Advanced Visualizer software 3.0 manual
+.%A Wavefront Technologies
+.%D 1992
+.%U http://fegemo.github.io/cefet-cg/attachments/obj-spec.pdf
+.Re
+.Rs
+.Pp
.%T The StL Format: Standard Data Format for Fabbers
.%A Marshall Burns
.%D 1993
@@ -167,5 +176,5 @@ datafile:
.Sh HISTORY
.Nm
has been initially developed as part of the
-.Sy Readynov
-.No 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.
