diff --git a/cmd-bind-key.c b/cmd-bind-key.c index dab03b01..01f8e961 100644 --- a/cmd-bind-key.c +++ b/cmd-bind-key.c @@ -38,7 +38,7 @@ const struct cmd_entry cmd_bind_key_entry = { .args = { "nrN:T:", 1, -1, cmd_bind_key_args_parse }, .usage = "[-nr] [-T key-table] [-N note] key " - "[command [arguments]]", + "[command [argument ...]]", .flags = CMD_AFTERHOOK, .exec = cmd_bind_key_exec diff --git a/cmd-display-menu.c b/cmd-display-menu.c index ac136766..ab1b7047 100644 --- a/cmd-display-menu.c +++ b/cmd-display-menu.c @@ -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 }, diff --git a/cmd-new-session.c b/cmd-new-session.c index c90369bc..06082653 100644 --- a/cmd-new-session.c +++ b/cmd-new-session.c @@ -43,7 +43,7 @@ const struct cmd_entry cmd_new_session_entry = { .usage = "[-AdDEPX] [-c start-directory] [-e environment] [-F format] " "[-f flags] [-n window-name] [-s session-name] " CMD_TARGET_SESSION_USAGE " [-x width] [-y height] " - "[shell-command]", + "[shell-command [argument ...]]", .target = { 't', CMD_FIND_SESSION, CMD_FIND_CANFAIL }, diff --git a/cmd-new-window.c b/cmd-new-window.c index f2d932de..dd64baab 100644 --- a/cmd-new-window.c +++ b/cmd-new-window.c @@ -40,7 +40,8 @@ const struct cmd_entry cmd_new_window_entry = { .args = { "abc:de:F:kn:PSt:", 0, -1, NULL }, .usage = "[-abdkPS] [-c start-directory] [-e environment] [-F format] " - "[-n window-name] " CMD_TARGET_WINDOW_USAGE " [shell-command]", + "[-n window-name] " CMD_TARGET_WINDOW_USAGE + " [shell-command [argument ...]]", .target = { 't', CMD_FIND_WINDOW, CMD_FIND_WINDOW_INDEX }, diff --git a/cmd-respawn-pane.c b/cmd-respawn-pane.c index 6d60002e..1e1dd4c6 100644 --- a/cmd-respawn-pane.c +++ b/cmd-respawn-pane.c @@ -36,7 +36,7 @@ const struct cmd_entry cmd_respawn_pane_entry = { .args = { "c:e:kt:", 0, -1, NULL }, .usage = "[-k] [-c start-directory] [-e environment] " - CMD_TARGET_PANE_USAGE " [shell-command]", + CMD_TARGET_PANE_USAGE " [shell-command [argument ...]]", .target = { 't', CMD_FIND_PANE, 0 }, diff --git a/cmd-respawn-window.c b/cmd-respawn-window.c index 9a1a02c9..e1eae0af 100644 --- a/cmd-respawn-window.c +++ b/cmd-respawn-window.c @@ -36,7 +36,7 @@ const struct cmd_entry cmd_respawn_window_entry = { .args = { "c:e:kt:", 0, -1, NULL }, .usage = "[-k] [-c start-directory] [-e environment] " - CMD_TARGET_WINDOW_USAGE " [shell-command]", + CMD_TARGET_WINDOW_USAGE " [shell-command [argument ...]]", .target = { 't', CMD_FIND_WINDOW, 0 }, diff --git a/cmd-run-shell.c b/cmd-run-shell.c index be4c7cac..4b4399c8 100644 --- a/cmd-run-shell.c +++ b/cmd-run-shell.c @@ -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]", diff --git a/cmd-send-keys.c b/cmd-send-keys.c index 35b3f140..aa7b22fd 100644 --- a/cmd-send-keys.c +++ b/cmd-send-keys.c @@ -35,7 +35,7 @@ const struct cmd_entry cmd_send_keys_entry = { .args = { "c:FHKlMN:Rt:X", 0, -1, NULL }, .usage = "[-FHKlMRX] [-c target-client] [-N repeat-count] " - CMD_TARGET_PANE_USAGE " key ...", + CMD_TARGET_PANE_USAGE " [key ...]", .target = { 't', CMD_FIND_PANE, 0 }, diff --git a/cmd-set-buffer.c b/cmd-set-buffer.c index 35e72955..0b0ec3a2 100644 --- a/cmd-set-buffer.c +++ b/cmd-set-buffer.c @@ -35,7 +35,7 @@ const struct cmd_entry cmd_set_buffer_entry = { .args = { "ab:t:n:w", 0, 1, NULL }, .usage = "[-aw] " CMD_BUFFER_USAGE " [-n new-buffer-name] " - CMD_TARGET_CLIENT_USAGE " data", + CMD_TARGET_CLIENT_USAGE " [data]", .flags = CMD_AFTERHOOK|CMD_CLIENT_TFLAG|CMD_CLIENT_CANFAIL, .exec = cmd_set_buffer_exec diff --git a/cmd-show-options.c b/cmd-show-options.c index 0e7e5192..68494060 100644 --- a/cmd-show-options.c +++ b/cmd-show-options.c @@ -66,7 +66,7 @@ const struct cmd_entry cmd_show_hooks_entry = { .alias = NULL, .args = { "gpt:w", 0, 1, NULL }, - .usage = "[-gpw] " CMD_TARGET_PANE_USAGE, + .usage = "[-gpw] " CMD_TARGET_PANE_USAGE " [hook]", .target = { 't', CMD_FIND_PANE, CMD_FIND_CANFAIL }, diff --git a/cmd-split-window.c b/cmd-split-window.c index 128e9e8b..bbec0cc8 100644 --- a/cmd-split-window.c +++ b/cmd-split-window.c @@ -43,7 +43,7 @@ const struct cmd_entry cmd_split_window_entry = { .args = { "bc:de:fF:hIl:p:Pt:vZ", 0, -1, NULL }, .usage = "[-bdefhIPvZ] [-c start-directory] [-e environment] " "[-F format] [-l size] " CMD_TARGET_PANE_USAGE - " [shell-command]", + " [shell-command [argument ...]]", .target = { 't', CMD_FIND_PANE, 0 }, diff --git a/tmux.1 b/tmux.1 index 2e4cbaa5..bd184811 100644 --- a/tmux.1 +++ b/tmux.1 @@ -1248,7 +1248,7 @@ Lock all clients attached to .Op Fl t Ar group-name .Op Fl x Ar width .Op Fl y Ar height -.Op Ar shell-command +.Op Ar shell-command Op Ar argument ... .Xc .D1 Pq alias: Ic new Create a new session with name @@ -3091,7 +3091,7 @@ option. .Op Fl F Ar format .Op Fl n Ar window-name .Op Fl t Ar target-window -.Op Ar shell-command +.Op Ar shell-command Op Ar argument ... .Xc .D1 Pq alias: Ic neww Create a new window. @@ -3339,7 +3339,7 @@ to manual in the window options. .Op Fl c Ar start-directory .Op Fl e Ar environment .Op Fl t Ar target-pane -.Op Ar shell-command +.Op Ar shell-command Op Ar argument ... .Xc .D1 Pq alias: Ic respawnp Reactivate a pane in which the command has exited (see the @@ -3365,7 +3365,7 @@ command. .Op Fl c Ar start-directory .Op Fl e Ar environment .Op Fl t Ar target-window -.Op Ar shell-command +.Op Ar shell-command Op Ar argument ... .Xc .D1 Pq alias: Ic respawnw Reactivate a window in which the command has exited (see the @@ -3493,10 +3493,10 @@ the command behaves like .Op Fl bdfhIvPZ .Op Fl c Ar start-directory .Op Fl e Ar environment +.Op Fl F Ar format .Op Fl l Ar size .Op Fl t Ar target-pane -.Op Ar shell-command -.Op Fl F Ar format +.Op Ar shell-command Op Ar argument ... .Xc .D1 Pq alias: Ic splitw Create a new pane by splitting @@ -3676,7 +3676,8 @@ Commands related to key bindings are as follows: .Op Fl nr .Op Fl N Ar note .Op Fl T Ar key-table -.Ar key command Op Ar argument ... +.Ar key +.Op Ar command Op Ar argument ... .Xc .D1 Pq alias: Ic bind Bind key @@ -3735,7 +3736,8 @@ command. .Tg lsk .It Xo Ic list-keys .Op Fl 1aN -.Op Fl P Ar prefix-string Fl T Ar key-table +.Op Fl P Ar prefix-string +.Op Fl T Ar key-table .Op Ar key .Xc .D1 Pq alias: Ic lsk @@ -3774,7 +3776,7 @@ lists the command for keys that do not have a note rather than skipping them. .Op Fl c Ar target-client .Op Fl N Ar repeat-count .Op Fl t Ar target-pane -.Ar key ... +.Op Ar key ... .Xc .D1 Pq alias: Ic send Send a key or keys to a window or client. @@ -3852,12 +3854,44 @@ option prevents errors being returned. The appearance and behaviour of .Nm may be modified by changing the value of various options. -There are four types of option: -.Em server options , -.Em session options , -.Em window options , +Each option belongs to one or multiple scopes +.Po +.Em server , +.Em session , +.Em window , and -.Em pane options . +.Em pane +.Pc and has a type +.Po +.Em string , +.Em number , +.Em key , +.Em colour , +.Em flag , +.Em choice , +or +.Em command +.Pc . Values of +.Em flag Ns -type +options may be one of: +.Ic 1 , +.Ic on , +.Ic yes , +.Ic 0 , +.Ic off , +or +.Ic no ; +for possible +.Em choice +values, see the respective option; for +.Em key +options, the +.Sx KEY BINDINGS +section; and for +.Em colour +options, the +.Sx STYLES +section. .Pp The .Nm @@ -3921,13 +3955,14 @@ $ tmux show -wv @foo abc123 .Ed .Pp -Commands which set options are as follows: +Options are managed with these commands: .Bl -tag -width Ds .Tg set .It Xo Ic set-option .Op Fl aFgopqsuUw .Op Fl t Ar target-pane -.Ar option Ar value +.Ar option +.Op Ar value .Xc .D1 Pq alias: Ic set Set a pane option with @@ -3943,7 +3978,7 @@ or .Fl s may be unnecessary - .Nm -will infer the type from the option name, assuming +will infer the scope from the option name, assuming .Fl w for pane options. If @@ -3964,8 +3999,9 @@ unsets an option (like but if the option is a pane option also unsets the option on any panes in the window. .Ar value -depends on the option and may be a number, a string, or a flag (on, off, or -omitted to toggle). +depends on the option and its type and can be omitted for flag and choice +options to toggle its value (choice options toggle between the first two +choices). .Pp The .Fl o @@ -4020,7 +4056,7 @@ or .Fl s may be unnecessary - .Nm -will infer the type from the option name, assuming +will infer the scope from the option name, assuming .Fl w for pane options. Global session or window options are listed if @@ -5467,7 +5503,7 @@ Hooks are managed with these commands: .Op Fl agpRuw .Op Fl t Ar target-pane .Ar hook-name -.Ar command +.Op Ar command .Xc Without .Fl R , @@ -5488,6 +5524,7 @@ immediately. .It Xo Ic show-hooks .Op Fl gpw .Op Fl t Ar target-pane +.Op Ar hook .Xc Shows hooks. The flags are the same as for @@ -6149,9 +6186,10 @@ The colour is one of: .Ic cyan , .Ic white ; if supported the bright variants +.Ic brightblack , .Ic brightred , -.Ic brightgreen , -.Ic brightyellow ; +.Eo ...; +.Ec .Ic colour0 to .Ic colour255 @@ -6664,7 +6702,8 @@ the default is .Op Fl y Ar position .Ar name .Ar key -.Ar command Op Ar argument ... +.Ar command +.Op Ar name key command ... .Xc .D1 Pq alias: Ic menu Display a menu on @@ -6837,12 +6876,14 @@ forwards any input read from stdin to the empty pane given by .Op Fl w Ar width .Op Fl x Ar position .Op Fl y Ar position -.Op Ar shell-command +.Op Ar shell-command Op Ar argument ... .Xc .D1 Pq alias: Ic popup Display a popup running .Ar shell-command -on +(or +.Ar default-command +when omitted) on .Ar target-client . A popup is a rectangular box drawn over the top of any panes. Panes are not updated while a popup is present.