From: Bart Schaefer <schaefer@brasslantern.com>
To: Daniel Shahaf <d.s@daniel.shahaf.name>
Cc: Ray Andrews <rayandrews@eastlink.ca>, Zsh Users <zsh-users@zsh.org>
Subject: Re: manual
Date: Tue, 20 Dec 2022 20:43:12 -0800 [thread overview]
Message-ID: <CAH+w=7aNr37jbzt1qM7f3FQpAhwn6H6JVCUd48q-kui7y+cbSQ@mail.gmail.com> (raw)
In-Reply-To: <20221221020026.GH8411@tarpaulin.shahaf.local2>
On Tue, Dec 20, 2022 at 6:00 PM Daniel Shahaf <d.s@daniel.shahaf.name> wrote:
>
> The synopsis just says «{+|-}options», with "options" in var() markup.
>
> That's unusual: most synopses spell out all valid flags.
"No; it is too much. Let me sum up." -- Inigo Montoya
There was for a long time an effort made to keep the first-line
synopsis of each command short enough to fit on one line of "man"
output. For a few commands that was impossible so we started adding
explicit line breaks with the expectation that the reader would
understand it was still all one command line. For some others there
was no way to add a line break at a sensible place.
In this particular case (as you noted) there's an entire other section
already dedicated to the single-letter options that can be manipulated
with "set" and another for the long names for "set -o".
It might have been nice to be consistent about what was an "option"
and what was a "flag" or a "switch", but those terms are thrown around
colloquially with interpretation expected from context.
next prev parent reply other threads:[~2022-12-21 4:44 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-20 22:41 manual Ray Andrews
2022-12-21 0:43 ` manual Lawrence Velázquez
2022-12-21 1:15 ` manual Ray Andrews
2022-12-21 1:44 ` manual Lawrence Velázquez
2022-12-21 4:15 ` manual Ray Andrews
2022-12-21 2:00 ` manual Daniel Shahaf
2022-12-21 4:12 ` manual Ray Andrews
2022-12-21 4:43 ` Bart Schaefer [this message]
2022-12-21 14:04 ` manual Ray Andrews
2022-12-22 6:31 ` manual Lawrence Velázquez
2022-12-22 14:20 ` manual Ray Andrews
2022-12-21 9:38 ` manual Lawrence Velázquez
2022-12-22 7:03 ` manual Lawrence Velázquez
2022-12-22 13:50 ` manual Ray Andrews
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAH+w=7aNr37jbzt1qM7f3FQpAhwn6H6JVCUd48q-kui7y+cbSQ@mail.gmail.com' \
--to=schaefer@brasslantern.com \
--cc=d.s@daniel.shahaf.name \
--cc=rayandrews@eastlink.ca \
--cc=zsh-users@zsh.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.vuxu.org/mirror/zsh/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).