Fix documentation around optional arguments. This includes:

- Syncing between the usage string in code and in the man page.
- Adding optional arguments that were not mentioned (such as
  shell-command arguments).
- Adding square brackets around arguments that are actually optional.

From Julian Prein (julian at druck dot dev) in GitHub issue 4419.
This commit is contained in:
nicm
2025-04-09 07:03:04 +00:00
parent 3e14e7c48b
commit 68ffe65499
12 changed files with 80 additions and 38 deletions

View File

@ -43,7 +43,7 @@ const struct cmd_entry cmd_display_menu_entry = {
.usage = "[-MO] [-b border-lines] [-c target-client] "
"[-C starting-choice] [-H selected-style] [-s style] "
"[-S border-style] " CMD_TARGET_PANE_USAGE " [-T title] "
"[-x position] [-y position] name key command ...",
"[-x position] [-y position] name [key] [command] ...",
.target = { 't', CMD_FIND_PANE, 0 },
@ -60,7 +60,7 @@ const struct cmd_entry cmd_display_popup_entry = {
"[-d start-directory] [-e environment] [-h height] "
"[-s style] [-S border-style] " CMD_TARGET_PANE_USAGE
" [-T title] [-w width] [-x position] [-y position] "
"[shell-command]",
"[shell-command [argument ...]]",
.target = { 't', CMD_FIND_PANE, 0 },