mandoc/man.cgi.7 - diff

Return to man.cgi.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/man.cgi.7 between version 1.1 and 1.2

version 1.1, 2011/11/24 12:43:34

version 1.2, 2011/11/27 11:46:44

Line 15 It interfaces with

databases for query and with

.Xr mandoc 1

for display.

This script operates in two modes: secure and insecure.

It operates over a cache of manuals generated by

.Bl -tag -width Ds

.Xr catman 8 .

.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

To use

.Nm

.Nm ,

into your web-server's CGI directory.

first create a manual cache in

The environment variable

.Xr catman 8 .

.Ev INSECURE

must be set.

.Pp

To run in secure mode, you must maintain a cache directory of

preformatted manuals using

.Xr manup 8 .

If your web-server is running in a jail, the cache directory must be

within the jail.

Set the environment variable

Line 51 If you're running in a jailed web-server, make sure th

Line 33 If you're running in a jailed web-server, make sure th

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

Line 64 The configuration file

Line 43 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

CVSweb