docs: updates to use man(7) macros to fix formatting

This commit is contained in:
2024-06-02 18:47:14 -06:00
parent b7f52902b6
commit 70cbc52c93
13 changed files with 406 additions and 495 deletions

View File

@@ -3,28 +3,27 @@
.\"
.\" 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/>.
.\"
.TH STR 1
.SH NAME
str \(en test the character types of string arguments
.\"
.SH SYNOPSIS
.\"
str
.RB [ type ]
.RB [ string... ]
.\"
.SH DESCRIPTION
.\"
Test string arguments.
The tests in this program are equivalent to the functions with the same names in
ctype.h(0p) and are the methods by which string arguments are tested.
.BR ctype.h (0p)
and are the methods by which string arguments are tested.
.\"
.SH DIAGNOSTICS
.\"
If all tests pass, the program will exit with an exit code of 0. If any of the
tests fail, the program will exit unsuccessfully with an error code of 1.
@@ -33,23 +32,26 @@ tests.
When invoked incorrectly, a debug message will be printed and the program will
exit with the appropriate sysexits.h(3) error code.
.SH BUGS
.\"
.SH CAVEATS
.\"
Theres no way of knowing which argument failed the test without re-testing
arguments individually.
If a character in a string isn't valid ASCII str will exit unsuccessfully.
.\"
.SH AUTHOR
Written by DTB <trinity@trinity.moe>.
.\"
Written by DTB
.MT trinity@trinity.moe
.ME .
.\"
.SH COPYRIGHT
.\"
Copyright © 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
<https://gnu.org/licenses/gpl.html>.
.\"
.SH SEE ALSO
ctype(3p), strcmp(1), ascii(7)
.BR ctype (3p),
.BR strcmp(1),
.BR ascii(7)