commit 88bdac5d9e36143e3f1e8a1d8fb2ac192f7c06d7
parent 1973963f37a44dea6c27fce8f47cae76fff99dd9
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Mon, 5 Jan 2026 15:55:36 +0100
Add the manual page for the shtr tool
Diffstat:
| M | Makefile | | | 3 | +++ |
| A | doc/shtr.1 | | | 119 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 122 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -133,6 +133,7 @@ install: library pkg utils
install 644 "$(DESTDIR)$(LIBPREFIX)/pkgconfig" shtr.pc; \
install 755 "$(DESTDIR)$(BINPREFIX)" shtr; \
install 644 "$(DESTDIR)$(INCPREFIX)/star" src/shtr.h; \
+ install 644 "$(DESTDIR)$(MANPREFIX)/man1" doc/shtr.1; \
install 644 "$(DESTDIR)$(PREFIX)/share/doc/star-hitran" COPYING README.md
uninstall:
@@ -140,6 +141,7 @@ uninstall:
rm -f "$(DESTDIR)$(LIBPREFIX)/pkgconfig/shtr.pc"
rm -f "$(DESTDIR)$(BINPREFIX)/shtr"
rm -f "$(DESTDIR)$(INCPREFIX)/star/shtr.h"
+ rm -f "$(DESTDIR)$(MANPREFIX)/man1/shtr.1"
rm -f "$(DESTDIR)$(PREFIX)/share/doc/star-hitran/COPYING"
rm -f "$(DESTDIR)$(PREFIX)/share/doc/star-hitran/README.md"
@@ -149,6 +151,7 @@ clean: clean_test
rm -f .config libshtr.o shtr.pc shtr-local.pc
lint:
+ mandoc -Tlint doc/shtr.1
################################################################################
# Tests
diff --git a/doc/shtr.1 b/doc/shtr.1
@@ -0,0 +1,119 @@
+.\" Copyright (C) 2022, 2025 |Méso|Star> (contact@meso-star.com)
+.\" Copyright (C) 2025 Université de Lorraine
+.\" Copyright (C) 2022 Centre National de la Recherche Scientifique
+.\" Copyright (C) 2022 Université Paul Sabatier
+.\"
+.\" 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 January 5, 2026
+.Dt SHTR 1
+.Os
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh NAME
+.Nm shtr
+.Nd load and print information on HITRAN files
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SYNOPSIS
+.Nm
+.Op Fl hv
+.Op Fl l Ar lines
+.Op Fl m Ar molparam
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh DESCRIPTION
+.Nm
+loads spectroscopic data formatted in HITRAN formats and displays
+informations about it.
+The data can be either isotopologue metadata or line-by-line parameters.
+In fact,
+.Nm
+is a utility for analyzing the behavior of the Star-HITRAN library with
+regard to the loading and internal structuring of spectroscopic data.
+.Pp
+All isotopologue metadata are loaded.
+However, since the number of lines can be very large, only a subset of
+their parameters is actually loaded.
+The parameters loaded line-by-line are as follows:
+.Bl -dash -compact -offset Ds
+.It
+Central wavenumber in vacuum
+.It
+Reference intensity
+.It
+Air broadening half-width
+.It
+Self broadening half-width
+.It
+Lower state energy
+.It
+Temperature-dependant exponent
+.It
+Air-pressure wavenumber
+.El
+.Pp
+On output,
+.Nm
+displays the range of each parameter for all loaded lines, in addition
+to their encoding error once loaded, relative to the use of
+double-precision floating-point encoding.
+The total memory used is finally printed.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl h
+Use suffixes to make memory usage easier to read: the number of
+consecutive digits is then three or less, using powers of 2 for sizes
+.Po
+KB = 1024, MB = 1048576, etc.
+.Pc .
+By default, memory usage is displayed in bytes.
+.It Fl l Ar lines
+Files storing line-by-line parameters to be loaded.
+.It Fl m Ar molparam
+Files storing isotopologue metadata to be loaded.
+.It Fl v
+Make
+.Nm
+verbose.
+Multiple
+.Fl v
+options increase the verbosity.
+The maximum is 3.
+.El
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh EXIT STATUS
+.Ex -std
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SEE ALSO
+.Rs
+.%T The HITRAN Database
+.%U https://hitran.org/
+.Re
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh STANDARDS
+.Rs
+.%A L.S. Rothman et al.
+.%T The HITRAN2012 molecular spectroscopic database
+.%J Journal of Quantitative Spectroscopy & Radiative Transfer
+.%V 130
+.%P pp. 4\(en50
+.%D 2013
+.Re
+.Pp
+.Rs
+.%A L.S. Rothman et al.
+.%T HITEMP, the high-temperature molecular spectroscopic database
+.%J Journal of Quantitative Spectroscopu & Radiative Transfer
+.%V 111
+.%P pp. 2139\(en2150
+.%D 2010
+.Re
