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:
Zbigniew Jędrzejewski-Szmek
2019-10-08 18:21:26 +02:00
parent 69d0eb4475
commit e1fac8a68a
23 changed files with 1799 additions and 1793 deletions
+8 -7
View File
@@ -1750,13 +1750,7 @@ static int help(void) {
return log_oom();
printf("%s [OPTIONS...]\n\n"
"Query and control the networking subsystem.\n\n"
" -h --help Show this help\n"
" --version Show package version\n"
" --no-pager Do not pipe output into a pager\n"
" --no-legend Do not show the headers and footers\n"
" -a --all Show status for all links\n"
" -s --stats Show detailed link statics\n"
"Query and control the networking subsystem.\n"
"\nCommands:\n"
" list [PATTERN...] List links\n"
" status [PATTERN...] Show link status\n"
@@ -1764,6 +1758,13 @@ static int help(void) {
" label Show current address label entries in the kernel\n"
" delete DEVICES.. Delete virtual netdevs\n"
" renew DEVICES.. Renew dynamic configurations\n"
"\nOptions\n"
" -h --help Show this help\n"
" --version Show package version\n"
" --no-pager Do not pipe output into a pager\n"
" --no-legend Do not show the headers and footers\n"
" -a --all Show status for all links\n"
" -s --stats Show detailed link statics\n"
"\nSee the %s for details.\n"
, program_invocation_short_name
, link