commit 5104e1e3a27343f963b7aa62d03291a2879caea9
parent e19d51516b9a1f5fb2063dd3544f6ad648db3157
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Tue, 11 Jun 2024 17:57:10 +0200
Translate asciidoc man page city_generator-output(5) to mdoc
Diffstat:
5 files changed, 174 insertions(+), 250 deletions(-)
diff --git a/Makefile b/Makefile
@@ -103,9 +103,6 @@ doc/city_generator2.1: doc/city_generator2.1.in
-e 's/@CG2_ARGS_STL_DEFAULT_STR@/$(CG2_ARGS_STL_DEFAULT_STR)/' \
$@.in > $@
-doc/city_generator2-output.5: doc/city_generator2-output.5.txt
- $(A2X) $(A2X_FLAGS) $<
-
################################################################################
# Installation
################################################################################
diff --git a/config.mk b/config.mk
@@ -33,7 +33,6 @@ LD = ld
OBJCOPY = objcopy
PKG_CONFIG = pkg-config
RANLIB = ranlib
-A2X = a2x
################################################################################
# Dependencies
@@ -101,11 +100,6 @@ CFLAGS_DEBUG = -g $(CFLAGS_COMMON)
CFLAGS = $(CFLAGS_$(BUILD_TYPE)) -fPIE
################################################################################
-# Asciidoc options
-################################################################################
-A2X_FLAGS = -dmanpage -fmanpage
-
-################################################################################
# Linker options
################################################################################
LDFLAGS_HARDENED = -Wl,-z,relro,-z,now
diff --git a/doc/city_generator2-man.css b/doc/city_generator2-man.css
@@ -1,96 +0,0 @@
-/* Copyright (C) 2016-2018 CNRS
- *
- * This is free style sheet: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This CSS is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see http://www.gnu.org/licenses/. */
-
-body.manpage {
- font-family:"Liberation Sans",sans-serif;
- font-size:10pt;
- text-align: justify;
- max-width: 55em;
- margin: 1em;
- background: #ffffff
-}
-
-body.manpage .monospaced, .literalblock {
- margin: 2em;
- color: #636261
-}
-
-body.manpage em {
- color: #660000
-}
-
-body.manpage div.verseblock > pre.content {
- font-family: "Liberation Mono",monospace;
-}
-
-body.manpage h1 {
- padding-bottom: 0.5em;
-}
-body.manpage h2 {
- border-style: none;
-}
-body.manpage div.sectionbody {
- margin-left: 3em;
-}
-
-body.manpage code {
- font-family: "Liberation Mono",monospace;
-}
-
-body.manpage #footer { display: none; }
-
-body.manpage div#toctitle { display: none; }
-
-body.manpage div#toc {
- display: block;
- position:fixed;
- top:0;
- left:60em;
- height:100%;
- width: 100%;
- padding:3em 0 0 0;
- border-left:1px solid #dbdbdb;
- background: #eeeeee
-}
-
-body.manpage a {
- font-weight: bold;
- color: #225588;
-}
-
-body.manpage div#toc a, div#toc a:link, div#toc a:visited {
- margin:0;
- padding-left: 2em;
- color:#999999;
- text-decoration:none;
- font-weight: normal;
-}
-
-body.manpage div.toclevel1 {
- line-height: 1.5em;
-}
-
-body.manpage div.toclevel2 {
- margin-left: 2em;
-}
-
-body.manpage div#toc a:hover {
- color:#666666;
-}
-
-@media print {
- body.manpage div#toc { display: none; }
-}
-
diff --git a/doc/city_generator2-output.5 b/doc/city_generator2-output.5
@@ -0,0 +1,174 @@
+.\" Copyright (C) 2022-2023 Université de Pau et des Pays de l'Adour UPPA
+.\" Copyright (C) 2022-2023 CNRS
+.\" Copyright (C) 2022-2023 Sorbonne Université
+.\" Copyright (C) 2022-2023 Université Paul Sabatier
+.\" Copyright (C) 2022-2023 |Meso|Star>.
+.\"
+.\" This program is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" 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 11, 2024
+.Dt CITY_GENERATOR2-OUTPUT 5
+.Os
+.Sh NAME
+.Nm city_generator2-output
+.Nd naming-scheme for files created by
+.Xr city_generator2 1
+.Sh DESCRIPTION
+The output of
+.Xr city-generator2 1
+is a set of STL files, in either ascii or binary format, that describe the
+ground and the building parts, along with all their boundaries.
+As expected for use by most solvers, including
+.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.
+.Sh NAMING SCHEME
+Some conventions apply in file names, regardless of which part of the output is
+concerned:
+.Bl -dash -offset indent
+.It
+The name begins either with
+.Sy ground No or the Sy name No of a building; the later obviously indicates
+that this file is part of the output for this building.
+.It
+The next part of the name is a capital letter that indicates what type of
+mesh the file describes:
+.Bl -tag -nested -width Ds
+.It B
+if the file describes a boundary (a frontier with the external fluid),
+.It C
+if the file describes a connection (a frontier between two solids or
+between a solid and the internal fluid),
+.It F
+if the file describes a fluid closed volume,
+.It S
+if the file describes a solid closed volume.
+.El
+.It
+The final part of the name indicates which part is being described.
+.It
+Parts are separated by underscore characters.
+.El
+.Pp
+The simplest part of the output is the ground.
+The mesh describing the ground is provided in 6 files, one file per face, named
+.Sm off
+.Sy ground_B_top.stl No \&,
+.Sm on
+.Sm off
+.Sy ground_B_bottom.stl No \&,
+.Sm on
+and
+.Sy ground_B_lateral_0.stl No through
+.Sm off
+.Sy ground_B_lateral_3.stl No \&.
+.Sm on
+The shape of the mesh is the box described in the city map file used in input
+(see
+.Xr city_generator2-intput 5 )
+punched with 1 hole per building, according to building footprints.
+.Pp
+The connection between the ground and each building is part of the building
+description.
+If a closed volume for the ground is needed, it can be obtained as
+the union of the meshes in
+.Sy ground_B_*.stl No and
+.Sm off
+.Sy *_C_ground.stl No \&.
+.Sm on
+.Pp
+Each building on the map is described by various files, depending on its
+construction mode.
+.Pp
+Buildings of construction mode
+.Sy Construction_Mode_0 No produce the following output files\&:
+.Bl -dash -offset indent
+.It
+The solid for the walls,
+.It
+The solid for the floor,
+.It
+The solid for the roof,
+.It
+The internal fluid,
+.It
+The 3 solid-fluid connections between the internal fluid and the 3 solids,
+.It
+The solid-solid connection between the building and the ground,
+.It
+The boundary of the walls,
+.It
+The boundary of the roof.
+.El
+.Pp
+Note that the many solid-solid connections between the different building layers
+are not part of the output.
+.Pp
+Buildings of construction mode
+.Sy Construction_Mode_1 No produce the following output files, some being
+optional:
+.Bl -dash -offset indent
+.It
+The solid for the walls,
+.It
+The solid for the floor,
+.It
+The solid for the roof,
+.It
+The solid for the glazing,
+.It
+The solid for the foundation (optional).
+.It
+The solid for the intermediate floors (optional, all levels merged).
+.It
+The solid for the internal insulation (optional).
+.It
+The solid for the external insulation (optional).
+.It
+The solid for the floor insulation (optional).
+.It
+The solid for the roof insulation (optional).
+.It
+The internal fluid in the attic (optional).
+.It
+The internal fluid in the crawlspace (optional).
+.It
+The internal fluid for the other levels (all levels merged).
+.It
+Various solid-fluid connections between an internal fluid and a solid.
+Depending on the presence of an optional layer, the connection can be between
+a fluid and the optional layer, or between a fluid and the next layer.
+.It
+The solid-solid connection between the building and the ground.
+.It
+The boundary of the various solids, including optional ones, that are part of
+the external layer of the building.
+.El
+.Pp
+Note that the many solid-solid connections between the different building layers
+are not part of the output.
+.Sh MESH ORIENTATION
+All the meshes enclosing either a fluid or a solid are defined with all
+triangles having their direct normal (right-hand rule) pointing to the outside.
+.Pp
+Additionally, all the meshes, whether they define an enclosure or a connection
+or a boundary, comply with a consistency requirement regarding normal
+orientation (all normals on the same side).
+.Sh SEE ALSO
+.Xr city_generator2 1 ,
+.Xr city_generator2-input 5
+.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.
diff --git a/doc/city_generator2-output.5.txt b/doc/city_generator2-output.5.txt
@@ -1,145 +0,0 @@
-// Copyright (C) 2022-2023 Université de Pau et des Pays de l'Adour UPPA
-// Copyright (C) 2022-2023 CNRS
-// Copyright (C) 2022-2023 Sorbonne Université
-// Copyright (C) 2022-2023 Université Paul Sabatier
-// Copyright (C) 2018-2022 |Meso|Star>
-//
-// This program is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-:toc:
-
-= city_generator2-output(5)
-
-== NAME
-
-city_generator2-output - naming-scheme for files created by city_generator2(1).
-
-== DESCRIPTION
-
-The output of *city_generator2* is a set of *STL* files, in either ascii or
-binary format, that describe the ground and the building parts, along with all
-their boundaries. As expected for use by most solvers, including *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.
-
-== NAMING SCHEME
-
-Some conventions apply in file names, regardless of which part of the output is
-concerned:
-
-- The name begins either with "ground" or the name of a building; the later
- obviously indicates that this file is part of the output for this building.
-
-- The next part of the name is a capital letter that indicates what type of
- mesh the file describes: *B* if the file describes a boundary (a frontier with
- the external fluid), *C* if the file describes a connection (a frontier
- between two solids or between a solid and the internal fluid), *F* if the file
- describes a fluid closed volume, and *S* if the file describes a solid closed
- volume.
-
-- The final part of the name indicates which part is being described.
-
-- Parts are separated by *_*.
-
-The simplest part of the output is the ground. The mesh describing the ground is
-provided in 6 files, one file per face, named *ground_B_top.stl*,
-*ground_B_bottom.stl*, and *ground_B_lateral_0.stl* through
-*ground_B_lateral_3.stl*. The shape of the mesh is the box described in the city
-map file used in input (see *city_generator2-intput*(5)) punched with 1 hole per
-building, according to building footprints.
-
-The connection between the ground and each building is part of the building
-description. If a closed volume for the ground is needed, it can be obtained as
-the union of the meshes in **ground_B_*.stl** and ***_C_ground.stl**.
-
-Each building on the map is described by various files, depending on its
-construction mode.
-
-Buildings of construction mode *Construction_Mode_0* produce the following
-output files:
-
-- The solid for the walls.
-
-- The solid for the floor.
-
-- The solid for the roof.
-
-- The internal fluid.
-
-- The 3 solid-fluid connections between the internal fluid and the 3 solids.
-
-- The solid-solid connection between the building and the ground.
-
-- The boundary of the walls.
-
-- The boundary of the roof.
-
-Note that the many solid-solid connections between the different building layers
-are not part of the output.
-
-Buildings of construction mode *Construction_Mode_1* produce the following
-output files, some being optional:
-
-- The solid for the walls.
-
-- The solid for the floor.
-
-- The solid for the roof.
-
-- The solid for the glazing.
-
-- The solid for the foundation (optional).
-
-- The solid for the intermediate floors (optional, all levels merged).
-
-- The solid for the internal insulation (optional).
-
-- The solid for the external insulation (optional).
-
-- The solid for the floor insulation (optional).
-
-- The solid for the roof insulation (optional).
-
-- The internal fluid in the attic (optional).
-
-- The internal fluid in the crawlspace (optional).
-
-- The internal fluid for the other levels (all levels merged).
-
-- Various solid-fluid connections between an internal fluid and a solid.
- Depending on the presence of an optional layer, the connection can be between
- a fluid and the optional layer, or between a fluid and the next layer.
-
-- The solid-solid connection between the building and the ground.
-
-- The boundary of the various solids, including optional ones, that are part of
- the external layer of the building.
-
-Note that the many solid-solid connections between the different building layers
-are not part of the output.
-
-== MESH ORIENTATION
-
-All the meshes enclosing either a fluid or a solid are defined with all
-triangles having their direct normal (right-hand rule) pointing to the outside.
-
-Additionally, all the meshes, whether they define an enclosure or a connection
-or a boundary, comply with a consistency requirement regarding normal
-orientation (all normals on the same side).
-
-== SEE ALSO
-
-*city_generator2*(1),
-*city_generator2-input*(5),
