src/usr.bin/tmux/tmux.1 - diff

Return to tmux.1 CVS log

Up to [local] / src / usr.bin / tmux

Diff for /src/usr.bin/tmux/tmux.1 between version 1.857 and 1.858

version 1.857, 2021/10/07 07:53:31

version 1.858, 2021/10/08 06:37:39

Line 1027

.Pp

The following commands are available to manage clients and sessions:

.Bl -tag -width Ds

.Tg attach

.It Xo Ic attach-session

.Op Fl dErx

.Op Fl c Ar working-directory

Line 1113

Line 1114

is used, the

.Ic update-environment

option will not be applied.

.Tg detach

.It Xo Ic detach-client

.Op Fl aP

.Op Fl E Ar shell-command

Line 1139

Line 1141

run

.Ar shell-command

to replace the client.

.Tg has

.It Ic has-session Op Fl t Ar target-session

.D1 (alias: Ic has )

Report an error and exit with 1 if the specified session does not exist.

Line 1160

Line 1163

.Fl C

flag clears alerts (bell, activity, or silence) in all windows linked to the

session.

.Tg lsc

.It Xo Ic list-clients

.Op Fl F Ar format

.Op Fl t Ar target-session

Line 1174

Line 1178

.Ar target-session

is specified, list only clients connected to that session.

.Tg lscm

.It Xo Ic list-commands

.Op Fl F Ar format

.Op Ar command

Line 1183

Line 1188

.Ar command

or - if omitted - of all commands supported by

.Nm .

.Tg ls

.It Xo Ic list-sessions

.Op Fl F Ar format

.Op Fl f Ar filter

Line 1197

Line 1203

See the

.Sx FORMATS

section.

.Tg lockc

.It Ic lock-client Op Fl t Ar target-client

.D1 (alias: Ic lockc )

Lock

Line 1204

Line 1211

see the

.Ic lock-server

command.

.Tg locks

.It Ic lock-session Op Fl t Ar target-session

.D1 (alias: Ic locks )

Lock all clients attached to

.Ar target-session .

.Tg new

.It Xo Ic new-session

.Op Fl AdDEPX

.Op Fl c Ar start-directory

Line 1327

Line 1336

.Ql VARIABLE=value

and sets an environment variable for the newly created session; it may be

specified multiple times.

.Tg refresh

.It Xo Ic refresh-client

.Op Fl cDlLRSU

.Op Fl A Ar pane:state

Line 1462

Line 1472

See the

.Ic window-size

option.

.Tg rename

.It Xo Ic rename-session

.Op Fl t Ar target-session

.Ar new-name

Line 1469

Line 1480

.D1 (alias: Ic rename )

Rename the session to

.Ar new-name .

.Tg showmsgs

.It Xo Ic show-messages

.Op Fl JT

.Op Fl t Ar target-client

Line 1482

Line 1494

and

.Fl T

show debugging information about jobs and terminals.

.Tg source

.It Xo Ic source-file

.Op Fl Fnqv

.Ar path

Line 1508

Line 1521

the file is parsed but no commands are executed.

.Fl v

shows the parsed commands and line numbers if possible.

.Tg start

.It Ic start-server

.D1 (alias: Ic start )

Start the

Line 1524

Line 1538

.Bd -literal -offset indent

$ tmux start \\; show -g

.Ed

.Tg suspendc

.It Xo Ic suspend-client

.Op Fl t Ar target-client

.Xc

Line 1531

Line 1546

Suspend a client by sending

.Dv SIGTSTP

(tty stop).

.Tg switchc

.It Xo Ic switch-client

.Op Fl ElnprZ

.Op Fl c Ar target-client

Line 1921

Line 1937

.Pp

Commands related to windows and panes are as follows:

.Bl -tag -width Ds

.Tg breakp

.It Xo Ic break-pane

.Op Fl abdP

.Op Fl F Ar format

Line 1949

Line 1966

.Ql #{session_name}:#{window_index}.#{pane_index}

but a different format may be specified with

.Fl F .

.Tg capturep

.It Xo Ic capture-pane

.Op Fl aepPqCJN

