version 1.8, 2014/07/21 15:45:17 |
version 1.12, 2015/11/05 17:47:51 |
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 267 For backward compatibility with the traditional |
|
Line 276 For backward compatibility with the traditional |
|
is supported as an alias for |
is supported as an alias for |
.Cm sec . |
.Cm sec . |
.El |
.El |
|
.Ss Restricted character set |
|
For security reasons, in particular to prevent cross site scripting |
|
attacks, some strings used by |
|
.Nm |
|
can only contain the following characters: |
|
.Pp |
|
.Bl -dash -compact -offset indent |
|
.It |
|
lower case and upper case ASCII letters |
|
.It |
|
the ten decimal digits |
|
.It |
|
the dash |
|
.Pq Sq - |
|
.It |
|
the dot |
|
.Pq Sq \&. |
|
.It |
|
the slash |
|
.Pq Sq / |
|
.It |
|
the underscore |
|
.Pq Sq _ |
|
.El |
|
.Pp |
|
In particular, this applies to the |
|
.Ev SCRIPT_NAME , |
|
to all manpaths, and to all architecture names. |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
The web server may pass the following CGI variables to |
The web server may pass the following CGI variables to |
.Nm : |
.Nm : |
Line 279 and ending before the |
|
Line 316 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 293 binary relative to the server root, usually |
|
Line 330 binary relative to the server root, usually |
|
.Pa /cgi-bin/man.cgi . |
.Pa /cgi-bin/man.cgi . |
This is used for generating URIs to be embedded |
This is used for generating URIs to be embedded |
in generated HTML code and HTTP headers. |
in generated HTML code and HTTP headers. |
|
If this contains any character not contained in the |
|
.Sx Restricted character set , |
|
.Nm |
|
reports an internal server error and exits without doing anything. |
.El |
.El |
.Sh FILES |
.Sh FILES |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
Line 311 Can be overridden by |
|
Line 352 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 332 Manual pages documenting |
|
Line 368 Manual pages documenting |
|
itself, linked from the index page. |
itself, linked from the index page. |
.It Pa /man/manpath.conf |
.It Pa /man/manpath.conf |
The list of available manpaths, one per line. |
The list of available manpaths, one per line. |
|
If any of the lines in this file contains a slash |
|
.Pq Sq / |
|
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/OpenBSD-current/man1/mandoc.1 |
.It Pa /man/OpenBSD-current/man1/mandoc.1 |
An example |
An example |
.Xr mdoc 7 |
.Xr mdoc 7 |