1
0
forked from bonsai/harakit

docs: fixed formatting of many manpages

This commit is contained in:
2024-03-26 18:26:51 -06:00
parent 127192185f
commit a6fd1108c6
6 changed files with 218 additions and 135 deletions

View File

@@ -1,5 +1,5 @@
.\" Copyright (c) 20232024 DTB <trinity@trinity.moe>
.\" Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
.\" Copyright (c) 20232024 Emma Tebibyte <emma@tebibyte.media>
.\"
.\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
.\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
@@ -13,29 +13,31 @@ npc \(en show non-printing characters
.SH SYNOPSIS
npc
.RB ( -eht )
.RB ( -et )
.SH DESCRIPTION
Npc reads from standard input and writes to standard output, replacing non-
printing characters with printable equivalents. Control characters print as a
carat ('^') followed by the character '@' through '_' corresponding to the
character replaced (e.g. control-X becomes "^X"). The delete character (0x7F)
becomes "^?". Characters with the high bit set (>127) are printed as "M-"
carat (“^”) followed by the character “@” through “_” corresponding to the
character replaced (e.g. control-X becomes ^X). The delete character (0x7F)
becomes ^?. Characters with the high bit set (>127) are printed as M-
followed by the graphical representation for the same character without the
high bit set.
.PP
The
.B -e
option prints a currency sign ('$') before each line ending.
.PP
The
.RS
Prints a currency sign (“$”) before each line ending.
.RE
.B -t
option prints tab characters as "^I" rather than a literal horizontal tab.
.RS
Prints tab characters as “^I” rather than a literal horizontal tab.
.RE
.SH DIAGNOSTICS
Npc prints a debug message and exits with the appropriate sysexits(3) error
Npc prints a debug message and exits with the appropriate sysexits.h(3) error
code in the event of an error, otherwise it exits successfully.
.SH BUGS
@@ -45,8 +47,9 @@ Npc operates in single-byte chunks regardless of intended encoding.
.SH RATIONALE
POSIX currently lacks a way to display non-printing characters in the terminal
using a standard tool. A popular extension to cat(1p), the -v option, is the
bandage solution GNU and other software suites use.
using a standard tool. A popular extension to cat(1p), the
.B -v
option, is the bandage solution GNU and other software suites use.
This functionality should be a separate tool because its usefulness extends
beyond that of cat(1p).