.Op Fl b Ar buffer-name

Line 2201

Line 2219

starts without the option information.

This command works only if at least one client is attached.

.It Xo

.Tg displayp

.Ic display-panes

.Op Fl bN

.Op Fl d Ar duration

Line 2241

Line 2260

With

.Fl b ,

other commands are not blocked from running until the indicator is closed.

.Tg findw

.It Xo Ic find-window

.Op Fl iCNrTZ

.Op Fl t Ar target-pane

Line 2269

Line 2289

zooms the pane.

.Pp

This command works only if at least one client is attached.

.Tg joinp

.It Xo Ic join-pane

.Op Fl bdfhv

.Op Fl l Ar size

Line 2298

Line 2319

.Ic select-pane

.Fl m ) ,

the marked pane is used rather than the current pane.

.Tg killp

.It Xo Ic kill-pane

.Op Fl a

.Op Fl t Ar target-pane

Line 2309

Line 2331

.Fl a

option kills all but the pane given with

.Fl t .

.Tg killw

.It Xo Ic kill-window

.Op Fl a

.Op Fl t Ar target-window

Line 2321

Line 2344

.Fl a

option kills all but the window given with

.Fl t .

.Tg lastp

.It Xo Ic last-pane

.Op Fl deZ

.Op Fl t Ar target-window

Line 2333

Line 2357

enables or

.Fl d

disables input to the pane.

.Tg last

.It Ic last-window Op Fl t Ar target-session

.D1 (alias: Ic last )

Select the last (previously selected) window.

If no

.Ar target-session

is specified, select the last window of the current session.

.Tg link

.It Xo Ic link-window

.Op Fl abdk

.Op Fl s Ar src-window

Line 2369

Line 2395

.Fl d

is given, the newly linked window is not selected.

.Tg lsp

.It Xo Ic list-panes

.Op Fl as

.Op Fl F Ar format

Line 2397

Line 2424

See the

.Sx FORMATS

section.

.Tg lsw

.It Xo Ic list-windows

.Op Fl a

.Op Fl F Ar format

Line 2417

Line 2445

See the

.Sx FORMATS

section.

.Tg movep

.It Xo Ic move-pane

.Op Fl bdfhv

.Op Fl l Ar size

Line 2426

Line 2455

.D1 (alias: Ic movep )

Does the same as

.Ic join-pane .

.Tg movew

.It Xo Ic move-window

.Op Fl abrdk

.Op Fl s Ar src-window

Line 2444

Line 2474

the

.Ic base-index

option.

.Tg neww

.It Xo Ic new-window

.Op Fl abdkPS

.Op Fl c Ar start-directory

Line 2526

Line 2557

.Ql #{session_name}:#{window_index}

but a different format may be specified with

.Fl F .

.Tg nextl

.It Ic next-layout Op Fl t Ar target-window

.D1 (alias: Ic nextl )

Move a window to the next layout and rearrange the panes to fit.

.Tg next

.It Xo Ic next-window

.Op Fl a

.Op Fl t Ar target-session

Line 2538

Line 2571

.Fl a

is used, move to the next window with an alert.

.Tg pipep

.It Xo Ic pipe-pane

.Op Fl IOo

.Op Fl t Ar target-pane

Line 2586

Line 2620

.Bd -literal -offset indent

bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'

.Ed

.Tg prevl

.It Xo Ic previous-layout

.Op Fl t Ar target-window

.Xc

.D1 (alias: Ic prevl )

Move to the previous layout in the session.

.Tg prev

.It Xo Ic previous-window

.Op Fl a

.Op Fl t Ar target-session

Line 2600

Line 2636

With

.Fl a ,

move to the previous window with an alert.

.Tg renamew

.It Xo Ic rename-window

.Op Fl t Ar target-window

.Ar new-name

Line 2609

Line 2646

.Ar target-window

if specified, to

.Ar new-name .

.Tg resizep

.It Xo Ic resize-pane

.Op Fl DLMRTUZ

.Op Fl t Ar target-pane

Line 2653

Line 2691

.Fl T

trims all lines below the current cursor position and moves lines out of the

