Annotation of mandoc/man.cgi.7, Revision 1.2
1.2 ! kristaps 1: .Dd $Mdocdate: November 24 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
16: .Xr mandoc 1
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
42: The configuration file
43: .Pa etc/man.conf
44: must exist within the cache directory.
45: This is built by
1.2 ! kristaps 46: .Xr catman 8 .
1.1 kristaps 47: .Sh SEE ALSO
48: .Xr apropos 1 ,
49: .Xr mandoc 1 ,
1.2 ! kristaps 50: .Xr catman 8 ,
1.1 kristaps 51: .Xr mandocdb 8
52: .Sh AUTHORS
53: The
54: .Nm
55: utility was written by
56: .An Kristaps Dzonsons ,
57: .Mt kristaps@bsd.lv .
CVSweb