=================================================================== RCS file: /cvs/mandoc/catman.8,v retrieving revision 1.1 retrieving revision 1.5 diff -u -p -r1.1 -r1.5 --- mandoc/catman.8 2011/11/26 19:54:13 1.1 +++ mandoc/catman.8 2011/12/25 19:35:44 1.5 @@ -1,4 +1,4 @@ -.\" $Id: catman.8,v 1.1 2011/11/26 19:54:13 kristaps Exp $ +.\" $Id: catman.8,v 1.5 2011/12/25 19:35:44 kristaps Exp $ .\" .\" Copyright (c) 2011 Kristaps Dzonsons .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: November 26 2011 $ +.Dd $Mdocdate: December 25 2011 $ .Dt CATMAN 8 .Os .Sh NAME @@ -23,19 +23,37 @@ .Sh SYNOPSIS .Nm catman .Op Fl fv +.Op Fl C Ar file .Op Fl M Ar manpath .Op Fl m Ar manpath .Op Fl o Ar path .Sh DESCRIPTION The .Nm -utility updates cached manpages for a jailed man.cgi. +utility updates cached manpages for a jailed +.Xr man.cgi 7 . +.Pp +By default, +.Nm +searches for +.Xr mandocdb 8 +databases in the default paths stipulated by +.Xr man 1 +and updates the cache in +.Pa /var/www/cache/man.cgi . +.Pp Its arguments are as follows: .Bl -tag -width Ds .It Fl f Force an update to all files. .It Fl v Print each file being updated. +.It Fl C Ar file +Specify an alternative configuration +.Ar file +in +.Xr man.conf 5 +format. .It Fl M Ar manpath Use the colon-separated path instead of the default list of paths searched for @@ -43,7 +61,7 @@ searched for databases. Invalid paths, or paths without manual databases, are ignored. .It Fl m Ar manpath -Append the colon-separated paths to the list of paths searched +Prepend the colon-separated paths to the list of paths searched for .Xr mandocdb 8 databases. @@ -53,26 +71,37 @@ Update into the directory tree under .Ar path . .El .Pp -By default, -.Nm -searches for +Cache updates occur when a .Xr mandocdb 8 -databases in the default paths stipulated by -.Xr man 1 -and updates the cache in -.Pa /var/www/cache/man.cgi . -.Pp -An update occurs when a -.Xr mandocdb 8 -database is older than the cached copy. +database is older than the cached copy unless +.Fl f +is specified, in which case files are always considered out of date. Cached manual pages are only updated if older than the master copy. +.Sh ENVIRONMENT +.Bl -tag -width Ds +.It Ev MANPATH +Colon-separated paths modifying the default list of paths searched for +manual databases. +Invalid paths, or paths without manual databases, are ignored. +Overridden by +.Fl M . If -.Fl f -is specified, all files are updated. +.Ev MANPATH +begins with a +.Sq \&: , +it is appended to the default list; +else if it ends with +.Sq \&: , +it is prepended to the default list; else if it contains +.Sq \&:: , +the default list is inserted between the colons. +If none of these conditions are met, it overrides the default list. +.El .Sh EXIT STATUS .Ex -std .Sh SEE ALSO .Xr mandoc 1 , +.Xr man.cgi 7 , .Xr mandocdb 8 .Sh AUTHORS The