@ferdnyc commented on this pull request.
> +Typographic conventions:
+- Put option aliases on separate lines
+- Put option arguments with pre-determined values into <> (see below)
+
+*-d*
+*--do-this*
+ Do Y instead of default action.
+
+*-o* _ARG_,
+*--output*=_ARG_
+ Use file _ARG_ for output.
+
+*--format*=<*aa*|*bb*>
+ Use format *aa* or *bb* for output.
+
+*--compress*=<_method_>
Traditionally in man pages, placeholders for args were usually shown in
`ALLCAPS`. (Or sometimes italicized _ALLCAPS_, which in the terminal displays
as underlined.) For example, here's an abbreviated look at `man autoconf`:
```text
SYNOPSIS
autoconf [OPTION]... [TEMPLATE-FILE]
DESCRIPTION
Generate a configuration script from a TEMPLATE-FILE if given, or 'con‐
figure.ac' if present, or else 'configure.in'. Output is sent to the
standard output if TEMPLATE-FILE is given, else into 'configure'.
Operation modes:
-o, --output=FILE
save output in FILE (stdout is the default)
-W, --warnings=CATEGORY
report the warnings falling in CATEGORY (comma-separated list ac‐
cepted)
```
Where the possible arguments are limited to a fixed set of values, I agree
`--parameter=<first|second|third>` makes sense as a notation. But I'm not sure
reusing that format for placeholder strings makes things clearer than sticking
with the traditional `ARGTYPE` placeholder convention.
--
Reply to this email directly or view it on GitHub:
https://github.com/rpm-software-management/rpm/pull/3639#discussion_r2000268057
You are receiving this because you are subscribed to this thread.
Message ID: <rpm-software-management/rpm/pull/3639/review/[email protected]>_______________________________________________
Rpm-maint mailing list
[email protected]
https://lists.rpm.org/mailman/listinfo/rpm-maint
