Differences between version 3 and predecessor to the previous major change of screen(1).
Other diffs: Previous Revision, Previous Author, or view the Annotated Edit History
| Newer page: | version 3 | Last edited on Friday, March 12, 2004 6:22:40 pm | by JohnMcPherson | Revert |
| Older page: | version 2 | Last edited on Monday, June 3, 2002 6:51:07 pm | by perry | Revert |
@@ -1,47 +1,19 @@
-SCREEN
!!!SCREEN
-NAME
-SYNOPSIS
-DESCRIPTION
-GETTING STARTED
-COMMAND-LINE OPTIONS
-DEFAULT KEY BINDINGS
-CUSTOMIZATION
-THE MESSAGE LINE
-WINDOW TYPES
-STRING ESCAPES
-FLOW-CONTROL
-TITLES (naming windows)
-THE VIRTUAL TERMINAL
-INPUT TRANSLATION
-SPECIAL TERMINAL CAPABILITIES
-CHARACTER TRANSLATION
-ENVIRONMENT
-FILES
-SEE ALSO
-AUTHORS
-COPYLEFT
-CONTRIBUTORS
-VERSION
-AVAILABILITY
-BUGS
+
----
!!NAME
screen - screen manager with VT100/ANSI terminal emulation
!!SYNOPSIS
-__screen__ [[ __-__''options'' ] [[ ''cmd'' [[
-
-
-__
.__
]''tty''[[__.__''host'']]__
-
-__
/__
[[[[''pid''__
.__
]''tty''[[__
.__
''host'']]
-!!DESCRIPTION
+
__screen__ [[ __-__''options'' ] [[ ''cmd'' [[''args'' ] ]
+
__screen -r__ [[[[''pid''.]''tty''[[__.__''host'']]
+
__screen -r__ ''sessionowner''/[[[[''pid''.]''tty''[[.''host'']]
+!!DESCRIPTION
''Screen'' is a full-screen window manager that
multiplexes a physical terminal between several processes
(typically interactive shells). Each virtual terminal
@@ -82,27 +54,26 @@
can be fully customized to be anything you like, though they
are always two characters in length.
-''Screen'' does not understand the prefix ``
C-''
to mean
-control. Please use the caret notation (``
^A''
instead of
-``
C-a''
) as arguments to e.g. the ''
escape''
command or
-the ''
-e''
option. ''Screen'' will also print out
+''Screen'' does not understand the prefix "
C-"
to mean
+control. Please use the caret notation ("
^A"
instead of
+"
C-a"
) as arguments to e.g. the "
escape"
command or
+the "
-e"
option. ''Screen'' will also print out
control characters in caret notation.
-The standard way to create a new window is to type ``
C-a
-c''
. This creates a new window running a shell and switches
+The standard way to create a new window is to type "
C-a
+c"
. This creates a new window running a shell and switches
to that window immediately, regardless of the state of the
process running in the current window. Similarly, you can
create a new window with a custom command in it by first
binding the command to a keystroke (in your .screenrc file
-or at the ``
C-a :''
command line) and then using it just
-like the ``
C-a c''
command. In addition, new windows can be
+or at the "
C-a :"
command line) and then using it just
+like the "
C-a c"
command. In addition, new windows can be
created by running a command like:
-
-
+;:
screen emacs prog.c
from a shell prompt within a previously created window. This
will not run another copy of ''screen'', but will instead
@@ -112,16 +83,16 @@
would start the emacs editor (editing prog.c) and switch to
its window.
-If ``
/var/run/utmp''
is writable by ''screen'', an
+If "
/var/run/utmp"
is writable by ''screen'', an
appropriate record will be written to this file for each
window, and removed when the window is terminated. This is
-useful for working with ``
talk''
, ``
script''
, ``
shutdown''
,
-``
rsend''
, ``
sccs''
and other similar programs that use the
+useful for working with "
talk"
, "
script"
, "
shutdown"
,
+"
rsend"
, "
sccs"
and other similar programs that use the
utmp file to determine who you are. As long as ''screen''
is active on your terminal, the terminal's own record is
-removed from the utmp file. See also ``
C-a L''
.
+removed from the utmp file. See also "
C-a L"
.
!!GETTING STARTED
Before you begin to use ''screen'' you'll need to make
@@ -131,359 +102,116 @@
If you're impatient and want to get started without doing a
lot more reading, you should remember this one command:
-``
C-a ?''
. Typing these two characters will display a list
+"
C-a ?"
. Typing these two characters will display a list
of the available ''screen'' commands and their bindings.
-Each keystroke is discussed in the section ``
DEFAULT KEY
-BINDINGS''
. The manual section ``
CUSTOMIZATION''
deals with
+Each keystroke is discussed in the section "
DEFAULT KEY
+BINDINGS"
. The manual section "
CUSTOMIZATION"
deals with
the contents of your .screenrc.
-If your terminal is a ``
true''
auto-margin terminal (it
+If your terminal is a "
true"
auto-margin terminal (it
doesn't allow the last position on the screen to be updated
without scrolling the screen) consider to use a version of
your terminal's termcap that has automatic margins turned
''off''. This will ensure an accurate and optimal update
of the screen in all circumstances. Most terminals nowadays
-have ``
magic''
margins (automatic margins plus usable last
+have "
magic"
margins (automatic margins plus usable last
column). This is the VT100 style type and perfectly suited
-for ''screen''. If all you've got is a ``
true''
+for ''screen''. If all you've got is a "
true"
auto-margin terminal ''screen'' will be content to use
it, but updating a character put into the last position on
the screen may not be possible until the screen scrolls or
the character is moved into a safe position in some other
way. This delay can be shortened by using a terminal with
insert-character capability.
+
+
!!COMMAND-LINE OPTIONS
Screen has the following command-line options:
-__-a__
-
-
-
-
-
-
-
-
-__-A__
-
-
-Adapt the sizes of all windows to the size of the current
-terminal. By default, ''screen'' tries to restore its old
-window sizes when attaching to resizable terminals (those
-with ``WS'' in its description, e.g. suncmd or some
-xterm).
-
-
-__-c__ ''file''
-
-
-override the default configuration file from
-``$HOME/.screenrc'' to ''file''.
-
-
-__-d__|__-D__ [[''pid.tty.host'']
-
-
-does not start ''screen'', but detaches the elsewhere
-running ''screen'' session. It has the same effect as
-typing ``C-a d'' from ''screen'''s controlling terminal.
-__-D__ is the equivalent to the power detach key. If no
-session can be detached, this option is ignored. In
-combination with the __-r__/__-R__ option more
-powerful effects can be achieved:
-
-
-__-d -r__
-
-
-Reattach a session and if necessary detach it
-first.
-
-
-__-d -R__
-
-
-Reattach a session and if necessary detach or even create it
-first.
-
-
-__-d -RR__
-
-
-Reattach a session and if necessary detach or create it. Use
-the first session if more than one session is
-available.
-
-
-__-D -r__
-
-
-Reattach a session. If necessary detach and logout remotely
-first.
-
-
-__-D -R__
-
-
-Attach here and now. In detail this means: If a session is
-running, then reattach. If necessary detach and logout
-remotely first. If it was not running create it and notify
-the user. This is the author's favorite.
-
-
-__-D -RR__
-
-
-Attach here and now. Whatever that means, just do
-it.
-
-
-Note: It is always a good idea to check the status of your
-sessions by means of ``screen -list''.
-
-
-__-e__ ''xy''
-
-
-specifies the command character to be ''x'' and the
-character generating a literal command character to ''y''
-(when typed after the command character). The default is
-``C-a'' and `a', which can be specified as ``-e^Aa''. When
-creating a ''screen'' session, this option sets the
-default command character. In a multiuser session all users
-added will start off with this command character. But when
-attaching to an already running session, this option changes
-only the command character of the attaching user. This
-option is equivalent to either the commands ``defescape'' or
-``escape'' respectively.
-
-
-__-f__, __-fn__, and __-fa__
-
-
-turns flow-control on, off, or ``automatic switching mode''.
-This can also be defined through the ``defflow'' .screenrc
-command.
-
-
-__-h__ ''num''
-
-
-Specifies the history scrollback buffer to be ''num''
-lines high.
-
-
-__-i__
-
-
-will cause the interrupt key (usually C-c) to interrupt the
-display immediately when flow-control is on. See the
-``defflow'' .screenrc command for details. The use of this
-option is discouraged.
-
-
-__-l__ and __-ln__
-
-
-turns login mode on or off (for /var/run/utmp updating).
-This can also be defined through the ``deflogin'' .screenrc
-command.
-
-
-__-ls__ and __-list__
-
-
-does not start ''screen'', but prints a list of
-''pid.tty.host'' strings identifying your ''screen''
-sessions. Sessions marked `detached' can be resumed with
-``screen -r''. Those marked `attached' are running and have
-a controlling terminal. If the session runs in multiuser
-mode, it is marked `multi'. Sessions marked as `unreachable'
-either live on a different host or are `dead'. An
-unreachable session is considered dead, when its name
-matches either the name of the local host, or the specified
-parameter, if any. See the __-r__ flag for a description
-how to construct matches. Sessions marked as `dead' should
-be thoroughly checked and removed. Ask your system
-administrator if you are not sure. Remove sessions with the
-__-wipe__ option.
-
-
-__-L__
-
-
-tells ''screen'' your auto-margin terminal has a writable
-last-position on the screen. This can also be set in your
-.screenrc by specifying `LP' in a ``termcap''
-command.
-
-
-__-m__
-
-
-causes ''screen'' to ignore the $STY environment
-variable. With ``screen -m'' creation of a new session is
-enforced, regardless whether ''screen'' is called from
-within another ''screen'' session or not. This flag has a
-special meaning in connection with the `-d'
-option:
-
-
-__-d -m__
-
-
-Start ''screen'' in ``detached'' mode. This creates a new
-session but doesn't attach to it. This is useful for system
-startup scripts.
-
-
-__-D -m__
-
-
-This also starts screen in ``detached'' mode, but doesn't
-fork a new process. The command exits if the session
-terminates.
-
-
-__-O__
-
-
-selects a more optimal output mode for your terminal rather
-than true VT100 emulation (only affects auto-margin
-terminals without `LP'). This can also be set in your
-.screenrc by specifying `OP' in a ``termcap''
-command.
-
-
-__-q__
-
-
-Suppress printing of error messages. In combination with
-``-ls'' the exit value is as follows: 9 indicates a
-directory without sessions. 10 indicates a directory with
-running but not attachable sessions. 11 (or more) indicates
-1 (or more) usable sessions. In combination with ``-r'' the
-exit value is as follows: 10 indicates that there is no
-session to resume. 12 (or more) indicates that there are 2
-(or more) sessions to resume and you should specify which
-one to choose. In all other cases ``-q'' has no
-effect.
-
-
-__-r__ [[''pid.tty.host'']
-
-
-__-r__ ''sessionowner/[[pid.tty.host'']
-
-
-resumes a detached ''screen'' session. No other options
-(except combinations with __-d__/__-D__) may be
-specified, though an optional prefix of
-[[''pid.'']''tty.host'' may be needed to distinguish
-between multiple detached ''screen'' sessions. The second
-form is used to connect to another user's screen session
-which runs in multiuser mode. This indicates that screen
-should look for sessions in another user's directory. This
-requires setuid-root.
-
+;
__-a__:
include ''all'' capabilities (with some minor exceptions) in each window's termcap, even if ''screen'' must redraw parts of the display in order to implement a function.
-__-R
__
+;
__-A
__: Adapt the sizes of all windows to the size of the current terminal. By default, ''screen'' tries to restore its old window sizes when attaching to resizable terminals (those with "WS" in its description, e.g. suncmd or some xterm).
+;__-c__ ''file'': override the default configuration file from "$HOME/.screenrc" to ''file''.
-attempts to resume the first detached ''screen'' session
-it finds. If successful, all other command-line options are
-ignored. If no detached session exists, starts a new session
-using the specified options, just as if __-R__ had not
-been specified. The option is set by default if
-''screen'' is run as a login-shell (actually screen uses
-``-xRR'' in that case). For combinations with the
-__-d__/__-D__ option see there.
+;__-d__|__-D__ [[''pid.tty.host'']: does not start ''screen'', but detaches the elsewhere running ''screen'' session. It has the same effect as typing "C-a d" from ''screen'''s controlling terminal. __-D__ is the equivalent to the power detach key. If no session can be detached, this option is ignored. In combination with the __-r__/__-R__ option more powerful effects can be achieved:
-__-s__
+;__-d -r__: Reattach a session and if necessary detach it first.
-sets the default shell to the program specified, instead of
-the value in the environment variable $SHELL (or ``/bin/sh''
-not defined). This can also be defined through the
-``shell'' .screenrc command
.
+;__-d -R__: Reattach a session and
if necessary detach or even create it first
.
+;__-d -RR__: Reattach a session and if necessary detach or create it. Use the first session if more than one session is available.
-__-S
__ ''sessionname''
+;
__-D -r
__: Reattach a session. If necessary detach and logout remotely first.
+:__-D -R__: Attach here and now. In detail this means: If a session is running, then reattach. If necessary detach and logout remotely first. If it was not running create it and notify the user. This is the author's favorite.
-When creating
a new session, this option can be used
to
-specify a meaningful name for
the session. This name
-identifies the session for
``screen -list'' and ``screen
--r'' actions. It substitutes the default [[''tty.host'']
-suffix
.
+;__-D -RR__: Attach here and now. Whatever that means, just do it. Note: It is always
a good idea
to check
the status of your sessions by means of
``screen -list''.
+;__-e__ ''xy'': specifies the command character to be ''x'' and the character generating a literal command character to ''y'' (when typed after the command character). The default is ``C-a'' and `a', which can be specified as ``-e^Aa''. When creating a ''screen'' session, this option sets the default command character. In a multiuser session all users added will start off with this command character. But when attaching to an already running session, this option changes only the command character of the attaching user. This option is equivalent to either the commands ``defescape'' or ``escape'' respectively.
-__-t
__ ''name''
+;
__-f
__, __-fn__, and __-fa__: turns flow-control on, off, or "automatic switching mode". This can also be defined through the "defflow" .screenrc command.
+;__-h__ ''num'': Specifies the history scrollback buffer to be ''num'' lines high.
-sets
the title
(a.k.a.
) for
the default shell or specified
-program
. See also
the ``shelltitle''
.screenrc
-
+;__-i__: will cause
the interrupt key
(usually C-c
) to interrupt
the display immediately when flow-control is on
. See the "defflow"
.screenrc command for details. The use of this option is discouraged
.
+;__-l__ and __-ln__: turns login mode on or off (for /var/run/utmp updating). This can also be defined through the ``deflogin'' .screenrc command.
-__-U
__
+;
__-ls
__ and __-list__: does not start ''screen'', but prints a list of ''pid.tty.host'' strings identifying your ''screen'' sessions. Sessions marked `detached' can be resumed with "screen -r". Those marked `attached' are running and have a controlling terminal. If the session runs in multiuser mode, it is marked `multi'. Sessions marked as `unreachable' either live on a different host or are `dead'. An unreachable session is considered dead, when its name matches either the name of the local host, or the specified parameter, if any. See the __-r__ flag for a description how to construct matches. Sessions marked as `dead' should be thoroughly checked and removed. Ask your system administrator if you are not sure. Remove sessions with the __-wipe__ option.
+;__-L__: tells ''screen'' your auto-margin terminal has a writable last-position on the screen. This can also be set in your .screenrc by specifying `LP' in a ``termcap'' command.
-Run screen in UTF
-8 mode
. This option tells
screen that your
-terminal sends and understands UTF
-8 encoded characters
. It
-also sets
the default encoding for new windows to
-utf8
'.
+;__
-m__: causes ''screen'' to ignore the $STY environment variable
. With ``
screen -m'' creation of a new session is enforced, regardless whether ''screen'' is called from within another ''screen'' session or not
. This flag has a special meaning in connection with
the `-d
' option:
+;__-d -m__: Start ''screen'' in "detached" mode. This creates a new session but doesn't attach to it. This is useful for system startup scripts.
-__-v
__
+;
__-D -m
__: This also starts screen in ``detached'' mode, but doesn't fork a new process. The command exits if the session terminates.
+;__-O__: selects a more optimal output mode for your terminal rather than true VT100 emulation (only affects auto-margin terminals without `LP'). This can also be set in your .screenrc by specifying `OP' in a "termcap" command.
-Print version number
.
+;__-q__: Suppress printing of error messages. In combination with ``-ls'' the exit value is as follows: 9 indicates a directory without sessions. 10 indicates a directory with running but not attachable sessions. 11 (or more) indicates 1 (or more) usable sessions. In combination with ``-r'' the exit value is as follows: 10 indicates that there is no session to resume. 12 (or more) indicates that there are 2 (or more) sessions to resume and you should specify which one to choose. In all other cases "-q" has no effect
.
+;__-r__ [[''pid.tty.host'']:
-__-wipe
__ [[''match
'']
+;
__-r
__ ''sessionowner/
[[pid.tty.host
'']: resumes a detached ''screen'' session. No other options (except combinations with __-d__/__-D__) may be specified, though an optional prefix of [[''pid.
'']''tty.host'' may be needed to distinguish between multiple detached ''screen'' sessions. The second form is used to connect to another user's screen session which runs in multiuser mode. This indicates that screen should look for sessions in another user's directory. This requires setuid-root.
+;__-R__: attempts to resume the first detached ''screen'' session it finds. If successful, all other command-line options are ignored. If no detached session exists, starts a new session using the specified options, just as if __-R__ had not been specified. The option is set by default if ''screen'' is run as a login-shell (actually screen uses "-xRR" in that case). For combinations with the __-d__/__-D__ option see there.
-does
the same as ``screen -ls''
, but removes destroyed
-sessions
instead of marking them as `dead'. An unreachable
-session is considered dead, when its name matches either
the
-name of
the local host,
or the explicitly given parameter,
-any
. See
the __-r__ flag for a description how to
-construct matches
.
+;__-s__: sets
the default shell to the program specified
, instead of the value in
the environment variable $SHELL (
or "/bin/sh"
if not defined)
. This can also be defined through
the "shell" .screenrc command
.
+;__-S__ ''sessionname'': When creating a new session, this option can be used to specify a meaningful name for the session. This name identifies the session for "screen -list" and "screen -r" actions. It substitutes the default [[''tty.host''] suffix.
-__-x
__
+;
__-t
__ ''name'': sets the title (a.k.a.) for the default shell or specified program. See also the "shelltitle" .screenrc command.
+;__-U__: Run screen in UTF-8 mode. This option tells screen that your terminal sends and understands UTF-8 encoded characters. It also sets the default encoding for new windows to `utf8'.
-Attach to a not detached ''screen'' session. (Multi
-display mode)
.
+;__-v__: Print version number
.
+;__-wipe__ [[''match'']: does the same as "screen -ls", but removes destroyed sessions instead of marking them as `dead'. An unreachable session is considered dead, when its name matches either the name of the local host, or the explicitly given parameter, if any. See the __-r__ flag for a description how to construct matches.
-__-X
__
+;
__-x
__: Attach to a not detached ''screen'' session. (Multi display mode).
+;__-X__: Send the specified command to a running screen session. You can use the __-d__ or __-r__ option to tell screen to look only for attached or detached screen sessions. Note that this command doesn't work if the session is password protected.
-Send the specified command to a running screen session. You
-can use the __-d__ or __-r__ option to tell screen to
-look only for attached or detached screen sessions. Note
-that this command doesn't work if the session is password
-protected.
!!DEFAULT KEY BINDINGS
As mentioned, each ''screen'' command consists of a
-``
C-a''
followed by one other character. For your
+"
C-a"
followed by one other character. For your
convenience, all commands that are bound to lower-case
letters are also bound to their control character
-counterparts (with the exception of ``
C-a a''
; see below),
-thus, ``
C-a c''
as well as ``
C-a C-c''
can be used to create
-a window. See section ``
CUSTOMIZATION''
for a description of
+counterparts (with the exception of "
C-a a"
; see below),
+thus, "
C-a c"
as well as "
C-a C-c"
can be used to create
+a window. See section "
CUSTOMIZATION"
for a description of
the command.
The following table shows the default key
