forked from tmux-python/tmuxp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path1.0.txt
1244 lines (985 loc) · 56.3 KB
/
1.0.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
TMUX(1) BSD General Commands Manual TMUX(1)
NAME
tmux -- terminal multiplexer
SYNOPSIS
tmux [-28dlqUuv] [-f file] [-L socket-name] [-S socket-path]
[command [flags]]
DESCRIPTION
tmux is a terminal multiplexer: it enables a number of terminals to be
created, accessed, and controlled from a single screen. tmux may be
detached from a screen and continue running in the background, then later
reattached.
When tmux is started it creates a new session with a single window and
displays it on screen. A status line at the bottom of the screen shows
information on the current session and is used to enter interactive com-
mands.
A session is a single collection of pseudo terminals under the management
of tmux. Each session has one or more windows linked to it. A window
occupies the entire screen and may be split into rectangular panes, each
of which is a separate pseudo terminal (the pty(4) manual page documents
the technical details of pseudo terminals). Any number of tmux instances
may connect to the same session, and any number of windows may be present
in the same session. Once all sessions are killed, tmux exits.
Each session is persistent and will survive accidental disconnection
(such as ssh(1) connection timeout) or intentional detaching (with the
'C-b d' key strokes). tmux may be reattached using:
$ tmux attach
In tmux, a session is displayed on screen by a client and all sessions
are managed by a single server. The server and each client are separate
processes which communicate through a socket in /tmp.
The options are as follows:
-2 Force tmux to assume the terminal supports 256 colours.
-8 Like -2, but indicates that the terminal supports 88
colours.
-d Force tmux to assume the terminal supports default colours.
-f file Specify an alternative configuration file. By default,
tmux loads the system configuration file from
/etc/tmux.conf, if present, then looks for a user configu-
ration file at ~/.tmux.conf. The configuration file is a
set of tmux commands which are executed in sequence when
the server is first started.
If a command in the configuration file fails, tmux will
report an error and exit without executing further com-
mands.
-l Behave as a login shell. This flag currently has no effect
and is for compatibility with other shells when using tmux
as a login shell.
-L socket-name
tmux stores the server socket in a directory under /tmp;
the default socket is named default. This option allows a
different socket name to be specified, allowing several
independent tmux servers to be run. Unlike -S a full path
is not necessary: the sockets are all created in the same
directory.
If the socket is accidentally removed, the SIGUSR1 signal
may be sent to the tmux server process to recreate it.
-q Prevent the server sending various informational messages,
for example when window flags are altered.
-S socket-path
Specify a full alternative path to the server socket. If
-S is specified, the default socket directory is not used
and any -L flag is ignored.
-U Unlock the server.
-u tmux attempts to guess if the terminal is likely to support
UTF-8 by checking the first of the LC_ALL, LC_CTYPE and
LANG environment variables to be set for the string
"UTF-8". This is not always correct: the -u flag explic-
itly informs tmux that UTF-8 is supported.
If the server is started from a client passed -u or where
UTF-8 is detected, the utf8 and status-utf8 options are
enabled in the global window and session options respec-
tively.
-v Request verbose logging. This option may be specified mul-
tiple times for increasing verbosity. Log messages will be
saved into tmux-client-PID.log and tmux-server-PID.log
files in the current directory, where PID is the PID of the
server or client process.
command [flags]
This specifies one of a set of commands used to control
tmux, as described in the following sections. If no com-
mands are specified, the new-session command is assumed.
KEY BINDINGS
tmux may be controlled from an attached client by using a key combination
of a prefix key, 'C-b' (Ctrl-b) by default, followed by a command key.
Some of the default key bindings are:
c Create a new window.
d Detach the current client.
l Move to the previously selected window.
n Change to the next window.
p Change to the previous window.
& Kill the current window.
, Rename the current window.
? List all key bindings.
A complete list may be obtained with the list-keys command (bound to '?'
by default). Key bindings may be changed with the bind-key and
unbind-key commands.
COMMANDS
This section contains a list of the commands supported by tmux. Most
commands accept the optional -t argument with one of target-client,
target-session target-window, or target-pane. These specify the client,
session, window or pane which a command should affect. target-client is
the name of the pty(4) file to which the client is connected, for example
either of /dev/ttyp1 or ttyp1 for the client attached to /dev/ttyp1. If
no client is specified, the current client is chosen, if possible, or an
error is reported. Clients may be listed with the list-clients command.
target-session is either the name of a session (as listed by the
list-sessions command) or the name of a client with the same syntax as
target-client, in which case the session attached to the client is used.
When looking for the session name, tmux initially searches for an exact
match; if none is found, the session names are checked for any for which
target-session is a prefix or for which it matches as an fnmatch(3) pat-
tern. If a single match is found, it is used as the target session; mul-
tiple matches produce an error. If a session is omitted, the current
session is used if available; if no current session is available, the
most recently created is chosen.
target-window specifies a window in the form session:window. session
follows the same rules as for target-session, and window is looked for in
order: as a window index, for example mysession:1; as an exact window
name, such as mysession:mywindow; then as an fnmatch(3) pattern or the
start of a window name, such as mysession:mywin* or mysession:mywin. An
empty window name specifies the next unused index if appropriate (for
example the new-window and link-window commands) otherwise the current
window in session is chosen. When the argument does not contain a colon,
tmux first attempts to parse it as window; if that fails, an attempt is
made to match a session.
target-pane takes a similar form to target-window but with the optional
addition of a period followed by a pane index, for example: myses-
sion:mywindow.1. If the pane index is omitted, the currently active pane
in the specified window is used. If neither a colon nor period appears,
tmux first attempts to use the argument as a pane index; if that fails,
it is looked up as for target-window.
Multiple commands may be specified together as part of a command
sequence. Each command should be separated by spaces and a semicolon;
commands are executed sequentially from left to right. A literal semi-
colon may be included by escaping it with a backslash (for example, when
specifying a command sequence to bind-key).
Examples include:
refresh-client -t/dev/ttyp2
rename-session -tfirst newname
set-window-option -t:0 monitor-activity on
new-window ; split-window -d
bind-key D detach-client \; lock-server
CLIENTS AND SESSIONS
The following commands are available:
attach-session [-d] [-t target-session]
(alias: attach)
If run from outside tmux, create a new client in the current ter-
minal and attach it to target-session. If used from inside,
switch the current client. If -d is specified, any other clients
attached to the session are detached.
If no server is started, attach-session will attempt to start it;
this will fail unless sessions are created in the configuration
file.
detach-client [-t target-client]
(alias: detach)
Detach the current client if bound to a key, or the specified
client with -t.
has-session [-t target-session]
(alias: has)
Report an error and exit with 1 if the specified session does not
exist. If it does exist, exit with 0.
kill-server
Kill the tmux server and clients and destroy all sessions.
kill-session [-t target-session]
Destroy the given session, closing any windows linked to it and
no other sessions, and detaching all clients attached to it.
list-clients
(alias: lsc)
List all clients attached to the server.
list-commands
(alias: lscm)
List the syntax of all commands supported by tmux.
list-sessions
(alias: ls)
List all sessions managed by the server.
new-session [-d] [-n window-name] [-s session-name] [command]
(alias: new)
Create a new session with name session-name. The new session is
attached to the current terminal unless -d is given. window-name
and command are the name of and command to execute in the initial
window.
If run from a terminal, any termios(4) special characters are
saved and used for new windows in the new session.
refresh-client [-t target-client]
(alias: refresh)
Refresh the current client if bound to a key, or a single client
if one is given with -t.
rename-session [-t target-session] new-name
(alias: rename)
Rename the session to new-name.
source-file path
(alias: source)
Execute commands from path.
start-server
(alias: start)
Start the tmux server, if not already running, without creating
any sessions.
suspend-client [-c target-client]
(alias: suspendc)
Suspend a client by sending SIGTSTP (tty stop).
switch-client [-c target-client] [-t target-session]
(alias: switchc)
Switch the current session for client target-client to
target-session.
WINDOWS AND PANES
A tmux window may be in one of several modes. The default permits direct
access to the terminal attached to the window. The others are:
output mode
This is entered when a command which produces output, such as
list-keys, is executed from a key binding.
scroll mode
This is entered with the scroll-mode command (bound to '=' by
default) and permits the window history buffer to be inspected.
copy mode
This permits a section of a window or its history to be copied to
a paste buffer for later insertion into another window. This
mode is entered with the copy-mode command, bound to ['' by
default.
The keys available depend on whether emacs or vi mode is selected (see
the mode-keys option). The following keys are supported as appropriate
for the mode:
Function vi emacs
Back to indentation ^ M-m
Clear selection Escape C-g
Copy selection Enter M-w
Cursor down j Down
Cursor left h Left
Cursor right l Right
Cursor up k Up
Delete entire line d C-u
Delete to end of line D C-k
End of line $ C-e
Goto line g g
Next page C-f Page down
Next word w M-f
Paste buffer p C-y
Previous page C-u Page up
Previous word b M-b
Quit mode q Escape
Search again n n
Search backward ? C-r
Search forward / C-s
Start of line 0 C-a
Start selection Space C-Space
Transpose chars C-t
These key bindings are defined in a set of named tables: vi-edit and
emacs-edit for keys used when line editing at the command prompt;
vi-choice and emacs-choice for keys used when choosing from lists (such
as produced by the window-choose command) or in output mode; and vi-copy
and emacs-copy used in copy and scroll modes. The tables may be viewed
with the list-keys command and keys modified or removed with bind-key and
unbind-key.
The paste buffer key pastes the first line from the top paste buffer on
the stack.
The mode commands are as follows:
copy-mode [-u] [-t target-pane]
Enter copy mode. The -u option scrolls one page up.
scroll-mode [-u] [-t target-pane]
Enter scroll mode. The -u has the same meaning as in the
copy-mode command.
Each window displayed by tmux may be split into one or more panes; each
pane takes up a certain area of the display and is a separate terminal.
A window may be split into panes using the split-window command. Windows
may be split horizontally (with the -h flag) or vertically. Panes may be
resized with the resize-pane command (bound to 'C-up', 'C-down' 'C-left'
and 'C-right' by default), the current pane may be changed with the
up-pane and down-pane commands and the rotate-window and swap-pane com-
mands may be used to swap panes without changing their position. Panes
are numbered beginning from zero in the order they are created.
A number of preset layouts are available. These may be selected with the
select-layout command or cycled with next-layout (bound to 'C-space' by
default); once a layout is chosen, panes within it may be moved and
resized as normal.
The following layouts are supported:
even-horizontal
Panes are spread out evenly from left to right across the window.
even-vertical
Panes are spread evenly from top to bottom.
main-horizontal
A large (main) pane is shown at the top of the window and the
remaining panes are spread from left to right in the leftover
space at the bottom. Use the main-pane-height window option to
specify the height of the top pane.
main-vertical
Similar to main-horizontal but the large pane is placed on the
left and the others spread from top to bottom along the right.
See the main-pane-width window option.
Commands related to windows and panes are as follows:
break-pane [-d] [-t target-pane]
(alias: breakp)
Break target-pane off from its containing window to make it the
only pane in a new window. If -d is given, the new window does
not become the current window.
choose-client [-t target-window] [template]
Put a window into client choice mode, allowing a client to be
selected interactively from a list. After a client is chosen,
'%%' is replaced by the client pty(4) path in template and the
result executed as a command. If template is not given, "detach-
client -t '%%'" is used. This command works only from inside
tmux.
choose-session [-t target-window] [template]
Put a window into session choice mode, where a session may be
selected interactively from a list. When one is chosen, '%%' is
replaced by the session name in template and the result executed
as a command. If template is not given, "switch-client -t '%%'"
is used. This command works only from inside tmux.
choose-window [-t target-window] [template]
Put a window into window choice mode, where a window may be cho-
sen interactively from a list. After a window is selected, '%%'
is replaced by the session name and window index in template and
the result executed as a command. If template is not given,
"select-window -t '%%'" is used. This command works only from
inside tmux.
display-panes [-t target-client]
(alias: displayp)
Display a visible indicator of each pane shown by target-client.
See the display-panes-time and display-panes-colour session
options. While the indicator is on screen, a pane may be
selected with the '0' to '9' keys.
down-pane [-t target-pane]
(alias: downp)
Move down a pane.
find-window [-t target-window] match-string
(alias: findw)
Search for the fnmatch(3) pattern match-string in window names,
titles, and visible content (but not history). If only one win-
dow is matched, it'll be automatically selected, otherwise a
choice list is shown. This command only works from inside tmux.
kill-pane [-t target-pane]
(alias: killp)
Destroy the given pane. If no panes remain in the containing
window, it is also destroyed.
kill-window [-t target-window]
(alias: killw)
Kill the current window or the window at target-window, removing
it from any sessions to which it is linked.
last-window [-t target-session]
(alias: last)
Select the last (previously selected) window. If no
target-session is specified, select the last window of the cur-
rent session.
link-window [-dk] [-s src-window] [-t dst-window]
(alias: linkw)
Link the window at src-window to the specified dst-window. If
dst-window is specified and no such window exists, the src-window
is linked there. If -k is given and dst-window exists, it is
killed, otherwise an error is generated. If -d is given, the
newly linked window is not selected.
list-windows [-t target-session]
(alias: lsw)
List windows in the current session or in target-session.
move-window [-d] [-s src-window] [-t dst-window]
(alias: movew)
This is similar to link-window, except the window at src-window
is moved to dst-window.
new-window [-dk] [-n window-name] [-t target-window] [command]
(alias: neww)
Create a new window. If -d is given, the session does not make
the new window the current window. target-window represents the
window to be created; if the target already exists an error is
shown, unless the -k flag is used, in which case it is destroyed.
command is the command to execute. If command is not specified,
the default command is used.
The TERM environment variable must be set to ``screen'' for all
programs running inside tmux. New windows will automatically
have ``TERM=screen'' added to their environment, but care must be
taken not to reset this in shell start-up files.
next-layout [-t target-window]
(alias: nextl)
Move a window to the next layout and rearrange the panes to fit.
next-window [-a] [-t target-session]
(alias: next)
Move to the next window in the session. If -a is used, move to
the next window with a bell, activity or content alert.
previous-window [-a] [-t target-session]
(alias: prev)
Move to the previous window in the session. With -a, move to the
previous window with a bell, activity or content alert.
rename-window [-t target-window] new-name
(alias: renamew)
Rename the current window, or the window at target-window if
specified, to new-name.
resize-pane [-DLRU] [-t target-pane] [adjustment]
(alias: resizep)
Resize a pane, upward with -U (the default), downward with -D, to
the left with -L and to the right with -R. The adjustment is
given in lines or cells (the default is 1).
respawn-window [-k] [-t target-window] [command]
(alias: respawnw)
Reactive a window in which the command has exited (see the
remain-on-exit window option). If command is not given, the com-
mand used when the window was created is executed. The window
must be already inactive, unless -k is given, in which case any
existing command is killed.
rotate-window [-DU] [-t target-window]
(alias: rotatew)
Rotate the positions of the panes within a window, either upward
(numerically lower) with -U or downward (numerically higher).
select-layout [-t target-window] [layout-name]
(alias: selectl)
Choose a specific layout for a window. If layout-name is not
given, the last layout used (if any) is reapplied.
select-pane [-t target-pane]
(alias: selectp)
Make pane target-pane the active pane in window target-window.
select-window [-t target-window]
(alias: selectw)
Select the window at target-window.
split-window [-dhv] [-l size | -p percentage] [-t target-window]
[command]
(alias: splitw)
Creates a new pane by splitting the active pane: -h does a hori-
zontal split and -v a vertical split; if neither is specified, -v
is assumed. The -l and -p options specify the size of the new
window in lines (for vertical split) or in cells (for horizontal
split), or as a percentage, respectively. All other options have
the same meaning as in the new-window command.
swap-pane [-dDU] [-s src-pane] [-t dst-pane]
(alias: swapp)
Swap two panes. If -U is used and no source pane is specified
with -s, dst-pane is swapped with the previous pane (before it
numerically); -D swaps with the next pane (after it numerically).
swap-window [-d] [-s src-window] [-t dst-window]
(alias: swapw)
This is similar to link-window, except the source and destination
windows are swapped. It is an error if no window exists at
src-window.
unlink-window [-k] [-t target-window]
(alias: unlinkw)
Unlink target-window. Unless -k is given, a window may be
unlinked only if it is linked to multiple sessions - windows may
not be linked to no sessions; if -k is specified and the window
is linked to only one session, it is unlinked and destroyed.
up-pane [-t target-pane]
(alias: upp)
Move up a pane.
KEY BINDINGS
Commands related to key bindings are as follows:
bind-key [-cnr] [-t key-table] key command [arguments]
(alias: bind)
Bind key key to command. Keys may be specified prefixed with
'C-' or '^' for Ctrl keys, or 'M-' for Alt (meta) keys.
By default (without -t) the primary key bindings are modified
(those normally activated with the prefix key); in this case, if
-n is specified, it is not necessary to use the prefix key,
command is bound to key alone. The -r flag indicates this key
may repeat, see the repeat-time option.
If -t is present, key is bound in key-table: the binding for com-
mand mode with -c or for normal mode without. To view the
default bindings and possible commands, see the list-keys com-
mand.
list-keys [-t key-table]
(alias: lsk)
List all key bindings. Without -t the primary key bindings -
those executed when preceded by the prefix key - are printed.
Keys bound without the prefix key (see bind-key -n) are enclosed
in square brackets.
With -t, the key bindings in key-table are listed; this may be
one of: vi-edit, emacs-edit, vi-choice, emacs-choice, vi-copy or
emacs-copy.
send-keys [-t target-pane] key ...
(alias: send)
Send a key or keys to a window. Each argument key is the name of
the key (such as 'C-a' or 'npage' ) to send; if the string is not
recognised as a key, it is sent as a series of characters. All
arguments are sent sequentially from first to last.
send-prefix [-t target-pane]
Send the prefix key to a window as if it was pressed.
unbind-key [-cn] [-t key-table] key
(alias: unbind)
Unbind the command bound to key. Without -t the primary key
bindings are modified; in this case, if -n is specified, the com-
mand bound to key without a prefix (if any) is removed.
If -t is present, key in key-table is unbound: the binding for
command mode with -c or for normal mode without.
OPTIONS
The appearance and behaviour of tmux may be modified by changing the
value of various options. There are two types of option: session options
and window options.
Each individual session may have a set of session options, and there is a
separate set of global session options. Sessions which do not have a
particular option configured inherit the value from the global session
options. Session options are set or unset with the set-option command
and may be listed with the show-options command. The available session
options are listed under the set-option command.
Similarly, a set of window options is attached to each window, and there
is a set of global window options from which any unset options are inher-
ited. Window options are altered with the set-window-option command and
can be listed with the show-window-options command. All window options
are documented with the set-window-option command.
Commands which set options are as follows:
set-option [-agu] [-t target-session] option value
(alias: set)
Set a session option. With -a, and if the option expects a
string, value is appended to the existing setting. If -g is
specified, the global session option is set. The -u flag unsets
an option, so a session inherits the option from the global
options - it is not possible to unset a global option.
Available session options are:
base-index index
Set the base index from which an unused index should be
searched when a new window is created. The default is
zero.
bell-action [any | none | current]
Set action on window bell. any means a bell in any win-
dow linked to a session causes a bell in the current win-
dow of that session, none means all bells are ignored and
current means only bell in windows other than the current
window are ignored.
buffer-limit number
Set the number of buffers kept for each session; as new
buffers are added to the top of the stack, old ones are
removed from the bottom if necessary to maintain this
maximum length.
default-command command
Set the command used for new windows (if not specified
when the window is created) to command, which may be any
sh(1) command. The default is an empty string, which
instructs tmux to create a login shell using the value of
the default-shell option.
default-shell path
Specify the default shell. This is used as the login
shell for new windows when the default-command option is
set to empty, and must be the full path of the exe-
cutable. When started tmux tries to set a default value
from the first suitable of the SHELL environment vari-
able, the shell returned by getpwuid(3), or /bin/sh.
This option should be configured when tmux is used as a
login shell.
default-path path
Set the default working directory for processes created
from keys, or interactively from the prompt. The default
is the current working directory when the server is
started.
default-terminal terminal
Set the default terminal for new windows created in this
session - the default value of the TERM environment vari-
able. For tmux to work correctly, this must be set to
'screen' or a derivative of it.
display-panes-colour colour
Set the colour used for the display-panes command.
display-panes-time time
Set the time in milliseconds for which the indicators
shown by the display-panes command appear.
display-time time
Set the amount of time for which status line messages and
other on-screen indicators are displayed. time is in
milliseconds.
history-limit lines
Set the maximum number of lines held in window history.
This setting applies only to new windows - existing win-
dow histories are not resized and retain the limit at the
point they were created.
lock-after-time number
Lock the server after number seconds of inactivity. The
default is off (set to 0). This has no effect as a ses-
sion option; it must be set as a global option using -g.
When passwords are entered incorrectly, tmux follows the
behaviour of login(1) and ignores further password
attempts for an increasing timeout.
message-attr attributes
Set status line message attributes, where attributes is
either default or a comma-delimited list of one or more
of: bright (or bold), dim, underscore, blink, reverse,
hidden, or italics.
message-bg colour
Set status line message background colour, where colour
is one of: black, red, green, yellow, blue, magenta,
cyan, white, colour0 to colour255 from the 256-colour
palette, or default.
message-fg colour
Set status line message foreground colour.
prefix key
Set the current prefix key.
repeat-time time
Allow multiple commands to be entered without pressing
the prefix-key again in the specified time milliseconds
(the default is 500). Whether a key repeats may be set
when it is bound using the -r flag to bind-key. Repeat
is enabled for the default keys bound to the resize-pane
command.
set-remain-on-exit [on | off]
Set the remain-on-exit window option for any windows
first created in this session.
set-titles [on | off]
Attempt to set the window title using the \e]2;...\007
xterm code if the terminal appears to be an xterm. This
option is off by default. Note that elinks will only
attempt to set the window title if the STY environment
variable is set.
set-titles-string string
String used to set the window title if set-titles is on.
Character sequences are replaced as for the status-left
option.
status [on | off]
Show or hide the status line.
status-attr attributes
Set status line attributes.
status-bg colour
Set status line background colour.
status-fg colour
Set status line foreground colour.
status-interval interval
Update the status bar every interval seconds. By
default, updates will occur every 15 seconds. A setting
of zero disables redrawing at interval.
status-justify [left | centre | right]
Set the position of the window list component of the sta-
tus line: left, centre or right justified.
status-keys [vi | emacs]
Use vi or emacs-style key bindings in the status line,
for example at the command prompt. Defaults to emacs.
status-left string
Display string to the left of the status bar. string
will be passed through strftime(3) before being used. By
default, the session name is shown. string may contain
any of the following special character sequences:
Character pair Replaced with
#(command) First line of command's output
#[attributes] Colour or attribute change
#H Hostname of local host
#I Current window index
#P Current pane index
#S Session name
#T Current window title
#W Current window name
## A literal '#'
The #(command) form executes 'command' as a shell command
and inserts the first line of its output. #[attributes]
allows a comma-separated list of attributes to be speci-
fied, these may be 'fg=colour' to set the foreground
colour, 'bg=colour' to set the background colour, or one
of the attributes described under the message-attr
option. Examples are:
#(sysctl vm.loadavg)
#[fg=yellow,bold]#(apm -l)%%#[default] [#S]
Where appropriate, these may be prefixed with a number to
specify the maximum length, for example '#24T'.
By default, UTF-8 in string is not interpreted, to enable
UTF-8, use the status-utf8 option.
status-left-attr attributes
Set the attribute of the left part of the status line.
status-left-fg colour
Set the foreground colour of the left part of the status
line.
status-left-bg colour
Set the background colour of the left part of the status
line.
status-left-length length
Set the maximum length of the left component of the sta-
tus bar. The default is 10.
status-right string
Display string to the right of the status bar. By
default, the date and time will be shown. As with
status-left, string will be passed to strftime(3), char-
acter pairs are replaced, and UTF-8 is dependent on the
status-utf8 option.
status-right-attr attributes
Set the attribute of the right part of the status line.
status-right-fg colour
Set the foreground colour of the right part of the status
line.
status-right-bg colour
Set the background colour of the right part of the status
line.
status-right-length length
Set the maximum length of the right component of the sta-
tus bar. The default is 40.
status-utf8 [on | off]
Instruct tmux to treat top-bit-set characters in the
status-left and status-right strings as UTF-8; notably,
this is important for wide characters. This option
defaults to off.
terminal-overrides string
Contains a list of entries which override terminal
descriptions read using terminfo(5). string is a comma-
separated list of items each a colon-separated string
made up of a terminal type pattern (matched using
fnmatch(3)) and a set of name=value entries.
For example, to set the 'clear' terminfo(5) entry to
'\e[H\e[2J' for all terminal types and the 'dch1' entry
to '\e[P' for the 'rxvt' terminal type, the option could
be set to the string:
"*:clear=\e[H\e[2J,rxvt:dch1=\e[P"
The terminal entry value is passed through strunvis(3)
before interpretation. The default value forcibly cor-
rects the 'colors' entry for terminals which support 88
or 256 colours:
"*88col*:colors=88,*256col*:colors=256"
update-environment variables
Set a space-separated string containing a list of envi-
ronment variables to be copied into the session environ-
ment when a new session is created or an existing session
is attached. Any variables that do not exist in the
source environment are set to be removed from the session
environment (as if -r was given to the set-environment
command). The default is "DISPLAY WINDOWID SSH_ASKPASS
SSH_AUTH_SOCK SSH_AGENT_PID SSH_CONNECTION".
visual-activity [on | off]
If on, display a status line message when activity occurs
in a window for which the monitor-activity window option
is enabled.
visual-bell [on | off]
If this option is on, a message is shown on a bell
instead of it being passed through to the terminal (which
normally makes a sound). Also see the bell-action
option.
visual-content [on | off]
Like visual-activity, display a message when content is
present in a window for which the monitor-content window
option is enabled.
set-window-option [-agu] [-t target-window] option value
(alias: setw)
Set a window option. The -a, -g and -u flags work similarly to
the set-option command.
Supported window options are:
aggressive-resize [on | off]
Aggressively resize the chosen window. This means that
tmux will resize the window to the size of the smallest
session for which it is the current window, rather than
the smallest session to which it is attached. The window
may resize when the current window is changed on another
sessions; this option is good for full-screen programs
which support SIGWINCH and poor for interactive programs
such as shells.
automatic-rename [on | off]
Control automatic window renaming. When this setting is
enabled, tmux will attempt - on supported platforms - to
rename the window to reflect the command currently run-
ning in it. This flag is automatically disabled for an
individual window when a name is specified at creation
with new-window or new-session, or later with
rename-window. It may be switched off globally with:
set-window-option -g automatic-rename off
clock-mode-colour colour
Set clock colour.
clock-mode-style [12 | 24]
Set clock hour format.
force-height height
force-width width
Prevent tmux from resizing a window to greater than width
or height. A value of zero restores the default unlim-
ited setting.
main-pane-width width
main-pane-height height
Set the width or height of the main (left or top) pane in
the main-horizontal or main-vertical layouts.
mode-attr attributes
Set window modes attributes.
mode-bg colour
Set window modes background colour.
mode-fg colour
Set window modes foreground colour.
mode-keys [vi | emacs]
Use vi or emacs-style key bindings in scroll, copy and
choice modes. Key bindings default to emacs.
mode-mouse [on | off]
Mouse state in modes. If on, tmux will respond to mouse
clicks by moving the cursor in copy mode or selecting an
option in choice mode.
monitor-activity [on | off]
Monitor for activity in the window. Windows with activ-
ity are highlighted in the status line.
monitor-content match-string
Monitor content in the window. When fnmatch(3) pattern
match-string appears in the window, it is highlighted in
the status line.
remain-on-exit [on | off]
A window with this flag set is not destroyed when the
program running in it exits. The window may be reacti-
vated with the respawn-window command.
utf8 [on | off]
Instructs tmux to expect UTF-8 sequences to appear in
this window.
window-status-attr attributes
Set status line attributes for a single window.
window-status-bg colour
Set status line background colour for a single window.
window-status-fg colour
Set status line foreground colour for a single window.
window-status-current-attr attributes
Set status line attributes for the currently active win-
dow.
window-status-current-bg colour
Set status line background colour for the currently
active window.
window-status-current-fg colour
Set status line foreground colour for the currently
active window.
xterm-keys [on | off]
If this option is set, tmux will generate xterm(1) -style
function key sequences; these have a number included to
indicate modifiers such as Shift, Alt or Ctrl.
show-options [-g] [-t target-session]
(alias: show)
Show the session options for target session, or the global ses-
sion options with -g.
show-window-options [-g] [-t target-window]
(alias: showw)
List the window options for target-window, or the global window