From 353b2baa20c5a643c3de1eeee963f8a46af90feb Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 15 Nov 2019 18:38:44 +0100 Subject: tree-wide: clean up --help texts a bit MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- src/timedate/timedatectl.c | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) (limited to 'src/timedate') diff --git a/src/timedate/timedatectl.c b/src/timedate/timedatectl.c index 2a98c48987..d31b319041 100644 --- a/src/timedate/timedatectl.c +++ b/src/timedate/timedatectl.c @@ -810,8 +810,8 @@ static int help(void) { if (r < 0) return log_oom(); - printf("%s%s [OPTIONS...] COMMAND ...\n\n" - "Query or change system time and date settings.%s\n" + printf("%s [OPTIONS...] COMMAND ...\n" + "\n%sQuery or change system time and date settings.%s\n" "\nCommands:\n" " status Show current time settings\n" " show Show properties of systemd-timedated\n" @@ -820,11 +820,10 @@ static int help(void) { " list-timezones Show known time zones\n" " set-local-rtc BOOL Control whether RTC is in local time\n" " set-ntp BOOL Enable or disable network time synchronization\n" - "\n" - "systemd-timesyncd Commands:\n" + "\nsystemd-timesyncd Commands:\n" " timesync-status Show status of systemd-timesyncd\n" " show-timesync Show properties of systemd-timesyncd\n" - "\nOptions\n" + "\nOptions:\n" " -h --help Show this help message\n" " --version Show package version\n" " --no-pager Do not pipe output into a pager\n" @@ -837,8 +836,8 @@ static int help(void) { " -a --all Show all properties, including empty ones\n" " --value When showing properties, only print the value\n" "\nSee the %s for details.\n" - , ansi_highlight() , program_invocation_short_name + , ansi_highlight() , ansi_normal() , link ); -- cgit v1.2.3