ahill/sbase
1
0
Fork 0
mirror of git://git.suckless.org/sbase synced 2026-01-26 05:37:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

sbase: improve man pages and some warnings.

Browse Source 
From ed5e4d34a16436a37c0e084666fcfb77cc4859c3 Mon Sep 17 00:00:00 2001
From: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Thu, 31 Jul 2025 14:42:59 +0200
Subject: [PATCH 4/4] improve man pages and some warnings.

Checking for warnings: mandoc -Tlint *.1

- Swap .St -p1003.1-2013 macro with text:
  mdoc does not support this macro and some texts were changed, like commit
  d4dfd42d3580ad36bedfdc5b8924ff6683981f53
- Typo fixes:
  exeption -> exception.
- xargs.1: document -P extension.
- sed.1: remove use of .Pp of .Ss.
- Wrap lines to less than 80 characters and use a new sentence for each line.
- find.1: Xr reference C library functions.
This commit is contained in:
Hiltjo Posthuma 2025-07-31 15:31:08 +02:00 committed by Roberto E. Vargas Caballero
parent 635515f6e3
commit a0998d0252
67 changed files with 103 additions and 346 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
basename.1
View File

@ -19,8 +19,4 @@ to stdout.
.Xr dirname 1 ,
.Xr basename 3
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
cal.1
View File

@ -61,11 +61,7 @@ or current year.
.Sh SEE ALSO
.Xr localtime 3
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The flags
.Op Fl 13cfmnsy

6
cat.1
View File

@ -24,8 +24,4 @@ reads from stdin.
Unbuffered output.
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
chgrp.1
View File

@ -44,8 +44,4 @@ This is the default.
.Xr chown 2 ,
.Xr getgrnam 3
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
chmod.1
View File

@ -67,11 +67,7 @@ Change modes recursively.
.Xr chgrp 1 ,
.Xr umask 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl HLP

6
chown.1
View File

@ -54,8 +54,4 @@ This is the default.
.Xr getgrnam 3 ,
.Xr getpwnam 3
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
cksum.1
View File

@ -21,8 +21,4 @@ is given,
.Nm
reads from stdin.
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
cmp.1
View File

@ -44,10 +44,6 @@ An error occurred.
.Xr comm 1 ,
.Xr diff 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The "char" in the default result format has been replaced with "byte".

8
comm.1
View File

@ -14,7 +14,7 @@
reads
.Ar file1
and
.Ar file2,
.Ar file2 ,
which should both be sorted lexically, and writes three text columns
to stdout:
.Bl -tag -width Ds
@ -37,8 +37,4 @@ Suppress column 1 | 2 | 3
.Xr sort 1 ,
.Xr uniq 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
cut.1
View File

@ -63,11 +63,7 @@ A character is written when its last byte is selected.
Suppress lines not containing field delimiters.
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The possibility of separating numbers and ranges with a space and specifying
multibyte delimiters of arbitrary length is an extension to that specification.

6
date.1
View File

@ -74,11 +74,7 @@ value of 20 is used.
The century and year are optional.
The default is the current year.
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl d

6
dirname.1
View File

@ -16,8 +16,4 @@ with its final path component removed to stdout.
.Xr basename 1 ,
.Xr dirname 3
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
du.1
View File

@ -50,11 +50,7 @@ This is the default.
Do not traverse file systems mount points.
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl dhP

6
echo.1
View File

@ -20,11 +20,7 @@ a newline.
Do not print the terminating newline.
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl n

9
ed.1
View File

@ -232,10 +232,7 @@ The dot is unchanged.
.Xr sed 1 ,
.Xr regexp 3
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification, except where noted here:
g and v operate on single commands rather than lists delimited with '\\'.
POSIX.1-2013.
Except where noted here:
g and v operate on single commands rather than lists delimited with '\e'.
e, E, r, w, and W commands cannot accept shell escapes.

6
env.1
View File

@ -40,11 +40,7 @@ in the environment.
.Xr putenv 3 ,
.Xr environ 7
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl u

6
expand.1
View File

@ -40,11 +40,7 @@ is "8".
.Xr fold 1 ,
.Xr unexpand 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl i

10
expr.1
View File

@ -16,7 +16,7 @@ and writes the result to stdout.
There are two elemental expressions,
.Sy integer
and
.Sy string.
.Sy string .
Let
.Sy expr
be a non-elemental expression and
@ -26,7 +26,7 @@ arbitrary expressions.
Then
.Sy expr
has the recursive form
.Sy expr = [(] expr1 operand expr2 [)].
.Sy expr = [(] expr1 operand expr2 [)] .
.Pp
With
.Sy operand
@ -98,8 +98,4 @@ An error occurred.
.Sh SEE ALSO
.Xr test 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
false.1
View File

@ -10,8 +10,4 @@
.Nm
returns a status code indicating failure.
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

8
find.1
View File

