[prev in list] [next in list] [prev in thread] [next in thread] 

List:       mandoc-source
Subject:    mdocml: State default usage before listing arguments of a utility.
From:       kristaps () mdocml ! bsd ! lv
Date:       2011-12-25 19:35:44
Message-ID: 201112251935.pBPJZijb014253 () krisdoz ! my ! domain
[Download RAW message or body]

Log Message:
-----------
State default usage before listing arguments of a utility.  Inspired by a 
patch to mandocdb.8 by schwarze@ some time ago.  Ok jmc@.

Modified Files:
--------------
    mdocml:
        apropos.1
        catman.8
        demandoc.1
        mandoc.1
        preconv.1
        whatis.1

Revision Data
-------------
Index: mandoc.1
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mandoc.1,v
retrieving revision 1.99
retrieving revision 1.100
diff -Lmandoc.1 -Lmandoc.1 -u -p -r1.99 -r1.100
--- mandoc.1
+++ mandoc.1
@@ -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
Index: demandoc.1
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/demandoc.1,v
retrieving revision 1.5
retrieving revision 1.6
diff -Ldemandoc.1 -Ldemandoc.1 -u -p -r1.5 -r1.6
--- demandoc.1
+++ demandoc.1
@@ -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,18 +56,7 @@ 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 ,
Index: preconv.1
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/preconv.1,v
retrieving revision 1.5
retrieving revision 1.6
diff -Lpreconv.1 -Lpreconv.1 -u -p -r1.5 -r1.6
--- preconv.1
+++ preconv.1
@@ -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
@@ -47,15 +52,6 @@ The document's encoding.
 .It Ar file
 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
Index: catman.8
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/catman.8,v
retrieving revision 1.4
retrieving revision 1.5
diff -Lcatman.8 -Lcatman.8 -u -p -r1.4 -r1.5
--- catman.8
+++ catman.8
@@ -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
Index: apropos.1
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/apropos.1,v
retrieving revision 1.15
retrieving revision 1.16
diff -Lapropos.1 -Lapropos.1 -u -p -r1.15 -r1.16
--- apropos.1
+++ apropos.1
@@ -36,6 +36,20 @@ utility queries manual page databases ge
 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
Index: whatis.1
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/whatis.1,v
retrieving revision 1.6
retrieving revision 1.7
diff -Lwhatis.1 -Lwhatis.1 -u -p -r1.6 -r1.7
--- whatis.1
+++ whatis.1
@@ -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
--
 To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv

[prev in list] [next in list] [prev in thread] [next in thread]