star-ty

commit 25e0e1ee1e626eeb5725e67871d4a8a1814182b8
parent e37e8e5c62e2a1bde0d412b87ed2f35da0b094b3
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Wed, 24 Sep 2025 14:53:53 +0200

Write the sty-index manual page

Diffstat:
M
Makefile
 | 
3
+++
A
doc/sty-index.1
 | 
52
++++++++++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 55 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -46,6 +46,7 @@ install: sty-genhead
 	install 755 "$(DESTDIR)$(BINPREFIX)" src/sty-list; \
 	install 644 "$(DESTDIR)$(MANPREFIX)/man1" doc/sty-list.1; \
 	install 644 "$(DESTDIR)$(MANPREFIX)/man1" doc/sty-hooks.1; \
+	install 644 "$(DESTDIR)$(MANPREFIX)/man1" doc/sty-index.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; \
@@ -71,6 +72,7 @@ uninstall:
 	rm -f "$(DESTDIR)$(BINPREFIX)/sty-list"
 	rm -f "$(DESTDIR)$(MANPREFIX)/man1/sty-list.1"
 	rm -f "$(DESTDIR)$(MANPREFIX)/man1/sty-hooks.1"
+	rm -f "$(DESTDIR)$(MANPREFIX)/man1/sty-index.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"
@@ -96,3 +98,4 @@ lint:
 	shellcheck -o all -P src -x src/sty-list
 	mandoc -Tlint -Wall doc/sty-list.1 || [ $$? -le 1 ]
 	mandoc -Tlint -Wall doc/sty-hooks.1 || [ $$? -le 1 ]
+	mandoc -Tlint -Wall doc/sty-index.1 || [ $$? -le 1 ]
diff --git a/doc/sty-index.1 b/doc/sty-index.1
@@ -0,0 +1,52 @@
+.\" 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-INDEX 1
+.Os
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh NAME
+.Nm sty-index
+.Nd POSIX make rules that make sections dependent on their index
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SYNOPSIS
+.Nm
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh DESCRIPTION
+.Nm
+prints a set of POSIX make rules to standard output that make the
+section index file a prerequisite for generating its content by
+.Xr star-typesetting 7 .
+It must be run from the root of the star-typesetting working directory.
+.Pp
+.Nm
+is not intended to be invoked manually.
+It is executed by
+.Xr star-typesetting 7
+in order to automate the generation of a section's content when its
+index is updated.
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh EXIT STATUS
+.Ex -std
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SEE ALSO
+.Xr star-typesetting 7
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh STANDARDS
+.Rs
+.%B Shell & Utilities
+.%Q The Open Group
+.%R POSIX.1-2024
+.%D 2024
+.Re