commit f0c80eb1129eca6c06ee2c622f8b90057f5346fe
parent c9352c543b0fbca3221534dc2603fffacb8de89b
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 27 Jan 2026 15:02:02 +0100
Rename manual page sources
Add the section to which it belongs as a suffix to the file name. This
allows the same name to be used for manual pages belonging to different
sections.
Diffstat:
4 files changed, 79 insertions(+), 78 deletions(-)
diff --git a/Makefile b/Makefile
@@ -122,11 +122,11 @@ pkg:
-e 's#@SSTL_VERSION@#$(SSTL_VERSION)#g'\
sphin.pc.in > sphin.pc
-sphin.1: doc/sphin.scd
- scdoc < doc/sphin.scd > $@
+sphin.1: doc/sphin.1.scd
+star-phor-input.5: doc/star-phor-input.5.scd
-star-phor-input.5: doc/star-phor-input.scd
- scdoc < doc/star-phor-input.scd > $@
+sphin.1 star-phor-input.5:
+ scdoc < doc/$@.scd > $@
sphin-local.pc: sphin.pc.in
sed -e '1d'\
@@ -147,8 +147,8 @@ install: library tool pkg star-phor-input.5 sphin.1
install 755 "$(DESTDIR)$(BINPREFIX)" sphin; \
install 644 "$(DESTDIR)$(LIBPREFIX)/pkgconfig" sphin.pc; \
install 644 "$(DESTDIR)$(INCPREFIX)/star" src/sphin.h; \
- install 644 "$(DESTDIR)$(MANPREFIX)/man5" star-phor-input.5; \
install 644 "$(DESTDIR)$(MANPREFIX)/man1" sphin.1; \
+ install 644 "$(DESTDIR)$(MANPREFIX)/man5" star-phor-input.5; \
install 644 "$(DESTDIR)$(PREFIX)/share/doc/star-phor-input" COPYING; \
install 644 "$(DESTDIR)$(PREFIX)/share/doc/star-phor-input" README.md
diff --git a/doc/sphin.1.scd b/doc/sphin.1.scd
@@ -0,0 +1,74 @@
+sphin(1) "UNIX"
+
+; Copyright (C) 2024-2026 Centre National de la Recherche Scientifique
+; Copyright (C) 2024-2026 Clermont Auvergne INP
+; Copyright (C) 2024-2026 INSA Lyon
+; Copyright (C) 2024-2026 Institut Mines Télécom Albi-Carmaux
+; Copyright (C) 2024-2026 Institut National Polytechnique de Toulouse
+; Copyright (C) 2024-2026 |Méso|Star> (contact@meso-star.com)
+; Copyright (C) 2024-2026 PhotonLyX (info@photonlyx.com)
+; Copyright (C) 2024-2026 Université de Lorraine
+; Copyright (C) 2024-2026 Université Paul Sabatier
+; Copyright (C) 2024-2026 Université Toulouse - Jean Jaurès
+;
+; 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/>.
+
+# NAME
+
+sphin - numerical consistency utility for photoreactive system description files
+
+# SYNOPSIS
+
+*sphin* [*-hv*]
+
+# DESCRIPTION
+
+*sphin* is an utility that verifies the numerical consistency of a given
+_star-phor-input_(5) file.
+
+The options are as follows:
+
+*-h*
+ Display short help and exit.
+
+*-v*
+ Make sphin verbose. Multiple -v options increase the verbosity.
+ The maximum is 3.
+
+# EXAMPLES
+
+Load a photoreactive system description from a local file:
+
+```
+sphin photoreactive_description_file.txt
+```
+
+Load a photoreactive system description from the standard input:
+
+```
+cat photoreactive_description_file.txt | sphin
+```
+
+# ERRORS
+
+The sphin utility exits 0 on success, and >0 if an error occurs.
+
+# SEE ALSO
+
+_star-phor-input_(5)
+
+# HISTORY
+
+*star-phor-input* has been developed thanks to the funding of the ECOCHEM
+project (ProjetIA-22-PESP-0006) belonging to the *PEPR SPLEEN*.
diff --git a/doc/sphin.scd b/doc/sphin.scd
@@ -1,73 +0,0 @@
-sphin(1) "UNIX"
-
-; Copyright (C) 2024-2026 Centre National de la Recherche Scientifique
-; Copyright (C) 2024-2026 Clermont Auvergne INP
-; Copyright (C) 2024-2026 INSA Lyon
-; Copyright (C) 2024-2026 Institut Mines Télécom Albi-Carmaux
-; Copyright (C) 2024-2026 Institut National Polytechnique de Toulouse
-; Copyright (C) 2024-2026 |Méso|Star> (contact@meso-star.com)
-; Copyright (C) 2024-2026 PhotonLyX (info@photonlyx.com)
-; Copyright (C) 2024-2026 Université de Lorraine
-; Copyright (C) 2024-2026 Université Paul Sabatier
-; Copyright (C) 2024-2026 Université Toulouse - Jean Jaurès
-;
-; 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/>.
-
-# NAME
-
-sphin - numerical consistency utility for photoreactive system description files
-# SYNOPSIS
-
-*sphin* [*-hv*]
-
-# DESCRIPTION
-
-*sphin* is an utility that verifies the numerical consistency of a given
-_star-phor-input_(5) file.
-
-The options are as follows:
-
-*-h*
- Display short help and exit.
-
-*-v*
- Make sphin verbose. Multiple -v options increase the verbosity.
- The maximum is 3.
-
-# EXAMPLES
-
-Load a photoreactive system description from a local file:
-
-```
-sphin photoreactive_description_file.txt
-```
-
-Load a photoreactive system description from the standard input:
-
-```
-cat photoreactive_description_file.txt | sphin
-```
-
-# ERRORS
-
-The sphin utility exits 0 on success, and >0 if an error occurs.
-
-# SEE ALSO
-
-_star-phor-input_(5)
-
-# HISTORY
-
-*star-phor-input* has been developed thanks to the funding of the ECOCHEM
-project (ProjetIA-22-PESP-0006) belonging to the *PEPR SPLEEN*.
diff --git a/doc/star-phor-input.scd b/doc/star-phor-input.5.scd
