mirror of
				https://github.com/tmux/tmux.git
				synced 2025-11-04 00:56:10 +00:00 
			
		
		
		
	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:
		@@ -38,7 +38,7 @@ const struct cmd_entry cmd_bind_key_entry = {
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
	.args = { "nrN:T:", 1, -1, cmd_bind_key_args_parse },
 | 
						.args = { "nrN:T:", 1, -1, cmd_bind_key_args_parse },
 | 
				
			||||||
	.usage = "[-nr] [-T key-table] [-N note] key "
 | 
						.usage = "[-nr] [-T key-table] [-N note] key "
 | 
				
			||||||
	         "[command [arguments]]",
 | 
						         "[command [argument ...]]",
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	.flags = CMD_AFTERHOOK,
 | 
						.flags = CMD_AFTERHOOK,
 | 
				
			||||||
	.exec = cmd_bind_key_exec
 | 
						.exec = cmd_bind_key_exec
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -43,7 +43,7 @@ const struct cmd_entry cmd_display_menu_entry = {
 | 
				
			|||||||
	.usage = "[-MO] [-b border-lines] [-c target-client] "
 | 
						.usage = "[-MO] [-b border-lines] [-c target-client] "
 | 
				
			||||||
		 "[-C starting-choice] [-H selected-style] [-s style] "
 | 
							 "[-C starting-choice] [-H selected-style] [-s style] "
 | 
				
			||||||
		 "[-S border-style] " CMD_TARGET_PANE_USAGE " [-T title] "
 | 
							 "[-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 },
 | 
						.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] "
 | 
							 "[-d start-directory] [-e environment] [-h height] "
 | 
				
			||||||
		 "[-s style] [-S border-style] " CMD_TARGET_PANE_USAGE
 | 
							 "[-s style] [-S border-style] " CMD_TARGET_PANE_USAGE
 | 
				
			||||||
		 " [-T title] [-w width] [-x position] [-y position] "
 | 
							 " [-T title] [-w width] [-x position] [-y position] "
 | 
				
			||||||
		 "[shell-command]",
 | 
							 "[shell-command [argument ...]]",
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	.target = { 't', CMD_FIND_PANE, 0 },
 | 
						.target = { 't', CMD_FIND_PANE, 0 },
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -43,7 +43,7 @@ const struct cmd_entry cmd_new_session_entry = {
 | 
				
			|||||||
	.usage = "[-AdDEPX] [-c start-directory] [-e environment] [-F format] "
 | 
						.usage = "[-AdDEPX] [-c start-directory] [-e environment] [-F format] "
 | 
				
			||||||
		 "[-f flags] [-n window-name] [-s session-name] "
 | 
							 "[-f flags] [-n window-name] [-s session-name] "
 | 
				
			||||||
		 CMD_TARGET_SESSION_USAGE " [-x width] [-y height] "
 | 
							 CMD_TARGET_SESSION_USAGE " [-x width] [-y height] "
 | 
				
			||||||
		 "[shell-command]",
 | 
							 "[shell-command [argument ...]]",
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	.target = { 't', CMD_FIND_SESSION, CMD_FIND_CANFAIL },
 | 
						.target = { 't', CMD_FIND_SESSION, CMD_FIND_CANFAIL },
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -40,7 +40,8 @@ const struct cmd_entry cmd_new_window_entry = {
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
	.args = { "abc:de:F:kn:PSt:", 0, -1, NULL },
 | 
						.args = { "abc:de:F:kn:PSt:", 0, -1, NULL },
 | 
				
			||||||
	.usage = "[-abdkPS] [-c start-directory] [-e environment] [-F format] "
 | 
						.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 },
 | 
						.target = { 't', CMD_FIND_WINDOW, CMD_FIND_WINDOW_INDEX },
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -36,7 +36,7 @@ const struct cmd_entry cmd_respawn_pane_entry = {
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
	.args = { "c:e:kt:", 0, -1, NULL },
 | 
						.args = { "c:e:kt:", 0, -1, NULL },
 | 
				
			||||||
	.usage = "[-k] [-c start-directory] [-e environment] "
 | 
						.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 },
 | 
						.target = { 't', CMD_FIND_PANE, 0 },
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -36,7 +36,7 @@ const struct cmd_entry cmd_respawn_window_entry = {
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
	.args = { "c:e:kt:", 0, -1, NULL },
 | 
						.args = { "c:e:kt:", 0, -1, NULL },
 | 
				
			||||||
	.usage = "[-k] [-c start-directory] [-e environment] "
 | 
						.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 },
 | 
						.target = { 't', CMD_FIND_WINDOW, 0 },
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -44,7 +44,7 @@ const struct cmd_entry cmd_run_shell_entry = {
 | 
				
			|||||||
	.name = "run-shell",
 | 
						.name = "run-shell",
 | 
				
			||||||
	.alias = "run",
 | 
						.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
 | 
						.usage = "[-bC] [-c start-directory] [-d delay] " CMD_TARGET_PANE_USAGE
 | 
				
			||||||
	         " [shell-command]",
 | 
						         " [shell-command]",
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -35,7 +35,7 @@ const struct cmd_entry cmd_send_keys_entry = {
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
	.args = { "c:FHKlMN:Rt:X", 0, -1, NULL },
 | 
						.args = { "c:FHKlMN:Rt:X", 0, -1, NULL },
 | 
				
			||||||
	.usage = "[-FHKlMRX] [-c target-client] [-N repeat-count] "
 | 
						.usage = "[-FHKlMRX] [-c target-client] [-N repeat-count] "
 | 
				
			||||||
	         CMD_TARGET_PANE_USAGE " key ...",
 | 
						         CMD_TARGET_PANE_USAGE " [key ...]",
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	.target = { 't', CMD_FIND_PANE, 0 },
 | 
						.target = { 't', CMD_FIND_PANE, 0 },
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -35,7 +35,7 @@ const struct cmd_entry cmd_set_buffer_entry = {
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
	.args = { "ab:t:n:w", 0, 1, NULL },
 | 
						.args = { "ab:t:n:w", 0, 1, NULL },
 | 
				
			||||||
	.usage = "[-aw] " CMD_BUFFER_USAGE " [-n new-buffer-name] "
 | 
						.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,
 | 
						.flags = CMD_AFTERHOOK|CMD_CLIENT_TFLAG|CMD_CLIENT_CANFAIL,
 | 
				
			||||||
	.exec = cmd_set_buffer_exec
 | 
						.exec = cmd_set_buffer_exec
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -66,7 +66,7 @@ const struct cmd_entry cmd_show_hooks_entry = {
 | 
				
			|||||||
	.alias = NULL,
 | 
						.alias = NULL,
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	.args = { "gpt:w", 0, 1, 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 },
 | 
						.target = { 't', CMD_FIND_PANE, CMD_FIND_CANFAIL },
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -43,7 +43,7 @@ const struct cmd_entry cmd_split_window_entry = {
 | 
				
			|||||||
	.args = { "bc:de:fF:hIl:p:Pt:vZ", 0, -1, NULL },
 | 
						.args = { "bc:de:fF:hIl:p:Pt:vZ", 0, -1, NULL },
 | 
				
			||||||
	.usage = "[-bdefhIPvZ] [-c start-directory] [-e environment] "
 | 
						.usage = "[-bdefhIPvZ] [-c start-directory] [-e environment] "
 | 
				
			||||||
		 "[-F format] [-l size] " CMD_TARGET_PANE_USAGE
 | 
							 "[-F format] [-l size] " CMD_TARGET_PANE_USAGE
 | 
				
			||||||
		 " [shell-command]",
 | 
							 " [shell-command [argument ...]]",
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	.target = { 't', CMD_FIND_PANE, 0 },
 | 
						.target = { 't', CMD_FIND_PANE, 0 },
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										93
									
								
								tmux.1
									
									
									
									
									
								
							
							
						
						
									
										93
									
								
								tmux.1
									
									
									
									
									
								
							@@ -1248,7 +1248,7 @@ Lock all clients attached to
 | 
				
			|||||||
.Op Fl t Ar group-name
 | 
					.Op Fl t Ar group-name
 | 
				
			||||||
.Op Fl x Ar width
 | 
					.Op Fl x Ar width
 | 
				
			||||||
.Op Fl y Ar height
 | 
					.Op Fl y Ar height
 | 
				
			||||||
.Op Ar shell-command
 | 
					.Op Ar shell-command Op Ar argument ...
 | 
				
			||||||
.Xc
 | 
					.Xc
 | 
				
			||||||
.D1 Pq alias: Ic new
 | 
					.D1 Pq alias: Ic new
 | 
				
			||||||
Create a new session with name
 | 
					Create a new session with name
 | 
				
			||||||
@@ -3091,7 +3091,7 @@ option.
 | 
				
			|||||||
.Op Fl F Ar format
 | 
					.Op Fl F Ar format
 | 
				
			||||||
.Op Fl n Ar window-name
 | 
					.Op Fl n Ar window-name
 | 
				
			||||||
.Op Fl t Ar target-window
 | 
					.Op Fl t Ar target-window
 | 
				
			||||||
.Op Ar shell-command
 | 
					.Op Ar shell-command Op Ar argument ...
 | 
				
			||||||
.Xc
 | 
					.Xc
 | 
				
			||||||
.D1 Pq alias: Ic neww
 | 
					.D1 Pq alias: Ic neww
 | 
				
			||||||
Create a new window.
 | 
					Create a new window.
 | 
				
			||||||
@@ -3339,7 +3339,7 @@ to manual in the window options.
 | 
				
			|||||||
.Op Fl c Ar start-directory
 | 
					.Op Fl c Ar start-directory
 | 
				
			||||||
.Op Fl e Ar environment
 | 
					.Op Fl e Ar environment
 | 
				
			||||||
.Op Fl t Ar target-pane
 | 
					.Op Fl t Ar target-pane
 | 
				
			||||||
.Op Ar shell-command
 | 
					.Op Ar shell-command Op Ar argument ...
 | 
				
			||||||
.Xc
 | 
					.Xc
 | 
				
			||||||
.D1 Pq alias: Ic respawnp
 | 
					.D1 Pq alias: Ic respawnp
 | 
				
			||||||
Reactivate a pane in which the command has exited (see the
 | 
					Reactivate a pane in which the command has exited (see the
 | 
				
			||||||
@@ -3365,7 +3365,7 @@ command.
 | 
				
			|||||||
.Op Fl c Ar start-directory
 | 
					.Op Fl c Ar start-directory
 | 
				
			||||||
.Op Fl e Ar environment
 | 
					.Op Fl e Ar environment
 | 
				
			||||||
.Op Fl t Ar target-window
 | 
					.Op Fl t Ar target-window
 | 
				
			||||||
.Op Ar shell-command
 | 
					.Op Ar shell-command Op Ar argument ...
 | 
				
			||||||
.Xc
 | 
					.Xc
 | 
				
			||||||
.D1 Pq alias: Ic respawnw
 | 
					.D1 Pq alias: Ic respawnw
 | 
				
			||||||
Reactivate a window in which the command has exited (see the
 | 
					Reactivate a window in which the command has exited (see the
 | 
				
			||||||
@@ -3493,10 +3493,10 @@ the command behaves like
 | 
				
			|||||||
.Op Fl bdfhIvPZ
 | 
					.Op Fl bdfhIvPZ
 | 
				
			||||||
.Op Fl c Ar start-directory
 | 
					.Op Fl c Ar start-directory
 | 
				
			||||||
.Op Fl e Ar environment
 | 
					.Op Fl e Ar environment
 | 
				
			||||||
 | 
					.Op Fl F Ar format
 | 
				
			||||||
.Op Fl l Ar size
 | 
					.Op Fl l Ar size
 | 
				
			||||||
.Op Fl t Ar target-pane
 | 
					.Op Fl t Ar target-pane
 | 
				
			||||||
.Op Ar shell-command
 | 
					.Op Ar shell-command Op Ar argument ...
 | 
				
			||||||
.Op Fl F Ar format
 | 
					 | 
				
			||||||
.Xc
 | 
					.Xc
 | 
				
			||||||
.D1 Pq alias: Ic splitw
 | 
					.D1 Pq alias: Ic splitw
 | 
				
			||||||
Create a new pane by splitting
 | 
					Create a new pane by splitting
 | 
				
			||||||
@@ -3676,7 +3676,8 @@ Commands related to key bindings are as follows:
 | 
				
			|||||||
.Op Fl nr
 | 
					.Op Fl nr
 | 
				
			||||||
.Op Fl N Ar note
 | 
					.Op Fl N Ar note
 | 
				
			||||||
.Op Fl T Ar key-table
 | 
					.Op Fl T Ar key-table
 | 
				
			||||||
.Ar key command Op Ar argument ...
 | 
					.Ar key
 | 
				
			||||||
 | 
					.Op Ar command Op Ar argument ...
 | 
				
			||||||
.Xc
 | 
					.Xc
 | 
				
			||||||
.D1 Pq alias: Ic bind
 | 
					.D1 Pq alias: Ic bind
 | 
				
			||||||
Bind key
 | 
					Bind key
 | 
				
			||||||
@@ -3735,7 +3736,8 @@ command.
 | 
				
			|||||||
.Tg lsk
 | 
					.Tg lsk
 | 
				
			||||||
.It Xo Ic list-keys
 | 
					.It Xo Ic list-keys
 | 
				
			||||||
.Op Fl 1aN
 | 
					.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
 | 
					.Op Ar key
 | 
				
			||||||
.Xc
 | 
					.Xc
 | 
				
			||||||
.D1 Pq alias: Ic lsk
 | 
					.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 c Ar target-client
 | 
				
			||||||
.Op Fl N Ar repeat-count
 | 
					.Op Fl N Ar repeat-count
 | 
				
			||||||
.Op Fl t Ar target-pane
 | 
					.Op Fl t Ar target-pane
 | 
				
			||||||
.Ar key ...
 | 
					.Op Ar key ...
 | 
				
			||||||
.Xc
 | 
					.Xc
 | 
				
			||||||
.D1 Pq alias: Ic send
 | 
					.D1 Pq alias: Ic send
 | 
				
			||||||
Send a key or keys to a window or client.
 | 
					Send a key or keys to a window or client.
 | 
				
			||||||
@@ -3852,12 +3854,44 @@ option prevents errors being returned.
 | 
				
			|||||||
The appearance and behaviour of
 | 
					The appearance and behaviour of
 | 
				
			||||||
.Nm
 | 
					.Nm
 | 
				
			||||||
may be modified by changing the value of various options.
 | 
					may be modified by changing the value of various options.
 | 
				
			||||||
There are four types of option:
 | 
					Each option belongs to one or multiple scopes
 | 
				
			||||||
.Em server options ,
 | 
					.Po
 | 
				
			||||||
.Em session options ,
 | 
					.Em server ,
 | 
				
			||||||
.Em window options ,
 | 
					.Em session ,
 | 
				
			||||||
 | 
					.Em window ,
 | 
				
			||||||
and
 | 
					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
 | 
					.Pp
 | 
				
			||||||
The
 | 
					The
 | 
				
			||||||
.Nm
 | 
					.Nm
 | 
				
			||||||
@@ -3921,13 +3955,14 @@ $ tmux show -wv @foo
 | 
				
			|||||||
abc123
 | 
					abc123
 | 
				
			||||||
.Ed
 | 
					.Ed
 | 
				
			||||||
.Pp
 | 
					.Pp
 | 
				
			||||||
Commands which set options are as follows:
 | 
					Options are managed with these commands:
 | 
				
			||||||
.Bl -tag -width Ds
 | 
					.Bl -tag -width Ds
 | 
				
			||||||
.Tg set
 | 
					.Tg set
 | 
				
			||||||
.It Xo Ic set-option
 | 
					.It Xo Ic set-option
 | 
				
			||||||
.Op Fl aFgopqsuUw
 | 
					.Op Fl aFgopqsuUw
 | 
				
			||||||
.Op Fl t Ar target-pane
 | 
					.Op Fl t Ar target-pane
 | 
				
			||||||
.Ar option Ar value
 | 
					.Ar option
 | 
				
			||||||
 | 
					.Op Ar value
 | 
				
			||||||
.Xc
 | 
					.Xc
 | 
				
			||||||
.D1 Pq alias: Ic set
 | 
					.D1 Pq alias: Ic set
 | 
				
			||||||
Set a pane option with
 | 
					Set a pane option with
 | 
				
			||||||
@@ -3943,7 +3978,7 @@ or
 | 
				
			|||||||
.Fl s
 | 
					.Fl s
 | 
				
			||||||
may be unnecessary -
 | 
					may be unnecessary -
 | 
				
			||||||
.Nm
 | 
					.Nm
 | 
				
			||||||
will infer the type from the option name, assuming
 | 
					will infer the scope from the option name, assuming
 | 
				
			||||||
.Fl w
 | 
					.Fl w
 | 
				
			||||||
for pane options.
 | 
					for pane options.
 | 
				
			||||||
If
 | 
					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
 | 
					but if the option is a pane option also unsets the option on any panes in the
 | 
				
			||||||
window.
 | 
					window.
 | 
				
			||||||
.Ar value
 | 
					.Ar value
 | 
				
			||||||
depends on the option and may be a number, a string, or a flag (on, off, or
 | 
					depends on the option and its type and can be omitted for flag and choice
 | 
				
			||||||
omitted to toggle).
 | 
					options to toggle its value (choice options toggle between the first two
 | 
				
			||||||
 | 
					choices).
 | 
				
			||||||
.Pp
 | 
					.Pp
 | 
				
			||||||
The
 | 
					The
 | 
				
			||||||
.Fl o
 | 
					.Fl o
 | 
				
			||||||
@@ -4020,7 +4056,7 @@ or
 | 
				
			|||||||
.Fl s
 | 
					.Fl s
 | 
				
			||||||
may be unnecessary -
 | 
					may be unnecessary -
 | 
				
			||||||
.Nm
 | 
					.Nm
 | 
				
			||||||
will infer the type from the option name, assuming
 | 
					will infer the scope from the option name, assuming
 | 
				
			||||||
.Fl w
 | 
					.Fl w
 | 
				
			||||||
for pane options.
 | 
					for pane options.
 | 
				
			||||||
Global session or window options are listed if
 | 
					Global session or window options are listed if
 | 
				
			||||||
@@ -5467,7 +5503,7 @@ Hooks are managed with these commands:
 | 
				
			|||||||
.Op Fl agpRuw
 | 
					.Op Fl agpRuw
 | 
				
			||||||
.Op Fl t Ar target-pane
 | 
					.Op Fl t Ar target-pane
 | 
				
			||||||
.Ar hook-name
 | 
					.Ar hook-name
 | 
				
			||||||
.Ar command
 | 
					.Op Ar command
 | 
				
			||||||
.Xc
 | 
					.Xc
 | 
				
			||||||
Without
 | 
					Without
 | 
				
			||||||
.Fl R ,
 | 
					.Fl R ,
 | 
				
			||||||
@@ -5488,6 +5524,7 @@ immediately.
 | 
				
			|||||||
.It Xo Ic show-hooks
 | 
					.It Xo Ic show-hooks
 | 
				
			||||||
.Op Fl gpw
 | 
					.Op Fl gpw
 | 
				
			||||||
.Op Fl t Ar target-pane
 | 
					.Op Fl t Ar target-pane
 | 
				
			||||||
 | 
					.Op Ar hook
 | 
				
			||||||
.Xc
 | 
					.Xc
 | 
				
			||||||
Shows hooks.
 | 
					Shows hooks.
 | 
				
			||||||
The flags are the same as for
 | 
					The flags are the same as for
 | 
				
			||||||
@@ -6149,9 +6186,10 @@ The colour is one of:
 | 
				
			|||||||
.Ic cyan ,
 | 
					.Ic cyan ,
 | 
				
			||||||
.Ic white ;
 | 
					.Ic white ;
 | 
				
			||||||
if supported the bright variants
 | 
					if supported the bright variants
 | 
				
			||||||
 | 
					.Ic brightblack ,
 | 
				
			||||||
.Ic brightred ,
 | 
					.Ic brightred ,
 | 
				
			||||||
.Ic brightgreen ,
 | 
					.Eo ...;
 | 
				
			||||||
.Ic brightyellow ;
 | 
					.Ec
 | 
				
			||||||
.Ic colour0
 | 
					.Ic colour0
 | 
				
			||||||
to
 | 
					to
 | 
				
			||||||
.Ic colour255
 | 
					.Ic colour255
 | 
				
			||||||
@@ -6664,7 +6702,8 @@ the default is
 | 
				
			|||||||
.Op Fl y Ar position
 | 
					.Op Fl y Ar position
 | 
				
			||||||
.Ar name
 | 
					.Ar name
 | 
				
			||||||
.Ar key
 | 
					.Ar key
 | 
				
			||||||
.Ar command Op Ar argument ...
 | 
					.Ar command
 | 
				
			||||||
 | 
					.Op Ar name key command ...
 | 
				
			||||||
.Xc
 | 
					.Xc
 | 
				
			||||||
.D1 Pq alias: Ic menu
 | 
					.D1 Pq alias: Ic menu
 | 
				
			||||||
Display a menu on
 | 
					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 w Ar width
 | 
				
			||||||
.Op Fl x Ar position
 | 
					.Op Fl x Ar position
 | 
				
			||||||
.Op Fl y Ar position
 | 
					.Op Fl y Ar position
 | 
				
			||||||
.Op Ar shell-command
 | 
					.Op Ar shell-command Op Ar argument ...
 | 
				
			||||||
.Xc
 | 
					.Xc
 | 
				
			||||||
.D1 Pq alias: Ic popup
 | 
					.D1 Pq alias: Ic popup
 | 
				
			||||||
Display a popup running
 | 
					Display a popup running
 | 
				
			||||||
.Ar shell-command
 | 
					.Ar shell-command
 | 
				
			||||||
on
 | 
					(or
 | 
				
			||||||
 | 
					.Ar default-command
 | 
				
			||||||
 | 
					when omitted) on
 | 
				
			||||||
.Ar target-client .
 | 
					.Ar target-client .
 | 
				
			||||||
A popup is a rectangular box drawn over the top of any panes.
 | 
					A popup is a rectangular box drawn over the top of any panes.
 | 
				
			||||||
Panes are not updated while a popup is present.
 | 
					Panes are not updated while a popup is present.
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user