history to replace them.

.Tg resizew

.It Xo Ic resize-window

.Op Fl aADLRU

.Op Fl t Ar target-window

Line 2685

Line 2724

This command will automatically set

.Ic window-size

to manual in the window options.

.Tg respawnp

.It Xo Ic respawn-pane

.Op Fl k

.Op Fl c Ar start-directory

Line 2710

Line 2750

option has the same meaning as for the

.Ic new-window

command.

.Tg respawnw

.It Xo Ic respawn-window

.Op Fl k

.Op Fl c Ar start-directory

Line 2735

Line 2776

option has the same meaning as for the

.Ic new-window

command.

.Tg rotatew

.It Xo Ic rotate-window

.Op Fl DUZ

.Op Fl t Ar target-window

Line 2746

Line 2788

or downward (numerically higher).

.Fl Z

keeps the window zoomed if it was zoomed.

.Tg selectl

.It Xo Ic select-layout

.Op Fl Enop

.Op Fl t Ar target-pane

Line 2768

Line 2811

applies the last set layout if possible (undoes the most recent layout change).

.Fl E

spreads the current pane and any panes next to it out evenly.

.Tg selectp

.It Xo Ic select-pane

.Op Fl DdeLlMmRUZ

.Op Fl T Ar title

Line 2812

Line 2856

.Ic swap-pane

and

.Ic swap-window .

.Tg selectw

.It Xo Ic select-window

.Op Fl lnpT

.Op Fl t Ar target-window

Line 2834

Line 2879

is given and the selected window is already the current window,

the command behaves like

.Ic last-window .

.Tg splitw

.It Xo Ic split-window

.Op Fl bdfhIvPZ

.Op Fl c Ar start-directory

Line 2894

Line 2940

All other options have the same meaning as for the

.Ic new-window

command.

.Tg swapp

.It Xo Ic swap-pane

.Op Fl dDUZ

.Op Fl s Ar src-pane

Line 2922

Line 2969

.Ic select-pane

.Fl m ) ,

the marked pane is used rather than the current pane.

.Tg swapw

.It Xo Ic swap-window

.Op Fl d

.Op Fl s Ar src-window

Line 2943

Line 2991

.Ic select-pane

.Fl m ) ,

the window containing the marked pane is used rather than the current window.

.Tg unlinkw

.It Xo Ic unlink-window

.Op Fl k

.Op Fl t Ar target-window

Line 3013

Line 3062

.Pp

Commands related to key bindings are as follows:

.Bl -tag -width Ds

.Tg bind

.It Xo Ic bind-key

.Op Fl nr

.Op Fl N Ar note

Line 3071

Line 3121

To view the default bindings and possible commands, see the

.Ic list-keys

command.

.Tg lsk

.It Xo Ic list-keys

.Op Fl 1aN

.Op Fl P Ar prefix-string Fl T Ar key-table

Line 3106

Line 3157

lists only the first matching key.

.Fl a

lists the command for keys that do not have a note rather than skipping them.

.Tg send

.It Xo Ic send-keys

.Op Fl FHlMRX

.Op Fl N Ar repeat-count

Line 3157

Line 3209

Send the prefix key, or with

.Fl 2

the secondary prefix key, to a window as if it was pressed.

.Tg unbind

.It Xo Ic unbind-key

.Op Fl anq

.Op Fl T Ar key-table

Line 3252

Line 3305

.Pp

Commands which set options are as follows:

.Bl -tag -width Ds

.Tg set

.It Xo Ic set-option

.Op Fl aFgopqsuUw

.Op Fl t Ar target-pane

Line 3326

Line 3380

Without

.Fl a ,

the result would be the default background and a blue foreground.

.Tg show

.It Xo Ic show-options

.Op Fl AgHpqsvw

.Op Fl t Ar target-pane

Line 5303

Line 5358

.Pp

Commands to alter and view the environment are:

.Bl -tag -width Ds

.Tg setenv

.It Xo Ic set-environment

.Op Fl Fhgru

.Op Fl t Ar target-session

Line 5328

Line 5384

new process.

