commit ca3479e3071c3e519bf13dcc3fb5e9300e14ab01
parent 73e50f5a351a6bb185473e1a26c62ea823db5bdd
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 4 Mar 2026 17:44:15 +0100
Add the sln-get utility manual page
Diffstat:
| M | Makefile | | | 3 | +++ |
| A | doc/sln-get.1 | | | 75 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 78 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -149,6 +149,7 @@ install: library pkg utils
install 644 "$(DESTDIR)$(LIBPREFIX)/pkgconfig" sln.pc; \
install 644 "$(DESTDIR)$(INCPREFIX)/star" src/sln.h; \
install 644 "$(DESTDIR)$(MANPREFIX)/man1" doc/sln-build.1; \
+ install 644 "$(DESTDIR)$(MANPREFIX)/man1" doc/sln-get.1; \
install 644 "$(DESTDIR)$(MANPREFIX)/man5" doc/sln-mixture.5; \
install 644 "$(DESTDIR)$(PREFIX)/share/doc/star-line" COPYING README.md
@@ -159,6 +160,7 @@ uninstall:
rm -f "$(DESTDIR)$(BINPREFIX)/sln"
rm -f "$(DESTDIR)$(INCPREFIX)/star/sln.h"
rm -f "$(DESTDIR)$(MANPREFIX)/man1/sln-build.1"
+ rm -f "$(DESTDIR)$(MANPREFIX)/man1/sln-get.1"
rm -f "$(DESTDIR)$(MANPREFIX)/man5/sln-mixture.5"
rm -f "$(DESTDIR)$(PREFIX)/share/doc/star-line/COPYING"
rm -f "$(DESTDIR)$(PREFIX)/share/doc/star-line/README.md"
@@ -169,6 +171,7 @@ clean: clean_test clean_utils
lint:
mandoc -Tlint -Wwarning doc/sln-build.1
+ mandoc -Tlint -Wwarning doc/sln-get.1
mandoc -Tlint doc/sln-mixture.5
################################################################################
diff --git a/doc/sln-get.1 b/doc/sln-get.1
@@ -0,0 +1,75 @@
+.\" Copyright (C) 2022, 2026 |Méso|Star> (contact@meso-star.com)
+.\" Copyright (C) 2026 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 March 4, 2026
+.Dt SLN-GET 1
+.Os
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh NAME
+.Nm sln-get
+.Nd data accessor of a tree used to sample lines by importance
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SYNOPSIS
+.Nm
+.Op Fl hmv
+.Op Ar tree
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh DESCRIPTION
+.Nm
+prints on the standard output the data of a
+.Ar tree ,
+built by
+.Xr sln-build 1 ,
+in order to speed up the importance sampling of spectral lines.
+If no structure is defined as an input argument, the
+.Ar tree
+is read on the standard input.
+.Pp
+By default, i.e. without options,
+.Nm
+prints a general description of the acceleration structure provided as
+input.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.\""""""""""""""""""""""""""""""""""
+.It Fl h
+Display short help and exit.
+.\""""""""""""""""""""""""""""""""""
+.It Fl m
+Print the root node mesh, i.e. the mesh representing the high resolution
+spectrum of all the lines it structures.
+.Pp
+The output data is a list of mesh vertices, in plain text, where each
+line represents the two values of a mesh vertex, separated by a space:
+its wavenumber in cm^-1, and its associated spectrum value.
+.\""""""""""""""""""""""""""""""""""
+.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
+.Xr sln-build 1
