aboutsummaryrefslogtreecommitdiff
path: root/tmux.1
diff options
context:
space:
mode:
Diffstat (limited to 'tmux.1')
-rw-r--r--tmux.1155
1 files changed, 130 insertions, 25 deletions
diff --git a/tmux.1 b/tmux.1
index 756ee964..67ceaa5a 100644
--- a/tmux.1
+++ b/tmux.1
@@ -14,7 +14,7 @@
.\" IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
.\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate$
+.Dd $Mdocdate: March 25 2013 $
.Dt TMUX 1
.Os
.Sh NAME
@@ -23,7 +23,7 @@
.Sh SYNOPSIS
.Nm tmux
.Bk -words
-.Op Fl 2Cluv
+.Op Fl 2CluvV
.Op Fl c Ar shell-command
.Op Fl f Ar file
.Op Fl L Ar socket-name
@@ -124,7 +124,7 @@ Specify an alternative configuration file.
By default,
.Nm
loads the system configuration file from
-.Pa /etc/tmux.conf ,
+.Pa @SYSCONFDIR@/tmux.conf ,
if present, then looks for a user configuration file at
.Pa ~/.tmux.conf .
.Pp
@@ -206,7 +206,6 @@ and
files in the current directory, where
.Em PID
is the PID of the server or client process.
-.Pp
If
.Fl v
is specified twice, an additional
@@ -222,6 +221,11 @@ signal may be sent to the
server process to toggle logging between on (as if
.Fl v
was given) and off.
+.It Fl V
+Report the
+.Nm
+version.
+.Pp
.It Ar command Op Ar flags
This specifies one of a set of commands used to control
.Nm ,
@@ -624,13 +628,13 @@ 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
+bind-key F1 set-window-option synchronize-panes on
.Ed
.Pp
Or if using
.Xr sh 1 :
.Bd -literal -offset indent
-$ tmux bind-key F1 set-window-option force-width 81
+$ tmux bind-key F1 set-window-option synchronize-panes on
.Ed
.Pp
Multiple commands may be specified together as part of a
@@ -846,13 +850,22 @@ and
are the name of and shell command to execute in the initial window.
With
.Fl d ,
-the initial size is 80 x 24;
+the initial size comes from the global
+.Ar default-size
+option;
.Fl x
and
.Fl y
can be used to specify a different size.
.Ql -
uses the size of the current client if any.
+If
+.Fl x
+or
+.Fl y
+is given, the
+.Ar default-size
+option is set for the session.
.Pp
If run from a terminal, any
.Xr termios 4
@@ -930,6 +943,36 @@ If
.Fl S
is specified, only update the client's status line.
.Pp
+The
+.Fl U ,
+.Fl D ,
+.Fl L
+.Fl R ,
+and
+.Fl c
+flags allow the visible portion of a window which is larger than the client
+to be changed.
+.Fl U
+moves the visible part up by
+.Ar adjustment
+rows and
+.Fl D
+down,
+.Fl L
+left by
+.Ar adjustment
+columns and
+.Fl R
+right.
+.Fl c
+returns to tracking the cursor automatically.
+If
+.Ar adjustment
+is omitted, 1 is used.
+Note that the visible position is a property of the client not of the
+window, changing the current window in the attached session will reset
+it.
+.Pp
.Fl C
sets the width and height of a control client.
.Fl l
@@ -1938,6 +1981,40 @@ and unzoomed (its normal position in the layout).
.Fl M
begins mouse resizing (only valid if bound to a mouse key binding, see
.Sx MOUSE SUPPORT ) .
+.It Xo Ic resize-window
+.Op Fl aADLUR
+.Op Fl t Ar target-window
+.Op Fl x Ar width
+.Op Fl y Ar height
+.Op Ar adjustment
+.Xc
+.D1 (alias: Ic resizew )
+Resize a window, up, down, left or right by
+.Ar adjustment
+with
+.Fl U ,
+.Fl D ,
+.Fl L
+or
+.Fl R ,
+to an absolute size
+with
+.Fl x
+or
+.Fl y ,
+or to the size of the smallest or largest session (with
+.Fl a
+or
+.Fl A ) .
+The
+.Ar adjustment
+is given in lines or cells (the default is 1).
+.Pp
+This command automatically sets the
+.Ic window-size
+option to
+.Ar manual
+for the window.
.It Xo Ic respawn-pane
.Op Fl c Ar start-directory
.Op Fl k
@@ -2681,6 +2758,16 @@ The default is an empty string, which instructs
to create a login shell using the value of the
.Ic default-shell
option.
+.It Ic default-size Ar XxY
+Set the default size of new windows when the
+.Ar window-size
+option is set to manual or when a session is created with
+.Ic new-session
+.Fl d .
+The value is the width and height separated by an
+.Ql x
+character.
+The default is 80x24.
.It Ic default-shell Ar path
Specify the default shell.
This is used as the login shell for new windows when the
@@ -3086,10 +3173,13 @@ Supported window options are:
Aggressively resize the chosen window.
This means that
.Nm
-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
+will resize the window to the size of the smallest or largest session
+(see the
+.Ic window-size
+option) for which it is the current window, rather than the session to
+which it is attached.
+The window may resize when the current window is changed on another
+session; this option is good for full-screen programs which support
.Dv SIGWINCH
and poor for interactive programs such as shells.
.Pp
@@ -3152,16 +3242,6 @@ Set clock colour.
.Xc
Set clock hour format.
.Pp
-.It Ic force-height Ar height
-.It Ic force-width Ar width
-Prevent
-.Nm
-from resizing a window to greater than
-.Ar width
-or
-.Ar height .
-A value of zero restores the default unlimited setting.
-.Pp
.It Ic main-pane-height Ar height
.It Ic main-pane-width Ar width
Set the width or height of the main (left or top) pane in the
@@ -3341,6 +3421,28 @@ see the
.Ic message-command-style
option.
.Pp
+.It Xo Ic Ic window-size
+.Ar largest | Ar smallest | Ar manual
+.Xc
+Configure how
+.Nm
+determines the window size.
+If set to
+.Ar largest ,
+the size of the largest attached session is used; if
+.Ar smallest ,
+the size of the smallest.
+If
+.Ar manual ,
+the size of a new window is set from the
+.Ic default-size
+option and windows are resized automatically.
+See also the
+.Ic resize-window
+command and the
+.Ic aggressive-resize
+option.
+.Pp
.It Ic window-style Ar style
Set the default window style.
For how to specify
@@ -3801,6 +3903,7 @@ The following variables are available, where appropriate:
.It Li "pane_at_top" Ta "" Ta "1 if pane is at the top of window"
.It Li "pane_bottom" Ta "" Ta "Bottom of pane"
.It Li "pane_current_command" Ta "" Ta "Current command if available"
+.It Li "pane_current_path" Ta "" Ta "Current path if available"
.It Li "pane_dead" Ta "" Ta "1 if pane is dead"
.It Li "pane_dead_status" Ta "" Ta "Exit status of process in dead pane"
.It Li "pane_format" Ta "" Ta "1 if format is for a pane (not assuming the current)"
@@ -3838,19 +3941,19 @@ The following variables are available, where appropriate:
.It Li "session_group_size" Ta "" Ta "Size of session group"
.It Li "session_group_list" Ta "" Ta "List of sessions in group"
.It Li "session_grouped" Ta "" Ta "1 if session in a group"
-.It Li "session_height" Ta "" Ta "Height of session"
.It Li "session_id" Ta "" Ta "Unique session ID"
.It Li "session_many_attached" Ta "" Ta "1 if multiple clients attached"
.It Li "session_name" Ta "#S" Ta "Name of session"
.It Li "session_stack" Ta "" Ta "Window indexes in most recent order"
-.It Li "session_width" Ta "" Ta "Width of session"
.It Li "session_windows" Ta "" Ta "Number of windows in session"
.It Li "socket_path" Ta "" Ta "Server socket path"
.It Li "start_time" Ta "" Ta "Server start time"
+.It Li "version" Ta "" Ta "Server version"
.It Li "window_activity" Ta "" Ta "Time of window last activity"
.It Li "window_activity_flag" Ta "" Ta "1 if window has activity"
.It Li "window_active" Ta "" Ta "1 if window active"
.It Li "window_bell_flag" Ta "" Ta "1 if window has bell"
+.It Li "window_bigger" Ta "" Ta "1 if window is larger than client"
.It Li "window_flags" Ta "#F" Ta "Window flags"
.It Li "window_format" Ta "" Ta "1 if format is for a window (not assuming the current)"
.It Li "window_height" Ta "" Ta "Height of window"
@@ -3860,6 +3963,8 @@ The following variables are available, where appropriate:
.It Li "window_layout" Ta "" Ta "Window layout description, ignoring zoomed window panes"
.It Li "window_linked" Ta "" Ta "1 if window is linked across sessions"
.It Li "window_name" Ta "#W" Ta "Name of window"
+.It Li "window_offset_x" Ta "" Ta "X offset into window if larger than client"
+.It Li "window_offset_y" Ta "" Ta "Y offset into window if larger than client"
.It Li "window_panes" Ta "" Ta "Number of panes in window"
.It Li "window_silence_flag" Ta "" Ta "1 if window has silence alert"
.It Li "window_stack_index" Ta "" Ta "Index in session most recent stack"
@@ -4602,12 +4707,12 @@ was renamed to
.Ar name .
.El
.Sh FILES
-.Bl -tag -width "/etc/tmux.confXXX" -compact
+.Bl -tag -width "@SYSCONFDIR@/tmux.confXXX" -compact
.It Pa ~/.tmux.conf
Default
.Nm
configuration file.
-.It Pa /etc/tmux.conf
+.It Pa @SYSCONFDIR@/tmux.conf
System-wide configuration file.
.El
.Sh EXAMPLES