element. .It Ev HTTP_HOST The FQDN of the (possibly virtual) host the HTTP server is running on. This is used for @@ -235,10 +238,19 @@ The host name and a following slash. .It The path to the program, normally .Pa cgi-bin/man.cgi/ . +On +.Lk http://man.openbsd.org/ , +.Xr httpd 8 +is configured such that the path to the program can be omitted. .It To show a single page, a slash, the manpath, another slash, and the name of the requested file, for example .Pa /OpenBSD-current/man1/mandoc.1 . +This can be abbreviated according to the following syntax: +.Sm off +.Op / Ar manpath Oo / Cm man Ar sec Oc Op / Ar arch +.Pf / Ar name Op \&. Ar sec +.Sm on .It For searches, a query string starting with a question mark and consisting of @@ -307,7 +319,7 @@ and ending before the .Ev QUERY_STRING . It is used by the .Cm show -page to aquire the manpath and filename it needs. +page to acquire the manpath and filename it needs. .It Ev QUERY_STRING The HTTP query string passed from the client to the server. It is the final part of the URI, after the question mark. @@ -343,15 +355,10 @@ Can be overridden by The path to the server document root relative to the server root. This is part of the web server configuration and not specific to .Nm . -.It Pa /htdocs/man-cgi.css -A style sheet for general -.Nm -styling, referenced from each generated HTML page. -.It Pa /htdocs/man.css +.It Pa /htdocs/mandoc.css A style sheet for .Xr mandoc 1 -HTML styling, referenced from each generated HTML page after -.Pa man-cgi.css . +HTML styling, referenced from each generated HTML page. .It Pa /man Default .Nm @@ -370,6 +377,12 @@ or any character not contained in the .Sx Restricted character set , .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. +.It Pa /man/footer.html +An optional file containing static HTML code to be inserted right +before closing the <BODY> element. .It Pa /man/OpenBSD-current/man1/mandoc.1 An example .Xr mdoc 7

=================================================================== RCS file: /cvs/mandoc/man.cgi.8,v retrieving revision 1.9 retrieving revision 1.14 diff -u -p -r1.9 -r1.14 --- mandoc/man.cgi.8 2014/07/22 18:14:13 1.9 +++ mandoc/man.cgi.8 2016/03/18 01:22:56 1.14 @@ -1,6 +1,6 @@ -.\" $Id: man.cgi.8,v 1.9 2014/07/22 18:14:13 schwarze Exp $ +.\" $Id: man.cgi.8,v 1.14 2016/03/18 01:22:56 schwarze Exp $ .\" -.\" Copyright (c) 2014 Ingo Schwarze +.\" Copyright (c) 2014, 2015, 2016 Ingo Schwarze .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -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: July 22 2014 $ +.Dd $Mdocdate: March 18 2016 $ .Dt MAN.CGI 8 .Os .Sh NAME @@ -43,6 +43,12 @@ either a name of a manual page or an using the syntax described in the .Xr apropos 1 manual; filling this in is required for each search. +.Pp +The expression is broken into words at whitespace. +Whitespace characters and backslashes can be escaped +by prepending a backslash. +The effect of prepending a backslash to another character is undefined; +in the current implementation, it has no effect. .It A .Dq Submit @@ -155,6 +161,9 @@ database inside each manpath. Configure your web server to execute CGI programs located in .Pa /cgi-bin . When using +.Ox +.Xr httpd 8 +or .Xr nginx 8 , the .Xr slowcgi 8 @@ -181,14 +190,8 @@ and to be specified without a trailing slash. When not specified, the CSS files are assumed to be in the document root. This is used in generated HTML code. -.It Ev CUSTOMIZE_BEGIN -A HTML string to be inserted right after opening the -.Aq BODY -element. .It Ev CUSTOMIZE_TITLE -An ASCII string to be used for the HTML -.Aq TITLE -element. +An ASCII string to be used for the HTML element. .It Ev HTTP_HOST The FQDN of the (possibly virtual) host the HTTP server is running on. This is used for @@ -235,10 +238,19 @@ The host name and a following slash. .It The path to the program, normally .Pa cgi-bin/man.cgi/ . +On +.Lk http://man.openbsd.org/ , +.Xr httpd 8 +is configured such that the path to the program can be omitted. .It To show a single page, a slash, the manpath, another slash, and the name of the requested file, for example .Pa /OpenBSD-current/man1/mandoc.1 . +This can be abbreviated according to the following syntax: +.Sm off +.Op / Ar manpath Oo / Cm man Ar sec Oc Op / Ar arch +.Pf / Ar name Op \&. Ar sec +.Sm on .It For searches, a query string starting with a question mark and consisting of @@ -307,7 +319,7 @@ and ending before the .Ev QUERY_STRING . It is used by the .Cm show -page to aquire the manpath and filename it needs. +page to acquire the manpath and filename it needs. .It Ev QUERY_STRING The HTTP query string passed from the client to the server. It is the final part of the URI, after the question mark. @@ -343,15 +355,10 @@ Can be overridden by The path to the server document root relative to the server root. This is part of the web server configuration and not specific to .Nm . -.It Pa /htdocs/man-cgi.css -A style sheet for general -.Nm -styling, referenced from each generated HTML page. -.It Pa /htdocs/man.css +.It Pa /htdocs/mandoc.css A style sheet for .Xr mandoc 1 -HTML styling, referenced from each generated HTML page after -.Pa man-cgi.css . +HTML styling, referenced from each generated HTML page. .It Pa /man Default .Nm @@ -370,6 +377,12 @@ or any character not contained in the .Sx Restricted character set , .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. +.It Pa /man/footer.html +An optional file containing static HTML code to be inserted right +before closing the <BODY> element. .It Pa /man/OpenBSD-current/man1/mandoc.1 An example .Xr mdoc 7