usbguard icon indicating copy to clipboard operation
usbguard copied to clipboard

Make `--help` indent better

Open genodeftest opened this issue 9 years ago • 3 comments

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.

genodeftest avatar Aug 14 '16 08:08 genodeftest

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!

dkopecek avatar Aug 14 '16 09:08 dkopecek

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?

dkopecek avatar Aug 16 '16 11:08 dkopecek

0001-Indent-subcommand-blocks-as-subsections.patch.txt

I've only checked the roff output.

endomandi avatar Dec 20 '16 23:12 endomandi