sbase/nl.1

.Dd March 18, 2015
.Dt NL 1
.Os sbase
.Sh NAME
.Nm nl
.Nd line numbering filter
.Sh SYNOPSIS
.Nm
.Op Fl p
.Op Fl b Ar type
.Op Fl d Ar delim
.Op Fl f Ar type
.Op Fl h Ar type
.Op Fl i Ar incr
.Op Fl l Ar num
.Op Fl n Ar format
.Op Fl s Ar sep
.Op Fl v Ar startnum
.Op Fl w Ar width
.Op Ar file
.Sh DESCRIPTION
.Nm
reads lines from the named
.Ar file
and writes them to stdout with non-empty lines numbered. If no
.Ar file
is given
.Nm
reads from stdin.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl p
Do not reset number for logical pages
.It Fl b Ar type
Defines which lines will be numbered for body sections:
.Bl -tag -width pstringXX
.It a
All lines.
.It n
No lines.
.It t
Only non-empty lines (default).
.It p Ns Ar expr
Only lines which match
.Ar expr ,
a regular expression as defined in
.Xr regex 7 .
.El
.It Fl d Ar delim
Specify the two characters delimiter (default is "\\:"). If only one character is specified, the second remains ':'.
.It Fl f Ar type
Same as
.Fl b
except for footer sections.
.It Fl h Ar type
Same as
.Fl b
except for header sections.
.It Fl i Ar incr
Defines the increment between numbered lines.
.It Fl l Ar num
Specify the number of adjacent blank lines to be considered as one. Default is 1.
.It Fl n Ar format
Specify the line number output format.
The
.Ar format
can be any of the following:
.Bl -tag -width pstringXX
.It ln
Left justified.
.It rn
Right justified.
.It rz
Right justified with leading zeroes.
.El
.Pp
The default
.Ar format
is rn.
.It Fl s Ar sep
Defines the string used to separate line numbers and lines. By default this is
a tab.
.It Fl v Ar startnum
Start counting from
.Ar startnum
instead of the default 1.
.It Fl w Ar width
The number of characters to be occupied by the line number
will be set to
.Ar width .
The default is 6.
.El
.Sh SEE ALSO
.Xr pr 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2008
specification.