diff options
| author | Klemens Nanni <kn@cvs.openbsd.org> | 2022-12-22 19:53:25 +0000 |
|---|---|---|
| committer | Klemens Nanni <kn@cvs.openbsd.org> | 2022-12-22 19:53:25 +0000 |
| commit | dcd007097b9192d37a4b39e41094f0b07bfbe237 (patch) | |
| tree | 5d14384480414cca7c4af172ac9a9dec1b03fdb2 /usr.bin/mandoc | |
| parent | 7cffd29be8ddc926f78306a722ae0466ca092588 (diff) | |
Denote multiple arguments with 'arg ...' not 'args'
A few programs used the plural in their synopsis which doesn't read as
clear as the obvious triple-dot notation.
mdoc(7) .Ar defaults to "file ..." if no arguments are given and consistent
use of 'arg ...' matches that behaviour.
Cleanup a few markups of the same argument so the text keeps reading
naturally; omit unhelpful parts like 'if optional arguments are given,
they are passed along' for tools like time(1) and timeout(1) that obviously
execute commands with whatever arguments where given -- just like doas(1)
which doesn't mention arguments in its DESCRIPTION in the first place.
For expr(1) the difference between 'expressions' and 'expression ...' is
crucial, as arguments must be passed as individual words.
Feedback millert jmc schwarze deraadt
OK jmc
Diffstat (limited to 'usr.bin/mandoc')
| -rw-r--r-- | usr.bin/mandoc/mandoc.1 | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/usr.bin/mandoc/mandoc.1 b/usr.bin/mandoc/mandoc.1 index 931370665f6..e571053cd25 100644 --- a/usr.bin/mandoc/mandoc.1 +++ b/usr.bin/mandoc/mandoc.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mandoc.1,v 1.189 2022/08/02 11:55:51 schwarze Exp $ +.\" $OpenBSD: mandoc.1,v 1.190 2022/12/22 19:53:23 kn Exp $ .\" .\" Copyright (c) 2012, 2014-2022 Ingo Schwarze <schwarze@openbsd.org> .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> @@ -15,7 +15,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: August 2 2022 $ +.Dd $Mdocdate: December 22 2022 $ .Dt MANDOC 1 .Os .Sh NAME @@ -765,7 +765,7 @@ Messages displayed by follow this format: .Bd -ragged -offset indent .Nm : -.Ar file : Ns Ar line : Ns Ar column : level : message : macro arguments +.Ar file : Ns Ar line : Ns Ar column : level : message : macro argument ... .Pq Ar os .Ed .Pp @@ -785,9 +785,7 @@ and strings are explained below. The name of the .Ar macro -triggering the message and its -.Ar arguments -are omitted where meaningless. +triggering the message and its arguments are omitted where meaningless. The .Ar os operating system specifier is omitted for messages that are relevant |