=================================================================== RCS file: /cvs/mandoc/Attic/man.cgi.7,v retrieving revision 1.1 retrieving revision 1.4 diff -u -p -r1.1 -r1.4 --- mandoc/Attic/man.cgi.7 2011/11/24 12:43:34 1.1 +++ mandoc/Attic/man.cgi.7 2011/12/07 13:00:40 1.4 @@ -1,4 +1,4 @@ -.Dd $Mdocdate: November 24 2011 $ +.Dd $Mdocdate: December 7 2011 $ .Dt MAN.CGI 7 .Os .Sh NAME @@ -13,33 +13,15 @@ script queries and displays manual pages. It interfaces with .Xr mandocdb 8 databases for query and with -.Xr mandoc 1 +.Xr mandoc 3 for display. -This script operates in two modes: secure and insecure. -.Bl -tag -width Ds -.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 +It operates over a cache of manuals generated by +.Xr catman 8 . .Pp -To run in insecure mode, drop -.Nm -into your web-server's CGI directory. -The environment variable -.Ev INSECURE -must be set. -.Pp -To run in secure mode, you must maintain a cache directory of -preformatted manuals using -.Xr manup 8 . +To use +.Nm , +first create a manual cache in +.Xr catman 8 . If your web-server is running in a jail, the cache directory must be within the jail. Set the environment variable @@ -51,24 +33,31 @@ If you're running in a jailed web-server, make sure th directory exists and is writable. .Sh ENVIRONMENT .Bl -tag -width Ds -.It Er INSECURE -Run in insecure mode. -Not recommended. .It Er CACHE_DIR The absolute path of the -.Xr manup 8 +.Xr catman 8 cache directory. .El .Sh FILES -The configuration file -.Pa etc/man.conf -must exist within the cache directory. -This is built by -.Xr manup 8 . +.Bl -tag -width Ds +.It Pa etc/catman.conf +Built by +.Xr catman 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 -.Xr apropos 1 , -.Xr mandoc 1 , -.Xr manup 8 , +.Xr mandoc 3 , +.Xr catman 8 , .Xr mandocdb 8 .Sh AUTHORS The