diff --git a/docs/scrut.1 b/docs/scrut.1 new file mode 100644 index 0000000..9e536a6 --- /dev/null +++ b/docs/scrut.1 @@ -0,0 +1,92 @@ +.\" Copyright (c) 2024 DTB +.\" +.\" This work is licensed under CC BY-SA 4.0. To see a copy of this license, +.\" visit . + +.TH scrut 1 + +.SH NAME + +scrute \(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 -b +requires the given files to exist and be block special files. +.PP +.B -c +requires the given files to exist and be character special files. +.PP +.B -d +requires the given files to exist and be directories. +.PP +.B -e +requires the given files to exist, and is redundant to any other option. +.PP +.B -e +requires the given files to exist and be regular files. +.PP +.B -g +requires the given files to exist and have their set group ID flags set. +.PP +.B -k +requires the given files to exist and have their sticky bit set. +.PP +.B -p +requires the given files to exist and be named pipes. +.PP +.B -r +requires the given files to exist and be readable. +.PP +.B -u +requires the given files to exist and have their set user ID flags set. +.PP +.B -w +requires the given files to exist and be writable. +.PP +.B -x +requires the given files to exist and be executable. +.PP +.B -L +requires the given files to exist and be symbolic links. +.PP +.B -S +requires the given files to exist and be sockets. + +.SH EXIT STATUS + +Scrut prints a debug message and exits unsuccessfully with the appropriate +sysexits(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 now shows usage information instead of being an alias to the modern +.B -L +option. + +.SH AUTHOR + +Written by DTB . + +.SH COPYRIGHT + +Copyright © 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later +. + +.SH SEE ALSO + +access(3p), lstat(3p), test(1p)