Return to man.cgi.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Make catman and man.cgi understand the index type-field.
Also make catman's man.conf be generated as catman.conf to avoid clobbering
a real man.conf file.
Finally, add a placeholder catman() function to man.cgi for preformatted
manuals in the cache.

.Dd $Mdocdate: December 4 2011 $
.Dt MAN.CGI 7
.Os
.Sh NAME
.Nm man.cgi
.Nd cgi for manpage query and display
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
The
.Nm
script queries and displays manual pages.
It interfaces with
.Xr mandocdb 8
databases for query and with
.Xr mandoc 3
for display.
It operates over a cache of manuals generated by
.Xr catman 8 .
.Pp
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
.Ev CACHE_DIR
to this directory, which defaults to
.Pa /cache/man.cgi .
If you're running in a jailed web-server, make sure the
.Pa /tmp
directory exists and is writable.
.Sh ENVIRONMENT
.Bl -tag -width Ds
.It Er CACHE_DIR
The absolute path of the
.Xr catman 8
cache directory.
.El
.Sh FILES
The configuration file
.Pa etc/catman.conf
must exist within the cache directory.
This is built by
.Xr catman 8 .
.Sh SEE ALSO
.Xr mandoc 3 ,
.Xr catman 8 ,
.Xr mandocdb 8
.Sh AUTHORS
The
.Nm
utility was written by
.An Kristaps Dzonsons ,
.Mt kristaps@bsd.lv .