version 1.4, 2014/07/13 00:19:51 |
version 1.23, 2018/05/20 21:48:44 |
|
|
.\" $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 |
|
|
CGI program searches for manual pages on a WWW server |
CGI program searches for manual pages on a WWW server |
and displays them to HTTP clients, |
and displays them to HTTP clients, |
providing functionality equivalent to the |
providing functionality equivalent to the |
.Xr apropos 1 |
|
and |
|
.Xr man 1 |
.Xr man 1 |
|
and |
|
.Xr apropos 1 |
utilities. |
utilities. |
It can use multiple manual trees in parallel. |
It can use multiple manual trees in parallel. |
.Ss HTML search interface |
.Ss HTML search interface |
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 |
|
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 |
.Xr man 1 |
or using |
submit button. |
|
The string in the input box is interpreted as the name of a manual page. |
|
.It |
|
An |
.Xr apropos 1 |
.Xr apropos 1 |
queries. |
submit button. |
|
The string in the input box is interpreted as a search |
|
.Ar expression . |
.It |
.It |
A dropdown menu to optionally select a manual section. |
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 |
Line 103 Lists are returned when searches match more than one m |
|
Line 104 Lists are returned when searches match more than one m |
|
The first column shows the names and section numbers of manuals |
The first column shows the names and section numbers of manuals |
as clickable links. |
as clickable links. |
The second column shows the one-line descriptions of the manuals. |
The second column shows the one-line descriptions of the manuals. |
|
For |
|
.Xr man 1 |
|
style searches, the content of the first manual page follows the list. |
.It A manual page. |
.It A manual page. |
This output format is used when a search matches exactly one |
This output format is used when a search matches exactly one |
manual page, or when a link on a list page or an |
manual page, or when a link on a list page or an |
Line 110 manual page, or when a link on a list page or an |
|
Line 114 manual page, or when a link on a list page or an |
|
link on another manual page is followed. |
link on another manual page is followed. |
.It A no-result page. |
.It A no-result page. |
This is shown when a search request returns no results - |
This is shown when a search request returns no results - |
eiher because it violates the query syntax, or because |
either because it violates the query syntax, or because |
the search does not match any manual pages. |
the search does not match any manual pages. |
.It \&An error page. |
.It \&An error page. |
This cannot happen by merely clicking the |
This cannot happen by merely clicking the |
Line 155 database inside each manpath. |
|
Line 159 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 |
.Xr nginx 8 , |
.Ox |
|
.Xr httpd 8 , |
the |
the |
.Xr slowcgi 8 |
.Xr slowcgi 8 |
proxy daemon is needed to translate FastCGI requests to plain old CGI. |
proxy daemon is needed to translate FastCGI requests to plain old CGI. |
|
.Pp |
|
To compile |
|
.Nm , |
|
first copy |
|
.Pa cgi.h.example |
|
to |
|
.Pa cgi.h |
|
and edit it according to your needs. |
|
It contains the following compile-time definitions: |
|
.Bl -tag -width Ds |
|
.It Ev COMPAT_OLDURI |
|
Only useful for running on www.openbsd.org to deal with old URIs containing |
|
.Qq "manpath=OpenBSD " |
|
where the blank character has to be translated to a hyphen. |
|
When compiling for other sites, this definition can be deleted. |
|
.It Dv CSS_DIR |
|
An optional file system path to the directory containing the file |
|
.Pa mandoc.css , |
|
to be specified relative to the server's document root, |
|
and to be specified without a trailing slash. |
|
When empty, the CSS file is assumed to be in the document root. |
|
Otherwise, a leading slash is needed. |
|
This is used in generated HTML code. |
|
.It Dv CUSTOMIZE_TITLE |
|
An ASCII string to be used for the HTML <TITLE> element. |
|
.It Dv MAN_DIR |
|
A file system path to the |
|
.Nm |
|
data directory relative to the web server |
|
.Xr chroot 2 |
|
directory, to be specified with a leading slash and without a trailing slash. |
|
It needs to have at least one component; the root directory cannot be used |
|
for this purpose. |
|
The files |
|
.Pa manpath.conf , |
|
.Pa header.html , |
|
and |
|
.Pa footer.html |
|
are looked up in this directory. |
|
It is also prepended to the manpath when opening |
|
.Xr mandoc.db 5 |
|
and manual page files. |
|
.It Dv SCRIPT_NAME |
|
The initial component of URIs, to be specified without leading |
|
and trailing slashes. |
|
It can be empty. |
|
.El |
|
.Pp |
|
After editing |
|
.Pa cgi.h , |
|
run |
|
.Pp |
|
.Dl make man.cgi |
|
.Pp |
|
and copy the resulting binary to the proper location, |
|
for example using the command: |
|
.Pp |
|
.Dl make installcgi |
|
.Pp |
|
In addition to that, make sure the default manpath contains the files |
|
.Pa man1/apropos.1 |
|
and |
|
.Pa man8/man.cgi.8 , |
|
or the documentation links at the bottom of the index page will not work. |
.Ss URI interface |
.Ss URI interface |
.Nm |
.Nm |
uniform resource identifiers are not needed for interactive use, |
uniform resource identifiers are not needed for interactive use, |
Line 168 They consist of: |
|
Line 237 They consist of: |
|
.It |
.It |
The |
The |
.Cm http:// |
.Cm http:// |
|
or |
|
.Cm https:// |
protocol specifier. |
protocol specifier. |
.It |
.It |
The host name and a following slash. |
The host name. |
.It |
.It |
The path to the program, normally |
The |
.Pa cgi-bin/man.cgi/ . |
.Dv SCRIPT_NAME , |
|
preceded by a slash unless empty. |
.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 |
|
.Op / Cm man Ar sec |
|
.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 206 For backward compatibility with the traditional |
|
Line 285 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 all manpaths and 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 |
.It Ev SCRIPT_NAME |
The FQDN of the (possibly virtual) host the HTTP server is running on. |
The initial part of the URI passed from the client to the server, |
This is used for |
starting after the server's host name and ending before |
.Ic Location: |
.Ev PATH_INFO . |
headers in HTTP 303 responses. |
This is ignored by |
|
.Nm . |
|
When constructing URIs for links and redirections, the |
|
.Dv SCRIPT_NAME |
|
preprocessor constant is used instead. |
.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 223 and ending before the |
|
Line 332 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. |
It is used by the |
It is used by the |
.Cm search |
.Cm search |
page to acquire the named parameters it needs. |
page to acquire the named parameters it needs. |
.It Ev SCRIPT_NAME |
|
The path to the |
|
.Nm |
|
binary relative to the server root, usually |
|
.Pa /cgi-bin/man.cgi . |
|
This is used for generating URIs to be embedded |
|
in generated HTML code and HTTP headers. |
|
.El |
.El |
.Sh FILES |
.Sh FILES |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
Line 246 Default web server |
|
Line 348 Default web server |
|
directory. |
directory. |
All the following paths are specified relative to this directory. |
All the following paths are specified relative to this directory. |
.It Pa /cgi-bin/man.cgi |
.It Pa /cgi-bin/man.cgi |
The path to the |
The usual file system path to the |
.Nm |
.Nm |
program relative to the server root. |
program inside the web server |
Can be overridden by |
.Xr chroot 2 |
.Ev SCRIPT_NAME . |
directory. |
|
A different name can be chosen, but in any case, it needs to be configured in |
|
.Xr httpd.conf 5 . |
.It Pa /htdocs |
.It Pa /htdocs |
The path to the server document root relative to the server root. |
The file system path to the server document root directory |
|
relative to the server |
|
.Xr chroot 2 |
|
directory. |
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 |
data directory containing all the manual trees. |
data directory containing all the manual trees. |
Can be overridden by |
Can be overridden by |
.Ev MAN_DIR . |
.Dv MAN_DIR . |
.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/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 |
Line 279 source file located below the |
|
Line 393 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 output may not be quite the same. |
However, the output looks quite different. |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr apropos 1 , |
.Xr apropos 1 , |
.Xr mandoc.db 5 , |
.Xr mandoc.db 5 , |
|
|
based on |
based on |
.Xr mandoc 1 |
.Xr mandoc 1 |
first appeared in mdocml-1.12.1 (March 2012). |
first appeared in mdocml-1.12.1 (March 2012). |
The current SQLite3-based version first appeared in |
The current |
.Ox 5.6 . |
.Xr mandoc.db 5 |
|
database format first appeared in |
|
.Ox 6.1 . |
.Sh AUTHORS |
.Sh AUTHORS |
.An -nosplit |
.An -nosplit |
The |
The |
.Nm |
.Nm |
program was written by |
program was written by |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv |
and ported to the SQLite3-based |
and is maintained by |
.Xr mandoc.db 5 |
.An Ingo Schwarze Aq Mt schwarze@openbsd.org , |
backend by |
who also designed and implemented the database format. |
.An Ingo Schwarze Aq Mt schwarze@openbsd.org . |
|