Annotation of mandoc/catman.8, Revision 1.3
1.3 ! kristaps 1: .\" $Id: catman.8,v 1.2 2011/12/04 22:52:50 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.3 ! kristaps 17: .Dd $Mdocdate: December 4 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
1.3 ! kristaps 26: .Op Fl C Ar file
1.1 kristaps 27: .Op Fl M Ar manpath
28: .Op Fl m Ar manpath
29: .Op Fl o Ar path
30: .Sh DESCRIPTION
31: The
32: .Nm
1.2 kristaps 33: utility updates cached manpages for a jailed
34: .Xr man.cgi 7 .
1.1 kristaps 35: Its arguments are as follows:
36: .Bl -tag -width Ds
37: .It Fl f
38: Force an update to all files.
39: .It Fl v
40: Print each file being updated.
1.3 ! kristaps 41: .It Fl C Ar file
! 42: Specify an alternative configuration
! 43: .Ar file
! 44: in
! 45: .Xr man.conf 5
! 46: format.
1.1 kristaps 47: .It Fl M Ar manpath
48: Use the colon-separated path instead of the default list of paths
49: searched for
50: .Xr mandocdb 8
51: databases.
52: Invalid paths, or paths without manual databases, are ignored.
53: .It Fl m Ar manpath
1.3 ! kristaps 54: Prepend the colon-separated paths to the list of paths searched
1.1 kristaps 55: for
56: .Xr mandocdb 8
57: databases.
58: Invalid paths, or paths without manual databases, are ignored.
59: .It Fl o Ar path
60: Update into the directory tree under
61: .Ar path .
62: .El
63: .Pp
64: By default,
65: .Nm
66: searches for
67: .Xr mandocdb 8
68: databases in the default paths stipulated by
69: .Xr man 1
70: and updates the cache in
71: .Pa /var/www/cache/man.cgi .
72: .Pp
73: An update occurs when a
74: .Xr mandocdb 8
75: database is older than the cached copy.
76: Cached manual pages are only updated if older than the master copy.
77: If
78: .Fl f
79: is specified, all files are updated.
1.3 ! kristaps 80: .Sh ENVIRONMENT
! 81: .Bl -tag -width Ds
! 82: .It Ev MANPATH
! 83: Colon-separated paths overriding the default list of paths searched for
! 84: manual databases.
! 85: Invalid paths, or paths without manual databases, are ignored.
! 86: Overridden by
! 87: .Fl M .
! 88: .El
1.1 kristaps 89: .Sh EXIT STATUS
90: .Ex -std
91: .Sh SEE ALSO
92: .Xr mandoc 1 ,
1.2 kristaps 93: .Xr man.cgi 7 ,
1.1 kristaps 94: .Xr mandocdb 8
95: .Sh AUTHORS
96: The
97: .Nm
98: utility was written by
99: .An Kristaps Dzonsons ,
100: .Mt kristaps@bsd.lv .
CVSweb