diff options
Diffstat (limited to 'doc/screen.1')
| -rw-r--r-- | doc/screen.1 | 574 |
1 files changed, 480 insertions, 94 deletions
diff --git a/doc/screen.1 b/doc/screen.1 index 74c35d4..aad6aef 100644 --- a/doc/screen.1 +++ b/doc/screen.1 @@ -1,5 +1,5 @@ .\" vi:set wm=5 -.TH SCREEN 1 "10 Jun 1999" +.TH SCREEN 1 "Jan 2002" .if n .ds Q \&" .if n .ds U \&" .if t .ds Q `` @@ -34,7 +34,7 @@ multiplexes a physical terminal between several processes (typically interactive shells). Each virtual terminal provides the functions of a DEC VT100 terminal and, in addition, several control functions -from the ISO 6492 (ECMA 48, ANSI X3.64) and ISO 2022 standards +from the ISO 6429 (ECMA 48, ANSI X3.64) and ISO 2022 standards (e.\|g. insert/delete line and support for multiple character sets). There is a scrollback history buffer for each virtual terminal and a copy-and-paste mechanism that allows moving text regions between @@ -74,9 +74,7 @@ does not understand the prefix \*QC-\*U to mean control. Please use the caret notation (\*Q^A\*U instead of \*QC-a\*U) as arguments to e.g. the .I escape -command or the -.I -e -option. +command or the \fI-e\fP option. .I Screen will also print out control characters in caret notation. .PP @@ -270,13 +268,13 @@ is called from within another session or not. This flag has a special meaning in connection with the `-d' option: .TP 8 -.B \-m \-d +.B \-d \-m Start .I screen in \*Qdetached\*U mode. This creates a new session but doesn't attach to it. This is useful for system startup scripts. .TP 8 -.B \-m \-D +.B \-D \-m This also starts screen in \*Qdetached\*U mode, but doesn't fork a new process. The command exits if the session terminates. .TP 5 @@ -320,7 +318,7 @@ options, just as if .B \-R had not been specified. The option is set by default if .I screen -is run as a login-shell. +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 @@ -338,6 +336,11 @@ 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 +.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 +encoding for new windows to `utf8'. +.TP 5 .B \-v Print version number. .TP 5 @@ -352,6 +355,12 @@ See the \fB-r\fP flag for a description how to construct matches. Attach to a not detached .I screen session. (Multi display mode). +.TP 5 +.B \-X +Send the specified command to a running screen session. You can use +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" @@ -368,11 +377,10 @@ of the command. .PP .TP 26n The following table shows the default key bindings: -.IP "\fBC-a '\fP" -.PD 0 -.IP "\fBC-a ""\fP (select)" -.PD +.IP "\fBC-a '\fP (select)" Prompt for a window name or number to switch to. +.IP "\fBC-a ""\fP (windowlist -b)" +Present a list of all windows for selection. .IP "\fBC-a 0\fP (select 0)" .PD 0 .IP "\fB ... \fP ..." @@ -689,6 +697,7 @@ If the second parameter is omitted all groups the user is in are listed. .B aclumask .RI [[ users ] +bits .RI |[ users ] -bits " .... ]" +.br .B umask .RI [[ users ] +bits .RI |[ users ] -bits " .... ]" @@ -773,6 +782,38 @@ a display is associated with the target windows. These commands may not work correctly under \*Qat\*U looping over windows. .sp .ne 3 +.BI "attrcolor " attrib +.RI [ "attribute/color-modifier" ] +.PP +This command can be used to highlight attributes by changing the color of +the text. If the attribute +.I attrib +is in use, the specified attribute/color modifier is also applied. If no +modifier is given, the current one is deleted. See the \*QSTRING ESCAPES\*U +chapter for the syntax of the modifier. Screen understands two +pseudo-attributes, \*Qi\*U stands for high-intensity foreground +color and \*QI\*U for high-intensity background color. +.sp +Examples: +.IP +attrcolor b "R" +.PP +Change the color to bright red if bold text is to be printed. +.IP +attrcolor u "-u b" +.PP +Use blue text instead of underline. +.IP +attrcolor b "I" +.PP +Use bright colors for bold text. Most terminal emulators do this +already. +.IP +attrcolor i "+b" +.PP +Make bright colored text also bold. +.sp +.ne 3 .BR "autodetach on" | off .PP Sets whether @@ -786,14 +827,6 @@ When turned off, a hangup signal will terminate and all the processes it contains. Autodetach is on by default. .sp .ne 3 -.BR "autofixterm on" | off -.PP -Sets whether -.I screen -will add missing capabilities to the termcap/info entry. It is on -by default. -.sp -.ne 3 .BR "autonuke on" | off .PP Sets whether a clear screen sequence should nuke all the output @@ -801,6 +834,14 @@ that has not been written to the terminal. See also \*Qobuflimit\*U. .sp .ne 3 +.BR "bce " [ on | off ] +.PP +Change background-color-erase setting. If \*Qbce\*U is set to on, all +characters cleared by an erase/insert/scroll/clear operation +will be displayed in the current background color. Otherwise +the default background color is used. +.sp +.ne 3 .B bell_msg .RI [ message ] .PP @@ -821,7 +862,10 @@ output of a message line (bell_msg ""). Without parameter, the current message is shown. .sp .ne 3 -.BI "bind " key +.BI "bind " +.RB [ -c +.IR class ] +.I key .RI [ command " [" args ]] .PP Bind a command to a key. @@ -840,6 +884,11 @@ The argument can also be quoted, if you like. If no further argument is given, any previously established binding for this key is removed. The \fIcommand\fP argument can be any command listed in this section. + +If a command class is specified via the \*Q-c\*U option, the key +is bound for the specified class. Use the \*Qcommand\*U command +to activate a class. Command classes can be used to create multiple +command keys or multi-character bindings. .PP Some examples: .PP @@ -861,6 +910,24 @@ binds \*QC-f\*U to the command \*Qcreate a window with a TELNET connection to foobar\*U, and bind \*Qescape\*U to the command that creates an non-login window with a.\|k.\|a. \*Qroot\*U in slot #9, with a superuser shell and a scrollback buffer of 1000 lines. +.PP +.nf + bind -c demo1 0 select 10 + bind -c demo1 1 select 11 + bind -c demo1 2 select 12 + bindkey "^B" command -c demo1 +.fi +.PP +makes \*QC-b 0\*U select window 10, \*QC-b 1\*U window 11, etc. +.PP +.nf + bind -c demo2 0 select 10 + bind -c demo2 1 select 11 + bind -c demo2 2 select 12 + bind - command -c demo2 +.fi +.PP +makes \*QC-a - 0\*U select window 10, \*QC-a - 1\*U window 11, etc. .sp .ne 3 .B bindkey @@ -1029,7 +1096,7 @@ mapping. On every position a '.' may be used to indicate that the corresponding charset/mapping should not be changed (\fIset\fP is padded to six characters internally by appending '.' chars). New windows have "BBBB02" as default charset, unless a -\*Qkanji\*U command is active. +\*Qencoding\*U command is active. .br The current setting can be viewed with the \*Qinfo\*U command. .sp @@ -1076,10 +1143,13 @@ you may regard \*QC-a esc\*U (copy mode) as its `Vi command mode'. .sp .ne 3 .B command +.RB [ -c +.IR class ] .PP This command has the same effect as typing the screen escape character (^A). It is probably only useful for key bindings. -See also \*Qbindkey\*U. +If the \*Q-c\*U option is given, select the specified command +class. See also \*Qbind\*U and \*Qbindkey\*U. .sp .ne 3 .BR "compacthist " [ on | off ] @@ -1296,6 +1366,12 @@ Note that you can use the special `AN' terminal capability if you want to have a dependency on the terminal type. .sp .ne 3 +.BR "defbce on" | off +.PP +Same as the \fBbce\fP command except that the default setting for new +windows is changed. Initial setting is `off'. +.sp +.ne 3 .B defbreaktype .RI [ tcsendbreak | TIOCSBRK .RI | TCSBRK ] @@ -1366,10 +1442,17 @@ is omitted, the current default string is displayed. Per default the hardstatus line of new windows is empty. .sp .ne 3 -.BR "defkanji jis" | sjis | euc +.BI "defencoding " enc .PP -Same as the \fBkanji\fP command except that the default setting for new -windows is changed. Initial setting is `off', i.e. `jis'. +Same as the \fBencoding\fP command except that the default setting for new +windows is changed. Initial setting is the encoding taken from the +terminal. +.sp +.ne 3 +.BR "deflog on" | off +.PP +Same as the \fBlog\fP command except that the default setting for new windows +is changed. Initial setting is `off'. .sp .ne 3 .BR "deflogin on" | off @@ -1421,6 +1504,13 @@ Same as the \fBslowpaste\fP command except that the default setting for new windows is changed. Initial setting is 0 milliseconds, meaning `off'. .sp .ne 3 +.BR "defutf8 on" | off +.PP +Same as the \fButf8\fP command except that the default setting for new +windows is changed. Initial setting is `on' if screen was started with +\*Q-U\*U, otherwise `off'. +.sp +.ne 3 .BR "defwrap on" | off .PP Same as the \fBwrap\fP command except that the default setting for new @@ -1441,6 +1531,7 @@ See there. .sp .ne 3 .B detach +.RB [ -h ] .PP Detach the .I screen @@ -1453,7 +1544,16 @@ can be resumed by invoking .I screen with the .B \-r -option. (See also section \*QCOMMAND-LINE OPTIONS\*U.) +option (see also section \*QCOMMAND-LINE OPTIONS\*U). The +.B \-h +option tells screen to immediately close the connection to the +terminal (\*Qhangup\*U). +.sp +.ne 3 +.B dinfo +.PP +Show what screen thinks about your terminal. Useful if you want to know +why features like color or the alternate charset don't work. .sp .ne 3 .B displays @@ -1519,6 +1619,14 @@ by a second character, such as \*Q\e^\*U or \*Q\e\e\*U. The default is \*Q^Aa\*U. .sp .ne 3 +.B eval +.I command1 +.RI [ command2 +.IR ... ] +.PP +Parses and executes each argument as seperate command. +.sp +.ne 3 .B exec .RI [[ fdpat ] .IR "newcommand " [ "args ..." ]] @@ -1627,10 +1735,19 @@ details and note, that this is subject to change in future releases. Default is set by `defflow'. .sp .ne 3 -.B focus +.BR "focus " [ up | down | top | bottom ] .PP Move the input focus to the next region. This is done in a cyclic -way so that the top region is selected after the bottom one. +way so that the top region is selected after the bottom one. If +no subcommand is given it defaults to `down'. `up' cycles in the +opposite order, `top' and `bottom' go to the top and bottom +region respectively. Useful bindings are (j and k as in vi) +.nf + bind j focus down + bind k focus up + bind t focus top + bind b focus bottom +.fi .sp .ne 3 .BR "gr " [ on | off ] @@ -1643,11 +1760,15 @@ otherwise the ISO88591 charset would not work. .sp .ne 3 .B hardcopy +.RB [ -h ] +.RI [ file ] .PP -Writes out the currently displayed image to a file \fIhardcopy.n\fP -in the window's default directory, where \fIn\fP is the number -of the current window. +Writes out the currently displayed image to the file \fIfile\fP, +or, if no filename is specified, to \fIhardcopy.n\fP in the +default directory, where \fIn\fP is the number of the current window. This either appends or overwrites the file if it exists. See below. +If the option \fB-h\fP is specified, dump also the contents of the +scrollback buffer. .sp .ne 3 .BR "hardcopy_append on" | off @@ -1703,12 +1824,12 @@ If you prepend the word \*Qalways\*U to the type, .I screen will use the type even if the terminal supports a hardstatus. .P -The third form specifies the contents of the hardstatus line. -'%h' is used as default string, i.e. the stored hardstatus of the -current window (settable via \\E]0;^G or \\E_\\\\) is displayed. -You can customize this to any string you like including -the escapes from the \*QSTRING ESCAPES\*U chapter. If you leave -out the argument +The third form specifies the contents of the hardstatus line. '%h' is +used as default string, i.e. the stored hardstatus of the current +window (settable via \*QESC]0;<string>^G\*U or \*QESC_<string>ESC\e\*U) +is displayed. You can customize this to any string you like including +the escapes from the \*QSTRING ESCAPES\*U chapter. If you leave out +the argument .IR string , the current string is displayed. .P @@ -1716,13 +1837,24 @@ You can mix the second and third form by providing the string as additional argument. .sp .ne 3 -.BR "height " [ \fIlines\fP ] +.B height +.RB [ -w | -d ] +.RI [ lines " [" cols ]] .PP Set the display height to a specified number of lines. When no argument -is given it toggles between 24 and 42 lines display. +is given it toggles between 24 and 42 lines display. You can also +specify a width if you want to change both values. +The +.B -w +option tells screen to leave the display size unchanged and just set +the window size, +.B -d +vice versa. .sp .ne 3 .B help +.RB [ -c +.IR class ] .PP Not really a online help, but displays a help @@ -1732,7 +1864,8 @@ The first pages list all the internal commands followed by their current bindings. Subsequent pages will display the custom commands, one command per key. Press space when you're done reading each page, or return to exit early. -All other characters are ignored. +All other characters are ignored. If the \*Q-c\*U option is given, +display all bound commands for the specified command class. See also \*QDEFAULT KEY BINDINGS\*U section. .sp .ne 3 @@ -1756,6 +1889,12 @@ scrollback buffer). Change the window's hardstatus line to the string \fIstatus\fP. .sp .ne 3 +.BR "ignorecase " [ on | off ] +.PP +Tell screen to ignore the case of caracters in searches. Default is +`off'. +.sp +.ne 3 .B info .PP Uses the message line to display some information about the current window: @@ -1782,7 +1921,8 @@ activity monitoring or partial redraw enabled. The currently active character set (\fIG0\fP, \fIG1\fP, \fIG2\fP, or \fIG3\fP) and in square brackets the terminal character sets that are -currently designated as \fIG0\fP through \fIG3\fP is shown. +currently designated as \fIG0\fP through \fIG3\fP is shown. If the window +is in UTF-8 mode, the string \*QUTF-8\*U is shown instead. Additional modes depending on the type of the window are displayed at the end of the status line (See also chapter \*QWINDOW TYPES\*U). .br @@ -1797,20 +1937,24 @@ For system information use the \*Qtime\*U command. No longer exists, use \*Qpaste\*U instead. .sp .ne 3 -.B kanji -.BR jis | euc | sjis -.RB [ jis | euc | sjis\fR] +.BI "encoding " enc +.RI [ enc ] .PP Tell .I screen -how to process kanji input/output. The first argument -sets the kanji type of the current window. Each window can emulate -a different type. The optional second parameter tells -.I screen -how to write the kanji codes to the connected terminal. The preferred -method of setting the display type is to use the \*QKJ\*U termcap -entry. -See also \*Qdefkanji\*U, which changes the default setting of a new +how to interpret the input/output. The first argument +sets the encoding of the current window. Each window can emulate +a different encoding. The optional second parameter overwrites +the encoding of the connected terminal. It should never be +needed as screen uses the locale setting to detect the encoding. +There is also a way to select a terminal encoding depending on +the terminal type by using the \*QKJ\*U termcap entry. + +Supported encodings are eucJP, SJIS, eucKR, eucCN, Big5, KOI8-R, +CP1251, UTF-8, ISO8859-2, ISO8859-3, ISO8859-4, ISO8859-5, ISO8859-6, +ISO8859-7, ISO8859-8, ISO8859-9, ISO8859-10, ISO8859-15, jis. + +See also \*Qdefencoding\*U, which changes the default setting of a new window. .sp .ne 3 @@ -2208,12 +2352,19 @@ Use the empty bind command (as in \*Qbind '^\e'\*U) to remove a key binding. .sp .ne 3 .B readbuf +.RB [ -e +.IR encoding ] +.RI [ filename ] .PP -Reads the contents of the current screen-exchange file into the paste buffer. +Reads the contents of the specified file into the paste buffer. +You can tell screen the encoding of the file via the \fB-e\fP option. +If no file is specified, the screen-exchange filename is used. See also \*Qbufferfile\*U command. .sp .ne 3 .B readreg +.RB [ -e +.IR encoding ] .RI [ register " [" filename ]] .PP Does one of two things, dependent on number of arguments: with zero or one @@ -2221,6 +2372,7 @@ arguments it it duplicates the paste buffer contents into the register specified or entered at the prompt. With two arguments it reads the contents of the named file into the register, just as \fIreadbuf\fP reads the screen-exchange file into the paste buffer. +You can tell screen the encoding of the file via the \fB-e\fP option. The following example will paste the system's password file into the .I screen @@ -2238,10 +2390,14 @@ Redisplay the current window. Needed to get a full redisplay when in partial redraw mode. .sp .ne 3 -.BI "register " "key string" +.B register +.RB [ -e +.IR encoding ] +.I "key string" .PP -Save the specified \fIstring\fP to the register \fIkey\fP. See also the -\*Qpaste\*U command. +Save the specified \fIstring\fP to the register \fIkey\fP. +The encoding of the string can be specified via the \fB-e\fP option. +See also the \*Qpaste\*U command. .sp .ne 3 .B "remove" @@ -2262,6 +2418,25 @@ settings (like scroll regions or graphics character set) are left over from an application. .sp .ne 3 +.B "resize" +.PP +Resize the current region. The space will be removed from or added to +the region below or if there's not enough space from the region above. +.IP +resize +N increase current region height by N +.IP +resize -N decrease current region height by N +.IP +resize N set current region height to N +.IP +resize = make all windows equally high +.IP +resize max maximize current region height +.IP +resize min minimize current region height +.PP +.sp +.ne 3 .B "screen \fP[\fI-opts\fP] [\fIn\fP] [\fIcmd\fP [\fIargs\fP]]" .PP Establish a new window. @@ -2341,6 +2516,16 @@ If no parameters are specified, the user will be prompted for both variable and value. The environment is inherited by all subsequently forked shells. .sp .ne 3 +.BR "setsid " [ on | off ] +.PP +Normally screen uses different sessions and process groups for +the windows. If setsid is turned \fIoff\fP, this is not done +anymore and all windows will be in the same process group as the +screen backend process. This also breaks job-control, so be careful. +The default is \fIon\fP, of course. This command is probably useful +only in rare circumstances. +.sp +.ne 3 .B "shell \fIcommand\fP" .PP Set the command to be used to create a new shell. @@ -2394,23 +2579,27 @@ underlying system exposes flow control problems while pasting large amounts of text. .sp .ne 3 +.BI "source " file +.PP +Read and execute commands from file \fIfile\fP. Source commands may +be nested to a maximum recursion level of ten. If file is not an +absolute path and screen already processes a source command, the +parent directory of the running source command file is used to search +for the new command file before screen's current directory. + +Note that termcap/terminfo/termcapinfo commands only work at +startup and reattach time, so they must be reached via the +default screenrc files to have an effect. +.sp +.ne 3 .B sorendition .RB [ "\fIattr\fR " [ \fIcolor ]] .PP Change the way .I screen does highlighting for text marking and printing messages. -.I Attr -is a hexadecimal number and describes the attributes (inverse, -underline, ...) the text will get. -.I Color -is a 2 digit number and changes the -foreground/background of the highlighted text. -Some knowledge of -.IR screen 's -internal character representation is -needed to make the characters appear in the desired way. The default -is currently 10 99 (standout, default colors). +See the \*QSTRING ESCAPES\*U chapter for the syntax of the modifiers. +The default is currently \*Q=s dd\*U (standout, default colors). .sp .ne 3 .B split @@ -2583,10 +2772,15 @@ man page for more information on termcap definitions. .sp .ne 3 .B time +.RI [ string ] .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. + +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 +"%c:%s %M %d %H%? %l%?". .sp .ne 3 .BR "title " [ \fIwindowalias ] @@ -2603,6 +2797,19 @@ releases. Unset an environment variable. .sp .ne 3 +.B utf8 +.RB [ on | off +.RB [ on | off ]] +.PP +Change the encoding used in the current window. If utf8 is enabled, the +strings sent to the window will be UTF-8 encoded and vice versa. Omitting the +parameter toggles the setting. If a second parameter is given, the display's +encoding is also changed (this should rather be done with screen's \*Q-U\*U +option). +See also \*Qdefutf8\*U, which changes the default setting of a new +window. +.sp +.ne 3 .B vbell .RB [ on | off ] .PP @@ -2653,12 +2860,45 @@ Write a message to all displays. The message will appear in the terminal's status line. .sp .ne 3 -.BR "width " [ \fInum ] +.B width +.RB [ -w | -d ] +.RI [ cols " [" lines ]] .PP -Toggle the window width between 80 and 132 columns or set it to \fInum\fP +Toggle the window width between 80 and 132 columns or set it to \fIcols\fP columns if an argument is specified. This requires a capable terminal and the termcap entries \*QZ0\*U and \*QZ1\*U. -See the \*Qtermcap\*U command for more information. +See the \*Qtermcap\*U command for more information. You can also specify +a new height if you want to change both values. +The +.B -w +option tells screen to leave the display size unchanged and just set +the window size, +.B -d +vice versa. +.sp +.ne 3 +.B windowlist +.RB [ -b "] |" +.B string +.RI [ string "] |" +.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. +If the +.B -b +option is given, screen will switch to the blank window before +presenting the list, so that the current window is also selectable. + +The table format can be changed with the \fBstring\fP and +\fBtitle\fP option, the title is displayed as table heading, while +the lines are made by using the string setting. The default +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). .sp .ne 3 .B windows @@ -2690,11 +2930,16 @@ Default is `on'. .sp .ne 3 .B writebuf +.RB [ -e +.IR encoding ] +.RI [ filename ] .PP -Writes the contents of the paste buffer to a public accessible screen-exchange -file. This is thought of as a primitive means of communication between +Writes the contents of the paste buffer to the specified file, or the public accessible screen-exchange +file if no filename is given. This is thought of as a primitive means of communication between .I screen -users on the same host. The filename can be set with the \fIbufferfile\fP +users on the same host. If an encoding is specified the paste buffer +is recoded on the fly to match the encoding. +The filename can be set with the \fIbufferfile\fP command and defaults to \*Q/tmp/screen-exchange\*U. .sp .ne 3 @@ -2897,8 +3142,14 @@ current time HH:MM in 12h format day number .IP D weekday name +.IP f +flags of the window +.IP F +sets %? to true if the window has the focus .IP h hardstatus of the window +.IP H +hostname of the system .IP l current load of the system .IP m @@ -2914,7 +3165,9 @@ window title .IP u all other users on this window .IP w -all window numbers and names +all window numbers and names. With '-' quailifier: up to the current +window; with '+' qualifier: starting with the window after the current +one. .IP W all window numbers and names except the current one .IP y @@ -2926,12 +3179,122 @@ the part to the next '%?' is displayed only if an escape expands to an nonempty string .IP : else part of '%?' +.IP = +pad the string to the display's width (like TeX's hfill). If a +number is specified, pad to the percentage of the window's width. +A '0' qualifier tells screen to treat the number as absolute position. +You can specify to pad relative to the last absolute pad position +by adding a '+' qualifier or to pad relative to the right margin +by using '-'. The padding truncates the string if the specified +position lies before the current position. Add the 'L' qualifier +to change this. +.IP < +same as '%=' but just do truncation, do not fill with spaces +.IP > +mark the current text position for the next truncation. When +screen needs to do truncation, it tries to do it in a way that +the marked position gets moved to the specified percentage of +the output area. (The area starts from the last absolute pad +position and ends with the position specified by the truncation +operator.) The 'L' qualifier tells screen to mark the truncated +parts with '...'. +.IP { +attribute/color modifier string terminated by the next \*Q}\*U .P The 'c' and 'C' escape may be qualified with a '0' to make .I screen -use zero instead of space as fill character. The 'n' escape understands -a length qualifier (e.g. '%3n'). - +use zero instead of space as fill character. The '0' qualifier +also makes the '=' escape use absolute positions. The 'n' and '=' +escapes understand +a length qualifier (e.g. '%3n'), 'D' and 'M' can be prefixed with 'L' +to generate long names, 'w' and 'W' also show the window flags +if 'L' is given. +.PP +An attribute/color modifier is is used to change the attributes or the +color settings. Its format +is \*Q[attribute modifier] [color description]\*U. The attribute modifier +must be prefixed by a change type indicator if it can be confused with +a color desciption. The following change types are known: +.IP + +add the specified set to the current attributes +.IP - +remove the set from the current attributes +.IP ! +invert the set in the current attributes +.IP = +change the current attributes to the specified set +.PP +The attribute set can either be specified as a hexadecimal number or +a combination of the following letters: +.IP u +underline +.PD 0 +.IP b +bold +.IP r +reverse +.IP s +standout +.IP B +blinking +.PD +.PP +Colors are coded either as a hexadecimal number or two letters specifying +the desired background and foreground color (in that order). The following +colors are known: +.IP k +black +.PD 0 +.IP r +red +.IP g +green +.IP y +yellow +.IP b +blue +.IP m +magenta +.IP c +cyan +.IP w +white +.IP d +default color +.IP . +leave color unchanged +.PD +.PP +The capitalized versions of the letter specify bright colors. You can also +use the pseudo-color 'i' to set just the brightness and leave the color +unchanged. +.br +A one digit/letter color description is treated as foreground or +background color dependant on the current attributes: if reverse mode is +set, the background color is changed instead of the foreground color. +If you don't like this, prefix the color with a \*Q.\*U. If you want +the same behaviour for two-letter color descriptions, also prefix them +with a \*Q.\*U. +.br +As a special case, \*Q%{-}\*U restores the attributes and colors that +were set before the last change was made (i.e. pops one level of the +color-change stack). +.PP +Examples: +.IP "\*QG\*U" +set color to bright green +.IP "\*Q+b r\*U" +use bold red +.IP "\*Q= yd\*U" +clear all attributes, write in default color on yellow background. +.IP "%-Lw%{= BW}%50>%n%f* %t%{-}%+Lw%<" +The available windows centered at the current window and truncated to +the available width. The current window is displayed white on blue. +This can be used with \*Qhardstatus alwayslastline\*U. +.IP "%?%F%{.R.}%?%3n %t%? [%h]%?" +The window number and title and the window's hardstatus, if one is set. +Also use a red background if this is the active focus. Useful for +\*Qcaption string\*U. .SH "FLOW-CONTROL" Each window has a flow-control setting that determines how .I screen @@ -2958,8 +3321,8 @@ Each window has an initial flow-control value set with either the .B \-f option or the \*Qdefflow\*U .screenrc command. Per default the windows are set to automatic flow-switching. -It can then be toggled between the three states 'fixed on', 'fixed off' and -'automatic' interactively with the \*Qflow\*U command bound to "C-a f". +It can then be toggled between the three states 'fixed on', 'fixed off' +and 'automatic' interactively with the \*Qflow\*U command bound to "C-a f". .PP The automatic flow-switching mode deals with flow control using the TIOCPKT mode (like \*Qrlogin\*U does). If @@ -3347,9 +3710,15 @@ terminal without interpretation. .BR "ESC _" " (A)" Application Program Command (Hardstatus) .TP 27 -.BR "ESC ]" " (A)" +.BR "ESC ] 0 ; string ^G" " (A)" Operating System Command (Hardstatus, xterm title hack) .TP 27 +.BR "ESC ] 83 ; cmd ^G" " (A)" +Execute screen command. This only works if multi-user support is +compiled into screen. The pseudo-user \*Q:window:\*U is used to +check the access control list. Use \*Qaddacl :window: -rwx #?\*U to +create a user with no rights and allow only the needed commands. +.TP 27 .BR "Control-N" " (A)" Lock Shift G1 (SO) .TP 27 @@ -3410,6 +3779,9 @@ From Beginning of Line to Cursor \h'\w'ESC [ Pn = 'u'\fB2\fP Entire Line .TP 27 +.B "ESC [ \fPPn\fB X" +Erase character +.TP 27 .B "ESC [ \fPPn\fB A" Cursor Up .TP 27 @@ -3581,9 +3953,15 @@ Reverse Video \h'\w'ESC [ Ps = 'u'\fB?7\fP (V) \fIWrap\fP Mode .TP 27 +\h'\w'ESC [ Ps = 'u'\fB?9\fP +X10 mouse tracking +.TP 27 \h'\w'ESC [ Ps = 'u'\fB?25\fP (V) Visible Cursor .TP 27 +\h'\w'ESC [ Ps = 'u'\fB?1000\fP (V) +VT200 mouse tracking +.TP 27 .BR "ESC [ 5 i" " (A)" Start relay to printer (ANSI Media Copy) .TP 27 @@ -3652,9 +4030,8 @@ Function key 7 k7 stuff \e033[18~ Function key 8 k8 stuff \e033[19~ Function key 9 k9 stuff \e033[20~ Function key 10 k; stuff \e033[21~ -Function key 11 F1 stuff \e033[22~ -Function key 12 F2 stuff \e033[23~ -Backspace kb stuff \e010 +Function key 11 F1 stuff \e033[23~ +Function key 12 F2 stuff \e033[24~ Home kh stuff \e033[1~ End kH stuff \e033[4~ Insert kI stuff \e033[2~ @@ -3761,8 +4138,8 @@ Turn on autonuke. See the 'autonuke' command for more details. Set the output buffer limit. See the 'obuflimit' command for more details. .TP 13 .BI KJ " (str)" -Set the kanji type of the terminal. Valid strings are \*Qjis\*U, -\*Qeuc\*U and \*Qsjis\*U. +Set the encoding of the terminal. See the 'encoding' command for +valid encodings. .TP 13 .BI AF " (str)" Change character foreground color in an ANSI conform way. This @@ -3779,6 +4156,12 @@ Does understand ANSI set default fg/bg color (\eE[39m / \eE[49m). Describe a translation of characters to strings depending on the current font. More details follow in the next section. .TP 13 +.BI XT " (bool)" +Terminal understands special xterm sequences (OSC, mouse tracking). +.TP 13 +.BI C8 " (bool)" +Terminal needs bold to display high-intensity colors (e.g. Eterm). +.TP 13 .BI TF " (bool)" Add missing capabilities to the termcap/info entry. (Set by default). @@ -3817,8 +4200,8 @@ Here is an example: termcap hp700 'XC=B\eE(K%\eE(B,\e304[,\e326\e\e\e\e,\e334]' -This tells .I -screen +This tells +.I screen how to translate ISOlatin1 (charset 'B') upper case umlaut characters on a hp700 terminal that has a german charset. '\e304' gets translated to '\eE(K[\eE(B' and so on. @@ -3877,7 +4260,8 @@ Alternate system screenrc file. Terminal name. .IP TERMCAP Terminal description. - +.IP WINDOW +Window number of a window (at creation time). .SH FILES .PD 0 @@ -3929,7 +4313,7 @@ produced by Wayne Davison, Juergen Weigert and Michael Schroeder. .SH COPYLEFT .nf -Copyright (C) 1999 +Copyright (C) 1993-2002 Juergen Weigert (jnweiger@immd4.informatik.uni-erlangen.de) Michael Schroeder (mlschroe@immd4.informatik.uni-erlangen.de) Copyright (C) 1987 Oliver Laumann @@ -3976,12 +4360,14 @@ E. Tye McQueen (tye%spillman.UUCP@uunet.uu.net), Matthew Green (mrg@mame.mu.oz.au), Christopher Williams (cgw@unt.edu), Matt Mosley (mattm@access.digex.net), -Gregory Neil Shapiro (gshapiro@wpi.WPI.EDU). +Gregory Neil Shapiro (gshapiro@wpi.WPI.EDU), +Johannes Zellner (johannes@zellner.org), +Pablo Averbuj (pablo@averbuj.com). .fi .SH VERSION -This is version 3.9 Its roots are a merge of a custom version +This is version 3.9.9. 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. @@ -3989,11 +4375,11 @@ numbered 2.x are copyright by Oliver Laumann. .SH AVAILABILITY The latest official release of .I screen -available via anonymous ftp from prep.ai.mit.edu, nic.funet.fi or any other +available via anonymous ftp from gnudist.gnu.org, nic.funet.fi or any other .I GNU distribution site. The home site of .I screen -is ftp.uni-erlangen.de (131.188.3.71), in the directory +is ftp.uni-erlangen.de, in the directory pub/utilities/screen. The subdirectory `private' contains the latest beta testing release. If you want to help, send a note to screen@uni-erlangen.de. |