1
0
forked from bonsai/harakit

docs: remove unnecessary references to the name of each program

This commit is contained in:
2024-03-26 19:22:30 -06:00
parent cf76fa94e6
commit 63a0c683f9
11 changed files with 129 additions and 106 deletions

View File

@@ -18,28 +18,31 @@ str
.SH DESCRIPTION
Str tests each character in an arbitrary quantity of string arguments against
the function of the same name within ctype(3).
Test string arguments against each other.
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.
.SH DIAGNOSTICS
Str exits successfully if all tests pass and unsuccessfully if a test failed.
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.
Str will exit unsuccessfully if a string is empty, as none of its contents
passed the test.
An empty string will cause an unsuccessful exit as none of its contents pass any
tests.
Str will print a message to standard error and exit unsuccessfully if used
improperly.
When invoked incorrectly, a debug message will be printed and the program will
exit with the appropriate sysexits.h(3) error code.
.SH DEPRECATED FEATURES
Str used to have an "isvalue" type as an extension to ctype(3). This was
removed in favor of using strcmp(1) to compare strings against the empty string
('').
Originally, there was an isvalue type as an extension to ctype.h(3), but it
was removed in favor of using strcmp(1) to compare strings against the empty
string ('').
.SH BUGS
There's no way of knowing which argument failed the test without re-testing
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.