mdoc(7) police: fix markup (demonstrates new -xwidth modifier).

This commit is contained in:
ru 2001-05-16 10:18:20 +00:00
parent 5f3f5f8091
commit f46bc2e2e9

View File

@ -38,7 +38,7 @@
.Dt NL 1
.Os
.Sh NAME
.Nm \&nl
.Nm nl
.Nd line numbering filter
.Sh SYNOPSIS
.Nm
@ -96,33 +96,31 @@ independently available for header, body and footer sections.
The starts of logical page sections are signalled by input lines containing
nothing but one of the following sequences of delimiter characters:
.Pp
.Bd -unfilled -offset indent
.Bl -column "\e:\e:\e: " "header "
.Bl -column "\e:\e:\e:" "Start of" -offset indent
.Em "Line Start of"
.It \e:\e:\e: header
.It \e:\e: body
.It \e: footer
.El
.Ed
.Pp
If the input does not contain any logical page section signalling directives,
the text being read is assumed to consist of a single logical page body.
.Pp
The following options are available:
.Bl -tag -width indent
.Bl -tag -xwidth ".Fl v Ar startnum"
.It Fl b Ar type
Specify the logical page body lines to be numbered.
Recognized
.Ar type
arguments are:
.Bl -tag -width pstringXX
.It a
.Bl -tag -width indent
.It Cm a
Number all lines.
.It t
.It Cm t
Number only non-empty lines.
.It n
.It Cm n
No line numbering.
.It p Ns Ar expr
.It Cm p Ns Ar expr
Number only those lines that contain the basic regular expression specified
by
.Ar expr .
@ -130,7 +128,8 @@ by
.Pp
The default
.Ar type
for logical page body lines is t.
for logical page body lines is
.Cm t .
.It Fl d Ar delim
Specify the delimiter characters used to indicate the start of a logical
page section in the input file. At most two characters may be specified;
@ -138,21 +137,24 @@ if only one character is specified, the first character is replaced and the
second character remains unchanged.
The default
.Ar delim
characters are ``\e:''.
characters are
.Dq Li \e: .
.It Fl f Ar type
Specify the same as
.Fl b Ar type
except for logical page footer lines.
The default
.Ar type
for logical page footer lines is n.
for logical page footer lines is
.Cm n .
.It Fl h Ar type
Specify the same as
.Fl b Ar type
except for logical page header lines.
The default
.Ar type
for logical page header lines is n.
for logical page header lines is
.Cm n .
.It Fl i Ar incr
Specify the increment value used to number logical page lines.
The default
@ -161,13 +163,10 @@ value is 1.
.It Fl l Ar num
If numbering of all lines is specified for the current logical section
using the corresponding
.Fl b
a,
.Fl f
a
.Fl b Cm a ,
.Fl f Cm a
or
.Fl h
a
.Fl h Cm a
option,
specify the number of adjacent blank lines to be considered as one.
For example,
@ -181,18 +180,19 @@ Specify the line numbering output format.
Recognized
.Ar format
arguments are:
.Bl -tag -width lnXX -compact
.It ln
.Bl -tag -width indent -compact
.It Cm ln
Left justified.
.It rn
.It Cm rn
Right justified, leading zeros suppressed.
.It rz
.It Cm rz
Right justified, leading zeros kept.
.El
.Pp
The default
.Ar format
is rn.
is
.Cm rn .
.It Fl p
Specify that line numbering should not be restarted at logical page delimiters.
.It Fl s Ar sep
@ -220,7 +220,7 @@ The default
.Ar width
is 6.
.El
.Sh EXIT STATUS
.Sh DIAGNOSTICS
The
.Nm
utility exits 0 on success, and >0 if an error occurs.