1
0
mirror of https://github.com/tmux/tmux.git synced 2025-04-14 07:18:49 +00:00

some cleanup; ok nicm

This commit is contained in:
Jason McIntyre 2009-06-03 06:49:05 +00:00
parent fdda4142bf
commit 646cfa6983

128
tmux.1
View File

@ -14,12 +14,12 @@
.\" IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING .\" IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
.\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\" .\"
.Dd April 20, 2009 .Dd $Mdocdate$
.Dt TMUX 1 .Dt TMUX 1
.Os .Os
.Sh NAME .Sh NAME
.Nm tmux .Nm tmux
.Nd "terminal multiplexer" .Nd terminal multiplexer
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm tmux .Nm tmux
.Bk -words .Bk -words
@ -31,7 +31,7 @@
.Ek .Ek
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
is a terminal multiplexer; it enables a number of terminals to be accessed and is a terminal multiplexer: it enables a number of terminals to be accessed and
controlled from a single terminal. controlled from a single terminal.
.Pp .Pp
.Nm .Nm
@ -61,7 +61,7 @@ to assume the terminal supports 256 colours.
.It Fl 8 .It Fl 8
Like Like
.Fl 2 , .Fl 2 ,
indicates the terminal supports 88 colours. but indicates that the terminal supports 88 colours.
.It Fl d .It Fl d
Force Force
.Nm .Nm
@ -91,12 +91,12 @@ a full path is not necessary: the sockets are all created in the same
directory. directory.
.Pp .Pp
If the socket is accidentally removed, the If the socket is accidentally removed, the
.Em SIGUSR1 .Dv SIGUSR1
signal may be sent to the signal may be sent to the
.Nm .Nm
server process to recreate it. server process to recreate it.
.It Fl q .It Fl q
Prevent the server sending various information messages, for example when Prevent the server sending various informational messages, for example when
window flags are altered. window flags are altered.
.It Fl S Ar socket-path .It Fl S Ar socket-path
Specify a full alternative path to the server socket. Specify a full alternative path to the server socket.
@ -117,7 +117,7 @@ This is not always correct: the
.Fl u .Fl u
flag explicitly informs flag explicitly informs
.Nm .Nm
that the UTF-8 is supported. that UTF-8 is supported.
.It Fl v .It Fl v
Request verbose logging. Request verbose logging.
This option may be specified multiple times for increasing verbosity. This option may be specified multiple times for increasing verbosity.
@ -127,18 +127,19 @@ and
.Pa tmux-server-PID.log .Pa tmux-server-PID.log
files in the current directory, where files in the current directory, where
.Em PID .Em PID
is the pid of the server or client process. is the PID of the server or client process.
.It Ar command Op Ar flags .It Ar command Op Ar flags
This specifies one of a set of commands used to control This specifies one of a set of commands used to control
.Nm , .Nm ,
and described in the following sections. as described in the following sections.
If no command and flags is specified, the If no command and flags are specified, the
.Ic new-session .Ic new-session
command is assumed. command is assumed.
.Pp
.El .El
.Sh QUICK START .Sh QUICK START
To create a new tmux session running To create a new
.Nm
session running
.Xr vi 1 : .Xr vi 1 :
.Pp .Pp
.Dl $ tmux new-session vi .Dl $ tmux new-session vi
@ -154,15 +155,14 @@ If there are several options, they are listed:
.Bd -literal -offset indent .Bd -literal -offset indent
$ tmux n $ tmux n
ambiguous command: n, could be: new-session, new-window, next-window ambiguous command: n, could be: new-session, new-window, next-window
$
.Ed .Ed
.Pp .Pp
Within an active session, a new window may be created by typing Within an active session, a new window may be created by typing
.Ql C-b .Ql C-b
(ctrl-b, known as the prefix key) (Ctrl, known as the prefix key,
followed by the followed by the
.Ql c .Ql b
key. key).
.Pp .Pp
Windows may be navigated with: Windows may be navigated with:
.Ql C-b 0 .Ql C-b 0
@ -184,31 +184,31 @@ Typing
.Ql C-b \&? .Ql C-b \&?
lists the current key bindings in the current window; up and down may be used lists the current key bindings in the current window; up and down may be used
to navigate the list or to navigate the list or
.Ql Q .Ql q
to exit from it. to exit from it.
.Sh KEY BINDINGS .Sh KEY BINDINGS
.Nm .Nm
may be controlled from an attached client by using a key combination of a may be controlled from an attached client by using a key combination of a
prefix key, prefix key,
.Ql C-b .Ql C-b
(ctrl-b) by default, followed by a command key. (Ctrl-b) by default, followed by a command key.
.Pp .Pp
Some of the default key bindings include: Some of the default key bindings include:
.Pp .Pp
.Bl -tag -width Ds -compact .Bl -tag -width Ds -offset 3n -compact
.It Ql d .It c
Detach current client.
.It Ql c
Create new window. Create new window.
.It Ql n .It d
Change to next window in the current session. Detach current client.
.It Ql p .It l
Change to previous window in the current session.
.It Ql l
Move to last (previously selected) window in the current session. Move to last (previously selected) window in the current session.
.It Ql t .It n
Change to next window in the current session.
.It p
Change to previous window in the current session.
.It t
Display a large clock. Display a large clock.
.It Ql \&? .It \&?
List current key bindings. List current key bindings.
.El .El
.Pp .Pp
@ -225,7 +225,7 @@ commands.
.Sh HISTORY .Sh HISTORY
.Nm .Nm
maintains a configurable history buffer for each window. maintains a configurable history buffer for each window.
By default, up to 2000 lines are kept, this can be altered with the By default, up to 2000 lines are kept; this can be altered with the
.Ic history-limit .Ic history-limit
option (see the option (see the
.Ic set-option .Ic set-option
@ -258,11 +258,8 @@ command, bound to
by default. by default.
.El .El
.Pp .Pp
The keys available depend on whether The keys available depend on whether emacs or vi mode is selected
.Xr emacs 1 (see the
or
.Xr vi 1
mode is selected (see the
.Ic mode-keys .Ic mode-keys
option). option).
The following keys are supported as appropriate for the mode: The following keys are supported as appropriate for the mode:
@ -333,20 +330,15 @@ commands may be used to swap panes without changing the window layout.
.Pp .Pp
The following layouts are supported: The following layouts are supported:
.Bl -tag -width Ds .Bl -tag -width Ds
.It Ic manual
Manual layout splits windows vertically (running across); only with this layout
may panes be resized using the
.Ic resize-pane
command.
.It Ic active-only .It Ic active-only
Only the active pane is shown - all other panes are hidden. Only the active pane is shown \(en all other panes are hidden.
.It Ic even-horizontal .It Ic even-horizontal
Panes are spread out evenly from left to right across the window. Panes are spread out evenly from left to right across the window.
.It Ic even-vertical .It Ic even-vertical
Panes are spread evenly from top to bottom. Panes are spread evenly from top to bottom.
.It Ic main-horizontal .It Ic main-horizontal
A large (main) pane is shown at the top of the window and the remaining panes are 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. spread from left to right in the leftover space at the bottom.
Use the Use the
.Em main-pane-height .Em main-pane-height
window option to specify the height of the top pane. window option to specify the height of the top pane.
@ -358,6 +350,11 @@ bottom along the right.
See the See the
.Em main-pane-width .Em main-pane-width
window option. window option.
.It Ic manual
Manual layout splits windows vertically (running across); only with this layout
may panes be resized using the
.Ic resize-pane
command.
.El .El
.Sh COMMANDS .Sh COMMANDS
This section contains a list of the commands supported by This section contains a list of the commands supported by
@ -382,9 +379,9 @@ command.
.Ar target-session .Ar target-session
is either the name of a session (as listed by the is either the name of a session (as listed by the
.Ic list-sessions .Ic list-sessions
command); or the name of a client as for command) or the name of a client,
.Ar target-client , .Ar target-client ,
in this case, the session attached to the client is used. in which case the session attached to the client is used.
An An
.Xr fnmatch 3 .Xr fnmatch 3
pattern may be used to match the session name. pattern may be used to match the session name.
@ -411,22 +408,20 @@ is omitted, the same rules as for
are followed; if are followed; if
.Em index .Em index
is not present, the current window for the given session is used. is not present, the current window for the given session is used.
When the argument does not contain a colon (:), When the argument does not contain a colon,
.Nm .Nm
first attempts to parse it as window index; if that fails, an attempt is made first attempts to parse it as window index; if that fails, an attempt is made
to match a session or client name. to match a session or client name.
.Pp .Pp
Multiple commands may be specified together as part of a Multiple commands may be specified together as part of a
.Em command sequence . .Em command sequence .
Each command should be separated by spaces and a semicolon Each command should be separated by spaces and a semicolon;
.Eo ( Ql \& \&; \& Ec ) ;
commands are executed sequentially from left to right. commands are executed sequentially from left to right.
A literal semicolon may be included by escaping it with a backslash (for A literal semicolon may be included by escaping it with a backslash (for
example, when specifying a command sequence to example, when specifying a command sequence to
.Ic bind-key ) . .Ic bind-key ) .
.Pp .Pp
Examples include: Examples include:
.Pp
.Bd -literal -offset indent .Bd -literal -offset indent
refresh-client -t/dev/ttyp2 refresh-client -t/dev/ttyp2
@ -468,9 +463,9 @@ Keys may be specified prefixed with
.Ql C- .Ql C-
or or
.Ql ^ .Ql ^
for ctrl keys, or for Ctrl keys, or
.Ql M- .Ql M-
for alt (meta) keys. for Alt (meta) keys.
The The
.Fl r .Fl r
flag indicates this key may repeat, see the flag indicates this key may repeat, see the
@ -1023,8 +1018,7 @@ window option for any windows first created in this session.
Attempt to set the window title using the \ee]2;...\e007 xterm code and Attempt to set the window title using the \ee]2;...\e007 xterm code and
the terminal appears to be an xterm. the terminal appears to be an xterm.
This option is enabled by default. This option is enabled by default.
Note that Note that elinks
.Xr elinks 1
will only attempt to set the window title if the STY environment will only attempt to set the window title if the STY environment
variable is set. variable is set.
.It Xo Ic status .It Xo Ic status
@ -1046,10 +1040,7 @@ A setting of zero disables redrawing at interval.
.It Xo Ic status-keys .It Xo Ic status-keys
.Op Ic vi | Ic emacs .Op Ic vi | Ic emacs
.Xc .Xc
Use Use vi or emacs-style
.Xr vi 1 -
or
.Xr emacs 1 -style
key bindings in the status line, for example at the command prompt. key bindings in the status line, for example at the command prompt.
Defaults to emacs. Defaults to emacs.
.It Ic status-left Ar string .It Ic status-left Ar string
@ -1138,8 +1129,9 @@ This means that
will resize the window to the size of the smallest session for which it is the 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. 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; 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 this option is good for full-screen programs which support
interactive programs such as shells. .Dv SIGWINCH
and poor for interactive programs such as shells.
.It Xo Ic automatic-rename .It Xo Ic automatic-rename
.Op Ic on | Ic off .Op Ic on | Ic off
.Xc .Xc
@ -1189,10 +1181,7 @@ Set window modes foreground colour.
.It Xo Ic mode-keys .It Xo Ic mode-keys
.Op Ic vi | Ic emacs .Op Ic vi | Ic emacs
.Xc .Xc
Use Use vi or emacs-style
.Xr vi 1 -
or
.Xr emacs 1 -style
key bindings in scroll and copy modes. key bindings in scroll and copy modes.
Key bindings default to emacs. Key bindings default to emacs.
.It Xo Ic monitor-activity .It Xo Ic monitor-activity
@ -1202,7 +1191,8 @@ Monitor for activity in the window.
Windows with activity are highlighted in the status line. Windows with activity are highlighted in the status line.
.It Xo Ic monitor-content Ar match-string .It Xo Ic monitor-content Ar match-string
.Xc .Xc
Monitor content in the window. When Monitor content in the window.
When
.Ar match-string .Ar match-string
appears in the window, it is highlighted in the status line. appears in the window, it is highlighted in the status line.
.It Xo Ic remain-on-exit .It Xo Ic remain-on-exit
@ -1233,7 +1223,7 @@ If this option is set,
will generate will generate
.Xr xterm 1 -style .Xr xterm 1 -style
function key sequences; these have a number included to indicate modifiers such function key sequences; these have a number included to indicate modifiers such
as shift, meta or ctrl. as Shift, Alt or Ctrl.
.El .El
.It Xo Ic show-buffer .It Xo Ic show-buffer
.Op Fl b Ar buffer-index .Op Fl b Ar buffer-index
@ -1306,7 +1296,9 @@ server, if not already running, without creating any sessions.
.Op Fl c target-client .Op Fl c target-client
.Xc .Xc
.D1 (alias: Ic suspendc ) .D1 (alias: Ic suspendc )
Suspend a client by sending SIGTSTP (tty stop). Suspend a client by sending
.Dv SIGTSTP
(tty stop).
.It Xo Ic swap-pane .It Xo Ic swap-pane
.Op Fl dDU .Op Fl dDU
.Op Fl p Ar src-index .Op Fl p Ar src-index
@ -1363,11 +1355,11 @@ not be linked to no sessions.
Move up a pane. Move up a pane.
.El .El
.Sh FILES .Sh FILES
.Bl -tag -width Ds -compact .Bl -tag -width "~/.tmux.confXXX" -compact
.It Pa ~/.tmux.conf .It Pa ~/.tmux.conf
default Default
.Nm .Nm
configuration file configuration file.
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr pty 4 .Xr pty 4