From fe96e1360e5ae0b06ebcc7fa1d8fa5e38846093b Mon Sep 17 00:00:00 2001 From: Kristaps Dzonsons Date: Sun, 25 Dec 2011 19:35:44 +0000 Subject: State default usage before listing arguments of a utility. Inspired by a patch to mandocdb.8 by schwarze@ some time ago. Ok jmc@. --- catman.8 | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) (limited to 'catman.8') 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 .\" @@ -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 -- cgit v1.2.3