usbguard
usbguard copied to clipboard
Make `--help` indent better
A perfectionist comment on the --help "page":
Currently, --help does not indent text for subcommands and text:
allow-device [OPTIONS] <id>
Authorize a device identified by the device id to interact with the system.
Available options:
-p, --permanent
Make the decision permanent. A device specific allow rule will be
appended to the current policy.
-h, --help
Show help.
I'd prefer it this way:
allow-device [OPTIONS] <id>
Authorize a device identified by the device id to interact with the system.
Available options:
-p, --permanent
Make the decision permanent. A device specific allow rule will be
appended to the current policy.
-h, --help
Show help.
With this change you could omit the ~ ~ ~ lines. This is the way man bash and man systemctl do it.
I hope that this will be doable with the markdown -> roff (via pandoc) conversion path. I'll adopt this format if it works. Thanks for the feedback!
I tried to indent the sub-command description block in the markdown source file but it doesn't work :-( Any idea how to achieve this in markdown?