version 1.1, 2014/07/10 00:31:10 |
version 1.4, 2014/07/13 00:19:51 |
Line 37 At the top of each generated HTML page, |
|
Line 37 At the top of each generated HTML page, |
|
displays a search form containing these elements: |
displays a search form containing these elements: |
.Bl -enum |
.Bl -enum |
.It |
.It |
A |
An input box for search queries, expecting |
.Dq Search |
either a name of a manual page or an |
button to send a search request from the client to the server, |
|
to be clicked after filling in the following input box(es). |
|
.It |
|
An input box for search queries, expecting an |
|
.Ar expression |
.Ar expression |
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. |
.It |
.It |
An input box for an optional section number. |
A |
|
.Dq Submit |
|
button to send a search request from the client to the server. |
|
.It |
|
A |
|
.Dq Reset |
|
button to undo any changes to the input boxes and the dropdown menus |
|
and reset them to the values contained in the |
|
.Ev QUERY_STRING . |
|
.It |
|
Radio buttons to select pages either by name like in |
|
.Xr man 1 |
|
or using |
|
.Xr apropos 1 |
|
queries. |
|
.It |
|
A dropdown menu to optionally select a manual section. |
If one is provided, it has the same effect as the |
If one is provided, it has the same effect as the |
|
.Xr man 1 |
|
and |
.Xr apropos 1 |
.Xr apropos 1 |
.Fl s |
.Fl s |
option. |
option. |
Otherwise, pages from all sections are shown. |
Otherwise, pages from all sections are shown. |
.It |
.It |
An input box for an optional architecture name. |
A dropdown menu to optionally select an architecture. |
If one is provided, it has the same effect as the |
If one is provided, it has the same effect as the |
|
.Xr man 1 |
|
and |
.Xr apropos 1 |
.Xr apropos 1 |
.Fl S |
.Fl S |
option. |
option. |
Line 67 If the configuration file |
|
Line 83 If the configuration file |
|
.Pa /var/www/man/manpath.conf |
.Pa /var/www/man/manpath.conf |
contains only one manpath, the dropdown menu is not shown. |
contains only one manpath, the dropdown menu is not shown. |
By default, the first manpath given in the file is used. |
By default, the first manpath given in the file is used. |
.It |
|
A |
|
.Dq Reset |
|
button to undo any changes to the input boxes and the dropdown menu |
|
and reset them to the values contained in the |
|
.Ev QUERY_STRING . |
|
.El |
.El |
.Ss Program output |
.Ss Program output |
The |
The |
Line 165 The host name and a following slash. |
|
Line 175 The host name and a following slash. |
|
The path to the program, normally |
The path to the program, normally |
.Pa cgi-bin/man.cgi/ . |
.Pa cgi-bin/man.cgi/ . |
.It |
.It |
A page name, which can be |
To show a single page, a slash, the manpath, another slash, |
.Cm index , |
|
which is the default and can be omitted, |
|
.Cm search , |
|
or |
|
.Cm show . |
|
.It |
|
For |
|
.Cm show |
|
only, 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 . |
.It |
.It |
For |
For searches, a query string starting with a question mark |
.Cm search |
|
only, a query string starting with a question mark |
|
and consisting of |
and consisting of |
.Ar key Ns = Ns Ar value |
.Ar key Ns = Ns Ar value |
pairs, separated by ampersands, for example |
pairs, separated by ampersands, for example |
.Pa ?manpath=OpenBSD-current&expr=mandoc . |
.Pa ?manpath=OpenBSD-current&query=mandoc . |
Supported keys are |
Supported keys are |
.Cm manpath , |
.Cm manpath , |
.Cm expr , |
.Cm query , |
.Cm sec , |
.Cm sec , |
and |
|
.Cm arch , |
.Cm arch , |
corresponding to |
corresponding to |
.Xr apropos 1 |
.Xr apropos 1 |
.Fl M , |
.Fl M , |
.Ar expression , |
.Ar expression , |
.Fl s , |
.Fl s , |
and |
|
.Fl S , |
.Fl S , |
respectively. |
respectively, and |
|
.Cm apropos , |
|
which is a boolean parameter to select or deselect the |
|
.Xr apropos 1 |
|
query mode. |
For backward compatibility with the traditional |
For backward compatibility with the traditional |
.Nm , |
.Nm , |
.Cm query |
|
is supported as an alias for |
|
.Cm expr |
|
and |
|
.Cm sektion |
.Cm sektion |
as an alias for |
is supported as an alias for |
.Cm sec . |
.Cm sec . |
.El |
.El |
.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 CSS_DIR |
|
An optional path to the directory containing the CSS files, |
|
to be specified relative to the server's document root, |
|
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 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 |
.Ic Location: |
.Ic Location: |
headers in HTTP 303 responses. |
headers in HTTP 303 responses. |
.It Ev MAN_DIR |
|
A path to the |
|
.Nm |
|
data directory to be used instead of |
|
.Pa /man , |
|
relative to the web server |
|
.Xr chroot 2 |
|
directory, to be specified without a trailing slash. |
|
This is prepended to the manpath when opening |
|
.Xr mandoc.db 5 |
|
and manual page files. |
|
.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 300 source file located below the |
|
Line 279 source file located below the |
|
.Dq OpenBSD-current |
.Dq OpenBSD-current |
manpath. |
manpath. |
.El |
.El |
|
.Sh COMPILE-TIME DEFINES |
|
.Bl -tag -width Ds |
|
.It Ev CSS_DIR |
|
An optional path to the directory containing the CSS files, |
|
to be specified relative to the server's document root, |
|
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 MAN_DIR |
|
A path to the |
|
.Nm |
|
data directory to be used instead of |
|
.Pa /var/www/man , |
|
relative to the web server |
|
.Xr chroot 2 |
|
directory, to be specified without a trailing slash. |
|
This is prepended to the manpath when opening |
|
.Xr mandoc.db 5 |
|
and manual page files. |
|
.El |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
The |
The |
.Nm |
.Nm |
CGI program is call-compatible with queries from the traditional |
CGI program is call-compatible with queries from the traditional |
.Pa man.cgi |
.Pa man.cgi |
script by Wolfram Schneider. |
script by Wolfram Schneider. |
However, the results may not be quite the same. |
However, the output may not be quite the same. |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr apropos 1 , |
.Xr apropos 1 , |
.Xr mandoc.db 5 , |
.Xr mandoc.db 5 , |
.Xr makewhatis 8 , |
.Xr makewhatis 8 , |
.Xr slowcgi 8 |
.Xr slowcgi 8 |
|
.Sh HISTORY |
|
A version of |
|
.Nm |
|
based on |
|
.Xr mandoc 1 |
|
first appeared in mdocml-1.12.1 (March 2012). |
|
The current SQLite3-based version first appeared in |
|
.Ox 5.6 . |
.Sh AUTHORS |
.Sh AUTHORS |
.An -nosplit |
.An -nosplit |
The |
The |