In man(1) mode, properly clean up the resn[] result array

[mandoc.git] / man.cgi.8

diff --git a/man.cgi.8 b/man.cgi.8
index db6cd89779c04dd0b45d5fd7d488a6d6077a2bdd..b8cd623c598d87672f643f71fab10afa36ba4508 100644 (file)
--- a/man.cgi.8
+++ b/man.cgi.8
@@ -1,6 +1,6 @@
-.\"     $Id: man.cgi.8,v 1.3 2014/07/12 23:41:04 schwarze Exp $
+.\"    $Id: man.cgi.8,v 1.23 2018/05/20 21:48:44 schwarze Exp $

 .\"
 .\"

-.\" 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
 .\" purpose with or without fee is hereby granted, provided that the above
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above


@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: July 12 2014 $
+.Dd $Mdocdate: May 20 2018 $

 .Dt MAN.CGI 8
 .Os
 .Sh NAME
 .Dt MAN.CGI 8
 .Os
 .Sh NAME


@@ -26,9 +26,9 @@ The
 CGI program searches for manual pages on a WWW server
 and displays them to HTTP clients,
 providing functionality equivalent to the
 CGI program searches for manual pages on a WWW server
 and displays them to HTTP clients,
 providing functionality equivalent to the

-.Xr apropos 1
-and

 .Xr man 1
 .Xr man 1

+and
+.Xr apropos 1

 utilities.
 It can use multiple manual trees in parallel.
 .Ss HTML search interface
 utilities.
 It can use multiple manual trees in parallel.
 .Ss HTML search interface


@@ -37,26 +37,43 @@ At the top of each generated HTML page,
 displays a search form containing these elements:
 .Bl -enum
 .It
 displays a search form containing these elements:
 .Bl -enum
 .It

-A
-.Dq Search
-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
+An input box for search queries, expecting
+either a name of a manual page or an

 .Ar expression
 using the syntax described in the
 .Xr apropos 1
 manual; filling this in is required for each search.
 .Ar expression
 using the syntax described in the
 .Xr apropos 1
 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
+A
+.Xr man 1
+submit button.
+The string in the input box is interpreted as the name of a manual page.

 .It
 .It

-An input box for an optional section number.
+An
+.Xr apropos 1
+submit button.
+The string in the input box is interpreted as a search
+.Ar expression .
+.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
 .Fl s
 option.
 Otherwise, pages from all sections are shown.
 .It
 .Xr apropos 1
 .Fl s
 option.
 Otherwise, pages from all sections are shown.
 .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
 .Fl S
 option.
 .Xr apropos 1
 .Fl S
 option.


@@ -67,12 +84,6 @@ If the configuration file
 .Pa /var/www/man/manpath.conf
 contains only one manpath, the dropdown menu is not shown.
 By default, the first manpath given in the file is used.
 .Pa /var/www/man/manpath.conf
 contains only one manpath, the dropdown menu is not shown.
 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
 .Ss Program output
 The
 .El
 .Ss Program output
 The


@@ -93,6 +104,9 @@ Lists are returned when searches match more than one manual page.
 The first column shows the names and section numbers of manuals
 as clickable links.
 The second column shows the one-line descriptions of the manuals.
 The first column shows the names and section numbers of manuals
 as clickable links.
 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.
 This output format is used when a search matches exactly one
 manual page, or when a link on a list page or an
 .It A manual page.
 This output format is used when a search matches exactly one
 manual page, or when a link on a list page or an


@@ -100,7 +114,7 @@ manual page, or when a link on a list page or an
 link on another manual page is followed.
 .It A no-result page.
 This is shown when a search request returns no results -
 link on another manual page is followed.
 .It A no-result page.
 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.
 .It \&An error page.
 This cannot happen by merely clicking the
 the search does not match any manual pages.
 .It \&An error page.
 This cannot happen by merely clicking the


@@ -145,10 +159,75 @@ database inside each manpath.
 Configure your web server to execute CGI programs located in
 .Pa /cgi-bin .
 When using
 Configure your web server to execute CGI programs located in
 .Pa /cgi-bin .
 When using

-.Xr nginx 8 ,
+.Ox
+.Xr httpd 8 ,

 the
 .Xr slowcgi 8
 proxy daemon is needed to translate FastCGI requests to plain old CGI.
 the
 .Xr slowcgi 8
 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
 .Nm
 uniform resource identifiers are not needed for interactive use,
 .Ss URI interface
 .Nm
 uniform resource identifiers are not needed for interactive use,


@@ -158,84 +237,93 @@ They consist of:
 .It
 The
 .Cm http://
 .It
 The
 .Cm http://

+or
+.Cm https://

 protocol specifier.
 .It
 protocol specifier.
 .It

-The host name and a following slash.
-.It
-The path to the program, normally
-.Pa cgi-bin/man.cgi/ .
+The host name.

 .It
 .It

-A page name, which can be
-.Cm index ,
-which is the default and can be omitted,
-.Cm search ,
-or
-.Cm show .
+The
+.Dv SCRIPT_NAME ,
+preceded by a slash unless empty.

 .It
 .It