@ -36,9 +36,13 @@ True if the name of the file matches the given pattern.
.It Fl path Ar pattern
True if the path to the file matches the given pattern.
.It Fl nouser
True if the file belongs to a user for which getpwuid() returns NULL.
True if the file belongs to a user for which
.Xr getpwuid 3
returns NULL.
.It Fl nogroup
True if the file belongs to a group for which getgrgid() returns NULL.
True if the file belongs to a group for which
.Xr getgrgid 3
returns NULL.
.It Fl xdev
True.
Do not enter directory on a different device.

6
fold.1
View File

@ -32,11 +32,7 @@ characters.
The default is 80.
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl Ns Ar num

7
getconf.1
View File

@ -51,10 +51,7 @@ An error occured or
was invalid.
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification except from the
POSIX.1-2013.
Except for the
.Op Fl v
flag.

10
grep.1
View File

@ -84,14 +84,10 @@ An error occurred.
.El
.Sh SEE ALSO
.Xr sed 1 ,
.Xr regex 7 ,
.Xr re_format 7
.Xr re_format 7 ,
.Xr regex 7
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl Hhw

6
head.1
View File

@ -33,11 +33,7 @@ Default is 10.
.Sh SEE ALSO
.Xr tail 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl Ns num

8
join.1
View File

@ -92,11 +92,9 @@ Print unpairable lines from file
instead of normal output.
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification with the following exeption:
POSIX.1-2013.
.Pp
With the following exception:
.Bl -bullet -offset indent
.It
Unpairable lines ignore formatting specified with

12
kill.1
View File

@ -30,18 +30,10 @@ The default is TERM.
.Xr kill 2 ,
.Xr signal 7
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Fl Ar signame
and
.Fl Ar num
syntax is marked by
.St -p1003.1-2013
as an
X/OPEN System Interfaces
option.
syntax is marked by POSIX.1-2013 as an X/OPEN System Interfaces option.

6
link.1
View File

@ -13,8 +13,4 @@ creates a hard link
to
.Ar target .
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
ln.1
View File

@ -58,8 +58,4 @@ because their purpose does not apply to symbolic links.
.Xr link 2 ,
.Xr symlink 2
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
logger.1
View File

@ -45,11 +45,7 @@ to each line in the log.
.Xr syslogd 1 ,
.Xr syslog 3
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl ipst

6
logname.1
View File

@ -10,8 +10,4 @@
.Nm
writes the login name of the current user to stdout.
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

7
ls.1
View File

@ -86,11 +86,8 @@ sorting or printing.
.Sh SEE ALSO
.Xr stat 2
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification except from the
POSIX.1-2013.
Except for the
.Op Fl Ckmpsx
flags.
.Pp

6
mkdir.1
View File

@ -31,8 +31,4 @@ already exists.
.Sh SEE ALSO
.Xr mkdir 2
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
mkfifo.1
View File

@ -25,8 +25,4 @@ See
.Sh SEE ALSO
.Xr mkfifo 3
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

9
mv.1
View File

@ -30,10 +30,7 @@ Do not prompt before overwriting.
Prompting has not been implemented yet.
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification except from the
.Op Fl i
POSIX.1-2013.
Except for the unsupported
.Fl i
flag.

6
nice.1
View File

@ -33,8 +33,4 @@ Default is 10.
.Xr nice 2 ,
.Xr renice 2
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
nl.1
View File

@ -113,8 +113,4 @@ The default is 6.
.Sh SEE ALSO
.Xr pr 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
nohup.1
View File

@ -37,8 +37,4 @@ could not be found.
.Sh SEE ALSO
.Xr signal 7
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

7
od.1
View File

@ -68,11 +68,8 @@ Equivalent to
.Fl t x2 .
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification except that the
POSIX.1-2013.
Except that the
.Op Fl v
flag is always enabled and the 'd' parameter for the
.Op Fl t

6
paste.1
View File

@ -44,8 +44,4 @@ sequentially instead of in parallel.
.Sh SEE ALSO
.Xr cut 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
pathchk.1
View File

@ -28,8 +28,4 @@ All pathname operands passed all of the checks.
An error occurred.
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

15
printf.1
View File

@ -21,14 +21,13 @@ interprets the standard escape sequences \e\e, \e', \e", \ea, \eb, \ee,
\ef, \en, \er, \et, \ev, \exH[H], \eO[OOO], the sequence \ec, which
terminates further output if it's found inside
.Ar format
or a %b format string, the format specification %b for an unescaped string and all C
or a %b format string, the format specification %b for an unescaped string and
all C
.Xr printf 3
format specifications ending with csdiouxXaAeEfFgG, including variable width and precision.
format specifications ending with csdiouxXaAeEfFgG, including variable width
and precision.
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The possibility of specifying 4-digit octals is an extension to that specification.
The possibility of specifying 4-digit octals is an extension to that
specification.

6
pwd.1
View File

@ -26,8 +26,4 @@ The logical path to the current working directory.
.Sh SEE ALSO
.Xr getcwd 3
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
renice.1
View File

@ -35,8 +35,4 @@ to
.Xr nice 2 ,
.Xr renice 2
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
rmdir.1
View File

