star-ty

commit 5d3aa6e0fc03a63a7041fca228b733f05add133d
parent c3d04741f2738200b59136b05d431b3279be0b3b
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Wed, 24 Sep 2025 17:38:54 +0200

Write the sty-genhead man page

Diffstat:
M
Makefile
 | 
9
++++++---
A
doc/sty-genhead.1
 | 
62
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 68 insertions(+), 3 deletions(-)
diff --git a/Makefile b/Makefile
@@ -44,9 +44,10 @@ 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)$(MANPREFIX)/man1" doc/sty-genhead.1; \
 	install 644 "$(DESTDIR)$(MANPREFIX)/man1" doc/sty-hooks.1; \
 	install 644 "$(DESTDIR)$(MANPREFIX)/man1" doc/sty-index.1; \
+	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; \
@@ -70,9 +71,10 @@ 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)$(MANPREFIX)/man1/sty-genhead.1"
 	rm -f "$(DESTDIR)$(MANPREFIX)/man1/sty-hooks.1"
 	rm -f "$(DESTDIR)$(MANPREFIX)/man1/sty-index.1"
+	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"
@@ -96,6 +98,7 @@ 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 ]
+	mandoc -Tlint -Wall doc/sty-genhead.1 || [ $$? -le 1 ]
 	mandoc -Tlint -Wall doc/sty-hooks.1 || [ $$? -le 1 ]
 	mandoc -Tlint -Wall doc/sty-index.1 || [ $$? -le 1 ]
+	mandoc -Tlint -Wall doc/sty-list.1 || [ $$? -le 1 ]
diff --git a/doc/sty-genhead.1 b/doc/sty-genhead.1
@@ -0,0 +1,62 @@
+.\" 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-GENHEAD 1
+.Os
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh NAME
+.Nm sty-genhead
+.Nd generate the header of a web page
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SYNOPSIS
+.Nm
+.Ar file
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh DESCRIPTION
+.Nm
+displays the header of a web page generated by
+.Xr star-typesetting 7
+on standard output.
+The header is not only the HTML header of a web page, but also the HTML
+formatting of the two-level navigation menu as defined by
+.Xr star-typesetting 7 .
+.Pp
+.Nm
+must be run from the root of the
+.Xr star-typesetting 7
+working directory.
+Note that its
+.Ar file
+argument can refer to a file that does not yet exist since it has not
+been generated.
+.Pp
+.Nm
+is not intended to be invoked manually.
+It is executed by
+.Xr star-typesetting 7
+to construct the header of the web pages it generates.
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh EXIT STATUS
+.Ex -std
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SEE ALSO
+.Xr star-typesetting 7
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh STANDARDS
+.Rs
+.%B HTML 4.01 specification
+.%Q W3C
+.%D December 24, 1999
+.Re