commit f31c0b520f6bb46aec185ad228ac373bf1820648
parent 64e2d8ccc842c9c91241494ff021dc8abbeb17be
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 24 Sep 2025 12:15:02 +0200
Write the sty-list manual page
Diffstat:
| M | Makefile | | | 6 | +++++- |
| A | doc/sty-list.1 | | | 72 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 77 insertions(+), 1 deletion(-)
diff --git a/Makefile b/Makefile
@@ -17,8 +17,9 @@
# Default install directories
PREFIX = /usr/local
-BINPREFIX = $(PREFIX)/bin
APPPREFIX = $(PREFIX)/share
+BINPREFIX = $(PREFIX)/bin
+MANPREFIX = $(PREFIX)/share/man
# Compilation/Linker flags used to compile build system tools
CFLAGS=-std=c99 -Wall -Wextra -Os
@@ -43,6 +44,7 @@ install: sty-genhead
install 755 "$(DESTDIR)$(BINPREFIX)" src/sty-hooks; \
install 755 "$(DESTDIR)$(BINPREFIX)" src/sty-index; \
install 755 "$(DESTDIR)$(BINPREFIX)" src/sty-list; \
+ install 644 "$(DESTDIR)$(MANPREFIX)/man1" doc/sty-list.1; \
install 644 "$(DESTDIR)$(PREFIX)/share/doc/star-ty" README.md; \
install 644 "$(DESTDIR)$(PREFIX)/share/doc/star-ty" COPYING; \
install 644 "$(DESTDIR)$(APPPREFIX)/star-ty" example/Makefile; \
@@ -66,6 +68,7 @@ uninstall:
rm -f "$(DESTDIR)$(BINPREFIX)/sty-hooks"
rm -f "$(DESTDIR)$(BINPREFIX)/sty-index"
rm -f "$(DESTDIR)$(BINPREFIX)/sty-list"
+ rm -f "$(DESTDIR)$(MANPREFIX)/man1/sty-list.1"
rm -f "$(DESTDIR)$(PREFIX)/share/doc/star-ty/README.md"
rm -f "$(DESTDIR)$(PREFIX)/share/doc/star-ty/COPYING"
rm -f "$(DESTDIR)$(APPPREFIX)/star-ty/Makefile"
@@ -89,3 +92,4 @@ lint:
shellcheck -o all -P src -x src/sty-hooks
shellcheck -o all -P src -x src/sty-index
shellcheck -o all -P src -x src/sty-list
+ mandoc -Tlint -Wall doc/sty-list.1 || [ $$? -le 1 ]
diff --git a/doc/sty-list.1 b/doc/sty-list.1
@@ -0,0 +1,72 @@
+.\" Copyright (C) 2017, 2025 |Méso|Star> (contact@meso-star.com)
+.\"
+.\" 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 September 24, 2025
+.Dt STY-LIST 1
+.Os
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh NAME
+.Nm sty-list
+.Nd list the resources in a working directory for star-typesetting
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SYNOPSIS
+.Nm
+.Ar resource
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh DESCRIPTION
+.Nm
+is a tool used internally by
+.Xr star-typesetting 7
+to list the resources it depends on to generate online content.
+It must be run from the root of the star-typesetting working directory.
+It is not intended to be invoked manually, but it can nevertheless be
+used to query the files and directories used by
+.Xr star-typesetting 7 .
+.Pp
+The only argument of
+.Nm
+is the resource type to query.
+The available resources are as follows:
+.Bl -tag -width Ds
+.It Cm hook
+list of hooks, i.e. shell scripts to be executed by section before
+their content can be generated.
+.It Cm html
+list of HTML files to generate from Markdown files or shell scripts
+stored in each section.
+.It Cm shell
+List the shell scripts relevant to
+.Xr star-typesetting 7 ,
+i.e. the
+shell script in the
+.Pa scripts
+directory at the root of the working tree
+and those in each section used to generate dynamic content.
+.It Cm shtml
+List of shell scripts that dynamically generate HTML content.
+This is actually a subset of the scripts returned by
+.Nm
+when executed whith the
+.Cm shell
+argument.
+.It Cm subdir
+List the relevant subdirectories of the sections, i.e. the directories
+in the sections that belong to the content to be published.
+.El
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh EXIT STATUS
+.Ex -std
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SEE ALSO
+.Xr star-typesetting 7
