State default usage before listing arguments of a utility. Inspired by a

patch to mandocdb.8 by schwarze@ some time ago.  Ok jmc@.

6 files changed, 70 insertions, 74 deletions

diff --git a/apropos.1 b/apropos.1
index a20ce399..f2e0171a 100644
--- a/apropos.1
+++ b/apropos.1
@@ -1,4 +1,4 @@
-.\"	$Id: apropos.1,v 1.15 2011/12/25 16:53:51 schwarze Exp $
+.\"	$Id: apropos.1,v 1.16 2011/12/25 19:35:44 kristaps Exp $
 .\"
 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
@@ -36,6 +36,20 @@ utility queries manual page databases generated by
 evaluating on
 .Ar expression
 for each file in each database.
+.Pp
+By default,
+.Nm
+searches for
+.Xr mandocdb 8
+databases in the default paths stipulated by
+.Xr man 1 ,
+parses terms as case-sensitive regular expressions
+.Pq the Li \&~ operator
+over manual names and descriptions
+.Pq the Li \&Nm No and Li \&Nd No macro keys .
+Multiple terms imply pairwise
+.Fl o .
+.Pp
 Its arguments are as follows:
 .Bl -tag -width Ds
 .It Fl C Ar file
@@ -126,18 +140,6 @@ is evaluated case-insensitively.
 Has no effect on substring terms.
 .El
 .Pp
-By default,
-.Nm
-searches for
-.Xr mandocdb 8
-databases in the default paths stipulated by
-.Xr man 1 ,
-parses terms as case-sensitive regular expressions
-.Pq the Li \&~ operator
-over manual names and descriptions
-.Pq the Li \&Nm No and Li \&Nd No macro keys .
-Multiple terms imply pairwise
-.Fl o .
 Results are sorted by manual title, with output formatted as
 .Pp
 .D1 title(sec) \- description
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
diff --git a/demandoc.1 b/demandoc.1
index 9d4ad218..845b9c14 100644
--- a/demandoc.1
+++ b/demandoc.1
@@ -1,4 +1,4 @@
-.\"	$Id: demandoc.1,v 1.5 2011/09/02 13:04:05 kristaps Exp $
+.\"	$Id: demandoc.1,v 1.6 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: September 2 2011 $
+.Dd $Mdocdate: December 25 2011 $
 .Dt DEMANDOC 1
 .Os
 .Sh NAME
@@ -33,6 +33,13 @@ and
 .Xr man 7
 .Ux
 manual files.
+.Pp
+By default,
+.Nm
+parses standard input and outputs only text nodes, preserving line
+and column position.
+Escape sequences are omitted from the output.
+.Pp
 Its arguments are as follows:
 .Bl -tag -width Ds
 .It Fl w
@@ -49,19 +56,8 @@ stripped.
 The input files.
 .El
 .Pp
-If
-.Ar file
-is not provided,
-.Nm
-accepts standard input.
 If a document is not well-formed, it is skipped.
 .Pp
-By default,
-.Nm
-parses its input and outputs only text nodes, preserving line column
-position.
-Escape sequences are omitted from the output.
-.Pp
 The
 .Fl i ,
 .Fl k ,
diff --git a/mandoc.1 b/mandoc.1
index 58242fee..dbff0e31 100644
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,4 +1,4 @@
-.\"	$Id: mandoc.1,v 1.99 2011/11/13 14:50:54 schwarze Exp $
+.\"	$Id: mandoc.1,v 1.100 2011/12/25 19:35:44 kristaps Exp $
 .\"
 .\" Copyright (c) 2009, 2010, 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: November 13 2011 $
+.Dd $Mdocdate: December 25 2011 $
 .Dt MANDOC 1
 .Os
 .Sh NAME
@@ -34,6 +34,19 @@ The
 utility formats
 .Ux
 manual pages for display.
+.Pp
+By default,
+.Nm
+reads
+.Xr mdoc 7
+or
+.Xr man 7
+text from stdin, implying
+.Fl m Ns Cm andoc ,
+and produces
+.Fl T Ns Cm ascii
+output.
+.Pp
 The arguments are as follows:
 .Bl -tag -width Ds
 .It Fl m Ns Ar format
@@ -96,18 +109,6 @@ If multiple files are specified,
 .Nm
 will halt with the first failed parse.
 .El
-.Pp
-By default,
-.Nm
-reads
-.Xr mdoc 7
-or
-.Xr man 7
-text from stdin, implying
-.Fl m Ns Cm andoc ,
-and produces
-.Fl T Ns Cm ascii
-output.
 .Ss Input Formats
 The
 .Nm
diff --git a/preconv.1 b/preconv.1
index 30d8fa4d..c4cb8c57 100644
--- a/preconv.1
+++ b/preconv.1
@@ -1,4 +1,4 @@
-.\"	$Id: preconv.1,v 1.5 2011/08/18 08:58:44 kristaps Exp $
+.\"	$Id: preconv.1,v 1.6 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: August 18 2011 $
+.Dd $Mdocdate: December 25 2011 $
 .Dt PRECONV 1
 .Os
 .Sh NAME
@@ -38,6 +38,11 @@ or other troff system supporting the
 escape sequence
 .Pc
 input.
+.Pp
+By default, it parses from standard output, determining encoding as
+described in
+.Sx Algorithm .
+.Pp
 Its arguments are as follows:
 .Bl -tag -width Ds
 .It Fl D Ar enc
@@ -48,15 +53,6 @@ The document's encoding.
 The input file.
 .El
 .Pp
-If
-.Ar file
-is not provided,
-.Nm
-accepts standard input.
-See
-.Sx Algorithm
-for encoding choice.
-.Pp
 The recoded input is written to standard output: Unicode characters in
 the ASCII range are printed as regular ASCII characters, while those
 above this range are printed using the
diff --git a/whatis.1 b/whatis.1
index 931b9588..ed1196ef 100644
--- a/whatis.1
+++ b/whatis.1
@@ -1,4 +1,4 @@
-.\"	$Id: whatis.1,v 1.6 2011/12/25 16:53:51 schwarze Exp $
+.\"	$Id: whatis.1,v 1.7 2011/12/25 19:35:44 kristaps Exp $
 .\"
 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
@@ -41,6 +41,13 @@ You can then use the
 .Xr man 1
 command to get more information.
 .Pp
+By default,
+.Nm
+searches for
+.Xr mandocdb 8
+databases in the default paths stipulated by
+.Xr man 1 .
+.Pp
 The options are as follows:
 .Bl -tag -width Ds
 .It Fl C Ar file
@@ -72,12 +79,6 @@ See
 for a listing of manual sections.
 .El
 .Pp
-By default,
-.Nm
-searches for
-.Xr mandocdb 8
-databases in the default paths stipulated by
-.Xr man 1 .
 Results are sorted by manual title, with output formatted as
 .Pp
 .D1 title(sec) \- description