two typos; patch from Raf Czlonka <rczlonka at gmail dot com>

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

index a2b99ad04f159f254087b5e869e32a1a21282e97..e83248cc2f5b0fe0bbf2a9641487c98cdf5f9226 100644 (file)
--- a/man.cgi.3
+++ b/man.cgi.3
@@ -1,6 +1,6 @@
-.\"    $Id: man.cgi.3,v 1.1 2016/04/15 21:16:22 schwarze Exp $
+.\"    $Id: man.cgi.3,v 1.4 2017/03/15 13:18:53 schwarze Exp $
  .\"
-.\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2016, 2017 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
@@ -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: April 15 2016 $
+.Dd $Mdocdate: March 15 2017 $
  .Dt MAN.CGI 3
  .Os
  .Sh NAME
@@ -55,14 +55,13 @@ the data directory containing all the manual trees;
  calls
  .Fn parse_manpath_conf ;
  .It
-calls
-.Fn parse_path_info ;
-.It
-calls
-.Fn parse_query_string
  if
  .Ev PATH_INFO
-is empty;
+is empty, calls
+.Fn parse_query_string ;
+otherwise,
+calls
+.Fn parse_path_info ;
  .It
  validates the manpath and the architecture;
  .It
@@ -127,12 +126,30 @@ contains a search query in short format or when
  is empty and a
  .Ev QUERY_STRING
  is provided.
-It changes into the manpath and calls
+If possible, requests using
+.Ev QUERY_STRING
+are redirected to URIs using
+.Ev PATH_INFO
+by calling
+.Fn pg_redirect .
+Otherwise, it changes into the manpath and calls
  .Xr mansearch 3 .
  Depending on the result, it calls either
  .Fn pg_noresult
  or
  .Fn pg_searchres .
+.It Ft void Fn pg_redirect "const struct req *req" "const char *name"
+This function is special in so far as it does not print an HTML page,
+but only an HTTP 303 response with a Location: of the form:
+.Sm off
+.No http://
+.Ar host Ns /
+.Op Ar scriptname Ns /
+.Op Ar manpath Ns /
+.Op Ar arch Ns /
+.Fa name
+.Op Pf . Ar sec
+.Sm on
  .It Ft void Fn pg_noresult "const struct req *req" "const char *msg"
  This function calls
  .Fn resp_begin_html ,
@@ -220,16 +237,26 @@ and
  are used.
  The highest level result generators are:
  .Bl -tag -width 1n
-.It Ft void Fn resp_begin_html "int code" "const char *msg"
+.It Ft void Fn resp_begin_html "int code" "const char *msg" "const char *file"
  This generator calls
  .Fn resp_begin_http
  to print the HTTP headers, then prints the HTML header up to the
  opening tag of the <body> element, then copies the file
  .Pa header.html
  to the output, if it exists and is readable.
-.It Ft void Fn resp_searchform "const struct req *req"
+If
+.Fa file
+is not
+.Dv NULL ,
+it is used for the <title> element.
+.It Ft void Fn resp_searchform "const struct req *req" "enum focus focus"
  This generator prints a search form, filling it with data
  from the provided request object.
+If the
+.Fa focus
+argument is
+.Dv FOCUS_QUERY ,
+it sets the document's autofocus to the query input box.
  .It Ft void Fn resp_show "const struct req *req" "const char *file"
  This wrapper dispatches to either
  .Fn resp_catman
@@ -278,5 +305,6 @@ and does not ascend to parent directories.
  .Sh SEE ALSO
  .Xr mandoc 3 ,
  .Xr mansearch 3 ,
+.Xr mchars_alloc 3 ,
  .Xr mandoc.db 5 ,
  .Xr man.cgi 8