improve the description of header.html and footer.html
authorschwarze <schwarze@openbsd.org>
Wed, 6 Jul 2022 15:47:10 +0000 (15:47 +0000)
committerschwarze <schwarze@openbsd.org>
Wed, 6 Jul 2022 15:47:10 +0000 (15:47 +0000)
usr.bin/mandoc/man.cgi.8

index a524f58..2175640 100644 (file)
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: man.cgi.8,v 1.22 2018/05/20 21:48:23 schwarze Exp $
+.\"    $OpenBSD: man.cgi.8,v 1.23 2022/07/06 15:47:10 schwarze Exp $
 .\"
 .\" Copyright (c) 2014, 2015, 2016 Ingo Schwarze <schwarze@openbsd.org>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: May 20 2018 $
+.Dd $Mdocdate: July 6 2022 $
 .Dt MAN.CGI 8
 .Os
 .Sh NAME
@@ -381,11 +381,13 @@ or any character not contained in the
 .Nm
 reports an internal server error and exits without doing anything.
 .It Pa /man/header.html
-An optional file containing static HTML code to be inserted right
-after opening the <BODY> element.
+An optional file containing static HTML code to be wrapped in
+a <HEADER> element and inserted right after opening the <BODY> element.
+For example, it can contain an <H1> element
+specifying the name of the website.
 .It Pa /man/footer.html
-An optional file containing static HTML code to be inserted right
-before closing the <BODY> element.
+An optional file containing static HTML code to be wrapped in
+a <FOOTER> element and inserted right before closing the <BODY> element.
 .It Pa /man/OpenBSD-current/man1/mandoc.1
 An example
 .Xr mdoc 7