diff options
Diffstat (limited to 'man.cgi.7')
| -rw-r--r-- | man.cgi.7 | 41 |
1 files changed, 10 insertions, 31 deletions
@@ -1,4 +1,4 @@ -.Dd $Mdocdate: November 24 2011 $ +.Dd $Mdocdate: November 27 2011 $ .Dt MAN.CGI 7 .Os .Sh NAME @@ -15,31 +15,13 @@ It interfaces with databases for query and with .Xr mandoc 1 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 -.Pp -To run in insecure mode, drop -.Nm -into your web-server's CGI directory. -The environment variable -.Ev INSECURE -must be set. +It operates over a cache of manuals generated by +.Xr catman 8 . .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,12 +33,9 @@ If you're running in a jailed web-server, make sure the 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 @@ -64,11 +43,11 @@ The configuration file .Pa etc/man.conf must exist within the cache directory. This is built by -.Xr manup 8 . +.Xr catman 8 . .Sh SEE ALSO .Xr apropos 1 , .Xr mandoc 1 , -.Xr manup 8 , +.Xr catman 8 , .Xr mandocdb 8 .Sh AUTHORS The |