version 1.6, 2014/07/13 15:38:36 |
version 1.10, 2014/08/22 15:49:50 |
|
|
An ASCII string to be used for the HTML |
An ASCII string to be used for the HTML |
.Aq TITLE |
.Aq TITLE |
element. |
element. |
|
.It Ev 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 Ev MAN_DIR |
.It Ev MAN_DIR |
A path to the |
A path to the |
.Nm |
.Nm |
Line 262 For backward compatibility with the traditional |
|
Line 267 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 : |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Ev 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 Ev PATH_INFO |
.It Ev PATH_INFO |
The final part of the URI path passed from the client to the server, |
The final part of the URI path passed from the client to the server, |
starting after the |
starting after the |
Line 279 and ending before the |
|
Line 307 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 321 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 332 Manual pages documenting |
|
Line 364 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 |