Return to man.cgi.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/man.cgi.7, Revision 1.6

1.6     ! kristaps    1: .Dd $Mdocdate: December 10 2011 $
1.1       kristaps    2: .Dt MAN.CGI 7
                      3: .Os
                      4: .Sh NAME
                      5: .Nm man.cgi
                      6: .Nd cgi for manpage query and display
                      7: .Sh SYNOPSIS
                      8: .Nm
                      9: .Sh DESCRIPTION
                     10: The
                     11: .Nm
                     12: script queries and displays manual pages.
                     13: It interfaces with
                     14: .Xr mandocdb 8
1.5       kristaps   15: databases cached with
1.2       kristaps   16: .Xr catman 8 .
1.1       kristaps   17: .Pp
1.2       kristaps   18: To use
                     19: .Nm ,
1.5       kristaps   20: create a manual cache in
1.2       kristaps   21: .Xr catman 8 .
1.5       kristaps   22: Assign this directory to the environment variable
                     23: .Ev CACHE_DIR ,
                     24: defaulting to
                     25: .Pa /cache/man.cgi .
                     26: Copy the
                     27: .Pa man.cgi
                     28: script into your CGI directory (see
                     29: .Sx FILES
                     30: for other relevant files).
                     31: .Pp
                     32: Multiple
                     33: .Xr catman 8
                     34: trees may be managed by
                     35: .Nm :
                     36: directories under
1.1       kristaps   37: .Ev CACHE_DIR
1.5       kristaps   38: containing
                     39: .Pa etc/catman.conf
                     40: are identified as
                     41: .Qq manroots .
1.6     ! kristaps   42: The path of a manroot under
1.5       kristaps   43: .Ev CACHE_DIR
                     44: is converted to a name by replacing path separators with spaces.
                     45: .Pp
                     46: Thus, if
                     47: .Ev CACHE_DIR
                     48: is the default
                     49: .Pa /cache/man.cgi ,
                     50: the web-server is jailed to
                     51: .Pa /var/www ,
                     52: and cache subdirectories
                     53: .Pa ./foo/1
                     54: and
                     55: .Pa ./bar/2
                     56: contain
                     57: .Pa etc/catman.conf ,
                     58: .Nm
                     59: will assign these to manroots
                     60: .Qq foo 1
                     61: and
                     62: .Qq bar 2 ,
                     63: respectively.
                     64: These names will appear as choices when searching for manuals.
                     65: .Pp
                     66: If
                     67: .Nm
                     68: finds only one manroot, or none, then the selection box is omitted.
                     69: If no manroot is specified during search, the first manroot is used by
                     70: default.
1.1       kristaps   71: .Sh ENVIRONMENT
                     72: .Bl -tag -width Ds
                     73: .It Er CACHE_DIR
                     74: The absolute path of the
1.2       kristaps   75: .Xr catman 8
1.1       kristaps   76: cache directory.
                     77: .El
                     78: .Sh FILES
1.4       kristaps   79: .Bl -tag -width Ds
                     80: .It Pa etc/catman.conf
                     81: Built by
                     82: .Xr catman 8
1.5       kristaps   83: and must exist at least once under the configuration directory root.
1.4       kristaps   84: .It Pa man.css
                     85: Must be visible in the server document root, used for styling source
                     86: manual page output.
                     87: .It Pa catman.css
                     88: Must be visible in the server document root, used for styling
                     89: pre-formatted manual page output.
                     90: .It Pa man.cgi.css
                     91: Must be visible in the server document root, used for general styling of
                     92: .Nm
                     93: search and error pages.
                     94: .El
1.5       kristaps   95: .Sh COMPATIBILITY
                     96: The
                     97: .Nm
                     98: script is call-compatible with queries from the traditional
                     99: .Pa man.cgi
                    100: script by Wolfram Schneider.
                    101: However, the results may not be quite the same.
1.1       kristaps  102: .Sh SEE ALSO
1.2       kristaps  103: .Xr catman 8 ,
1.1       kristaps  104: .Xr mandocdb 8
                    105: .Sh AUTHORS
                    106: The
                    107: .Nm
                    108: utility was written by
                    109: .An Kristaps Dzonsons ,
                    110: .Mt kristaps@bsd.lv .
1.5       kristaps  111: .Sh CAVEATS
                    112: If you're running in a jailed web-server, make sure the
                    113: .Pa /tmp
                    114: directory exists and is writable.
                    115: The databases may need this for scratch space.