.Fl h

marks the variable as hidden.

.Tg showenv

.It Xo Ic show-environment

.Op Fl hgs

.Op Fl t Ar target-session

Line 5412

Line 5469

.Pp

Commands related to the status line are as follows:

.Bl -tag -width Ds

.Tg clrphist

.It Xo Ic clear-prompt-history

.Op Fl T Ar prompt-type

.Xc

Line 5534

Line 5592

.Fl b ,

the prompt is shown in the background and the invoking client does not exit

until it is dismissed.

.Tg confirm

.It Xo Ic confirm-before

.Op Fl b

.Op Fl p Ar prompt

Line 5556

Line 5615

.Fl b ,

the prompt is shown in the background and the invoking client does not exit

until it is dismissed.

.Tg menu

.It Xo Ic display-menu

.Op Fl O

.Op Fl c Ar target-client

Line 5647

Line 5707

.It Li "Down" Ta "Select next item"

.It Li "q" Ta "Exit menu"

.El

.Tg display

.It Xo Ic display-message

.Op Fl aINpv

.Op Fl c Ar target-client

Line 5688

Line 5749

.Fl I

forwards any input read from stdin to the empty pane given by

.Ar target-pane .

.Tg popup

.It Xo Ic display-popup

.Op Fl BCE

.Op Fl c Ar target-client

Line 5735

Line 5797

The

.Fl C

flag closes any popup on the client.

.Tg showphist

.It Xo Ic show-prompt-history

.Op Fl T Ar prompt-type

.Xc

Line 5864

Line 5927

.Fl N

starts without the preview.

This command works only if at least one client is attached.

.Tg clearhist

.It Ic clear-history Op Fl t Ar target-pane

.D1 (alias: Ic clearhist )

Remove and free the history for the specified pane.

.Tg deleteb

.It Ic delete-buffer Op Fl b Ar buffer-name

.D1 (alias: Ic deleteb )

Delete the buffer named

.Ar buffer-name ,

or the most recently added automatically named buffer if not specified.

.Tg lsb

.It Xo Ic list-buffers

.Op Fl F Ar format

.Op Fl f Ar filter

Line 5892

Line 5958

.Op Fl t Ar target-client

.Ar path

.Xc

.Tg loadb

.D1 (alias: Ic loadb )

Load the contents of the specified paste buffer from

.Ar path .

Line 5902

Line 5969

using the

.Xr xterm 1

escape sequence, if possible.

.Tg pasteb

.It Xo Ic paste-buffer

.Op Fl dpr

.Op Fl b Ar buffer-name

Line 5926

Line 5994

.Fl p

is specified, paste bracket control codes are inserted around the

buffer if the application has requested bracketed paste mode.

.Tg saveb

.It Xo Ic save-buffer

.Op Fl a

.Op Fl b Ar buffer-name

Line 5941

Line 6010

.Op Fl aw

.Op Fl b Ar buffer-name

.Op Fl t Ar target-client

.Tg setb

.Op Fl n Ar new-buffer-name

.Ar data

.Xc

Line 5961

Line 6031

.Fl n

option renames the buffer to

.Ar new-buffer-name .

.Tg showb

.It Xo Ic show-buffer

.Op Fl b Ar buffer-name

.Xc

Line 5972

Line 6043

.Bl -tag -width Ds

.It Ic clock-mode Op Fl t Ar target-pane

Display a large clock.

.Tg if

.It Xo Ic if-shell

.Op Fl bF

.Op Fl t Ar target-pane

Line 6003

Line 6075

.Ar shell-command

is not executed but considered success if neither empty nor zero (after formats

are expanded).

.Tg lock

.It Ic lock-server

.D1 (alias: Ic lock )

Lock each client individually by running the command specified by the

.Ic lock-command

option.

.Tg run

.It Xo Ic run-shell

.Op Fl bC

.Op Fl d Ar delay

Line 6041

Line 6115

.Fl t

or the current pane if omitted) after the command finishes.

If the command fails, the exit status is also displayed.

.Tg wait

.It Xo Ic wait-for

.Op Fl L | S | U

.Ar channel