diff options
author | Lennart Poettering <lennart@poettering.net> | 2019-11-15 18:38:44 +0100 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2019-11-18 15:14:43 +0100 |
commit | 353b2baa20c5a643c3de1eeee963f8a46af90feb (patch) | |
tree | 738e1eeda41919111e3f2370ce3df753688d7210 /src/portable | |
parent | ce0d4c4f91173d3b79b7c7ae7344abd52912ab42 (diff) | |
download | systemd-353b2baa20c5a643c3de1eeee963f8a46af90feb.tar.gz |
tree-wide: clean up --help texts a bit
This cleans up and unifies the outut of --help texts a bit:
1. Highlight the human friendly description string, not the command
line via ANSI sequences. Previously both this description string and
the brief command line summary was marked with the same ANSI
highlight sequence, but given we auto-page to less and less does not
honour multi-line highlights only the command line summary was
affectively highlighted. Rationale: for highlighting the description
instead of the command line: the command line summary is relatively
boring, and mostly the same for out tools, the description on the
other hand is pregnant, important and captions the whole thing and
hence deserves highlighting.
2. Always suffix "Options" with ":" in the help text
3. Rename "Flags" → "Options" in one case
4. Move commands to the top in a few cases
5. add coloring to many more help pages
6. Unify on COMMAND instead of {COMMAND} in the command line summary.
Some tools did it one way, others the other way. I am not sure what
precisely {} is supposed to mean, that uppercasing doesn't, hence
let's simplify and stick to the {}-less syntax
And minor other tweaks.
Diffstat (limited to 'src/portable')
-rw-r--r-- | src/portable/portablectl.c | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/portable/portablectl.c b/src/portable/portablectl.c index 06ab7735ad..7246c6c814 100644 --- a/src/portable/portablectl.c +++ b/src/portable/portablectl.c @@ -781,9 +781,9 @@ static int help(int argc, char *argv[], void *userdata) { if (r < 0) return log_oom(); - printf("%s%s [OPTIONS...] {COMMAND} ...\n\n" - "Attach or detach portable services from the local system.%s\n" - "Commands:\n" + printf("%s [OPTIONS...] COMMAND ...\n\n" + "%sAttach or detach portable services from the local system.%s\n" + "\nCommands:\n" " list List available portable service images\n" " attach NAME|PATH [PREFIX...]\n" " Attach the specified portable service image\n" @@ -794,7 +794,7 @@ static int help(int argc, char *argv[], void *userdata) { " read-only NAME|PATH [BOOL] Mark or unmark portable service image read-only\n" " remove NAME|PATH... Remove a portable service image\n" " set-limit [NAME|PATH] Set image or pool size limit (disk quota)\n" - "\nOptions\n" + "\nOptions:\n" " -h --help Show this help\n" " --version Show package version\n" " --no-pager Do not pipe output into a pager\n" @@ -810,8 +810,8 @@ static int help(int argc, char *argv[], void *userdata) { " --cat When inspecting include unit and os-release file\n" " contents\n" "\nSee the %s for details.\n" - , ansi_highlight() , program_invocation_short_name + , ansi_highlight() , ansi_normal() , link ); |