1
0
forked from bonsai/harakit

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,122 +3,86 @@
.\"
.\" 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 scrut 1
.SH NAME
scrut \(en scrutinize file properties
.SH SYNOPSIS
.\"
scrut
.RB ( -bcdefgkprsuwxLS )
.RB [ file... ]
.\"
.SH DESCRIPTION
.\"
Determine if files comply with requirements.
.\"
.SH OPTIONS
.B -L
.RS
.\"
.IP -L
Requires the given files to exist and be symbolic links.
.RE
.B -S
.RS
.IP -S
Requires the given files to exist and be sockets.
.RE
.B -b
.RS
.IP -b
Requires the given files to exist and be block special files.
.RE
.B -c
.RS
.IP -c
Requires the given files to exist and be character special files.
.RE
.B -d
.RS
.IP -d
Requires the given files to exist and be directories.
.RE
.B -e
.RS
.IP -e
Requires the given files to exist, and is redundant to any other option.
.RE
.B -e
.RS
.IP -e
Requires the given files to exist and be regular files.
.RE
.B -g
.RS
.IP -g
Requires the given files to exist and have their set group ID flags set.
.RE
.B -k
.RS
.IP -k
Requires the given files to exist and have their sticky bit set.
.RE
.B -p
.RS
.IP -p
Requires the given files to exist and be named pipes.
.RE
.B -r
.RS
.IP -r
Requires the given files to exist and be readable.
.RE
.B -u
.RS
.IP -u
Requires the given files to exist and have their set user ID flags set.
.RE
.B -w
.RS
.IP -w
Requires the given files to exist and be writable.
.RE
.B -x
.RS
.IP -x
Requires the given files to exist and be executable.
.RE
.SH EXIT STATUS
.\"
.SH DIAGNOSTICS
.\"
If the given files comply with the specified requirements, the program will exit
successfully. If not, it exits unsuccessfully.
When invoked incorrectly, a debug message will be printed and the program will
exit with the appropriate sysexits.h(3) error code.
.SH STANDARDS
The test(1p) utility contains functionality that was broken out into separate
programs. Thus, the scope of this program is narrower than it. Notably, the
exit with the appropriate
.BR sysexits.h (3)
error code.
.\"
.SH RATIONALE
.\"
The
.BR test (1p)
utility contains functionality that was broken out into separate programs. Thus,
the scope of this program is narrower than it. Notably, the
.B -h
option is now invalid and therefore shows usage information instead of being an
alias to the modern
.B -L
option.
.\"
.SH AUTHOR
Written by DTB <trinity@trinity.moe>.
.\"
Written by DTB
.MT trinity@trinity.moe
.ME .
.\"
.SH COPYRIGHT
Copyright © 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
Copyright \(co 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
<https://gnu.org/licenses/agpl.html>.
.SH SEE ALSO
access(3p), lstat(3p), test(1p)
.BR access (3p),
.BR lstat (3p),
.BR test (1p)