version 1.1, 2011/11/26 19:54:13 |
version 1.4, 2011/12/24 22:37:16 |
|
|
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm catman |
.Nm catman |
.Op Fl fv |
.Op Fl fv |
|
.Op Fl C Ar file |
.Op Fl M Ar manpath |
.Op Fl M Ar manpath |
.Op Fl m Ar manpath |
.Op Fl m Ar manpath |
.Op Fl o Ar path |
.Op Fl o Ar path |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility updates cached manpages for a jailed man.cgi. |
utility updates cached manpages for a jailed |
|
.Xr man.cgi 7 . |
Its arguments are as follows: |
Its arguments are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl f |
.It Fl f |
Force an update to all files. |
Force an update to all files. |
.It Fl v |
.It Fl v |
Print each file being updated. |
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 |
.It Fl M Ar manpath |
Use the colon-separated path instead of the default list of paths |
Use the colon-separated path instead of the default list of paths |
searched for |
searched for |
|
|
databases. |
databases. |
Invalid paths, or paths without manual databases, are ignored. |
Invalid paths, or paths without manual databases, are ignored. |
.It Fl m Ar manpath |
.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 |
for |
.Xr mandocdb 8 |
.Xr mandocdb 8 |
databases. |
databases. |
Line 69 Cached manual pages are only updated if older than the |
|
Line 77 Cached manual pages are only updated if older than the |
|
If |
If |
.Fl f |
.Fl f |
is specified, all files are updated. |
is specified, all files are updated. |
|
.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 |
|
.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 |
.Sh EXIT STATUS |
.Ex -std |
.Ex -std |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
|
.Xr man.cgi 7 , |
.Xr mandocdb 8 |
.Xr mandocdb 8 |
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |