version 1.132, 2009/12/08 07:49:31 |
version 1.133, 2009/12/10 09:16:52 |
|
|
.Nm |
.Nm |
server process to recreate it. |
server process to recreate it. |
.It Fl q |
.It Fl q |
Prevent the server sending various informational messages, for example when |
Set the |
window flags are altered. |
.Ic quiet |
|
server option to prevent the server sending various informational messages. |
.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. |
If |
If |
|
|
The appearance and behaviour of |
The appearance and behaviour of |
.Nm |
.Nm |
may be modified by changing the value of various options. |
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 |
.Em session options |
and |
and |
.Em window options . |
.Em window options . |
.Pp |
.Pp |
Each individual session may have a set of session options, and there is a |
The |
separate set of global session options. |
.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 |
Sessions which do not have a particular option configured inherit the value |
from the global session options. |
from the global session options. |
Session options are set or unset with the |
Session options are set or unset with the |
|
|
command and may be listed with the |
command and may be listed with the |
.Ic show-options |
.Ic show-options |
command. |
command. |
The available session options are listed under the |
The available server and session options are listed under the |
.Ic set-option |
.Ic set-option |
command. |
command. |
.Pp |
.Pp |
|
|
Commands which set options are as follows: |
Commands which set options are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Xo Ic set-option |
.It Xo Ic set-option |
.Op Fl aguw |
.Op Fl agsuw |
.Op Fl t Ar target-session | Ar target-window |
.Op Fl t Ar target-session | Ar target-window |
.Ar option Ar value |
.Ar option Ar value |
.Xc |
.Xc |
.D1 (alias: Ic set ) |
.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 |
With |
.Fl a , |
.Fl a , |
and if the option expects a string, |
and if the option expects a string, |
.Ar value |
.Ar value |
is appended to the existing setting. |
is appended to the existing setting. |
If |
|
.Fl g |
|
is specified, the global session option is set. |
|
The |
The |
.Fl u |
.Fl u |
flag unsets an option, so a session inherits the option from the global |
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 |
.Pp |
With |
Available window options are listed under |
.Fl w , |
.Ic set-window-option . |
this command is equivalent to |
|
.Ic set-window-option |
|
with |
|
.Ar target-window . |
|
.Pp |
.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: |
Available session options are: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Ic base-index Ar index |
.It Ic base-index Ar index |
|
|
The default is off. |
The default is off. |
.El |
.El |
.It Xo Ic show-options |
.It Xo Ic show-options |
.Op Fl gw |
.Op Fl gsw |
.Op Fl t Ar target-session | Ar target-window |
.Op Fl t Ar target-session | Ar target-window |
.Xc |
.Xc |
.D1 (alias: Ic show ) |
.D1 (alias: Ic show ) |
Show the session options for |
Show the window options with |
.Ar target session , |
|
or the global session options with |
|
.Fl g . |
|
.Pp |
|
If |
|
.Fl w |
.Fl w |
is used, this command is equivalent to |
(equivalent to |
.Ic show-window-options |
.Ic show-window-options ), |
with |
the server options with |
.Ar target-window . |
.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 |
.It Xo Ic show-window-options |
.Op Fl g |
.Op Fl g |
.Op Fl t Ar target-window |
.Op Fl t Ar target-window |