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

Diff for /mandoc/man.cgi.8 between version 1.7 and 1.14

version 1.7, 2014/07/18 19:03:39 version 1.14, 2016/03/18 01:22:56
Line 1 
Line 1 
 .\"     $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
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  .Dq Submit
Line 155  database inside each manpath.
Line 161  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
   .Ox
   .Xr httpd 8
   or
 .Xr nginx 8 ,  .Xr nginx 8 ,
 the  the
 .Xr slowcgi 8  .Xr slowcgi 8
Line 181  and to be specified without a trailing slash.
Line 190  and to be specified without a trailing slash.
 When not specified, the CSS files  When not specified, the CSS files
 are assumed to be in the document root.  are assumed to be in the document root.
 This is used in generated HTML code.  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  .It Ev CUSTOMIZE_TITLE
 An ASCII string to be used for the HTML  An ASCII string to be used for the HTML <TITLE> element.
 .Aq TITLE  .It Ev HTTP_HOST
 element.  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  .It Ev MAN_DIR
 A path to the  A path to the
 .Nm  .Nm
Line 230  The host name and a following slash.
Line 238  The host name and a following slash.
 .It  .It
 The path to the program, normally  The path to the program, normally
 .Pa cgi-bin/man.cgi/ .  .Pa cgi-bin/man.cgi/ .
   On
   .Lk http://man.openbsd.org/ ,
   .Xr httpd 8
   is configured such that the path to the program can be omitted.
 .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 Oo / Cm man Ar sec Oc 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 262  For backward compatibility with the traditional
Line 279  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 the
   .Ev SCRIPT_NAME ,
   to all manpaths, and to all 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 :
Line 274  and ending before the
Line 319  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.
Line 288  binary relative to the server root, usually
Line 333  binary relative to the server root, usually
 .Pa /cgi-bin/man.cgi .  .Pa /cgi-bin/man.cgi .
 This is used for generating URIs to be embedded  This is used for generating URIs to be embedded
 in generated HTML code and HTTP headers.  in generated HTML code and HTTP headers.
   If this contains any character not contained in the
   .Sx Restricted character set ,
   .Nm
   reports an internal server error and exits without doing anything.
 .El  .El
 .Sh FILES  .Sh FILES
 .Bl -tag -width Ds  .Bl -tag -width Ds
Line 306  Can be overridden by
Line 355  Can be overridden by
 The path to the server document root relative to the server root.  The path to the server document root relative to the server root.
 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
Line 327  Manual pages documenting
Line 371  Manual pages documenting
 itself, linked from the index page.  itself, linked from the index page.
 .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

Legend:
Removed from v.1.7  
changed lines
  Added in v.1.14

CVSweb