Annotation of mandoc/man.cgi.7, Revision 1.1
1.1 ! kristaps 1: .Dd $Mdocdate$
! 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.
! 18: This script operates in two modes: secure and insecure.
! 19: .Bl -tag -width Ds
! 20: .It insecure
! 21: Act as a web-based
! 22: .Xr apropos 1
! 23: and
! 24: .Xr mandoc 1 .
! 25: This assumes full access to the file-system.
! 26: It is not recommended for public-facing servers.
! 27: .It secure
! 28: Act on manual pages cached by
! 29: .Xr manup 8 .
! 30: A cached file tree is queried for pre-formatted manuals.
! 31: .El
! 32: .Pp
! 33: To run in insecure mode, drop
! 34: .Nm
! 35: into your web-server's CGI directory.
! 36: The environment variable
! 37: .Ev INSECURE
! 38: must be set.
! 39: .Pp
! 40: To run in secure mode, you must maintain a cache directory of
! 41: preformatted manuals using
! 42: .Xr manup 8 .
! 43: If your web-server is running in a jail, the cache directory must be
! 44: within the jail.
! 45: Set the environment variable
! 46: .Ev CACHE_DIR
! 47: to this directory, which defaults to
! 48: .Pa /cache/man.cgi .
! 49: If you're running in a jailed web-server, make sure the
! 50: .Pa /tmp
! 51: directory exists and is writable.
! 52: .Sh ENVIRONMENT
! 53: .Bl -tag -width Ds
! 54: .It Er INSECURE
! 55: Run in insecure mode.
! 56: Not recommended.
! 57: .It Er CACHE_DIR
! 58: The absolute path of the
! 59: .Xr manup 8
! 60: cache directory.
! 61: .El
! 62: .Sh FILES
! 63: The configuration file
! 64: .Pa etc/man.conf
! 65: must exist within the cache directory.
! 66: This is built by
! 67: .Xr manup 8 .
! 68: .Sh SEE ALSO
! 69: .Xr apropos 1 ,
! 70: .Xr mandoc 1 ,
! 71: .Xr manup 8 ,
! 72: .Xr mandocdb 8
! 73: .Sh AUTHORS
! 74: The
! 75: .Nm
! 76: utility was written by
! 77: .An Kristaps Dzonsons ,
! 78: .Mt kristaps@bsd.lv .
CVSweb