Annotation of mandoc/man.cgi.7, Revision 1.4
1.4 ! kristaps 1: .Dd $Mdocdate: December 4 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
15: databases for query and with
1.3 kristaps 16: .Xr mandoc 3
1.1 kristaps 17: for display.
1.2 kristaps 18: It operates over a cache of manuals generated by
19: .Xr catman 8 .
1.1 kristaps 20: .Pp
1.2 kristaps 21: To use
22: .Nm ,
23: first create a manual cache in
24: .Xr catman 8 .
1.1 kristaps 25: If your web-server is running in a jail, the cache directory must be
26: within the jail.
27: Set the environment variable
28: .Ev CACHE_DIR
29: to this directory, which defaults to
30: .Pa /cache/man.cgi .
31: If you're running in a jailed web-server, make sure the
32: .Pa /tmp
33: directory exists and is writable.
34: .Sh ENVIRONMENT
35: .Bl -tag -width Ds
36: .It Er CACHE_DIR
37: The absolute path of the
1.2 kristaps 38: .Xr catman 8
1.1 kristaps 39: cache directory.
40: .El
41: .Sh FILES
1.4 ! kristaps 42: .Bl -tag -width Ds
! 43: .It Pa etc/catman.conf
! 44: Built by
! 45: .Xr catman 8
! 46: and must exist under the configuration directory root.
! 47: .It Pa man.css
! 48: Must be visible in the server document root, used for styling source
! 49: manual page output.
! 50: .It Pa catman.css
! 51: Must be visible in the server document root, used for styling
! 52: pre-formatted manual page output.
! 53: .It Pa man.cgi.css
! 54: Must be visible in the server document root, used for general styling of
! 55: .Nm
! 56: search and error pages.
! 57: .El
1.1 kristaps 58: .Sh SEE ALSO
1.3 kristaps 59: .Xr mandoc 3 ,
1.2 kristaps 60: .Xr catman 8 ,
1.1 kristaps 61: .Xr mandocdb 8
62: .Sh AUTHORS
63: The
64: .Nm
65: utility was written by
66: .An Kristaps Dzonsons ,
67: .Mt kristaps@bsd.lv .
CVSweb