diff options
| -rw-r--r-- | apropos.1 | 26 | ||||
| -rw-r--r-- | catman.8 | 28 | ||||
| -rw-r--r-- | demandoc.1 | 18 | ||||
| -rw-r--r-- | mandoc.1 | 25 | ||||
| -rw-r--r-- | preconv.1 | 14 | ||||
| -rw-r--r-- | whatis.1 | 13 |
6 files changed, 60 insertions, 64 deletions
@@ -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 @@ -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 @@ -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 , @@ -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 @@ -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 @@ -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 |