element. -.It Dv HTTP_HOST -The FQDN of the (possibly virtual) host the HTTP server is running on. -This is used for -.Ic Location: -headers in HTTP 303 responses. .It Dv MAN_DIR A file system path to the .Nm @@ -239,6 +237,8 @@ They consist of: .It The .Cm http:// +or +.Cm https:// protocol specifier. .It The host 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 @@ -399,7 +401,7 @@ The CGI program is call-compatible with queries from the traditional .Pa man.cgi script by Wolfram Schneider. -However, the output may not be quite the same. +However, the output looks quite different. .Sh SEE ALSO .Xr apropos 1 , .Xr mandoc.db 5 ,

=================================================================== RCS file: /cvs/mandoc/man.cgi.8,v retrieving revision 1.21 retrieving revision 1.24 diff -u -p -r1.21 -r1.24 --- mandoc/man.cgi.8 2017/03/17 12:56:57 1.21 +++ mandoc/man.cgi.8 2022/07/06 15:47:28 1.24 @@ -1,4 +1,4 @@ -.\" $Id: man.cgi.8,v 1.21 2017/03/17 12:56:57 schwarze Exp $ +.\" $Id: man.cgi.8,v 1.24 2022/07/06 15:47:28 schwarze Exp $ .\" .\" Copyright (c) 2014, 2015, 2016 Ingo Schwarze .\" @@ -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: March 17 2017 $ +.Dd $Mdocdate: July 6 2022 $ .Dt MAN.CGI 8 .Os .Sh NAME @@ -104,6 +104,9 @@ Lists are returned when searches match more than one m The first column shows the names and section numbers of manuals as clickable links. The second column shows the one-line descriptions of the manuals. +For +.Xr man 1 +style searches, the content of the first manual page follows the list. .It A manual page. This output format is used when a search matches exactly one manual page, or when a link on a list page or an @@ -111,7 +114,7 @@ manual page, or when a link on a list page or an link on another manual page is followed. .It A no-result page. This is shown when a search request returns no results - -eiher because it violates the query syntax, or because +either because it violates the query syntax, or because the search does not match any manual pages. .It \&An error page. This cannot happen by merely clicking the @@ -186,11 +189,6 @@ Otherwise, a leading slash is needed. This is used in generated HTML code. .It Dv CUSTOMIZE_TITLE An ASCII string to be used for the HTML element. -.It Dv HTTP_HOST -The FQDN of the (possibly virtual) host the HTTP server is running on. -This is used for -.Ic Location: -headers in HTTP 303 responses. .It Dv MAN_DIR A file system path to the .Nm @@ -239,6 +237,8 @@ They consist of: .It The .Cm http:// +or +.Cm https:// protocol specifier. .It The host 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 @@ -399,7 +401,7 @@ The CGI program is call-compatible with queries from the traditional .Pa man.cgi script by Wolfram Schneider. -However, the output may not be quite the same. +However, the output looks quite different. .Sh SEE ALSO .Xr apropos 1 , .Xr mandoc.db 5 ,