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

@ -44,7 +44,7 @@ const struct cmd_entry cmd_run_shell_entry = {
.name = "run-shell",
.alias = "run",
.args = { "bd:Ct:c:", 0, 2, cmd_run_shell_args_parse },
.args = { "bd:Ct:c:", 0, 1, cmd_run_shell_args_parse },
.usage = "[-bC] [-c start-directory] [-d delay] " CMD_TARGET_PANE_USAGE
" [shell-command]",