logo

utils-std

Collection of commonly available Unix tools
commit: 46dd0e92c16007cd0929539c18e27467295e466a
parent b2b8a0ef7ead2b993fdf6f268353b400395170f9
Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me>
Date:   Fri, 10 May 2024 23:01:24 +0200

cmd/*.1: Use singular and no space before ‘...’

Kept singular to ease grammar and make multiple synopsis forms
easier to deal with while keeping the exact same named argument.

For ‘...’ I find that it eases associativity with the named argument,
specially when it isn't the last argument, such as in mv(1).

Diffstat:

Mcmd/base64.12+-
Mcmd/cat.12+-
Mcmd/chmod.12+-
Mcmd/chown.14++--
Mcmd/chroot.12+-
Mcmd/echo.12+-
Mcmd/env.12+-
Mcmd/mkfifo.12+-
Mcmd/nice.12+-
Mcmd/nohup.12+-
Mcmd/pathchk.12+-
Mcmd/printf.16+++---
Mcmd/realpath.12+-
Mcmd/rm.12+-
Mcmd/sleep.12+-
Mcmd/strings.12+-
Mcmd/tee.12+-
Mcmd/timeout.12+-
Mcmd/unlink.115++++++++++++---
Mcmd/yes.12+-
20 files changed, 34 insertions(+), 25 deletions(-)

diff --git a/cmd/base64.1 b/cmd/base64.1 @@ -11,7 +11,7 @@ .Nm .Op Fl d .Op Fl w Ar wrap -.Op Ar file ... +.Op Ar file... .Sh DESCRIPTION .Nm reads diff --git a/cmd/cat.1 b/cmd/cat.1 @@ -10,7 +10,7 @@ .Sh SYNOPSIS .Nm .Op Fl u -.Op Ar files ... +.Op Ar file... .Sh DESCRIPTION .Nm reads each diff --git a/cmd/chmod.1 b/cmd/chmod.1 @@ -11,7 +11,7 @@ .Nm .Op Fl cRv .Ar mode -.Ar file ... +.Ar file... .Sh DESCRIPTION .Nm sets the permissions bits given by diff --git a/cmd/chown.1 b/cmd/chown.1 @@ -12,12 +12,12 @@ .Op Fl v .Op Fl h | Fl R Op Fl HLP .Ar owner Ns Op : Ns Ar group -.Ar file ... +.Ar file... .Nm chgrp .Op Fl v .Op Fl h | Fl R Op Fl HLP .Ar group -.Ar file ... +.Ar file... .Sh DESCRIPTION .Nm chown sets the user ID given by diff --git a/cmd/chroot.1 b/cmd/chroot.1 @@ -10,7 +10,7 @@ .Sh SYNOPSIS .Nm .Ar newroot -.Op Ar command Op Ar args ... +.Op Ar command Op Ar argument... .Sh DESCRIPTION .Nm runs diff --git a/cmd/echo.1 b/cmd/echo.1 @@ -10,7 +10,7 @@ .Sh SYNOPSIS .Nm .Op Fl n -.Op Ar string ... +.Op Ar string... .Sh DESCRIPTION .Nm buffers all diff --git a/cmd/env.1 b/cmd/env.1 @@ -13,7 +13,7 @@ .Op Fl u Ar name .Op Fl -unset= Ns Ar name .Op Ar name Ns = Ns Ar value -.Op Ar command Op Ar argument ... +.Op Ar command Op Ar argument... .Sh DESCRIPTION .Nm with no arguments prints the environment, or if specified runs diff --git a/cmd/mkfifo.1 b/cmd/mkfifo.1 @@ -10,7 +10,7 @@ .Sh SYNOPSIS .Nm .Op Fl m Ar mode -.Ar file ... +.Ar file... .Sh DESCRIPTION .Nm creates a FIFO special file at diff --git a/cmd/nice.1 b/cmd/nice.1 @@ -11,7 +11,7 @@ .Nm .Op Fl n Ar increment .Ar command -.Op Ar arguments ... +.Op Ar argument... .Sh DESCRIPTION .Nm runs diff --git a/cmd/nohup.1 b/cmd/nohup.1 @@ -10,7 +10,7 @@ .Sh SYNOPSIS .Nm .Ar command -.Op Ar arguments ... +.Op Ar argument... .Sh DESCRIPTION .Nm runs diff --git a/cmd/pathchk.1 b/cmd/pathchk.1 @@ -10,7 +10,7 @@ .Sh SYNOPSIS .Nm .Op Fl pP -.Ar pathname ... +.Ar pathname... .Sh DESCRIPTION .Nm checks each diff --git a/cmd/printf.1 b/cmd/printf.1 @@ -37,7 +37,7 @@ .Nd formatted output .Sh SYNOPSIS .Nm -.Ar format Op Ar arguments ... +.Ar format Op Ar argument... .Sh DESCRIPTION The .Nm @@ -53,7 +53,7 @@ each of which causes printing of the next successive .Ar argument . .Pp The -.Ar arguments +.Ar argument after the first are treated as strings if the corresponding format is either .Cm c , b @@ -70,7 +70,7 @@ character code of the next character. .El .Pp The format string is reused as often as necessary to satisfy the -.Ar arguments . +.Ar argument . Any extra format specifications are evaluated with zero or the null string. .Pp diff --git a/cmd/realpath.1 b/cmd/realpath.1 @@ -11,7 +11,7 @@ .Nm .Op Fl E Ns | Ns Fl e .Op Fl n Ns | Ns Fl z -.Ar path ... +.Ar path... .Sh DESCRIPTION The .Nm diff --git a/cmd/rm.1 b/cmd/rm.1 @@ -10,7 +10,7 @@ .Sh SYNOPSIS .Nm .Op Fl dfirRv -.Op Ar file ... +.Op Ar file... .Sh DESCRIPTION The .Nm diff --git a/cmd/sleep.1 b/cmd/sleep.1 @@ -9,7 +9,7 @@ .Nd delay for a specified amount of time .Sh SYNOPSIS .Nm -.Ar duration ... +.Ar duration... .Sh DESCRIPTION The .Nm diff --git a/cmd/strings.1 b/cmd/strings.1 @@ -12,7 +12,7 @@ .Op Fl a .Op Fl t Ar format .Op Fl n Ar number -.Op Ar files ... +.Op Ar file... .Sh DESCRIPTION .Nm reads each diff --git a/cmd/tee.1 b/cmd/tee.1 @@ -11,7 +11,7 @@ .Nm .Op Fl a .Op Fl i -.Op Ar file ... +.Op Ar file... .Sh DESCRIPTION .Nm copies standard input to standard output and to each given diff --git a/cmd/timeout.1 b/cmd/timeout.1 @@ -13,7 +13,7 @@ .Op Fl s Ar SIGNAL .Ar duration .Ar command -.Op Ar arguments... +.Op Ar argument... .Sh DESCRIPTION The .Nm diff --git a/cmd/unlink.1 b/cmd/unlink.1 @@ -9,13 +9,22 @@ .Nd unlink filenames and possibly the referred files .Sh SYNOPSIS .Nm -.Op Ar files ... +.Op Ar file... .Sh DESCRIPTION .Nm -deletes a filename from the filesystem. -If that filename was the last link to a file and no processes have the file open, the file is deleted. +deletes each +.Ar file +link from the filesystem. +If +.Ar file +was the last link and no processes have it open, +.Ar file +is deleted. .Sh EXIT STATUS .Ex -std +.Sh SEE ALSO +.Xr ln 1 , +.Xr rm 1 .Sh STANDARDS .Nm should be compliant with the diff --git a/cmd/yes.1 b/cmd/yes.1 @@ -9,7 +9,7 @@ .Nd output a string repeatedly .Sh SYNOPSIS .Nm -.Op Ar string ... +.Op Ar string... .Sh DESCRIPTION The .Nm