-For
-.Cm show
-only, 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
 .Pa /OpenBSD-current/man1/mandoc.1 .
 and the name of the requested file, for example
 .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
-.Cm search
-only, a query string starting with a question mark
+For searches, a query string starting with a question mark

 and consisting of
 .Ar key Ns = Ns Ar value
 pairs, separated by ampersands, for example
 and consisting of
 .Ar key Ns = Ns Ar value
 pairs, separated by ampersands, for example

-.Pa ?manpath=OpenBSD-current&expr=mandoc .
+.Pa ?manpath=OpenBSD-current&query=mandoc .

 Supported keys are
 .Cm manpath ,
 Supported keys are
 .Cm manpath ,

-.Cm expr ,
+.Cm query ,

 .Cm sec ,
 .Cm sec ,

-and

 .Cm arch ,
 corresponding to
 .Xr apropos 1
 .Fl M ,
 .Ar expression ,
 .Fl s ,
 .Cm arch ,
 corresponding to
 .Xr apropos 1
 .Fl M ,
 .Ar expression ,
 .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
 .Nm ,
 For backward compatibility with the traditional
 .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 .
 .El
 .Cm sec .
 .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
 The web server may pass the following CGI variables to
 .Nm :
 .Bl -tag -width Ds
 .Sh ENVIRONMENT
 The web server may pass the following CGI variables to
 .Nm :
 .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
-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
-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 SCRIPT_NAME
+The initial part of the URI passed from the client to the server,
+starting after the server's host name and ending before
+.Ev PATH_INFO .
+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
 The final part of the URI path passed from the client to the server,
 starting after the
 .It Ev PATH_INFO
 The final part of the URI path passed from the client to the server,
 starting after the


@@ -244,20 +332,13 @@ and ending before the
 .Ev QUERY_STRING .
 It is used by the
 .Cm show
 .Ev QUERY_STRING .
 It is used by the
 .Cm show

-page to aquire the manpath and filename it needs.
+page to acquire the manpath and filename it needs.

 .It Ev QUERY_STRING
 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 used by the
 .Cm search
 page to acquire the named parameters it needs.
 .It Ev QUERY_STRING
 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 used by the
 .Cm search
 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
 .Sh FILES
 .Bl -tag -width Ds
 .El
 .Sh FILES
 .Bl -tag -width Ds


@@ -267,32 +348,44 @@ Default web server
 directory.
 All the following paths are specified relative to this directory.
 .It Pa /cgi-bin/man.cgi
 directory.
 All the following paths are specified relative to this directory.
 .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.
-Can be overridden by
-.Ev SCRIPT_NAME .
+program inside the web server
+.Xr chroot 2
+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
 .Nm .
 This is part of the web server configuration and not specific to
 .Nm .

-.It Pa /htdocs/man-cgi.css
-A style sheet for general
-.Nm
-styling, referenced from each generated HTML page.
-.It Pa /htdocs/man.css
+.It Pa /htdocs/mandoc.css

 A style sheet for
 .Xr mandoc 1
 A style sheet for
 .Xr mandoc 1

-HTML styling, referenced from each generated HTML page after
-.Pa man-cgi.css .
+HTML styling, referenced from each generated HTML page.

 .It Pa /man
 Default
 .Nm
 data directory containing all the manual trees.
 Can be overridden by
 .It Pa /man
 Default
 .Nm
 data directory containing all the manual trees.
 Can be overridden by

-.Ev MAN_DIR .
+.Dv MAN_DIR .

 .It Pa /man/manpath.conf
 The list of available manpaths, one per line.
 .It Pa /man/manpath.conf
 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
 An example
 .Xr mdoc 7
 .It Pa /man/OpenBSD-current/man1/mandoc.1
 An example
 .Xr mdoc 7


@@ -306,7 +399,7 @@ The
 CGI program is call-compatible with queries from the traditional
 .Pa man.cgi
 script by Wolfram Schneider.
 CGI program is call-compatible with queries from the traditional
 .Pa man.cgi
 script by Wolfram Schneider.

-However, the results may not be quite the same.
+However, the output looks quite different.

 .Sh SEE ALSO
 .Xr apropos 1 ,
 .Xr mandoc.db 5 ,
 .Sh SEE ALSO
 .Xr apropos 1 ,
 .Xr mandoc.db 5 ,


@@ -318,15 +411,16 @@ A version of
 based on
 .Xr mandoc 1
 first appeared in mdocml-1.12.1 (March 2012).
 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 .
+The current
+.Xr mandoc.db 5
+database format first appeared in
+.Ox 6.1 .

 .Sh AUTHORS
 .An -nosplit
 The
 .Nm
 program was written by
 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
 .Sh AUTHORS
 .An -nosplit
 The
 .Nm
 program was written by
 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv

-and ported to the SQLite3-based
-.Xr mandoc.db 5
-backend by
-.An Ingo Schwarze Aq Mt schwarze@openbsd.org .
+and is maintained by
+.An Ingo Schwarze Aq Mt schwarze@openbsd.org ,
+who also designed and implemented the database format.