Annotation of mandoc/catman.8, Revision 1.2
1.2 ! kristaps 1: .\" $Id: catman.8,v 1.1 2011/11/26 19:54:13 kristaps Exp $
1.1 kristaps 2: .\"
3: .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4: .\"
5: .\" Permission to use, copy, modify, and distribute this software for any
6: .\" purpose with or without fee is hereby granted, provided that the above
7: .\" copyright notice and this permission notice appear in all copies.
8: .\"
9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: .\"
1.2 ! kristaps 17: .Dd $Mdocdate: November 26 2011 $
1.1 kristaps 18: .Dt CATMAN 8
19: .Os
20: .Sh NAME
21: .Nm catman
22: .Nd update a man.cgi manpage cache
23: .Sh SYNOPSIS
24: .Nm catman
25: .Op Fl fv
26: .Op Fl M Ar manpath
27: .Op Fl m Ar manpath
28: .Op Fl o Ar path
29: .Sh DESCRIPTION
30: The
31: .Nm
1.2 ! kristaps 32: utility updates cached manpages for a jailed
! 33: .Xr man.cgi 7 .
1.1 kristaps 34: Its arguments are as follows:
35: .Bl -tag -width Ds
36: .It Fl f
37: Force an update to all files.
38: .It Fl v
39: Print each file being updated.
40: .It Fl M Ar manpath
41: Use the colon-separated path instead of the default list of paths
42: searched for
43: .Xr mandocdb 8
44: databases.
45: Invalid paths, or paths without manual databases, are ignored.
46: .It Fl m Ar manpath
47: Append the colon-separated paths to the list of paths searched
48: for
49: .Xr mandocdb 8
50: databases.
51: Invalid paths, or paths without manual databases, are ignored.
52: .It Fl o Ar path
53: Update into the directory tree under
54: .Ar path .
55: .El
56: .Pp
57: By default,
58: .Nm
59: searches for
60: .Xr mandocdb 8
61: databases in the default paths stipulated by
62: .Xr man 1
63: and updates the cache in
64: .Pa /var/www/cache/man.cgi .
65: .Pp
66: An update occurs when a
67: .Xr mandocdb 8
68: database is older than the cached copy.
69: Cached manual pages are only updated if older than the master copy.
70: If
71: .Fl f
72: is specified, all files are updated.
73: .Sh EXIT STATUS
74: .Ex -std
75: .Sh SEE ALSO
76: .Xr mandoc 1 ,
1.2 ! kristaps 77: .Xr man.cgi 7 ,
1.1 kristaps 78: .Xr mandocdb 8
79: .Sh AUTHORS
80: The
81: .Nm
82: utility was written by
83: .An Kristaps Dzonsons ,
84: .Mt kristaps@bsd.lv .
CVSweb