star-ty

commit 3a65151d07b9478ad7d70ee652d17c4168744050
parent 20bf1dcb2667e60220b898be17c267aadf756919
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Wed, 24 Sep 2025 14:27:52 +0200

Write the sty-hooks manual page

Diffstat:
M
Makefile
 | 
3
+++
A
doc/sty-hooks.1
 | 
53
+++++++++++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 56 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -45,6 +45,7 @@ install: sty-genhead
 	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)$(MANPREFIX)/man1" doc/sty-hooks.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; \
@@ -69,6 +70,7 @@ uninstall:
 	rm -f "$(DESTDIR)$(BINPREFIX)/sty-index"
 	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)$(PREFIX)/share/doc/star-ty/README.md"
 	rm -f "$(DESTDIR)$(PREFIX)/share/doc/star-ty/COPYING"
 	rm -f "$(DESTDIR)$(APPPREFIX)/star-ty/Makefile"
@@ -93,3 +95,4 @@ lint:
 	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 ]
+	mandoc -Tlint -Wall doc/sty-hooks.1 || [ $$? -le 1 ]
diff --git a/doc/sty-hooks.1 b/doc/sty-hooks.1
@@ -0,0 +1,53 @@
+.\" 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-HOOKS 1
+.Os
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh NAME
+.Nm sty-hooks
+.Nd generate POSIX make targets to automate hook management
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SYNOPSIS
+.Nm
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh DESCRIPTION
+.Nm
+prints to standard output a set of POSIX make rules that manage
+dependencies between the content of sections generated by
+.Xr star-typesetting 7
+and their hooks, i.e. shell scripts to be executed by section before
+their content.
+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
+to automate the execution of hooks while generating content.
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.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