Don't retain the search query in the resulting manual links.

[mandoc.git] / man.cgi.8
diff --git a/man.cgi.8 b/man.cgi.8

index 69335e632ec99453ab02fcda0d86bb3d69d67881..2e54dbf4b81fd555325df0a4e725834d6287eafa 100644 (file)
--- a/man.cgi.8
+++ b/man.cgi.8
@@ -1,4 +1,4 @@
-.\"     $Id: man.cgi.8,v 1.9 2014/07/22 18:14:13 schwarze Exp $
+.\"     $Id: man.cgi.8,v 1.13 2015/11/05 20:55:41 schwarze Exp $
  .\"
  .\" Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
  .\"
@@ -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.
  .\"
-.Dd $Mdocdate: July 22 2014 $
+.Dd $Mdocdate: November 5 2015 $
  .Dt MAN.CGI 8
  .Os
  .Sh NAME
@@ -43,6 +43,12 @@ either a name of a manual page or an
  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
  .Dq Submit
@@ -155,6 +161,9 @@ database inside each manpath.
  Configure your web server to execute CGI programs located in
  .Pa /cgi-bin .
  When using
+.Ox
+.Xr httpd 8
+or
  .Xr nginx 8 ,
  the
  .Xr slowcgi 8
@@ -181,14 +190,8 @@ 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 CUSTOMIZE_BEGIN
-A HTML string to be inserted right after opening the
-.Aq BODY
-element.
  .It Ev CUSTOMIZE_TITLE
-An ASCII string to be used for the HTML
-.Aq TITLE
-element.
+An ASCII string to be used for the HTML <TITLE> element.
  .It Ev HTTP_HOST
  The FQDN of the (possibly virtual) host the HTTP server is running on.
  This is used for
@@ -307,7 +310,7 @@ and ending before the
  .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.
@@ -343,15 +346,10 @@ Can be overridden by
  The path to the server document root relative to the server root.
  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
-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
@@ -370,6 +368,12 @@ 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