[BACK]Return to man.cgi.3 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.cgi.3 between version 1.1 and 1.4

version 1.1, 2016/04/15 21:16:22 version 1.4, 2017/03/15 13:18:53
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" 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  .\" 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
Line 55  the data directory containing all the manual trees;
Line 55  the data directory containing all the manual trees;
 calls  calls
 .Fn parse_manpath_conf ;  .Fn parse_manpath_conf ;
 .It  .It
   if
   .Ev PATH_INFO
   is empty, calls
   .Fn parse_query_string ;
   otherwise,
 calls  calls
 .Fn parse_path_info ;  .Fn parse_path_info ;
 .It  .It
 calls  
 .Fn parse_query_string  
 if  
 .Ev PATH_INFO  
 is empty;  
 .It  
 validates the manpath and the architecture;  validates the manpath and the architecture;
 .It  .It
 calls the appropriate one among the  calls the appropriate one among the
Line 127  contains a search query in short format or when
Line 126  contains a search query in short format or when
 is empty and a  is empty and a
 .Ev QUERY_STRING  .Ev QUERY_STRING
 is provided.  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 .  .Xr mansearch 3 .
 Depending on the result, it calls either  Depending on the result, it calls either
 .Fn pg_noresult  .Fn pg_noresult
 or  or
 .Fn pg_searchres .  .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"  .It Ft void Fn pg_noresult "const struct req *req" "const char *msg"
 This function calls  This function calls
 .Fn resp_begin_html ,  .Fn resp_begin_html ,
Line 220  and
Line 237  and
 are used.  are used.
 The highest level result generators are:  The highest level result generators are:
 .Bl -tag -width 1n  .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  This generator calls
 .Fn resp_begin_http  .Fn resp_begin_http
 to print the HTTP headers, then prints the HTML header up to the  to print the HTTP headers, then prints the HTML header up to the
 opening tag of the <body> element, then copies the file  opening tag of the <body> element, then copies the file
 .Pa header.html  .Pa header.html
 to the output, if it exists and is readable.  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  This generator prints a search form, filling it with data
 from the provided request object.  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"  .It Ft void Fn resp_show "const struct req *req" "const char *file"
 This wrapper dispatches to either  This wrapper dispatches to either
 .Fn resp_catman  .Fn resp_catman
Line 278  and does not ascend to parent directories.
Line 305  and does not ascend to parent directories.
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 3 ,  .Xr mandoc 3 ,
 .Xr mansearch 3 ,  .Xr mansearch 3 ,
   .Xr mchars_alloc 3 ,
 .Xr mandoc.db 5 ,  .Xr mandoc.db 5 ,
 .Xr man.cgi 8  .Xr man.cgi 8

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.4

CVSweb