From: Stephen Gregoratto <dev@sgregoratto.me>
To: discuss@mandoc.bsd.lv
Subject: mdoc synopsis style for more than one mandatory, mutually exclusive options?
Date: Tue, 20 Jul 2021 08:48:54 +1000 [thread overview]
Message-ID: <20210719224854.hrmf3ez2oynitfe3@BlackBox> (raw)
I am working on a utility that takes input from different sources:
1. Arguments after options parsing (i.e., after --).
2. From the named file after the `-R` flag.
3. From the named file after the `-I` flag.
The program will quit if input == 0, so at least one of these options
must be used. And there can be multiple instances of each (i.e., -R and
-I can be specified more than once).
My question is: how can I format this in the synopsis without it being
overwhelming? Semantically, .Op is out because it isn't optional. I've
seen other utilities use something like
(a | -F b)...
instead, but I've never seen this form in a manpage before.
--
Stephen Gregoratto
--
To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv
next reply other threads:[~2021-07-19 22:49 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-19 22:48 Stephen Gregoratto [this message]
2021-07-20 0:34 ` Ingo Schwarze
2021-07-20 4:10 ` Stephen Gregoratto
2021-07-20 13:02 ` Ingo Schwarze
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=20210719224854.hrmf3ez2oynitfe3@BlackBox \
--to=dev@sgregoratto.me \
--cc=discuss@mandoc.bsd.lv \
/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.
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).