bonsix/docs/scrut.1

.\" Copyright (c) 2024 DTB <trinity@trinity.moe>
.\" Copyright (c) 2024 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/>.

.TH scrut 1

.SH NAME

scrut \(en scrutinize file properties

.SH SYNOPSIS

scrut
.RB ( -bcdefgkprsuwxLS )
.RB [ file... ]

.SH DESCRIPTION

Scrut determines if given files comply with the opted requirements.

.SH OPTIONS

.B -L
.RS
Requires the given files to exist and be symbolic links.
.RE

.B -S
.RS
Requires the given files to exist and be sockets.
.RE

.B -b
.RS
Requires the given files to exist and be block special files.
.RE

.B -c
.RS
Requires the given files to exist and be character special files.
.RE

.B -d
.RS
Requires the given files to exist and be directories.
.RE

.B -e
.RS
Requires the given files to exist, and is redundant to any other option.
.RE

.B -e
.RS
Requires the given files to exist and be regular files.
.RE

.B -g
.RS
Requires the given files to exist and have their set group ID flags set.
.RE

.B -k
.RS
Requires the given files to exist and have their sticky bit set.
.RE

.B -p
.RS
Requires the given files to exist and be named pipes.
.RE

.B -r
.RS
Requires the given files to exist and be readable.
.RE

.B -u
.RS
Requires the given files to exist and have their set user ID flags set.
.RE

.B -w
.RS
Requires the given files to exist and be writable.
.RE

.B -x
.RS
Requires the given files to exist and be executable.
.RE

.SH EXIT STATUS

Scrut prints a debug message and exits unsuccessfully with the appropriate
sysexits.h(3) error code if invoked incorrectly. Scrut exits successfully if
the given files comply with their requirements and unsuccessfully otherwise.

.SH STANDARDS

Scrut is nearly compatible with POSIX's test utility though it is narrower in
scope. 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>.

.SH COPYRIGHT

Copyright © 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)