Move the Commands section above Options section
For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
This commit is contained in:
+14
-14
@@ -810,20 +810,8 @@ static int help(void) {
|
||||
return log_oom();
|
||||
|
||||
printf("%s [OPTIONS...] COMMAND ...\n\n"
|
||||
"Query or change system time and date settings.\n\n"
|
||||
" -h --help Show this help message\n"
|
||||
" --version Show package version\n"
|
||||
" --no-pager Do not pipe output into a pager\n"
|
||||
" --no-ask-password Do not prompt for password\n"
|
||||
" -H --host=[USER@]HOST Operate on remote host\n"
|
||||
" -M --machine=CONTAINER Operate on local container\n"
|
||||
" --adjust-system-clock Adjust system clock when changing local RTC mode\n"
|
||||
" --monitor Monitor status of systemd-timesyncd\n"
|
||||
" -p --property=NAME Show only properties by this name\n"
|
||||
" -a --all Show all properties, including empty ones\n"
|
||||
" --value When showing properties, only print the value\n"
|
||||
"\n"
|
||||
"Commands:\n"
|
||||
"Query or change system time and date settings.\n"
|
||||
"\nCommands:\n"
|
||||
" status Show current time settings\n"
|
||||
" show Show properties of systemd-timedated\n"
|
||||
" set-time TIME Set system time\n"
|
||||
@@ -835,6 +823,18 @@ static int help(void) {
|
||||
"systemd-timesyncd Commands:\n"
|
||||
" timesync-status Show status of systemd-timesyncd\n"
|
||||
" show-timesync Show properties of systemd-timesyncd\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"
|
||||
" --no-ask-password Do not prompt for password\n"
|
||||
" -H --host=[USER@]HOST Operate on remote host\n"
|
||||
" -M --machine=CONTAINER Operate on local container\n"
|
||||
" --adjust-system-clock Adjust system clock when changing local RTC mode\n"
|
||||
" --monitor Monitor status of systemd-timesyncd\n"
|
||||
" -p --property=NAME Show only properties by this name\n"
|
||||
" -a --all Show all properties, including empty ones\n"
|
||||
" --value When showing properties, only print the value\n"
|
||||
"\nSee the %s for details.\n"
|
||||
, program_invocation_short_name
|
||||
, link
|
||||
|
||||
Reference in New Issue
Block a user