version 1.152, 2010/02/11 20:39:40 |
version 1.153, 2010/02/17 21:12:06 |
|
|
server will be started to retrieve the |
server will be started to retrieve the |
.Ic default-shell |
.Ic default-shell |
option. |
option. |
|
This option is for compatibility with |
|
.Xr sh 1 |
|
when |
|
.Nm |
|
is used as a login shell. |
.It Fl f Ar file |
.It Fl f Ar file |
Specify an alternative configuration file. |
Specify an alternative configuration file. |
By default, |
By default, |
|
|
.Em bottom-right |
.Em bottom-right |
may be used instead of a pane index. |
may be used instead of a pane index. |
.Pp |
.Pp |
|
.Ar shell-command |
|
arguments are |
|
.Xr sh 1 |
|
commands. |
|
These must be passed as a single item, which typically means quoting them, for |
|
example: |
|
.Bd -literal -offset indent |
|
new-window 'vi /etc/passwd' |
|
.Ed |
|
.Pp |
|
.Ar command |
|
.Op Ar arguments |
|
refers to a |
|
.Nm |
|
command, passed with the command and arguments separately, for example: |
|
.Bd -literal -offset indent |
|
bind-key F1 set-window-option force-width 81 |
|
.Ed |
|
.Pp |
|
Or if using |
|
.Xr sh 1 : |
|
.Pp |
|
.Bd -literal -offset indent |
|
$ tmux bind-key F1 set-window-option force-width 81 |
|
.Ed |
|
.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; |
|
|
example, when specifying a command sequence to |
example, when specifying a command sequence to |
.Ic bind-key ) . |
.Ic bind-key ) . |
.Pp |
.Pp |
Examples include: |
Example |
|
.Nm |
|
commands include: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
refresh-client -t/dev/ttyp2 |
refresh-client -t/dev/ttyp2 |
|
|
|
|
|
|
new-window ; split-window -d |
new-window ; split-window -d |
.Ed |
.Ed |
|
.Pp |
|
Or from |
|
.Xr sh 1 : |
|
.Pp |
|
.Bd -literal -offset indent |
|
$ tmux kill-window -t :1 |
|
|
|
$ tmux new-window \\; split-window -d |
|
|
|
$ tmux new-session -d 'vi /etc/passwd' \\; split-window -d \\; attach |
|
.Ed |
.Sh CLIENTS AND SESSIONS |
.Sh CLIENTS AND SESSIONS |
The following commands are available: |
The |
|
.Nm |
|
server manages clients, sessions, windows and panes. |
|
Clients are attached to sessions to interact with them, either |
|
when they are created with the |
|
.Ic new-session |
|
command, or later with the |
|
.Ic attach-session |
|
command. |
|
Each session has one of more windows |
|
.Em linked |
|
into it. |
|
Windows may be linked to multiple sessions and are made up of one or |
|
more panes, |
|
each of which contains a pseudo terminal. |
|
Commands for creating, linking and otherwise manipulating windows |
|
are covered |
|
in the |
|
.Sx WINDOWS AND PANES |
|
section. |
|
.Pp |
|
The following commands are available to manage clients and sessions: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Xo Ic attach-session |
.It Xo Ic attach-session |
.Op Fl dr |
.Op Fl dr |
|
|
.Op Fl n Ar window-name |
.Op Fl n Ar window-name |
.Op Fl s Ar session-name |
.Op Fl s Ar session-name |
.Op Fl t Ar target-session |
.Op Fl t Ar target-session |
.Op Ar command |
.Op Ar shell-command |
.Xc |
.Xc |
.D1 (alias: Ic new ) |
.D1 (alias: Ic new ) |
Create a new session with name |
Create a new session with name |
.Ar session-name . |
.Ar session-name . |
|
.Pp |
The new session is attached to the current terminal unless |
The new session is attached to the current terminal unless |
.Fl d |
.Fl d |
is given. |
is given. |
.Ar window-name |
.Ar window-name |
and |
and |
.Ar command |
.Ar shell-command |
are the name of and command to execute in the initial window. |
are the name of and shell command to execute in the initial window. |
.Pp |
.Pp |
If run from a terminal, any |
If run from a terminal, any |
.Xr termios 4 |
.Xr termios 4 |
|
|
Giving |
Giving |
.Fl n |
.Fl n |
or |
or |
.Ar command |
.Ar shell-command |
are invalid if |
are invalid if |
.Fl t |
.Fl t |
is used. |
is used. |
|
|
.Op Fl dk |
.Op Fl dk |
.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 command |
.Op Ar shell-command |
.Xc |
.Xc |
.D1 (alias: Ic neww ) |
.D1 (alias: Ic neww ) |
Create a new window. |
Create a new window. |
|
|
shown, unless the |
shown, unless the |
.Fl k |
.Fl k |
flag is used, in which case it is destroyed. |
flag is used, in which case it is destroyed. |
.Ar command |
.Ar shell-command |
is the command to execute. |
is the command to execute. |
If |
If |
.Ar command |
.Ar shell-command |
is not specified, the default command is used. |
is not specified, the value of the |
|
.Ic default-command |
|
option is used. |
.Pp |
.Pp |
|
When the shell command completes, the window closes. |
|
See the |
|
.Ic remain-on-exit |
|
option to change this behaviour. |
|
.Pp |
The |
The |
.Ev TERM |
.Ev TERM |
environment variable must be set to |
environment variable must be set to |
|
|
.It Xo Ic pipe-pane |
.It Xo Ic pipe-pane |
.Op Fl o |
.Op Fl o |
.Op Fl t Ar target-pane |
.Op Fl t Ar target-pane |
.Op Ar command |
.Op Ar shell-command |
.Xc |
.Xc |
.D1 (alias: Ic pipep ) |
.D1 (alias: Ic pipep ) |
Pipe any output sent by the program in |
Pipe any output sent by the program in |
|
|
to a shell command. |
to a shell command. |
A pane may only be piped to one command at a time, any existing pipe is |
A pane may only be piped to one command at a time, any existing pipe is |
closed before |
closed before |
.Ar command |
.Ar shell-command |
is executed. |
is executed. |
If no |
If no |
.Ar command |
.Ar shell-command |
is given, the current pipe (if any) is closed. |
is given, the current pipe (if any) is closed. |
.Pp |
.Pp |
The |
The |
|
|
.It Xo Ic respawn-window |
.It Xo Ic respawn-window |
.Op Fl k |
.Op Fl k |
.Op Fl t Ar target-window |
.Op Fl t Ar target-window |
.Op Ar command |
.Op Ar shell-command |
.Xc |
.Xc |
.D1 (alias: Ic respawnw ) |
.D1 (alias: Ic respawnw ) |
Reactive a window in which the command has exited (see the |
Reactivate a window in which the command has exited (see the |
.Ic remain-on-exit |
.Ic remain-on-exit |
window option). |
window option). |
If |
If |
.Ar command |
.Ar shell-command |
is not given, the command used when the window was created is executed. |
is not given, the command used when the window was created is executed. |
The window must be already inactive, unless |
The window must be already inactive, unless |
.Fl k |
.Fl k |
|
|
.Ar size | |
.Ar size | |
.Fl p Ar percentage Oc |
.Fl p Ar percentage Oc |
.Op Fl t Ar target-pane |
.Op Fl t Ar target-pane |
.Op Ar command |
.Op Ar shell-command |
.Xc |
.Xc |
.D1 (alias: splitw ) |
.D1 (alias: splitw ) |
Create a new pane by splitting |
Create a new pane by splitting |
|
|
Set the number of buffers kept for each session; as new buffers are added to |
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 |
the top of the stack, old ones are removed from the bottom if necessary to |
maintain this maximum length. |
maintain this maximum length. |
.It Ic default-command Ar command |
.It Ic default-command Ar shell-command |
Set the command used for new windows (if not specified when the window is |
Set the command used for new windows (if not specified when the window is |
created) to |
created) to |
.Ar command , |
.Ar shell-command , |
which may be any |
which may be any |
.Xr sh 1 |
.Xr sh 1 |
command. |
command. |
|
|
.Ic lock-server |
.Ic lock-server |
option is set. |
option is set. |
The default is not to lock (set to 0). |
The default is not to lock (set to 0). |
.It Ic lock-command Ar command |
.It Ic lock-command Ar shell-command |
Command to run when locking each client. |
Command to run when locking each client. |
The default is to run |
The default is to run |
.Xr lock 1 |
.Xr lock 1 |
|
|
Set the |
Set the |
.Ic remain-on-exit |
.Ic remain-on-exit |
window option for any windows first created in this session. |
window option for any windows first created in this session. |
|
When this option is true, windows in which the running program has |
|
exited do not close, instead remaining open but inactivate. |
|
Use the |
|
.Ic respawn-window |
|
command to reactivate such a window, or the |
|
.Ic kill-window |
|
command to destroy it. |
.It Xo Ic set-titles |
.It Xo Ic set-titles |
.Op Ic on | off |
.Op Ic on | off |
.Xc |
.Xc |
|
|
may contain any of the following special character sequences: |
may contain any of the following special character sequences: |
.Bl -column "Character pair" "Replaced with" -offset indent |
.Bl -column "Character pair" "Replaced with" -offset indent |
.It Sy "Character pair" Ta Sy "Replaced with" |
.It Sy "Character pair" Ta Sy "Replaced with" |
.It Li "#(command)" Ta "First line of command's output" |
.It Li "#(shell-command)" Ta "First line of the command's output" |
.It Li "#[attributes]" Ta "Colour or attribute change" |
.It Li "#[attributes]" Ta "Colour or attribute change" |
.It Li "#H" Ta "Hostname of local host" |
.It Li "#H" Ta "Hostname of local host" |
.It Li "#F" Ta "Current window flag" |
.It Li "#F" Ta "Current window flag" |
|
|
.It Li "##" Ta "A literal" Ql # |
.It Li "##" Ta "A literal" Ql # |
.El |
.El |
.Pp |
.Pp |
The #(command) form executes |
The #(shell-command) form executes |
.Ql command |
.Ql shell-command |
as a shell command and inserts the first line of its output. |
and inserts the first line of its output. |
Note that shell commands are only executed once at the interval specified by |
Note that shell commands are only executed once at the interval specified by |
the |
the |
.Ic status-interval |
.Ic status-interval |
|
|
Lock each client individually by running the command specified by the |
Lock each client individually by running the command specified by the |
.Ic lock-command |
.Ic lock-command |
option. |
option. |
.It Ic run-shell Ar command |
.It Ic run-shell Ar shell-command |
.D1 (alias: Ic run ) |
.D1 (alias: Ic run ) |
Execute |
Execute |
.Ar command |
.Ar shell-command |
in the background without creating a window. |
in the background without creating a window. |
After the command finishes, any output to stdout is displayed in output mode. |
After it finishes, any output to stdout is displayed in output mode. |
If |
If the command doesn't return success, the exit status is also displayed. |
.Ar command |
|
doesn't return success, the exit status is also displayed. |
|
.It Ic server-info |
.It Ic server-info |
.D1 (alias: Ic info ) |
.D1 (alias: Ic info ) |
Show server information and terminal details. |
Show server information and terminal details. |