@ -26,8 +26,4 @@ and its parents in the pathname
.Xr rmdir 2 ,
.Xr unlink 2
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

2
sed.1
View File

@ -60,7 +60,6 @@ Multiple functions for the specified address (or address-range) can be enclosed
in blocks with '{' and '}':
.Pp
[address[,address]] { function ; function }
.Pp
.Ss Addresses
Addresses are either blank, a positive decimal integer denoting a line
number, the character '$' denoting the last line of input, or a regular
@ -75,7 +74,6 @@ The character '!' may be appended after the addresses,
in which case the function is executed only if the addresses
.Em don't
match.
.Pp
.Ss Functions
.Bl -tag -width Ds
.It Ar a Op Ar text

6
sleep.1
View File

@ -15,8 +15,4 @@ seconds to elapse.
.Sh SEE ALSO
.Xr sleep 3
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

8
sort.1
View File

@ -50,7 +50,7 @@ Specify a key definition of the form
.Sy s
.No ][
.Sy f
.No ][,
.No ][ ,
.Sy E
.No [.
.Sy e
@ -95,8 +95,4 @@ as the field delimiter.
Print equal lines only once.
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
split.1
View File

@ -39,11 +39,7 @@ Use decimal rather than alphabetical suffixes.
.Sh SEE ALSO
.Xr cat 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl d

6
strings.1
View File

@ -40,11 +40,7 @@ being one of
for decimal, octal or hexadecimal numbers.
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl t

6
tail.1
View File

@ -44,11 +44,7 @@ grows.
.Sh SEE ALSO
.Xr head 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl Ns Ar num

11
tar.1
View File

@ -68,8 +68,9 @@ The
utility is compliant with the UStar (Uniform Standard Tape ARchive)
format defined in the
.St -p1003.1-88
specification. For long file paths (>99 bytes), the UStar, 'L' and 'x'
header formats are supported for reading (to a maximum size of PATH_MAX
or 255 bytes, depending on format), and the 'L' format is supported for
writing (with unlimited path size). Link targets are limited to the
UStar maximum of 100 bytes.
specification.
For long file paths (>99 bytes), the UStar, 'L' and 'x' header formats are
supported for reading (to a maximum size of PATH_MAX or 255 bytes, depending on
format), and the 'L' format is supported for writing (with unlimited path
size).
Link targets are limited to the UStar maximum of 100 bytes.

6
tee.1
View File

@ -23,8 +23,4 @@ Ignore SIGINT, see
.Xr signal 7 .
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
test.1
View File

@ -128,8 +128,4 @@ An error occurred.
.Sh SEE ALSO
.Xr expr 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
time.1
View File

@ -42,8 +42,4 @@ could not be found.
.Xr times 2 ,
.Xr waitpid 2
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

9
touch.1
View File

@ -21,7 +21,7 @@ doesn't exist, it is created with default permissions.
.Bl -tag -width Ds
.It Fl a | Fl m
Set the access | modification time of
.Ar file.
.Ar file .
.It Fl c
Don't create
.Ar file
@ -54,11 +54,8 @@ of the format [[CC]YY]MMDDhhmm[.SS] used for
.Sh SEE ALSO
.Xr date 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification except from fractional seconds with
POSIX.1-2013.
Except for fractional seconds with
.Op Fl d .
.Pp
The

7
tr.1
View File

@ -80,8 +80,5 @@ An error occurred.
.Xr sed 1 ,
.Xr utf8 7
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification except from equivalence classes.
POSIX.1-2013.
Except from equivalence classes.

6
true.1
View File

@ -10,8 +10,4 @@
.Nm
returns a status code indicating success.
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
tsort.1
View File

@ -67,8 +67,4 @@ represents the graph
┗━━━┛ ┗━━━┛
.Ed
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
tty.1
View File

@ -21,8 +21,4 @@ An error occurred.
.Sh SEE ALSO
.Xr ttyname 3
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
uname.1
View File

@ -32,8 +32,4 @@ Print the operating system's version name.
.Sh SEE ALSO
.Xr uname 2
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
unexpand.1
View File

@ -38,8 +38,4 @@ is "8".
.Sh SEE ALSO
.Xr expand 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
uniq.1
View File

@ -42,8 +42,4 @@ Ignore the first
fields | characters in each input line when doing comparisons.
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
unlink.1
View File

@ -16,8 +16,4 @@ on
.Sh SEE ALSO
.Xr unlink 2
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
uudecode.1
View File

@ -39,11 +39,7 @@ yields an error.
.Sh SEE ALSO
.Xr uuencode 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl m

6
uuencode.1
View File

@ -31,8 +31,4 @@ Use Base64 for encoding.
.Sh SEE ALSO
.Xr uudecode 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

6
wc.1
View File

@ -25,8 +25,4 @@ reads from stdin.
Print the number of bytes | lines | characters | words.
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.

8
xargs.1
View File

@ -112,12 +112,10 @@ could not be found.
Some other error occurred.
.El
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
POSIX.1-2013.
.Pp
The
.Op Fl r
and
.Op Fl P
flag is an extension to that specification.