version 1.9, 2014/07/22 18:14:13 |
version 1.14, 2016/03/18 01:22:56 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2014, 2015, 2016 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
Line 43 either a name of a manual page or an |
|
Line 43 either a name of a manual page or an |
|
using the syntax described in the |
using the syntax described in the |
.Xr apropos 1 |
.Xr apropos 1 |
manual; filling this in is required for each search. |
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 |
.It |
A |
A |
.Dq Submit |
.Dq Submit |
Line 155 database inside each manpath. |
|
Line 161 database inside each manpath. |
|
Configure your web server to execute CGI programs located in |
Configure your web server to execute CGI programs located in |
.Pa /cgi-bin . |
.Pa /cgi-bin . |
When using |
When using |
|
.Ox |
|
.Xr httpd 8 |
|
or |
.Xr nginx 8 , |
.Xr nginx 8 , |
the |
the |
.Xr slowcgi 8 |
.Xr slowcgi 8 |
Line 181 and to be specified without a trailing slash. |
|
Line 190 and to be specified without a trailing slash. |
|
When not specified, the CSS files |
When not specified, the CSS files |
are assumed to be in the document root. |
are assumed to be in the document root. |
This is used in generated HTML code. |
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 |
.It Ev CUSTOMIZE_TITLE |
An ASCII string to be used for the HTML |
An ASCII string to be used for the HTML <TITLE> element. |
.Aq TITLE |
|
element. |
|
.It Ev HTTP_HOST |
.It Ev HTTP_HOST |
The FQDN of the (possibly virtual) host the HTTP server is running on. |
The FQDN of the (possibly virtual) host the HTTP server is running on. |
This is used for |
This is used for |
Line 235 The host name and a following slash. |
|
Line 238 The host name and a following slash. |
|
.It |
.It |
The path to the program, normally |
The path to the program, normally |
.Pa cgi-bin/man.cgi/ . |
.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 |
.It |
To show a single page, a slash, the manpath, another slash, |
To show a single page, a slash, the manpath, another slash, |
and the name of the requested file, for example |
and the name of the requested file, for example |
.Pa /OpenBSD-current/man1/mandoc.1 . |
.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 |
.It |
For searches, a query string starting with a question mark |
For searches, a query string starting with a question mark |
and consisting of |
and consisting of |
Line 307 and ending before the |
|
Line 319 and ending before the |
|
.Ev QUERY_STRING . |
.Ev QUERY_STRING . |
It is used by the |
It is used by the |
.Cm show |
.Cm show |
page to aquire the manpath and filename it needs. |
page to acquire the manpath and filename it needs. |
.It Ev QUERY_STRING |
.It Ev QUERY_STRING |
The HTTP query string passed from the client to the server. |
The HTTP query string passed from the client to the server. |
It is the final part of the URI, after the question mark. |
It is the final part of the URI, after the question mark. |
Line 343 Can be overridden by |
|
Line 355 Can be overridden by |
|
The path to the server document root relative to the server root. |
The path to the server document root relative to the server root. |
This is part of the web server configuration and not specific to |
This is part of the web server configuration and not specific to |
.Nm . |
.Nm . |
.It Pa /htdocs/man-cgi.css |
.It Pa /htdocs/mandoc.css |
A style sheet for general |
|
.Nm |
|
styling, referenced from each generated HTML page. |
|
.It Pa /htdocs/man.css |
|
A style sheet for |
A style sheet for |
.Xr mandoc 1 |
.Xr mandoc 1 |
HTML styling, referenced from each generated HTML page after |
HTML styling, referenced from each generated HTML page. |
.Pa man-cgi.css . |
|
.It Pa /man |
.It Pa /man |
Default |
Default |
.Nm |
.Nm |
Line 370 or any character not contained in the |
|
Line 377 or any character not contained in the |
|
.Sx Restricted character set , |
.Sx Restricted character set , |
.Nm |
.Nm |
reports an internal server error and exits without doing anything. |
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 |
.It Pa /man/OpenBSD-current/man1/mandoc.1 |
An example |
An example |
.Xr mdoc 7 |
.Xr mdoc 7 |