aboutsummaryrefslogtreecommitdiff
path: root/tmux.1
diff options
context:
space:
mode:
authorNicholas Marriott <nicm@openbsd.org>2009-12-10 09:16:52 +0000
committerNicholas Marriott <nicm@openbsd.org>2009-12-10 09:16:52 +0000
commita4c9a80dacf405623698acfc971d636bbc0e43c7 (patch)
tree059539758458dfcbcd8348ea471e843f30dc0ab0 /tmux.1
parent6311bd119ed728117fd6f0073792a76c2a6b842b (diff)
downloadrtmux-a4c9a80dacf405623698acfc971d636bbc0e43c7.tar.gz
rtmux-a4c9a80dacf405623698acfc971d636bbc0e43c7.tar.bz2
rtmux-a4c9a80dacf405623698acfc971d636bbc0e43c7.zip
Add "server options" which are server-wide and not bound to a session or
window. Set and displayed with "set -s" and "show -s". Currently the only option is "quiet" (like command-line -q, allowing it to be set from .tmux.conf), but others will come along.
Diffstat (limited to 'tmux.1')
-rw-r--r--tmux.185
1 files changed, 56 insertions, 29 deletions
diff --git a/tmux.1 b/tmux.1
index a188feaf..fbbfe79e 100644
--- a/tmux.1
+++ b/tmux.1
@@ -151,8 +151,9 @@ signal may be sent to the
.Nm
server process to recreate it.
.It Fl q
-Prevent the server sending various informational messages, for example when
-window flags are altered.
+Set the
+.Ic quiet
+server option to prevent the server sending various informational messages.
.It Fl S Ar socket-path
Specify a full alternative path to the server socket.
If
@@ -1209,13 +1210,26 @@ or for normal mode without.
The appearance and behaviour of
.Nm
may be modified by changing the value of various options.
-There are two types of option:
+There are three types of option:
+.Em server options ,
.Em session options
and
.Em window options .
.Pp
-Each individual session may have a set of session options, and there is a
-separate set of global session options.
+The
+.Nm
+server has a set of global options which do not apply to any particular
+window or session.
+These are altered with the
+.Ic set-option
+.Fl s
+command, or displayed with the
+.Ic show-options
+.Fl s
+command.
+.Pp
+In addition, 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
@@ -1223,7 +1237,7 @@ Session options are set or unset with the
command and may be listed with the
.Ic show-options
command.
-The available session options are listed under the
+The available server and session options are listed under the
.Ic set-option
command.
.Pp
@@ -1241,31 +1255,44 @@ command.
Commands which set options are as follows:
.Bl -tag -width Ds
.It Xo Ic set-option
-.Op Fl aguw
+.Op Fl agsuw
.Op Fl t Ar target-session | Ar target-window
.Ar option Ar value
.Xc
.D1 (alias: Ic set )
-Set a session option.
+Set a window option with
+.Fl w
+(equivalent to the
+.Ic set-window-option
+command),
+a server option with
+.Fl s ,
+otherwise a session option.
+.Pp
+If
+.Fl g
+is specified, the global session or window option is set.
With
.Fl a ,
and if the option expects a string,
.Ar value
is appended to the existing setting.
-If
-.Fl g
-is specified, the global session option is set.
The
.Fl u
flag unsets an option, so a session inherits the option from the global
-options - it is not possible to unset a global option.
+options.
+It is not possible to unset a global option.
.Pp
-With
-.Fl w ,
-this command is equivalent to
-.Ic set-window-option
-with
-.Ar target-window .
+Available window options are listed under
+.Ic set-window-option .
+.Pp
+Available server options are:
+.Bl -tag -width Ds
+.It Ic quiet
+Enable of disable the display of various informational messages (see also the
+.Fl q
+command line flag).
+.El
.Pp
Available session options are:
.Bl -tag -width Ds
@@ -1850,21 +1877,21 @@ as Shift, Alt or Ctrl.
The default is off.
.El
.It Xo Ic show-options
-.Op Fl gw
+.Op Fl gsw
.Op Fl t Ar target-session | Ar target-window
.Xc
.D1 (alias: Ic show )
-Show the session options for
-.Ar target session ,
-or the global session options with
-.Fl g .
-.Pp
-If
+Show the window options with
.Fl w
-is used, this command is equivalent to
-.Ic show-window-options
-with
-.Ar target-window .
+(equivalent to
+.Ic show-window-options ),
+the server options with
+.Fl s ,
+otherwise the session options for
+.Ar target session .
+Global session or window options are listed if
+.Fl g
+is used.
.It Xo Ic show-window-options
.Op Fl g
.Op Fl t Ar target-window