summaryrefslogtreecommitdiff
path: root/src/doc/screen.1
diff options
context:
space:
mode:
Diffstat (limited to 'src/doc/screen.1')
-rw-r--r--src/doc/screen.1562
1 files changed, 487 insertions, 75 deletions
diff --git a/src/doc/screen.1 b/src/doc/screen.1
index 399e55e..4cd6dc4 100644
--- a/src/doc/screen.1
+++ b/src/doc/screen.1
@@ -97,7 +97,9 @@ but will instead supply the command name and its arguments to the window
manager (specified in the $STY environment variable) who will use it to
create the new window.
The above example would start the emacs editor (editing prog.c) and switch
-to its window.
+to its window. - Note that you cannot transport environment variables from
+the invoking shell to the application (emacs in this case), because it is
+forked from the parent screen process, not from the invoking shell.
.PP
If \*Q/etc/utmp\*U is writable by
.IR screen ,
@@ -231,7 +233,11 @@ The use of this option is discouraged.
turns login mode on or off (for /etc/utmp updating).
This can also be defined through the \*Qdeflogin\*U .screenrc command.
.TP 5
-.BR \-ls " and " \-list
+.BR \-ls " [" \fImatch ]
+.PD 0
+.TP 5
+.BR \-list " [" \fImatch ]
+.PD
does not start
.IR screen ,
but prints a list of
@@ -282,12 +288,14 @@ emulation (only affects auto-margin terminals without `LP').
This can also be set in your .screenrc by specifying `OP' in a \*Qtermcap\*U
command.
.TP 5
-.BI "\-p " number_or_name
+.BI "\-p " number_or_name|-|=|+
Preselect a window. This is useful when you want to reattach to a
specific window or you want to send a command via the \*Q-X\*U
option to a specific window. As with screen's select command, \*Q-\*U
selects the blank window. As a special case for reattach, \*Q=\*U
-brings up the windowlist on the blank window.
+brings up the windowlist on the blank window, while a \*Q+\*U
+will create a new window. The command will not be
+executed if the specified window could not be found.
.TP 5
.B \-q
Suppress printing of error messages. In combination with \*Q-ls\*U the exit
@@ -299,6 +307,23 @@ 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-q\*U has no effect.
.TP 5
+.B \-Q
+Some commands now can be queried from a remote session using this
+flag, e.g. 'screen -Q windows'. The commands will send the
+response to the stdout of the querying process. If there was an
+error in the command, then the querying process will exit with
+a non-zero status.
+
+The commands that can be queried now are:
+ \fBecho\fP
+ \fBinfo\fP
+ \fBlastmsg\fP
+ \fBnumber\fP
+ \fBselect\fP
+ \fBtime\fP
+ \fBtitle\fP
+ \fBwindows\fP
+.TP 5
.BR \-r " [" \fIpid.tty.host ]
.PD 0
.TP 5
@@ -326,7 +351,7 @@ had not been specified. The option is set by default if
is run as a login-shell (actually screen uses \*Q-xRR\*U in that case).
For combinations with the \fB\-d\fP/\fB\-D\fP option see there.
.TP 5
-.B \-s
+.BI "\-s " program
sets the default shell to the program specified, instead of the value
in the environment variable $SHELL (or \*Q/bin/sh\*U if not defined).
This can also be defined through the \*Qshell\*U .screenrc command.
@@ -341,6 +366,10 @@ default [\fItty.host\fP] suffix.
sets the title (a.\|k.\|a.) for the default shell or specified program.
See also the \*Qshelltitle\*U .screenrc command.
.TP 5
+.BI "\-T " term
+Set the $TERM enviroment varible using the spcified term as
+opposed to the defualt setting of \fBscreen\fP.
+.TP 5
.B \-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
@@ -370,7 +399,6 @@ the \fB-d\fP or \fB-r\fP 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.
-
.SH "DEFAULT KEY BINDINGS"
.ta 12n 26n
As mentioned, each
@@ -509,7 +537,7 @@ automatic margins on and off).
.PD
Send a control-s to the current window.
.IP "\fBC-a S\fP (split)"
-Split the current region into two new ones.
+Split the current region horizontally into two new ones.
See also \fIonly, remove, focus\fP.
.IP "\fBC-a t\fP"
.PD 0
@@ -561,6 +589,8 @@ Enter command line mode.
.IP "\fBC-a esc\fP (copy)"
.PD
Enter copy/scrollback mode.
+.IP "\fBC-a C-]\fP"
+.PD 0
.IP "\fBC-a ]\fP (paste .)"
.PD
Write the contents of the paste buffer to the stdin queue of the
@@ -582,6 +612,8 @@ Shows where
comes from, where it went to and why you can use it.
.IP "\fBC-a _\fP (silence)"
Start/stop monitoring the current window for inactivity.
+.IP "\fBC-a |\fP (split -v)"
+Split the current region vertically into two new ones.
.IP "\fBC-a *\fP (displays)"
Show a listing of all currently attached displays.
@@ -1084,7 +1116,8 @@ This command is normally used together with the \*Qidle\*U command.
.B blankerprg
.RI [ "program args" ]
.PP
-Defines a blanker program. Disables the blanker program if no
+Defines a blanker program. Disables the blanker program if an
+empty argument is given. Shows the currently set blanker program if no
arguments are given.
.sp
.ne 3
@@ -1246,28 +1279,45 @@ window and its history into the paste buffer. In this mode a vi-like
.br
.in +4n
.ti -2n
-\fBh\fP, \fBj\fP, \fBk\fP, \fBl\fP move the cursor line by line or
-column by column.
+\fBh\fP, \fBC-h\fP, or \fBleft arrow\fP move the cursor left.
.br
.ti -2n
-\fB0\fP, \fB^\fP and \fB$\fP move to the leftmost column, to the first or last
-non-whitespace character on the line.
+\fBj\fP, \fBC-n\fP, or \fBdown arrow\fP move the cursor down.
+.br
+.ti -2n
+\fBk\fP, \fBC-p\fP, or \fBup arrow\fP move the cursor up.
+.br
+.ti -2n
+\fBl\fP ('el') or \fBright arrow\fP move the cursor right.
+.br
+.ti -2n
+\fB0\fP (zero) or \fBC-a\fP move to the leftmost column.
+.br
+.ti -2n
+\fB+\fP and \fB\-\fP positions one line up and down.
.br
.ti -2n
\fBH\fP, \fBM\fP and \fBL\fP move the cursor to the leftmost column
of the top, center or bottom line of the window.
.br
.ti -2n
-\fB+\fP and \fB\-\fP positions one line up and down.
+\fB|\fP moves to the specified absolute column.
.br
.ti -2n
-\fBG\fP moves to the specified absolute line (default: end of buffer).
+\fBg\fP or \fBhome\fP moves to the beginning of the buffer.
+.br
+.ti -2n
+\fBG\fP or \fBend\fP moves to the specified absolute line (default: end of buffer).
.br
.ti -2n
-\fB|\fP moves to the specified absolute column.
+\fB%\fP jumps to the specified percentage of the buffer.
.br
.ti -2n
-\fBw\fP, \fBb\fP, \fBe\fP move the cursor word by word.
+\fB^\fP or \fB$\fP move to the leftmost column, to the first or last
+non-whitespace character on the line.
+.br
+.ti -2n
+\fBw\fP, \fBb\fP, and \fBe\fP move the cursor word by word.
.br
.ti -2n
\fBB\fP, \fBE\fP move the cursor WORD by WORD (as in vi).
@@ -1278,7 +1328,11 @@ of the top, center or bottom line of the window.
move the cursor to the 3rd 'y' to the right.)
.br
.ti -2n
-\fB;\fP \fB,\fP Repeat the last f/F/t/T command in the same/opposite direction.
+\fB;\fP and \fB,\fP Repeat the last f/F/t/T command in the same/opposite direction.
+.br
+.ti -2n
+\fBC-e\fP and \fBC-y\fP scroll the display up/down by one line
+while preserving the cursor position.
.br
.ti -2n
\fBC-u\fP and \fBC-d\fP scroll the display up/down by the specified amount of
@@ -1287,12 +1341,6 @@ lines while preserving the cursor position. (Default: half screen-full).
.ti -2n
\fBC-b\fP and \fBC-f\fP scroll the display up/down a full screen.
.br
-.ti -2n
-\fBg\fP moves to the beginning of the buffer.
-.br
-.ti -2n
-\fB%\fP jumps to the specified percentage of the buffer.
-.br
.ti -4n
.IR Note :
@@ -1306,11 +1354,12 @@ emacs-style keymap, as this involves multi-character codes.
.IR Marking :
.br
The copy range is specified by setting two marks. The text between these marks
-will be highlighted. Press
+will be highlighted. Press:
.br
.ti -2n
-\fBspace\fP to set the first or second mark
-respectively.
+\fBspace\fP or \fBenter\fP to set the first or second mark
+respectively. If \fBmousetrack\fP is set to `on', marks can also be set using
+\fPleft mouse click\fP.
.br
.ti -2n
\fBY\fP and \fBy\fP used to mark one whole line or to mark from
@@ -1342,6 +1391,10 @@ Example: \*QC-a C-[ H 10 j 5 Y\*U will copy lines
\fBC-a s\fP \fIEmacs\fP style incremental search forward.
.ti -2n
\fBC-r\fP \fIEmacs\fP style reverse i-search.
+.ti -2n
+\fBn\fP Find next search pattern.
+.ti -2n
+\fBN\fP Find previous search pattern.
.ti -4n
.IR Specials :
.br
@@ -1350,7 +1403,7 @@ There are however some keys that act differently than in
.I Vi
does not allow one to yank rectangular blocks of text, but
.I screen
-does. Press
+does. Press:
.br
.ti -2n
\fBc\fP or \fBC\fP to set the left or right margin respectively. If no repeat count is
@@ -1375,7 +1428,7 @@ whitespace and comma separated lines. Note that you can prepend the newline
character with a carriage return character, by issuing a \*Qcrlf on\*U.
.br
.ti -2n
-\fBv\fP is for all the
+\fBv\fP or \fBV\fP is for all the
.I vi
users with \*Q:set numbers\*U \- it toggles the left margin between column 9
and 1. Press
@@ -1399,10 +1452,13 @@ to that file: \*QC-A [ g SPACE G $ >\*U.
\fBC-g\fP gives information about the current line and column.
.br
.ti -2n
-\fBx\fP exchanges the first mark and the current cursor position. You
+\fBx\fP or \fBo\fP exchanges the first mark and the current cursor position. You
can use this to adjust an already placed mark.
.br
.ti -2n
+\fBC-l\fP ('el') will redraw the screen.
+.br
+.ti -2n
\fB@\fP does nothing. Does not even exit copy mode.
.br
.ti -2n
@@ -1555,6 +1611,12 @@ Same as the \fBmonitor\fP command except that the default setting for new
windows is changed. Initial setting is `off'.
.sp
.ne 3
+.BR "defmousetrack on" | off
+.PP
+Same as the \fBmousetrack\fP command except that the default setting for new
+windows is changed. Initial setting is `off'.
+.sp
+.ne 3
.B defnonblock
.BR on | off | \fInumsecs
.PP
@@ -1648,9 +1710,93 @@ why features like color or the alternate charset don't work.
.PP
Shows a tabular listing of all currently connected user front-ends (displays).
This is most useful for multiuser sessions.
+The following keys can be used in displays list:
+.br
+.in +4n
+.ti -2n
+\fBk\fP, \fBC-p\fP, or \fBup\fP Move up one line.
+.br
+.ti -2n
+\fBj\fP, \fBC-n\fP, or \fBdown\fP Move down one line.
+.br
+.ti -2n
+\fBC-a\fP or \fBhome\fP Move to the first line.
+.br
+.ti -2n
+\fBC-e\fP or \fBend\fP Move to the last line.
+.br
+.ti -2n
+\fBC-u\fP or \fBC-d\fP Move one half page up or down.
+.br
+.ti -2n
+\fBC-b\fP or \fBC-f\fP Move one full page up or down.
+.br
+.ti -2n
+\fBmouseclick\fP Move to the selected line. Available
+when \*Qmousetrack\*U is set to on.
+.br
+.ti -2n
+\fBspace\fP Refresh the list
+.br
+.ti -2n
+\fBd\fP Detach that display
+.br
+.ti -2n
+\fBD\fP Power detach that display
+.br
+.ti -2n
+\fBC-g\fP, \fBenter\fP, or \fBescape\fP Exit the list
+.br
+.ti -4n
+.PP
+The following is an example of what \*Qdisplays\*U could look like:
+.IP
+xterm 80x42 jnweiger@/dev/ttyp4 0(m11) &rWx
+.br
+facit 80x24 mlschroe@/dev/ttyhf nb 11(tcsh) rwx
+.br
+xterm 80x42 jnhollma@/dev/ttyp5 0(m11) &R.x
+.br
+ (A) (B) (C) (D) (E) (F)(G) (H)(I)
+.PP
+The legend is as follows:
+.br
+(A) The terminal type known by screen for this display.
+.br
+(B) Displays geometry as width x height.
+.br
+(C) Username who is logged in at the display.
+.br
+(D) Device name of the display or the attached device
+.br
+(E) Display is in blocking or nonblocking mode. The available modes are "nb", "NB",
+"Z<", "Z>", and "BL".
+.br
+(F) Number of the window
+.br
+(G) Name/title of window
+.br
+(H) Whether the window is shared
+.br
+(I) Window permissions. Made up of three characters:
+ (1st character)
+ ‘-’ : no read
+ ‘r’ : read
+ ‘R’ : read only due to foreign wlock
+ (2nd character)
+ ‘-’ : no write
+ ‘.’ : write suppressed by foreign wlock
+ ‘w’ : write
+ ‘W’ : own wlock
+ (3rd character)
+ ‘-’ : no execute
+ ‘x’ : execute
+
+\*QDisplays\*U needs a region size of at least 10 characters wide and 5 characters high in
+order to display.
.sp
.ne 3
-.BR "digraph " [ \fIpreset ]
+.BR "digraph " [ \fIpreset [ \fI unicode-value ] ]
.PP
This command prompts the user for a digraph sequence. The next
two characters typed are looked up in a builtin table and the
@@ -1664,6 +1810,11 @@ number instead. The optional argument
is treated as user input, thus one can create an \*Qumlaut\*U key.
For example the command "bindkey ^K digraph '"'" enables the user
to generate an a-umlaut by typing CTRL-K a.
+When a non-zero
+.I unicode-value
+is specified, a new digraph is created with the specified preset. The digraph is unset
+if a zero value is provided for the
+.I unicode-value.
.sp
.ne 3
.B dumptermcap
@@ -1860,6 +2011,20 @@ region respectively. Useful bindings are (j and k as in vi)
Note that \fBk\fP is traditionally bound to the \fIkill\fP command.
.sp
.ne 3
+.BI "focusminsize [ ( " width "|max|_ ) ( " height "|max|_ ) ]"
+.PP
+This forces any currently selected region to be automatically
+resized at least a certain \fIwidth\fP and \fIheight\fP. All
+other surrounding regions will be resized in order to accommodate.
+This constraint follows everytime the \*Qfocus\*U command is
+used. The \*Qresize\*U command can be used to increase either
+dimension of a region, but never below what is set with
+\*Qfocusminsize\*U. The underscore `_' is a synonym for
+\fBmax\fP. Setting a \fIwidth\fP and \fIheight\fP of `0 0'
+(zero zero) will undo any constraints and allow for manual resizing.
+Without any parameters, the minimum width and height is shown.
+.sp
+.ne 3
.BR "gr " [ on | off ]
.PP
Turn GR charset switching on/off. Whenever screen sees an input
@@ -1869,6 +2034,15 @@ default (see also \*Qdefgr\*U) is not to process GR switching because
otherwise the ISO88591 charset would not work.
.sp
.ne 3
+.BI group
+.RI [ grouptitle ]
+.PP
+Change or show the group the current window belongs to. Windows can
+be moved around between different groups by specifying the name of
+the destination group. Without specifying a group, the title of the
+current group is displayed.
+.sp
+.ne 3
.B hardcopy
.RB [ -h ]
.RI [ file ]
@@ -2007,14 +2181,14 @@ Sets a command that is run after the specified number of seconds
inactivity is reached. This command will normally be the \*Qblanker\*U
command to create a screen blanker, but it can be any screen command.
If no command is specified, only the timeout is set. A timeout of
-zero (ot the special timeout \fBoff\fP) disables the timer.
+zero (or the special timeout \fBoff\fP) disables the timer.
If no arguments are given, the current settings are displayed.
.sp
.ne 3
.BR "ignorecase " [ on | off ]
.PP
Tell screen to ignore the case of characters in searches. Default is
-`off'.
+`off'. Without any options, the state of ignorecase is toggled.
.sp
.ne 3
.B info
@@ -2090,6 +2264,123 @@ away when you press a key (unless your terminal has a hardware status line).
Refer to the commands \*Qmsgwait\*U and \*Qmsgminwait\*U for fine tuning.
.sp
.ne 3
+.BR "layout new " [\fItitle\fP]
+.PP
+Create a new layout. The screen will change to one whole region
+and be switched to the blank window. From here, you build the
+regions and the windows they show as you desire. The new layout
+will be numbered with the smallest available integer, starting
+with zero. You can optionally give a title to your new layout.
+Otherwise, it will have a default title of \*Qlayout\*U. You
+can always change the title later by using the command
+\fBlayout title\fP.
+.sp
+.ne 3
+.BR "layout remove " [\fIn|title\fP]
+.PP
+Remove, or in other words, delete the specified layout. Either
+the number or the title can be specified. Without either
+specification, \fIscreen\fP will remove the current layout.
+
+Removing a layout does not affect your set windows or regions.
+.sp
+.ne 3
+.B layout next
+.PP
+Switch to the next layout available
+.sp
+.ne 3
+.B layout prev
+.PP
+Switch to the previous layout available
+.sp
+.ne 3
+.BR "layout select " [\fIn|title\fP]
+.PP
+Select the desired layout. Either the number or the title can
+be specified. Without either specification, \fIscreen\fP will
+prompt and ask which screen is desired. To see which layouts are
+available, use the \fBlayout show\fP command.
+.sp
+.ne 3
+.B layout show
+.PP
+List on the message line the number(s) and title(s) of the available
+layout(s). The current layout is flagged.
+.sp
+.ne 3
+.BR "layout title " [\fItitle\fP]
+.PP
+Change or display the title of the current layout. A string given
+will be used to name the layout. Without any options, the current
+title and number is displayed on the message line.
+.sp
+.ne 3
+.BR "layout number " [\fIn\fP]
+.PP
+Change or display the number of the current layout. An integer given
+will be used to number the layout. Without any options, the current
+number and title is displayed on the message line.
+.sp
+.ne 3
+.BR "layout attach " [\fItitle\fP|\fB:last\fP]
+.PP
+Change or display which layout to reattach back to. The default is
+\fB:last\fP, which tells \fIscreen\fP to reattach back to the last
+used layout just before detachment. By supplying a title, You can
+instruct \fIscreen\fP to reattach to a particular layout regardless
+which one was used at the time of detachment. Without any options,
+the layout to reattach to will be shown in the message line.
+.sp
+.ne 3
+.BR "layout save " [\fIn|title\fP]
+.PP
+Remember the current arrangement of regions. When used, \fIscreen\fP
+will remember the arrangement of vertically and horizontally split
+regions. This arrangement is restored when a \fIscreen\fP session
+is reattached or switched back from a different layout. If the
+session ends or the \fIscreen\fP process dies, the layout
+arrangements are lost. The \fBlayout dump\fP command should help
+in this siutation. If a number
+or title is supplied, \fIscreen\fP will remember the arrangement of
+that particular layout. Without any options, \fIscreen\fP will
+remember the current layout.
+
+Saving your regions can be done automatically by using the
+\fBlayout autosave\fP command.
+.sp
+.ne 3
+.BR "layout autosave " [\fBon|off\fP]
+.PP
+Change or display the status of automatcally saving layouts. The
+default is \fBon\fP, meaning when \fIscreen\fP is detached or
+changed to a different layout, the arrangement of regions and windows
+will be remembered at the time of change and restored upon return.
+If autosave is set to \fBoff\fP, that arrangement will only be
+restored to either to the last manual save, using \fBlayout save\fP,
+or to when the layout was first created, to a single region with
+a single window. Without either an \fBon\fP or \fBoff\fP, the
+current status is displayed on the message line.
+.sp
+.ne 3
+.BR "layout dump " [\fIfilename\fP]
+.PP
+Write to a file the order of splits made in the current layout. This
+is useful to recreate the order of your regions used in your current
+layout. Only the current layout is recorded. While the order of the
+regions are recorded, the sizes of those regions and which windows
+correspond to which regions are not. If no filename is specified,
+the default is \fIlayout-dump\fP, saved in the directory that the
+\fIscreen\fP process was started in. If the file already exists,
+\fBlayout dump\fP will append to that file. As an example:
+.PP
+.nf
+ C-a : layout dump /home/user/.screenrc
+.fi
+.PP
+will save or append the layout to the user's \fI.screenrc\fP file.
+.sp
+.ne 3
.B license
.PP
Display the disclaimer page. This is done whenever
@@ -2193,11 +2484,11 @@ Like mapdefault, but don't even look in the default bindkey table.
.sp
.ne 3
.B maptimeout
-.RI [ timo ]
+.RI [ timeout ]
.PP
Set the inter-character timer for input sequence detection to a timeout
of
-.I timo
+.I timeout
ms. The default timeout is 300ms. Maptimeout with no arguments shows
the current setting.
See also \*Qbindkey\*U.
@@ -2223,7 +2514,8 @@ single statement.
.BI "maxwin " num
.PP
Set the maximum window number screen will create. Doesn't affect
-already existing windows. The number may only be decreased.
+already existing windows. The number can be increased only when there are no
+existing windows.
.sp
.ne 3
.B meta
@@ -2241,6 +2533,18 @@ with an `@' in the window-status display.
Monitoring is initially off for all windows.
.sp
.ne 3
+.BR "mousetrack " [ on | off ]
+.PP
+This command determines whether
+.I screen
+will watch for
+mouse clicks. When this command is enabled, regions that have
+been split in various ways can be selected by pointing to them
+with a mouse and left-clicking them. Without specifying \fBon\fP
+or \fBoff\fP, the current state is displayed. The default state
+is determined by the \*Qdefmousetrack\*U command.
+.sp
+.ne 3
.BI "msgminwait " sec
.PP
Defines the time
@@ -2281,7 +2585,8 @@ available if
.I screen
was compiled with the NETHACK flag defined. The
default setting is then determined by the presence of the environment
-variable $NETHACKOPTIONS.
+variable $NETHACKOPTIONS and the file ~/.nethackrc - if either one is present,
+the default is \fBon\fP.
.sp
.ne 3
.B next
@@ -2305,11 +2610,12 @@ some time it restarts to accept characters, screen will unblock
the display and redisplay the updated window contents.
.sp
.ne 3
-.BR "number " [ \fIn ]
+.BR "number " [[+|-] \fIn ]
.PP
-Change the current windows number. If the given number \fIn\fP is already
+Change the current window's number. If the given number \fIn\fP is already
used by another window, both windows exchange their numbers. If no argument is
-specified, the current window number (and title) is shown.
+specified, the current window number (and title) is shown. Using `+' or `-'
+will change the window's number by the relative amount specified.
.sp
.ne 3
.BR "obuflimit " [ \fIlimit ]
@@ -2523,6 +2829,15 @@ Unlinks the screen-exchange file used by the commands \*Qwritebuf\*U and
\*Qreadbuf\*U.
.sp
.ne 3
+.B "rendition bell" | monitor | silence | so
+.RB "\fIattr\fR " [ \fIcolor ]
+.PP
+Change the way
+.I screen
+renders the titles of windows that have monitor or bell flags set in caption or hardstatus or windowlist. See the \*QSTRING ESCAPES\*U chapter for the syntax of the modifiers.
+The default for monitor is currently \*Q=b \*U (bold, active colors), for bell \*Q=ub \*U (underline, bold and active colors), and \*Q=u \*U for silence.
+.sp
+.ne 3
.B "reset"
.PP
Reset the virtual terminal to its \*Qpower-on\*U values. Useful when strange
@@ -2549,7 +2864,7 @@ resize min minimize current region height
.PP
.sp
.ne 3
-.B "screen \fP[\fI-opts\fP] [\fIn\fP] [\fIcmd\fP [\fIargs\fP]]"
+.B "screen \fP[\fI-opts\fP] [\fIn\fP] [\fIcmd\fP [\fIargs\fP]|\fB//group\fP]"
.PP
Establish a new window.
The flow-control options (\fB\-f\fP, \fB\-fn\fP and \fB\-fa\fP),
@@ -2558,11 +2873,14 @@ title (a.\|k.\|a.) option (\fB\-t\fP), login options (\fB-l\fP and \fB-ln\fP)
and scrollback option (\fB-h\fP <num>) may be specified with each command.
The option (\fB-M\fP) turns monitoring on for this window.
The option (\fB-L\fP) turns output logging on for this window.
-If an optional number \fIn\fP in the range 0..9 is given, the window
-number \fIn\fP is assigned to the newly created window (or, if this
-number is already in-use, the next available number).
+If an optional number \fIn\fP in the range 0..MAXWIN-1 is given,
+the window number \fIn\fP is assigned to the newly created window
+(or, if this number is already in-use, the next available number).
If a command is specified after \*Qscreen\*U, this command (with the given
arguments) is started in the window; otherwise, a shell is created.
+If \fB//group\fP is supplied, a container-type window is created in
+which other windows may be created inside it.
+
Thus, if your \*Q.screenrc\*U contains the lines
.sp
.nf
@@ -2592,8 +2910,9 @@ See also chapter \*QWINDOW TYPES\*U.
.PP
Set the size of the scrollback buffer for the current windows to \fInum\fP
lines. The default scrollback is 100 lines.
-See also the \*Qdefscrollback\*U command and use \*QC-a i\*U to view the
-current setting.
+See also the \*Qdefscrollback\*U command and use \*Qinfo\*U to view the
+current setting. To access and use the contents in the scrollback buffer,
+use the \*Qcopy\*U command.
.sp
.ne 3
.BR "select " [ \fIWindowID ]
@@ -2606,7 +2925,7 @@ When a new window is established, the first available number
is assigned to this window.
Thus, the first window can be activated by \*Qselect 0\*U.
The number of windows is limited at compile-time by the MAXWIN
-configuration parameter.
+configuration parameter (which defaults to 40).
There are two special WindowIDs, \*Q-\*U selects the
internal blank window and \*Q.\*U selects the current window. The
latter is useful if used with screen's \*Q-X\*U option.
@@ -2617,8 +2936,10 @@ latter is useful if used with screen's \*Q-X\*U option.
Rename the current session. Note, that for \*Qscreen -list\*U the
name shows up with the process-id prepended. If the argument \*Qname\*U
is omitted, the name of this session is displayed. Caution: The $STY
-environment variables still reflects the old name. This may result in
-confusion.
+environment variables will still reflect the old name in pre-existing
+shells. This may result in confusion. Use of this command is generally
+discouraged. Use the \*Q-S\*U command-line option if you want to
+name a new session.
The default is constructed from the tty and host names.
.sp
.ne 3
@@ -2710,20 +3031,17 @@ default screenrc files to have an effect.
.B sorendition
.RB [ "\fIattr\fR " [ \fIcolor ]]
.PP
-Change the way
-.I screen
-does highlighting for text marking and printing messages.
-See the \*QSTRING ESCAPES\*U chapter for the syntax of the modifiers.
-The default is currently \*Q=s dd\*U (standout, default colors).
+This command is deprecated. See "rendition so" instead.
.sp
.ne 3
.B split
+.RB [ -v ]
.PP
Split the current region into two new ones. All regions on the
display are resized to make room for the new region. The blank
-window is displayed on the new region. Use the \*Qremove\*U or the
-\*Qonly\*U command to delete regions.
-Use \*Qfocus\*U to toggle between regions.
+window is displayed on the new region. Splits are made horizontally
+unless -v is used. Use the \*Qremove\*U or the \*Qonly\*U command
+to delete regions. Use \*Qfocus\*U to toggle between regions.
.sp
.ne 3
.B "startup_message on\fP|\fBoff"
@@ -2732,21 +3050,22 @@ Select whether you want to see the copyright notice during startup.
Default is `on', as you probably noticed.
.sp
.ne 3
-.B stuff
-.I string
+.B stuff
+.RB [ "\fIstring\fR" ]
.PP
Stuff the string
.I string
in the input buffer of the current window.
This is like the \*Qpaste\*U command but with much less overhead.
+Without a paramter, screen will prompt for a string to stuff.
You cannot paste
large buffers with the \*Qstuff\*U command. It is most useful for key
bindings. See also \*Qbindkey\*U.
.sp
.ne 3
.B su
-.RB [ username " [" password
-.RB [ password2 ]]
+.RI [ username " [" password
+.RI [ password2 ]]]
.PP
Substitute the user of a display. The command prompts for all parameters that
are omitted. If passwords are specified as parameters, they have to be
@@ -2893,7 +3212,7 @@ man page for more information on termcap definitions.
.PP
Uses the message line to display the time of day, the host name, and the load
averages over 1, 5, and 15 minutes (if this is available on your system).
-For window specific information use \*Qinfo\*U.
+For window specific information, use \*Qinfo\*U.
If a string is specified, it changes the format of the time report like it is
described in the \*QSTRING ESCAPES\*U chapter. Screen uses a default of
@@ -2909,6 +3228,14 @@ prompts for one. This command was known as `aka' in previous
releases.
.sp
.ne 3
+.BI "unbindall "
+.PP
+Unbind all the bindings. This can be useful when
+screen is used solely for its detaching abilities, such as when
+letting a console application run as a daemon. If, for some reason,
+it is necessary to bind commands after this, use 'screen -X'.
+.sp
+.ne 3
.BI "unsetenv " var
.PP
Unset an environment variable.
@@ -2948,7 +3275,7 @@ Sets the visual bell message. \fImessage\fP is printed to the status line if
the window receives a bell character (^G), vbell is set to \*Qon\*U, but the
terminal does not support a visual bell.
The default message is \*QWuff, Wuff!!\*U.
-Without parameter, the current message is shown.
+Without a parameter, the current message is shown.
.sp
.ne 3
.BI "vbellwait " sec
@@ -2963,7 +3290,7 @@ visual bell message. The default is 1 second.
.PP
If verbose is switched on, the command name is echoed, whenever a window
is created (or resurrected from zombie state). Default is off.
-Without parameter, the current setting is shown.
+Without a parameter, the current setting is shown.
.sp
.ne 3
.B version
@@ -2997,6 +3324,7 @@ vice versa.
.B windowlist
.RB [ -b ]
.RB [ -m ]
+.RB [ -g ]
.br
.B windowlist
.B string
@@ -3006,9 +3334,9 @@ vice versa.
.B title
.RI [ title ]
.PP
-Display all windows in a table for visual window selection. The
-desired window can be selected via the standard movement keys (see
-the \*Qcopy\*U command) and activated via the return key.
+Display all windows in a table for visual window selection.
+If screen was in a window group, screen will
+back out of the group and then display the windows in that group.
If the
.B -b
option is given, screen will switch to the blank window before
@@ -3017,6 +3345,76 @@ The
.B -m
option changes the order of the windows, instead of sorting by
window numbers screen uses its internal most-recently-used list.
+The
+.B -g
+option will show the windows inside any groups in that level
+and downwards.
+
+The following keys are used to navigate in \*Qwindowlist\*U:
+.br
+.in +4n
+.ti -2n
+\fBk\fP, \fBC-p\fP, or \fBup\fP Move up one line.
+.br
+.ti -2n
+\fBj\fP, \fBC-n\fP, or \fBdown\fP Move down one line.
+.br
+.ti -2n
+\fBC-g\fP or \fBescape\fP Exit windowlist.
+.br
+.ti -2n
+\fBC-a\fP or \fBhome\fP Move to the first line.
+.br
+.ti -2n
+\fBC-e\fP or \fBend\fP Move to the last line.
+.br
+.ti -2n
+\fBC-u\fP or \fBC-d\fP Move one half page up or down.
+.br
+.ti -2n
+\fBC-b\fP or \fBC-f\fP Move one full page up or down.
+.br
+.ti -2n
+\fB0..9\fP Using the number keys, move to the selected line.
+.br
+.ti -2n
+\fBmouseclick\fP Move to the selected line. Available when
+\*Qmousetrack\*U is set to \*Qon\*U
+.br
+.ti -2n
+\fB/\fP Search.
+.br
+.ti -2n
+\fBn\fP Repeat search in the forward direction.
+.br
+.ti -2n
+\fBN\fP Repeat search in the backward direction.
+.br
+.ti -2n
+\fBm\fP Toggle MRU.
+.br
+.ti -2n
+\fBg\fP Toggle group nesting.
+.br
+.ti -2n
+\fBa\fP All window view.
+.br
+.ti -2n
+\fBC-h\fP or backspace Back out the group.
+.br
+.ti -2n
+\fB,\fP Switch numbers with the previous window.
+.br
+.ti -2n
+\fB.\fP Switch numbers with the next window.
+.br
+.ti -2n
+\fBK\fP Kill that window.
+.br
+.ti -2n
+\fBspace\fP or \fBenter\fP Select that window.
+.br
+.in -4n
The table format can be changed with the \fBstring\fP and
\fBtitle\fP option, the title is displayed as table heading, while
@@ -3025,6 +3423,9 @@ setting is \*QNum Name%=Flags\*U for the title and \*Q%3n %t%=%f\*U
for the lines.
See the \*QSTRING ESCAPES\*U chapter for more codes (e.g. color
settings).
+
+\*QWindowlist\*U needs a region size of at least 10 characters wide
+and 6 characters high in order to display.
.sp
.ne 3
.B windows
@@ -3052,7 +3453,7 @@ When line-wrap is on, the second consecutive printable character output at
the last column of a line will wrap to the start of the following line.
As an added feature, backspace (^H) will also wrap through the left margin
to the previous line.
-Default is `on'.
+Default is `on'. Without any options, the state of wrap is toggled.
.sp
.ne 3
.B writebuf
@@ -3198,7 +3599,7 @@ Usually 300, 1200, 9600 or 19200. This affects transmission as well as receive s
Specify the transmission of eight (or seven) bits per byte.
.IP "ixon or -ixon"
Enables (or disables) software flow-control (CTRL-S/CTRL-Q) for sending data.
-.IP "ixoff or -ixon"
+.IP "ixoff or -ixoff"
Enables (or disables) software flow-control for receiving data.
.IP "istrip or -istrip"
Clear (or keep) the eight bit in each received byte.
@@ -3218,13 +3619,12 @@ Signals that are logical low (inactive) have their name preceded by
an exclamation mark (!), otherwise the signal is logical high (active).
Signals not supported by the hardware but available to the ioctl() interface
are usually shown low.
-.br
+.PP
When the CLOCAL status bit is true, the whole set of modem signals is placed
inside curly braces ({ and }).
When the CRTSCTS or TIOCSOFTCAR bit is set, the signals `CTS' or `CD'
are shown in parenthesis, respectively.
-
-
+.PP
For tty windows, the command
.B break
causes the Data transmission line (TxD) to go low for a specified period of
@@ -3233,6 +3633,7 @@ No data is sent and no modem control line is changed when a
.B break
is issued.
.RE
+
.IP \(bu
If the first parameter is \*Q//telnet\*U, the second parameter is expected to
be a host name, and an optional third parameter may specify a TCP port number
@@ -3297,7 +3698,7 @@ day number
.IP D
weekday name
.IP f
-flags of the window
+flags of the window, see \*Qwindows\*U for meanings of the various flags
.IP F
sets %? to true if the window has the focus
.IP h
@@ -3312,6 +3713,8 @@ month number
month name
.IP n
window number
+.IP P
+sets %? to true if the current region is in copy/paste mode
.IP S
session name
.IP s
@@ -4482,10 +4885,19 @@ termcap(5), utmp(5), vi(1), captoinfo(1), tic(1)
.SH AUTHORS
Originally created by Oliver Laumann, this latest version was
-produced by Wayne Davison, Juergen Weigert and Michael Schroeder.
+produced by Juergen Weigert, Michael Schroeder, Micah Cowan and
+Sadrul Habib Chowdhury.
.SH COPYLEFT
.nf
+Copyright (c) 2010
+ Juergen Weigert (jnweiger@immd4.informatik.uni-erlangen.de)
+ Sadrul Habib Chowdhury (sadrul@users.sourceforge.net)
+Copyright (c) 2008, 2009
+ Juergen Weigert (jnweiger@immd4.informatik.uni-erlangen.de)
+ Michael Schroeder (mlschroe@immd4.informatik.uni-erlangen.de)
+ Micah Cowan (micah@cowan.name)
+ Sadrul Habib Chowdhury (sadrul@users.sourceforge.net)
Copyright (C) 1993-2003
Juergen Weigert (jnweiger@immd4.informatik.uni-erlangen.de)
Michael Schroeder (mlschroe@immd4.informatik.uni-erlangen.de)
@@ -4494,7 +4906,7 @@ Copyright (C) 1987 Oliver Laumann
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2, or (at your option)
+the Free Software Foundation; either version 3, or (at your option)
any later version.
.PP
This program is distributed in the hope that it will be useful,
@@ -4540,7 +4952,7 @@ Pablo Averbuj (pablo@averbuj.com).
.SH VERSION
-This is version 4.0.2. Its roots are a merge of a custom version
+This is version 4.1.0. Its roots are a merge of a custom version
2.3PR7 by Wayne Davison
and several enhancements to Oliver Laumann's version 2.0. Note that all versions
numbered 2.x are copyright by Oliver Laumann.