harakit/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 2024-06-06 "Harakit X.X.X"
.SH NAME
scrut \(en scrutinize file properties
.SH SYNOPSIS

scrut
.RB [ -LSbcdefgkprsuwx ]
.B file...
.\"
.SH DESCRIPTION

Determine if files comply with requirements. If the given files comply with the
specified requirements, the program will exit successfully. Otherwise, it exits
unsuccessfully.
.\"
.SH OPTIONS

.IP \fB-L\fB
Requires the given files to exist and be symbolic links.
.IP \fB-S\fP
Requires the given files to exist and be sockets.
.IP \fB-b\fP
Requires the given files to exist and be block special files.
.IP \fB-c\fP
Requires the given files to exist and be character special files.
.IP \fB-d\fP
Requires the given files to exist and be directories.
.IP \fB-e\fP
Requires the given files to exist, and is redundant to any other option.
.IP \fB-f\fP
Requires the given files to exist and be regular files.
.IP \fB-g\fP
Requires the given files to exist and have their set group ID flags set.
.IP \fB-k\fP
Requires the given files to exist and have their sticky bit set.
.IP \fB-p\fP
Requires the given files to exist and be named pipes.
.IP \fB-r\fP
Requires the given files to exist and be readable.
.IP \fB-u\fP
Requires the given files to exist and have their set user ID flags set.
.IP \fB-w\fP
Requires the given files to exist and be writable.
.IP \fB-x\fP
Requires the given files to exist and be executable.
.\"
.SH DIAGNOSTICS

When invoked incorrectly, a debug message will be printed and the program will
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
.MT trinity@trinity.moe
.ME .
.\"
.SH COPYRIGHT

Copyright \(co 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
<https://gnu.org/licenses/agpl.html>.
.\"
.SH SEE ALSO
.BR access (3p),
.BR lstat (3p),
.BR test (1p)
scrut(1): add man page 2024-02-16 08:40:38 +00:00			`.\" Copyright (c) 2024 DTB <trinity@trinity.moe>`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`.\" Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>`
scrut(1): add man page 2024-02-16 08:40:38 +00:00			`.\"`
			`.\" 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/>.`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
Makefile, docs: programmatically generate version for docs (i got tired of doing it myself) 2024-06-24 05:47:29 +00:00			`.TH SCRUT 1 2024-06-06 "Harakit X.X.X"`
scrut(1): add man page 2024-02-16 08:40:38 +00:00			`.SH NAME`
scrut.1: update man page based on review (see #62) 2024-02-18 06:12:39 +00:00			`scrut \(en scrutinize file properties`
scrut(1): add man page 2024-02-16 08:40:38 +00:00			`.SH SYNOPSIS`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
scrut(1): add man page 2024-02-16 08:40:38 +00:00			`scrut`
docs, src: updates usage text for utilities 2024-06-29 11:18:20 +00:00			`.RB [ -LSbcdefgkprsuwx ]`
			`.B file...`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
scrut(1): add man page 2024-02-16 08:40:38 +00:00			`.SH DESCRIPTION`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
fop.1: removes Unicode representation of RS; hru.1: removes erroneous line break; mm.1: formatting & grammar; npc.1: dollar sign, not currency sign; rpn.1: syntax error; scrut.1: move description to DESCRIPTION; str.1: comma; swab.1: wording & escape codes; true.1: formatting 2024-06-06 05:07:15 +00:00			`Determine if files comply with requirements. If the given files comply with the`
			`specified requirements, the program will exit successfully. Otherwise, it exits`
			`unsuccessfully.`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
scrut(1): add man page 2024-02-16 08:40:38 +00:00			`.SH OPTIONS`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
docs: formatting 2024-06-04 22:11:33 +00:00			`.IP \fB-L\fB`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`Requires the given files to exist and be symbolic links.`
docs: formatting 2024-06-04 22:11:33 +00:00			`.IP \fB-S\fP`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`Requires the given files to exist and be sockets.`
docs: formatting 2024-06-04 22:11:33 +00:00			`.IP \fB-b\fP`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`Requires the given files to exist and be block special files.`
docs: formatting 2024-06-04 22:11:33 +00:00			`.IP \fB-c\fP`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`Requires the given files to exist and be character special files.`
docs: formatting 2024-06-04 22:11:33 +00:00			`.IP \fB-d\fP`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`Requires the given files to exist and be directories.`
docs: formatting 2024-06-04 22:11:33 +00:00			`.IP \fB-e\fP`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`Requires the given files to exist, and is redundant to any other option.`
docs: formatting 2024-06-04 22:11:33 +00:00			`.IP \fB-f\fP`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`Requires the given files to exist and be regular files.`
docs: formatting 2024-06-04 22:11:33 +00:00			`.IP \fB-g\fP`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`Requires the given files to exist and have their set group ID flags set.`
docs: formatting 2024-06-04 22:11:33 +00:00			`.IP \fB-k\fP`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`Requires the given files to exist and have their sticky bit set.`
docs: formatting 2024-06-04 22:11:33 +00:00			`.IP \fB-p\fP`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`Requires the given files to exist and be named pipes.`
docs: formatting 2024-06-04 22:11:33 +00:00			`.IP \fB-r\fP`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`Requires the given files to exist and be readable.`
docs: formatting 2024-06-04 22:11:33 +00:00			`.IP \fB-u\fP`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`Requires the given files to exist and have their set user ID flags set.`
docs: formatting 2024-06-04 22:11:33 +00:00			`.IP \fB-w\fP`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`Requires the given files to exist and be writable.`
docs: formatting 2024-06-04 22:11:33 +00:00			`.IP \fB-x\fP`
docs: fixed formatting of many manpages 2024-03-27 00:26:51 +00:00			`Requires the given files to exist and be executable.`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
			`.SH DIAGNOSTICS`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
docs: remove unnecessary references to the name of each program 2024-03-27 01:22:30 +00:00			`When invoked incorrectly, a debug message will be printed and the program will`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`exit with the appropriate`
			`.BR sysexits.h (3)`
			`error code.`
			`.\"`
			`.SH RATIONALE`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`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`
scrut(1): add man page 2024-02-16 08:40:38 +00:00			`.B -h`
scrut.1: update man page based on review (see #62) 2024-02-18 06:12:39 +00:00			`option is now invalid and therefore shows usage information instead of being an`
			`alias to the modern`
scrut(1): add man page 2024-02-16 08:40:38 +00:00			`.B -L`
			`option.`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
scrut(1): add man page 2024-02-16 08:40:38 +00:00			`.SH AUTHOR`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`Written by DTB`
			`.MT trinity@trinity.moe`
			`.ME .`
			`.\"`
scrut(1): add man page 2024-02-16 08:40:38 +00:00			`.SH COPYRIGHT`

docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`Copyright \(co 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later`
scrut(1): add man page 2024-02-16 08:40:38 +00:00			`<https://gnu.org/licenses/agpl.html>.`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00			`.\"`
scrut(1): add man page 2024-02-16 08:40:38 +00:00			`.SH SEE ALSO`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.BR access (3p),`
			`.BR lstat (3p),`
			`.BR test (1p)`