diff options
Diffstat (limited to 'usr.bin/tmux/tmux.1')
| -rw-r--r-- | usr.bin/tmux/tmux.1 | 68 |
1 files changed, 67 insertions, 1 deletions
diff --git a/usr.bin/tmux/tmux.1 b/usr.bin/tmux/tmux.1 index c7d341af824..81378eae95f 100644 --- a/usr.bin/tmux/tmux.1 +++ b/usr.bin/tmux/tmux.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tmux.1,v 1.62 2009/08/08 20:36:42 nicm Exp $ +.\" $OpenBSD: tmux.1,v 1.63 2009/08/08 21:52:43 nicm Exp $ .\" .\" Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net> .\" @@ -1321,6 +1321,18 @@ entry for terminals which support 88 or 256 colours: .Bd -literal -offset indent "*88col*:colors=88,*256col*:colors=256" .Ed +.It Ic update-environment Ar variables +Set a space-separated string containing a list of environment variables to be +copied into the session environment when a new session is created or an +existing session is attached. +Any variables that do not exist in the source environment are set to be +removed from the session environment (as if +.Fl r +was given to the +.Ic set-environment +command). +The default is +.Ev DISPLAY . .It Xo Ic visual-activity .Op Ic on | off .Xc @@ -1525,6 +1537,60 @@ or the global window options if .Fl g is used. .El +.Sh ENVIRONMENT +When the server is started, +.Nm +copies the environment into the +.Em global environment ; +in addition, each session has a +.Em session environment . +When a window is created, the session and global environments are merged with +the session environment overriding any variable present in both. +This is the initial environment passed to the new process. +.Pp +The +.Ic update-environment +session option may be used to update the session environment from the client +when a new session is created or an old reattached. +.Nm +also initialises the +.Ev TMUX +variable with some internal information to allow commands to be executed +from inside, and the +.Ev TERM +variable with the correct terminal setting of +.Ql screen . +.Pp +Commands to alter and view the environment are: +.Bl -tag -width Ds +.It Xo Ic set-environment +.Op Fl gru +.Op Fl t Ar target-session +.Ar name Op Ar value +.Xc +Set or unset an environment variable. +If +.Fl g +is used, the change is made in the global environment; otherwise, it is applied +to the session environment for +.Ar target-session . +The +.Fl u +flag unsets a variable. +.Fl r +indicates the variable is to be removed from the environment before starting a +new process. +.It Xo Ic show-environment +.Op Fl g +.Op Fl t Ar target-session +.Xc +Display the environment for +.Ar target-session +or the global environment with +.Fl g . +Variables removed from the environment are prefixed with +.Ql - . +.El .Sh STATUS LINE .Nm includes an optional status line which is displayed in the bottom line of each |