fbt/sbase
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
97905f6991
sbase/nl.1

98 lines
1.7 KiB
Groff
Raw Normal View History

POSIX 2013 audit Mostly manpage-shuffling according to the changes in the corrigendum, wording changes and more idiomatic expressions. All this is finished up by marking the POSIX 2013 conformant tools with .St -p1003.1-2013 which is not available in older mandoc builds or nroff, but which reflects what we actually did, so who cares? This is a huge step and it's not far until we can release sbase 0.1.
2015-03-27 16:22:48 +00:00
.Dd March 27, 2015
remove sbase-VERSION from man page, fix sponge.1 date
2015-01-31 13:20:02 +00:00
.Dt NL 1
Add .Os sbase and sed replace to .Os sbase $(VERSION) in make install
2015-01-31 19:37:03 +00:00
.Os sbase
Update nl(1) manpage
2014-12-04 13:49:07 +00:00
.Sh NAME
.Nm nl
.Nd line numbering filter
.Sh SYNOPSIS
add some mandoc pages and fix some warnings - add .Os, it is mandatory. - don't redeclare .Nm when it's not needed. - fix some warnings (checked with mandoc -Tlint). - remove some leftover old stuff.
2015-01-30 20:17:58 +00:00
.Nm
nl: add -d -p -f -h options
2015-03-18 16:58:09 +00:00
.Op Fl p
Update nl(1) manpage
2014-12-04 13:49:07 +00:00
.Op Fl b Ar type
nl: add -d -p -f -h options
2015-03-18 16:58:09 +00:00
.Op Fl d Ar delim
.Op Fl f Ar type
.Op Fl h Ar type
Audit nl(1) 1) Refactor the manpage to use the num-syntax and concise wording. 2) Build format instead of having a list of static strings. 3) BUGFIX: if (!buf[0] || buf[0] == '\n') Process last-read-line properly. 4) BUGFIX: In case we hit a formatting line, print a newline instead of just dropping it. 5) Use a switch instead of having spaghetti-cases. 6) Don't use printf-magic but explicitly do a putchar(' ')-loop. 7) Update usage(), indent properly. 8) BUGFIX: strchr is not NULL when type[0] is \0. Check for \0 separately beforehand. 9) Reorder arg.h-cases for better readability.
2015-03-22 15:29:50 +00:00
.Op Fl i Ar num
nl: add -l option
2015-03-10 11:49:56 +00:00
.Op Fl l Ar num
Implement nl -n format
2015-02-20 14:12:03 +00:00
.Op Fl n Ar format
Update nl(1) manpage
2014-12-04 13:49:07 +00:00
.Op Fl s Ar sep
Audit nl(1) 1) Refactor the manpage to use the num-syntax and concise wording. 2) Build format instead of having a list of static strings. 3) BUGFIX: if (!buf[0] || buf[0] == '\n') Process last-read-line properly. 4) BUGFIX: In case we hit a formatting line, print a newline instead of just dropping it. 5) Use a switch instead of having spaghetti-cases. 6) Don't use printf-magic but explicitly do a putchar(' ')-loop. 7) Update usage(), indent properly. 8) BUGFIX: strchr is not NULL when type[0] is \0. Check for \0 separately beforehand. 9) Reorder arg.h-cases for better readability.
2015-03-22 15:29:50 +00:00
.Op Fl v Ar num
.Op Fl w Ar num
Update nl(1) manpage
2014-12-04 13:49:07 +00:00
.Op Ar file
.Sh DESCRIPTION
.Nm
Audit nl(1) 1) Refactor the manpage to use the num-syntax and concise wording. 2) Build format instead of having a list of static strings. 3) BUGFIX: if (!buf[0] || buf[0] == '\n') Process last-read-line properly. 4) BUGFIX: In case we hit a formatting line, print a newline instead of just dropping it. 5) Use a switch instead of having spaghetti-cases. 6) Don't use printf-magic but explicitly do a putchar(' ')-loop. 7) Update usage(), indent properly. 8) BUGFIX: strchr is not NULL when type[0] is \0. Check for \0 separately beforehand. 9) Reorder arg.h-cases for better readability.
2015-03-22 15:29:50 +00:00
reads lines from
Update nl(1) manpage
2014-12-04 13:49:07 +00:00
.Ar file
Audit nl(1) 1) Refactor the manpage to use the num-syntax and concise wording. 2) Build format instead of having a list of static strings. 3) BUGFIX: if (!buf[0] || buf[0] == '\n') Process last-read-line properly. 4) BUGFIX: In case we hit a formatting line, print a newline instead of just dropping it. 5) Use a switch instead of having spaghetti-cases. 6) Don't use printf-magic but explicitly do a putchar(' ')-loop. 7) Update usage(), indent properly. 8) BUGFIX: strchr is not NULL when type[0] is \0. Check for \0 separately beforehand. 9) Reorder arg.h-cases for better readability.
2015-03-22 15:29:50 +00:00
and writes them to stdout, numbering non-empty lines.
If no
fix mandoc warnings - sort references in SEE ALSO section to section number, name. - cols.1: proper order of sections. - wrap lines to max 79 column length.
2015-01-31 13:43:27 +00:00
.Ar file
is given
Update nl(1) manpage
2014-12-04 13:49:07 +00:00
.Nm
reads from stdin.
.Sh OPTIONS
.Bl -tag -width Ds
nl: add -d -p -f -h options
2015-03-18 16:58:09 +00:00
.It Fl p
Audit nl(1) 1) Refactor the manpage to use the num-syntax and concise wording. 2) Build format instead of having a list of static strings. 3) BUGFIX: if (!buf[0] || buf[0] == '\n') Process last-read-line properly. 4) BUGFIX: In case we hit a formatting line, print a newline instead of just dropping it. 5) Use a switch instead of having spaghetti-cases. 6) Don't use printf-magic but explicitly do a putchar(' ')-loop. 7) Update usage(), indent properly. 8) BUGFIX: strchr is not NULL when type[0] is \0. Check for \0 separately beforehand. 9) Reorder arg.h-cases for better readability.
2015-03-22 15:29:50 +00:00
Do not reset line number for logical pages.
.It Fl h Ar type | Fl b Ar type | Fl f Ar type
Define which lines to number in the head | body | footer section:
Update nl(1) manpage
2014-12-04 13:49:07 +00:00
.Bl -tag -width pstringXX
.It a
All lines.
.It n
No lines.
.It t
Audit nl(1) 1) Refactor the manpage to use the num-syntax and concise wording. 2) Build format instead of having a list of static strings. 3) BUGFIX: if (!buf[0] || buf[0] == '\n') Process last-read-line properly. 4) BUGFIX: In case we hit a formatting line, print a newline instead of just dropping it. 5) Use a switch instead of having spaghetti-cases. 6) Don't use printf-magic but explicitly do a putchar(' ')-loop. 7) Update usage(), indent properly. 8) BUGFIX: strchr is not NULL when type[0] is \0. Check for \0 separately beforehand. 9) Reorder arg.h-cases for better readability.
2015-03-22 15:29:50 +00:00
Only non-empty lines. This is the default.
Update nl(1) manpage
2014-12-04 13:49:07 +00:00
.It p Ns Ar expr
Audit nl(1) 1) Refactor the manpage to use the num-syntax and concise wording. 2) Build format instead of having a list of static strings. 3) BUGFIX: if (!buf[0] || buf[0] == '\n') Process last-read-line properly. 4) BUGFIX: In case we hit a formatting line, print a newline instead of just dropping it. 5) Use a switch instead of having spaghetti-cases. 6) Don't use printf-magic but explicitly do a putchar(' ')-loop. 7) Update usage(), indent properly. 8) BUGFIX: strchr is not NULL when type[0] is \0. Check for \0 separately beforehand. 9) Reorder arg.h-cases for better readability.
2015-03-22 15:29:50 +00:00
Only lines matching
.Ar expr
according to
man pages: improve consistency
2015-02-01 19:52:28 +00:00
.Xr regex 7 .
Update nl(1) manpage
2014-12-04 13:49:07 +00:00
.El
nl: add -d -p -f -h options
2015-03-18 16:58:09 +00:00
.It Fl d Ar delim
Audit nl(1) 1) Refactor the manpage to use the num-syntax and concise wording. 2) Build format instead of having a list of static strings. 3) BUGFIX: if (!buf[0] || buf[0] == '\n') Process last-read-line properly. 4) BUGFIX: In case we hit a formatting line, print a newline instead of just dropping it. 5) Use a switch instead of having spaghetti-cases. 6) Don't use printf-magic but explicitly do a putchar(' ')-loop. 7) Update usage(), indent properly. 8) BUGFIX: strchr is not NULL when type[0] is \0. Check for \0 separately beforehand. 9) Reorder arg.h-cases for better readability.
2015-03-22 15:29:50 +00:00
Set
.Ar delim
as the delimiter for logical pages. If
.Ar delim
Fix small typo in nl.1
2015-03-22 16:25:11 +00:00
is only one character,
Audit nl(1) 1) Refactor the manpage to use the num-syntax and concise wording. 2) Build format instead of having a list of static strings. 3) BUGFIX: if (!buf[0] || buf[0] == '\n') Process last-read-line properly. 4) BUGFIX: In case we hit a formatting line, print a newline instead of just dropping it. 5) Use a switch instead of having spaghetti-cases. 6) Don't use printf-magic but explicitly do a putchar(' ')-loop. 7) Update usage(), indent properly. 8) BUGFIX: strchr is not NULL when type[0] is \0. Check for \0 separately beforehand. 9) Reorder arg.h-cases for better readability.
2015-03-22 15:29:50 +00:00
.Nm
appends ":" to it. The default is "\e:".
.It Fl i Ar num
Set the increment between numbered lines to
.Ar num .
nl: add -l option
2015-03-10 11:49:56 +00:00
.It Fl l Ar num
Audit nl(1) 1) Refactor the manpage to use the num-syntax and concise wording. 2) Build format instead of having a list of static strings. 3) BUGFIX: if (!buf[0] || buf[0] == '\n') Process last-read-line properly. 4) BUGFIX: In case we hit a formatting line, print a newline instead of just dropping it. 5) Use a switch instead of having spaghetti-cases. 6) Don't use printf-magic but explicitly do a putchar(' ')-loop. 7) Update usage(), indent properly. 8) BUGFIX: strchr is not NULL when type[0] is \0. Check for \0 separately beforehand. 9) Reorder arg.h-cases for better readability.
2015-03-22 15:29:50 +00:00
Set the number of adjacent blank lines to be considered as one to
.Ar num .
The default is 1.
Implement nl -n format
2015-02-20 14:12:03 +00:00
.It Fl n Ar format
Audit nl(1) 1) Refactor the manpage to use the num-syntax and concise wording. 2) Build format instead of having a list of static strings. 3) BUGFIX: if (!buf[0] || buf[0] == '\n') Process last-read-line properly. 4) BUGFIX: In case we hit a formatting line, print a newline instead of just dropping it. 5) Use a switch instead of having spaghetti-cases. 6) Don't use printf-magic but explicitly do a putchar(' ')-loop. 7) Update usage(), indent properly. 8) BUGFIX: strchr is not NULL when type[0] is \0. Check for \0 separately beforehand. 9) Reorder arg.h-cases for better readability.
2015-03-22 15:29:50 +00:00
Set the line number output
Implement nl -n format
2015-02-20 14:12:03 +00:00
.Ar format
Audit nl(1) 1) Refactor the manpage to use the num-syntax and concise wording. 2) Build format instead of having a list of static strings. 3) BUGFIX: if (!buf[0] || buf[0] == '\n') Process last-read-line properly. 4) BUGFIX: In case we hit a formatting line, print a newline instead of just dropping it. 5) Use a switch instead of having spaghetti-cases. 6) Don't use printf-magic but explicitly do a putchar(' ')-loop. 7) Update usage(), indent properly. 8) BUGFIX: strchr is not NULL when type[0] is \0. Check for \0 separately beforehand. 9) Reorder arg.h-cases for better readability.
2015-03-22 15:29:50 +00:00
to one of:
Implement nl -n format
2015-02-20 14:12:03 +00:00
.Bl -tag -width pstringXX
.It ln
Left justified.
.It rn
Audit nl(1) 1) Refactor the manpage to use the num-syntax and concise wording. 2) Build format instead of having a list of static strings. 3) BUGFIX: if (!buf[0] || buf[0] == '\n') Process last-read-line properly. 4) BUGFIX: In case we hit a formatting line, print a newline instead of just dropping it. 5) Use a switch instead of having spaghetti-cases. 6) Don't use printf-magic but explicitly do a putchar(' ')-loop. 7) Update usage(), indent properly. 8) BUGFIX: strchr is not NULL when type[0] is \0. Check for \0 separately beforehand. 9) Reorder arg.h-cases for better readability.
2015-03-22 15:29:50 +00:00
Right justified. This is the default.
Implement nl -n format
2015-02-20 14:12:03 +00:00
.It rz
Right justified with leading zeroes.
.El
Update nl(1) manpage
2014-12-04 13:49:07 +00:00
.It Fl s Ar sep
Audit nl(1) 1) Refactor the manpage to use the num-syntax and concise wording. 2) Build format instead of having a list of static strings. 3) BUGFIX: if (!buf[0] || buf[0] == '\n') Process last-read-line properly. 4) BUGFIX: In case we hit a formatting line, print a newline instead of just dropping it. 5) Use a switch instead of having spaghetti-cases. 6) Don't use printf-magic but explicitly do a putchar(' ')-loop. 7) Update usage(), indent properly. 8) BUGFIX: strchr is not NULL when type[0] is \0. Check for \0 separately beforehand. 9) Reorder arg.h-cases for better readability.
2015-03-22 15:29:50 +00:00
Use
.Ar sep
to separate line numbers and lines. The default is "\et".
.It Fl v Ar num
Start counting lines from
.Ar num .
The default is 1.
.It Fl w Ar num
Set the width of the line number to
.Ar num .
Implement nl -w width
2015-02-20 12:15:43 +00:00
The default is 6.
Update nl(1) manpage
2014-12-04 13:49:07 +00:00
.El
.Sh SEE ALSO
.Xr pr 1
nl: add -d -p -f -h options
2015-03-18 16:58:09 +00:00
.Sh STANDARDS
The
.Nm
utility is compliant with the
POSIX 2013 audit Mostly manpage-shuffling according to the changes in the corrigendum, wording changes and more idiomatic expressions. All this is finished up by marking the POSIX 2013 conformant tools with .St -p1003.1-2013 which is not available in older mandoc builds or nroff, but which reflects what we actually did, so who cares? This is a huge step and it's not far until we can release sbase 0.1.
2015-03-27 16:22:48 +00:00
.St -p1003.1-2013
nl: add -d -p -f -h options
2015-03-18 16:58:09 +00:00
specification.
Reference in New Issue Copy Permalink