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

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

version 1.1, 2011/11/24 12:43:34 version 1.4, 2011/12/07 13:00:40
Line 13  script queries and displays manual pages.
Line 13  script queries and displays manual pages.
 It interfaces with  It interfaces with
 .Xr mandocdb 8  .Xr mandocdb 8
 databases for query and with  databases for query and with
 .Xr mandoc 1  .Xr mandoc 3
 for display.  for display.
 This script operates in two modes: secure and insecure.  It operates over a cache of manuals generated by
 .Bl -tag -width Ds  .Xr catman 8 .
 .It insecure  
 Act as a web-based  
 .Xr apropos 1  
 and  
 .Xr mandoc 1 .  
 This assumes full access to the file-system.  
 It is not recommended for public-facing servers.  
 .It secure  
 Act on manual pages cached by  
 .Xr manup 8 .  
 A cached file tree is queried for pre-formatted manuals.  
 .El  
 .Pp  .Pp
 To run in insecure mode, drop  To use
 .Nm  .Nm ,
 into your web-server's CGI directory.  first create a manual cache in
 The environment variable  .Xr catman 8 .
 .Ev INSECURE  
 must be set.  
 .Pp  
 To run in secure mode, you must maintain a cache directory of  
 preformatted manuals using  
 .Xr manup 8 .  
 If your web-server is running in a jail, the cache directory must be  If your web-server is running in a jail, the cache directory must be
 within the jail.  within the jail.
 Set the environment variable  Set the environment variable
Line 51  If you're running in a jailed web-server, make sure th
Line 33  If you're running in a jailed web-server, make sure th
 directory exists and is writable.  directory exists and is writable.
 .Sh ENVIRONMENT  .Sh ENVIRONMENT
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Er INSECURE  
 Run in insecure mode.  
 Not recommended.  
 .It Er CACHE_DIR  .It Er CACHE_DIR
 The absolute path of the  The absolute path of the
 .Xr manup 8  .Xr catman 8
 cache directory.  cache directory.
 .El  .El
 .Sh FILES  .Sh FILES
 The configuration file  .Bl -tag -width Ds
 .Pa etc/man.conf  .It Pa etc/catman.conf
 must exist within the cache directory.  Built by
 This is built by  .Xr catman 8
 .Xr manup 8 .  and must exist under the configuration directory root.
   .It Pa man.css
   Must be visible in the server document root, used for styling source
   manual page output.
   .It Pa catman.css
   Must be visible in the server document root, used for styling
   pre-formatted manual page output.
   .It Pa man.cgi.css
   Must be visible in the server document root, used for general styling of
   .Nm
   search and error pages.
   .El
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr apropos 1 ,  .Xr mandoc 3 ,
 .Xr mandoc 1 ,  .Xr catman 8 ,
 .Xr manup 8 ,  
 .Xr mandocdb 8  .Xr mandocdb 8
 .Sh AUTHORS  .Sh AUTHORS
 The  The
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.4
CVSweb