aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/catman.8
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2011-12-25 19:35:44 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2011-12-25 19:35:44 +0000
commitfe96e1360e5ae0b06ebcc7fa1d8fa5e38846093b (patch)
tree83c49312a96c65a95ef35f03cf8ed9c774d8131a /catman.8
parentca227bf5f3d09e4e0e8db2c2931780855601912a (diff)
downloadmandoc-fe96e1360e5ae0b06ebcc7fa1d8fa5e38846093b.tar.gz
mandoc-fe96e1360e5ae0b06ebcc7fa1d8fa5e38846093b.tar.zst
mandoc-fe96e1360e5ae0b06ebcc7fa1d8fa5e38846093b.zip
State default usage before listing arguments of a utility. Inspired by a
patch to mandocdb.8 by schwarze@ some time ago. Ok jmc@.
Diffstat (limited to 'catman.8')
-rw-r--r--catman.832
1 files changed, 16 insertions, 16 deletions
diff --git a/catman.8 b/catman.8
index fdd4cc9d..f5246f9a 100644
--- a/catman.8
+++ b/catman.8
@@ -1,4 +1,4 @@
-.\" $Id: catman.8,v 1.4 2011/12/24 22:37:16 kristaps Exp $
+.\" $Id: catman.8,v 1.5 2011/12/25 19:35:44 kristaps Exp $
.\"
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\"
@@ -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: December 24 2011 $
+.Dd $Mdocdate: December 25 2011 $
.Dt CATMAN 8
.Os
.Sh NAME
@@ -32,6 +32,16 @@ The
.Nm
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
@@ -61,22 +71,12 @@ Update into the directory tree under
.Ar path .
.El
.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
-An update occurs when a
+Cache updates occur when a
.Xr mandocdb 8
-database is older than the cached copy.
-Cached manual pages are only updated if older than the master copy.
-If
+database is older than the cached copy unless
.Fl f
-is specified, all files are updated.
+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