Document the onsilent/onactivity event.
[screen-lua.git] / src / doc / screen.1
blob314b75824db0ba40fc81a9d24aacb17c05570600
1 .\" vi:set wm=5
2 .TH SCREEN 1 "Aug 2003"
3 .if n .ds Q \&"
4 .if n .ds U \&"
5 .if t .ds Q ``
6 .if t .ds U ''
7 .UC 4
8 .SH NAME
9 screen \- screen manager with VT100/ANSI terminal emulation
12 .SH SYNOPSIS
13 .B screen
15 .B \-\fIoptions\fP
16 ] [
17 .B \fIcmd\fP
19 .B \fIargs\fP
20 ] ]
21 .br
22 .B screen \-r
23 [[\fIpid\fP\fB.\fP]\fItty\fP[\fB.\fP\fIhost\fP]]
24 .br
25 .B screen \-r
26 \fIsessionowner\fP\fB/\fP[[\fIpid\fP\fB.\fP]\fItty\fP[\fB.\fP\fIhost\fP]]
27 .ta .5i 1.8i
30 .SH DESCRIPTION
31 .I Screen
32 is a full-screen window manager that
33 multiplexes a physical terminal between several processes (typically
34 interactive shells).
35 Each virtual terminal provides the functions
36 of a DEC VT100 terminal and, in addition, several control functions
37 from the ISO 6429 (ECMA 48, ANSI X3.64) and ISO 2022 standards
38 (e.\|g. insert/delete line and support for multiple character sets).
39 There is a scrollback history buffer for each virtual terminal and a
40 copy-and-paste mechanism that allows moving text regions between
41 windows.
42 .PP
43 When
44 .I screen
45 is called, it creates a single window with a shell in it (or the specified
46 command) and then gets out of your way so that you can use the program as you
47 normally would.
48 Then, at any time, you can create new (full-screen) windows with other programs
49 in them (including more shells), kill existing windows, view a list of
50 windows, turn output logging on and off, copy-and-paste text between
51 windows, view the scrollback history, switch between windows
52 in whatever manner you wish, etc. All windows run their programs completely
53 independent of each other. Programs continue to run when their window
54 is currently not visible and even when the whole 
55 .I screen 
56 session is detached from the user's terminal.  When a program terminates,
57 .I screen
58 (per default) kills the window that contained it.
59 If this window was in the foreground, the display switches to the previous
60 window; if none are left,
61 .I screen
62 exits.
63 .PP
64 Everything you type is sent to the program running in the current window.
65 The only exception to this is the one keystroke that is used to initiate
66 a command to the window manager.
67 By default, each command begins with a control-a (abbreviated C-a from
68 now on), and is followed by one other keystroke.
69 The command character and all the key bindings can be fully customized
70 to be anything you like, though they are always two characters in length.
71 .PP
72 .I Screen
73 does not understand the prefix \*QC-\*U to mean control. 
74 Please use the caret notation (\*Q^A\*U instead of \*QC-a\*U) as arguments
75 to e.g. the 
76 .I escape
77 command or the \fI-e\fP option.
78 .I Screen
79 will also print out control characters in caret notation.
80 .PP
81 The standard way to create a new window is to type \*QC-a c\*U.
82 This creates a new window running a shell and switches to that
83 window immediately, regardless of the state of the process running
84 in the current window.
85 Similarly, you can create a new window with a custom command in it by
86 first binding the command to a keystroke (in your .screenrc file or at the
87 \*QC-a :\*U command line) and
88 then using it just like the \*QC-a c\*U command.
89 In addition, new windows can be created by running a command like:
90 .IP
91 screen emacs prog.c
92 .PP
93 from a shell prompt within a previously created window.
94 This will not run another copy of
95 .IR screen ,
96 but will instead supply the command name and its arguments to the window
97 manager (specified in the $STY environment variable) who will use it to
98 create the new window.
99 The above example would start the emacs editor (editing prog.c) and switch
100 to its window.
102 If \*Q/etc/utmp\*U is writable by
103 .IR screen ,
104 an appropriate record will be written to this file for each window, and
105 removed when the window is terminated.
106 This is useful for working with \*Qtalk\*U, \*Qscript\*U, \*Qshutdown\*U,
107 \*Qrsend\*U, \*Qsccs\*U and other similar programs that use the utmp
108 file to determine who you are. As long as
109 .I screen
110 is active on your terminal,
111 the terminal's own record is removed from the utmp file. See also \*QC-a L\*U.
114 .SH GETTING STARTED
115 Before you begin to use
116 .I screen
117 you'll need to make sure you have correctly selected your terminal type,
118 just as you would for any other termcap/terminfo program.
119 (You can do this by using
120 .IR tset
121 for example.)
123 If you're impatient and want to get started without doing a lot more reading,
124 you should remember this one command:  \*QC-a ?\*U.
125 Typing these two characters will display a list of the available
126 .I screen
127 commands and their bindings. Each keystroke is discussed in
128 the section \*QDEFAULT KEY BINDINGS\*U. The manual section \*QCUSTOMIZATION\*U
129 deals with the contents of your .screenrc.
131 If your terminal is a \*Qtrue\*U auto-margin terminal (it doesn't allow
132 the last position on the screen to be updated without scrolling the
133 screen) consider using a version of your terminal's termcap that has
134 automatic margins turned \fIoff\fP. This will ensure an accurate and
135 optimal update of the screen in all circumstances. Most terminals
136 nowadays have \*Qmagic\*U margins (automatic margins plus usable last
137 column). This is the VT100 style type and perfectly suited for
138 .IR screen .
139 If all you've got is a \*Qtrue\*U auto-margin terminal 
140 .I screen
141 will be content to use it, but updating a character put into the last
142 position on the screen may not be possible until the screen scrolls or
143 the character is moved into a safe position in some other way. This
144 delay can be shortened by using a terminal with insert-character
145 capability.
148 .SH "COMMAND-LINE OPTIONS"
149 Screen has the following command-line options:
150 .TP 5
151 .B \-a
152 include \fIall\fP capabilities (with some minor exceptions) in each
153 window's termcap, even if
154 .I screen
155 must redraw parts of the display in order to implement a function.
156 .TP 5
157 .B \-A
158 Adapt the sizes of all windows to the size of the current terminal.
159 By default,
160 .I screen
161 tries to restore its old window sizes when attaching to resizable terminals
162 (those with \*QWS\*U in its description, e.g. suncmd or some xterm).
163 .TP 5
164 .BI "\-c " file
165 override the default configuration file from \*Q$HOME/.screenrc\*U
166 to \fIfile\fP.
167 .TP 5
168 .BR \-d | \-D " [" \fIpid.tty.host ]
169 does not start
170 .IR screen ,
171 but detaches the elsewhere running
172 .I screen
173 session. It has the same effect as typing \*QC-a d\*U from
174 .IR screen 's
175 controlling terminal. \fB\-D\fP is the equivalent to the power detach key.
176 If no session can be detached, this option is ignored. In combination with the
177 \fB\-r\fP/\fB\-R\fP option more powerful effects can be achieved:
178 .TP 8
179 .B \-d \-r
180 Reattach a session and if necessary detach it first.
181 .TP 8
182 .B \-d \-R
183 Reattach a session and if necessary detach or even create it first.
184 .TP 8
185 .B \-d \-RR
186 Reattach a session and if necessary detach or create it. Use the first
187 session if more than one session is available.
188 .TP 8
189 .B \-D \-r
190 Reattach a session. If necessary detach and logout remotely first.
191 .TP 8
192 .B \-D \-R
193 Attach here and now. In detail this means: If a session is running, then
194 reattach. If necessary detach and logout remotely first.
195 If it was not running create it and notify the user. This is the
196 author's favorite.
197 .TP 8
198 .B \-D \-RR
199 Attach here and now. Whatever that means, just do it.
200 .IP "" 5
201 Note: It is always a good idea to check the status of your sessions by means of
202 \*Qscreen \-list\*U.
203 .TP 5
204 .BI "\-e " xy
205 specifies the command character to be \fIx\fP and the character generating a
206 literal command character to \fIy\fP (when typed after the command character).
207 The default is \*QC-a\*U and `a', which can be specified as \*Q-e^Aa\*U.
208 When creating a
209 .I screen
210 session, this option sets the default command character. In a multiuser
211 session all users added will start off with this command character. But
212 when attaching to an already running session, this option changes only
213 the command character of the attaching user.
214 This option is equivalent to either the commands \*Qdefescape\*U or
215 \*Qescape\*U respectively.
216 .TP 5
217 .BR \-f\fP ", " \-fn ", and " \-fa
218 turns flow-control on, off, or \*Qautomatic switching mode\*U.
219 This can also be defined through the \*Qdefflow\*U .screenrc command.
220 .TP 5
221 .BI "\-h " num
222 Specifies the history scrollback buffer to be \fInum\fP lines high.
223 .TP 5
224 .B \-i
225 will cause the interrupt key (usually C-c) to interrupt the display
226 immediately when flow-control is on.
227 See the \*Qdefflow\*U .screenrc command for details.
228 The use of this option is discouraged.
229 .TP 5
230 .BR \-l " and " \-ln
231 turns login mode on or off (for /etc/utmp updating).
232 This can also be defined through the \*Qdeflogin\*U .screenrc command.
233 .TP 5
234 .BR \-ls " and " \-list
235 does not start
236 .IR screen ,
237 but prints a list of
238 .I pid.tty.host
239 strings identifying your
240 .I screen
241 sessions.
242 Sessions marked `detached' can be resumed with \*Qscreen -r\*U. Those marked
243 `attached' are running and have a controlling terminal. If the session runs in 
244 multiuser mode, it is marked `multi'. Sessions marked as `unreachable' either
245 live on a different host or are `dead'.
246 An unreachable session is considered dead, when its name
247 matches either the name of the local host, or the specified parameter, if any.
248 See the \fB-r\fP flag for a description how to construct matches.
249 Sessions marked as `dead' should be thoroughly checked and removed. 
250 Ask your system administrator if you are not sure. Remove sessions with the 
251 \fB-wipe\fP option. 
252 .TP 5
253 .B \-L
254 tells
255 .I screen
256 to turn on automatic output logging for the windows.
257 .TP 5
258 .B \-m
259 causes
260 .I screen
261 to ignore the $STY environment variable. With \*Qscreen -m\*U creation of
262 a new session is enforced, regardless whether
263 .I screen
264 is called from within another
265 .I screen
266 session or not. This flag has a special meaning in connection
267 with the `-d' option:
268 .TP 8
269 .B \-d \-m
270 Start
271 .I screen
272 in \*Qdetached\*U mode. This creates a new session but doesn't
273 attach to it. This is useful for system startup scripts.
274 .TP 8
275 .B \-D \-m
276 This also starts screen in \*Qdetached\*U mode, but doesn't fork
277 a new process. The command exits if the session terminates.
278 .TP 5
279 .B \-O
280 selects a more optimal output mode for your terminal rather than true VT100
281 emulation (only affects auto-margin terminals without `LP').
282 This can also be set in your .screenrc by specifying `OP' in a \*Qtermcap\*U
283 command.
284 .TP 5
285 .BI "\-p " number_or_name
286 Preselect a window. This is useful when you want to reattach to a
287 specific window or you want to send a command via the \*Q-X\*U
288 option to a specific window. As with screen's select command, \*Q-\*U
289 selects the blank window. As a special case for reattach, \*Q=\*U
290 brings up the windowlist on the blank window.
291 .TP 5
292 .B \-q
293 Suppress printing of error messages. In combination with \*Q-ls\*U the exit 
294 value is as follows: 9 indicates a directory without sessions. 10 
295 indicates a directory with running but not attachable sessions. 11 (or more) 
296 indicates 1 (or more) usable sessions.
297 In combination with \*Q-r\*U the exit value is as follows: 10 indicates that 
298 there is no session to resume. 12 (or more) indicates that there are 2 (or 
299 more) sessions to resume and you should specify which one to choose. 
300 In all other cases \*Q-q\*U has no effect.
301 .TP 5
302 .BR \-r " [" \fIpid.tty.host ]
303 .PD 0
304 .TP 5
305 .BR \-r " \fIsessionowner/[" \fIpid.tty.host ]
307 resumes a detached
308 .I screen
309 session.  No other options (except combinations with \fB\-d\fP/\fB\-D\fP) may
310 be specified, though an optional prefix of [\fIpid.\fP]\fItty.host\fP
311 may be needed to distinguish between multiple detached
312 .I screen
313 sessions.  The second form is used to connect to another user's screen session
314 which runs in multiuser mode. This indicates that screen should look for
315 sessions in another user's directory. This requires setuid-root.
316 .TP 5
317 .B \-R
318 attempts to resume the first detached
319 .I screen
320 session it finds.  If successful, all other command-line options are ignored.
321 If no detached session exists, starts a new session using the specified
322 options, just as if
323 .B \-R
324 had not been specified. The option is set by default if
325 .I screen
326 is run as a login-shell (actually screen uses \*Q-xRR\*U in that case).
327 For combinations with the \fB\-d\fP/\fB\-D\fP option see there.
328 .TP 5
329 .B \-s
330 sets the default shell to the program specified, instead of the value
331 in the environment variable $SHELL (or \*Q/bin/sh\*U if not defined).
332 This can also be defined through the \*Qshell\*U .screenrc command.
333 .TP 5
334 .BI "\-S " sessionname
335 When creating a new session, this option can be used to specify a
336 meaningful name for the session. This name identifies the session for
337 \*Qscreen -list\*U and \*Qscreen -r\*U actions. It substitutes the
338 default [\fItty.host\fP] suffix.
339 .TP 5
340 .BI "\-t " name
341 sets the title (a.\|k.\|a.) for the default shell or specified program.
342 See also the \*Qshelltitle\*U .screenrc command.
343 .TP 5
344 .B \-U
345 Run screen in UTF-8 mode. This option tells screen that your terminal
346 sends and understands UTF-8 encoded characters. It also sets the default
347 encoding for new windows to `utf8'.
348 .TP 5
349 .B \-v
350 Print version number.
351 .TP 5
352 .BR \-wipe " [" \fImatch ]
353 does the same as \*Qscreen -ls\*U, but removes destroyed sessions instead of
354 marking them as `dead'.
355 An unreachable session is considered dead, when its name matches either 
356 the name of the local host, or the explicitly given parameter, if any.
357 See the \fB-r\fP flag for a description how to construct matches.
358 .TP 5
359 .B \-x
360 Attach to a not detached
361 .I screen
362 session. (Multi display mode).
363 .I Screen
364 refuses to attach from within itself. 
365 But when cascading multiple screens, loops are not detected; take care.
366 .TP 5
367 .B \-X
368 Send the specified command to a running screen session. You can use
369 the \fB-d\fP or \fB-r\fP option to tell screen to look only for
370 attached or detached screen sessions. Note that this command doesn't
371 work if the session is password protected.
374 .SH "DEFAULT KEY BINDINGS"
375 .ta 12n 26n
376 As mentioned, each
377 .I screen
378 command consists of a
379 \*QC-a\*U followed by one other character.
380 For your convenience, all commands that are bound to lower-case letters are
381 also bound to their control character counterparts (with the exception
382 of \*QC-a a\*U; see below), thus, \*QC-a c\*U as well as \*QC-a C-c\*U can
383 be used to create a window. See section \*QCUSTOMIZATION\*U for a description
384 of the command.
386 .TP 26n
387 The following table shows the default key bindings:
388 .IP "\fBC-a '\fP        (select)"
389 Prompt for a window name or number to switch to.
390 .IP "\fBC-a ""\fP       (windowlist -b)"
391 Present a list of all windows for selection.
392 .IP "\fBC-a 0\fP        (select 0)"
393 .PD 0
394 .IP "\fB ... \fP           ..."
395 .IP "\fBC-a 9\fP        (select 9)"
396 .IP "\fBC-a -\fP        (select -)"
398 Switch to window number 0 \- 9, or to the blank window.
399 .IP "\fBC-a tab\fP      (focus)"
401 Switch the input focus to the next region.
402 See also \fIsplit, remove, only\fP.
403 .IP "\fBC-a C-a\fP      (other)"
404 Toggle to the window displayed previously.
405 Note that this binding defaults to the command character typed twice,
406 unless overridden.  For instance, if you use the option \*Q\fB\-e]x\fP\*U,
407 this command becomes \*Q]]\*U.
408 .IP "\fBC-a a\fP        (meta)"
409 Send the command character (C-a) to window. See \fIescape\fP command.
410 .IP "\fBC-a A\fP        (title)"
411 Allow the user to enter a name for the current window.
412 .IP "\fBC-a b\fP"
413 .PD 0
414 .IP "\fBC-a C-b\fP      (break)"
416 Send a break to window.
417 .IP "\fBC-a B\fP        (pow_break)"
418 Reopen the terminal line and send a break.
419 .IP "\fBC-a c\fP"
420 .PD 0
421 .IP "\fBC-a C-c\fP      (screen)"
423 Create a new window with a shell and switch to that window.
424 .IP "\fBC-a C\fP        (clear)"
425 Clear the screen.
426 .IP "\fBC-a d\fP"
427 .PD 0
428 .IP "\fBC-a C-d\fP      (detach)"
430 Detach
431 .I screen
432 from this terminal.
433 .IP "\fBC-a D D\fP      (pow_detach)"
434 Detach and logout.
435 .IP "\fBC-a f\fP"
436 .PD 0
437 .IP "\fBC-a C-f\fP      (flow)"
439 Toggle flow \fIon\fP, \fIoff\fP or \fIauto\fP.
440 .IP "\fBC-a F\fP        (fit)"
441 Resize the window to the current region size.
442 .IP "\fBC-a C-g\fP      (vbell)"
443 Toggles
444 .I screen's
445 visual bell mode.
446 .IP "\fBC-a h\fP        (hardcopy)"
448 Write a hardcopy of the current window to the file \*Qhardcopy.\fIn\fP\*U.
449 .IP "\fBC-a H\fP        (log)"
450 Begins/ends logging of the current window to the file \*Qscreenlog.\fIn\fP\*U.
451 .IP "\fBC-a i\fP"
452 .PD 0
453 .IP "\fBC-a C-i\fP      (info)"
455 Show info about this window.
456 .IP "\fBC-a k\fP"
457 .PD 0
458 .IP "\fBC-a C-k\fP      (kill)"
460 Destroy current window.
461 .IP "\fBC-a l\fP"
462 .PD 0
463 .IP "\fBC-a C-l\fP      (redisplay)"
465 Fully refresh current window.
466 .IP "\fBC-a L\fP        (login)"
467 Toggle this windows login slot. Available only if
468 .I screen
469 is configured to update the utmp database.
470 .IP "\fBC-a m\fP"
471 .PD 0
472 .IP "\fBC-a C-m\fP      (lastmsg)"
474 Repeat the last message displayed in the message line.
475 .IP "\fBC-a M\fP        (monitor)"
476 Toggles monitoring of the current window.
477 .IP "\fBC-a space\fP"
478 .PD 0
479 .IP "\fBC-a n\fP"
480 .IP "\fBC-a C-n\fP      (next)"
482 Switch to the next window.
483 .IP "\fBC-a N\fP        (number)"
484 Show the number (and title) of the current window.
485 .IP "\fBC-a backspace\fP"
486 .PD 0
487 .IP "\fBC-a h\fP"
488 .IP "\fBC-a p\fP"
489 .IP "\fBC-a C-p\fP      (prev)"
491 Switch to the previous window (opposite of \fBC-a n\fP).
492 .IP "\fBC-a q\fP"
493 .PD 0
494 .IP "\fBC-a C-q\fP      (xon)"
496 Send a control-q to the current window.
497 .IP "\fBC-a Q\fP        (only)"
498 Delete all regions but the current one.
499 See also \fIsplit, remove, focus\fP.
500 .IP "\fBC-a r\fP"
501 .PD 0
502 .IP "\fBC-a C-r\fP      (wrap)"
504 Toggle the current window's line-wrap setting (turn the current window's
505 automatic margins on and off).
506 .IP "\fBC-a s\fP"
507 .PD 0
508 .IP "\fBC-a C-s\fP      (xoff)"
510 Send a control-s to the current window.
511 .IP "\fBC-a S\fP        (split)"
512 Split the current region into two new ones.
513 See also \fIonly, remove, focus\fP.
514 .IP "\fBC-a t\fP"
515 .PD 0
516 .IP "\fBC-a C-t\fP      (time)"
518 Show system information.
519 .IP "\fBC-a v\fP        (version)"
521 Display the version and compilation date.
522 .IP "\fBC-a C-v\fP      (digraph)"
524 Enter digraph.
525 .IP "\fBC-a w\fP"
526 .PD 0
527 .IP "\fBC-a C-w\fP      (windows)"
529 Show a list of window.
530 .IP "\fBC-a W\fP        (width)"
531 Toggle 80/132 columns.
532 .IP "\fBC-a x\fP"
533 .PD 0
534 .IP "\fBC-a C-x\fP      (lockscreen)"
536 Lock this terminal.
537 .IP "\fBC-a X\fP        (remove)"
538 Kill the current region.
539 See also \fIsplit, only, focus\fP.
540 .IP "\fBC-a z\fP"
541 .PD 0
542 .IP "\fBC-a C-z\fP      (suspend)"
544 Suspend
545 .IR screen .
546 Your system must support BSD-style job-control.
547 .IP "\fBC-a Z\fP        (reset)"
548 Reset the virtual terminal to its \*Qpower-on\*U values.
549 .IP "\fBC-a .\fP        (dumptermcap)"
550 Write out a \*Q.termcap\*U file.
551 .IP "\fBC-a ?\fP        (help)"
552 Show key bindings.
553 .IP "\fBC-a C-\e\fP     (quit)"
554 Kill all windows and terminate
555 .IR screen .
556 .IP "\fBC-a :\fP        (colon)"
557 Enter command line mode.
558 .IP "\fBC-a [\fP"
559 .PD 0
560 .IP "\fBC-a C-[\fP"
561 .IP "\fBC-a esc\fP      (copy)"
563 Enter copy/scrollback mode.
564 .IP "\fBC-a ]\fP        (paste .)"
566 Write the contents of the paste buffer to the stdin queue of the
567 current window. 
568 .IP "\fBC-a {\fP
569 .PD 0
570 .IP "\fBC-a }\fP        (history)"
572 Copy and paste a previous (command) line.
573 .IP "\fBC-a >\fP        (writebuf)"
574 Write paste buffer to a file.
575 .IP "\fBC-a <\fP        (readbuf)"
576 Reads the screen-exchange file into the paste buffer.
577 .IP "\fBC-a =\fP        (removebuf)"
578 Removes the file used by \fBC-a <\fP and \fPC-a >\fP.
579 .IP "\fBC-a ,\fP        (license)"
580 Shows where
581 .I screen
582 comes from, where it went to and why you can use it.
583 .IP "\fBC-a _\fP        (silence)"
584 Start/stop monitoring the current window for inactivity.
585 .IP "\fBC-a *\fP        (displays)"
586 Show a listing of all currently attached displays.
589 .SH CUSTOMIZATION
590 The \*Qsocket directory\*U defaults either to $HOME/.screen or simply to
591 /tmp/screens or preferably to /usr/local/screens chosen at compile-time. If
592 .I screen
593 is installed setuid-root, then the administrator
594 should compile
595 .I screen
596 with an adequate (not NFS mounted) socket directory. If
597 .I screen
598 is not running setuid-root, the user can specify any mode 700 directory
599 in the environment variable $SCREENDIR.
601 When
602 .I screen
603 is invoked, it executes initialization commands from the files
604 \*Q/usr/local/etc/screenrc\*U and
605 \*Q.screenrc\*U in the user's home directory. These are the \*Qprogrammer's
606 defaults\*U that can be overridden in the following ways: for the
607 global screenrc file 
608 .I screen
609 searches for the environment variable $SYSSCREENRC (this override feature
610 may be disabled at compile-time). The user specific
611 screenrc file is searched in $SCREENRC, then $HOME/.screenrc.
612 The command line option \fB-c\fP takes
613 precedence over the above user screenrc files.
615 Commands in these files are used to set options, bind functions to
616 keys, and to automatically establish one or more windows at the
617 beginning of your
618 .I screen
619 session.
620 Commands are listed one per line, with empty lines being ignored.
621 A command's arguments are separated by tabs or spaces, and may be
622 surrounded by single or double quotes.
623 A `#' turns the rest of the line into a comment, except in quotes.
624 Unintelligible lines are warned about and ignored.
625 Commands may contain references to environment variables. The 
626 syntax is the shell-like "$VAR " or "${VAR}". Note that this causes 
627 incompatibility with previous 
628 .I screen
629 versions, as now the '$'-character has to be protected with '\e' if no
630 variable substitution shall be performed. A string in single-quotes is also
631 protected from variable substitution.
633 Two configuration files are shipped as examples with your screen distribution:
634 \*Qetc/screenrc\*U and \*Qetc/etcscreenrc\*U. They contain a number of
635 useful examples for various commands.
637 Customization can also be done 'on-line'. To enter the command mode type
638 `C-a :'. Note that commands starting with \*Qdef\*U change default values,
639 while others change current settings.
641 The following commands are available:
642 .sp 
643 .ne 3
644 .BI acladd " usernames"
645 .RI [ crypted-pw ]
647 .BI addacl " usernames"
649 Enable users to fully access this screen session. \fIUsernames\fP can be one
650 user or a comma separated list of users. This command enables to attach to the
651 .I screen
652 session and performs the equivalent of `aclchg \fIusernames\fP +rwx \&"#?\&"'.
653 executed. To add a user with restricted access, use the `aclchg' command below.
654 If an optional second parameter is supplied, it should be a crypted password
655 for the named user(s). `Addacl' is a synonym to `acladd'.
656 Multi user mode only.
657 .sp 
658 .ne 3
659 .BI aclchg " usernames permbits list"
661 .BI chacl " usernames permbits list"
663 Change permissions for a comma separated list of users. Permission bits are
664 represented as `r', `w' and `x'. Prefixing `+' grants the permission, `-' 
665 removes it. The third parameter is a comma separated list of commands and/or
666 windows (specified either by number or title). The special list `#' refers to 
667 all windows, `?' to all commands. if \fIusernames\fP consists of a single `*',
668 all known users are affected.
669 A command can be executed when the user has the `x' bit for it.
670 The user can type input to a window when he has its `w' bit set and no other
671 user obtains a writelock for this window. 
672 Other bits are currently ignored.  
673 To withdraw the writelock from another user in window 2:
674 `aclchg \fIusername\fP -w+w 2'.
675 To allow read-only access to the session: `aclchg \fIusername\fP
676 -w \&"#\&"'. As soon as a user's name is known to 
677 .I screen 
678 he can attach to the session and (per default) has full permissions for all 
679 command and windows. Execution permission for the acl commands, `at' and others
680 should also be removed or the user may be able to regain write permission.
681 Rights of the special username
682 .B nobody
683 cannot be changed (see the \*Qsu\*U command).
684 `Chacl' is a synonym to `aclchg'.
685 Multi user mode only.
687 .ne 3
688 .BI acldel " username"
690 Remove a user from
691 .IR screen 's
692 access control list. If currently attached, all the
693 user's displays are detached from the session. He cannot attach again.
694 Multi user mode only.
696 .ne 3
697 .BI aclgrp " username"
698 .RI [ groupname ]
700 Creates groups of users that share common access rights. The name of the 
701 group is the username of the group leader. Each member of the group inherits
702 the permissions that are granted to the group leader. That means, if a user
703 fails an access check, another check is made for the group leader.
704 A user is removed from all groups the special value \*Qnone\*U is used for
705 .IR groupname .
706 If the second parameter is omitted all groups the user is in are listed.
708 .ne 3
709 .B aclumask
710 .RI [[ users ] +bits 
711 .RI |[ users ] -bits " .... ]"
713 .B umask
714 .RI [[ users ] +bits 
715 .RI |[ users ] -bits " .... ]"
717 This specifies the access other users have to windows that will be created by
718 the caller of the command.
719 .I Users
720 may be no, one or a comma separated list of known usernames. If no users are
721 specified, a list of all currently known users is assumed. 
722 .I Bits
723 is any combination of access control bits allowed defined with the 
724 \*Qaclchg\*U command. The special username \*Q?\*U predefines the access
725 that not yet known users will be granted to any window initially.
726 The special username \*Q??\*U predefines the access that not yet known 
727 users are granted to any command. 
728 Rights of the special username
729 .B nobody
730 cannot be changed (see the \*Qsu\*U command).
731 `Umask' is a synonym to `aclumask'.
733 .ne 3
734 .BI activity " message"
736 When any activity occurs in a background window that is being monitored,
737 .I screen
738 displays a notification in the message line.
739 The notification message can be re-defined by means of the \*Qactivity\*U
740 command.
741 Each occurrence of `%' in \fImessage\fP is replaced by
742 the number of the window in which activity has occurred,
743 and each occurrence of `^G' is replaced by the definition for bell
744 in your termcap (usually an audible bell).
745 The default message is
747         'Activity in window %n'
749 Note that monitoring is off for all windows by default, but can be altered
750 by use of the \*Qmonitor\*U command (C-a M).
752 .ne 3
753 .BR "allpartial on" | off
755 If set to on, only the current cursor line is refreshed on window change.
756 This affects all windows and is useful for slow terminal lines. The 
757 previous setting of full/partial refresh for each window is restored
758 with \*Qallpartial off\*U.  This is a global flag that immediately takes effect
759 on all windows overriding the \*Qpartial\*U settings. It does not change the
760 default redraw behavior of newly created windows.
762 .ne 3
763 .BR "altscreen on" | off
765 If set to on, "alternate screen" support is enabled in virtual terminals,
766 just like in xterm.  Initial setting is `off'.
768 .ne 3
769 .BR "at " "[\fIidentifier\fP][" "#\fP|\fP*\fP|\fP%\fP] "
770 .IR "command " [ args " ... ]"
772 Execute a command at other displays or windows as if it had been entered there.
773 \*QAt\*U changes the context (the `current window' or `current display'
774 setting) of the command. If the first parameter describes a 
775 non-unique context, the command will be executed multiple times. If the first 
776 parameter is of the form `\fIidentifier\fP*' then identifier is matched against
777 user names.  The command is executed once for each display of the selected 
778 user(s). If the first parameter is of the form `\fIidentifier\fP%' identifier 
779 is matched against displays. Displays are named after the ttys they 
780 attach. The prefix `/dev/' or `/dev/tty' may be omitted from the identifier.
781 If \fIidentifier\fP has a `#' or nothing appended it is matched against 
782 window numbers and titles. Omitting an identifier in front of the `#', `*' or 
783 `%'-character selects all users, displays or windows because a prefix-match is
784 performed. Note that on the affected display(s) a short message will describe
785 what happened. Permission is checked for initiator of the \*Qat\*U command,
786 not for the owners of the affected display(s).
787 Note that the '#' character works as a comment introducer when it is preceded by
788 whitespace. This can be escaped by prefixing a '\e'. 
789 Permission is checked for the initiator of the \*Qat\*U command, not for the
790 owners of the affected display(s).
792 Caveat: 
793 When matching against windows, the command is executed at least 
794 once per window. Commands that change the internal arrangement of windows
795 (like \*Qother\*U) may be called again. In shared windows the command will
796 be repeated for each attached display. Beware, when issuing toggle commands
797 like \*Qlogin\*U!
798 Some commands (e.g. \*Qprocess\*U) require that 
799 a display is associated with the target windows.  These commands may not work
800 correctly under \*Qat\*U looping over windows.
802 .ne 3
803 .BI "attrcolor " attrib
804 .RI [ "attribute/color-modifier" ]
806 This command can be used to highlight attributes by changing the color of
807 the text. If the attribute
808 .I attrib
809 is in use, the specified attribute/color modifier is also applied. If no
810 modifier is given, the current one is deleted. See the \*QSTRING ESCAPES\*U
811 chapter for the syntax of the modifier. Screen understands two
812 pseudo-attributes, \*Qi\*U stands for high-intensity foreground
813 color and \*QI\*U for high-intensity background color.
815 Examples:
817 attrcolor b "R"
819 Change the color to bright red if bold text is to be printed.
821 attrcolor u "-u b"
823 Use blue text instead of underline.
825 attrcolor b ".I"
827 Use bright colors for bold text. Most terminal emulators do this
828 already.
830 attrcolor i "+b"
832 Make bright colored text also bold.
834 .ne 3
835 .BR "autodetach on" | off
837 Sets whether 
838 .I screen
839 will automatically detach upon hangup, which
840 saves all your running programs until they are resumed with a
841 .B "screen -r"
842 command.
843 When turned off, a hangup signal will terminate 
844 .I screen
845 and all the processes it contains. Autodetach is on by default.
847 .ne 3
848 .BR "autonuke on" | off
850 Sets whether a clear screen sequence should nuke all the output
851 that has not been written to the terminal. See also
852 \*Qobuflimit\*U.
854 .ne 3
855 .BI "backtick " id
856 .I lifespan
857 .I autorefresh
858 .I cmd
859 .I args...
861 .BI "backtick " id
863 Program the backtick command with the numerical id \fIid\fP.
864 The output of such a command is used for substitution of the
865 \*Q%`\*U string escape. The specified \fIlifespan\fP is the number
866 of seconds the output is considered valid. After this time, the
867 command is run again if a corresponding string escape is encountered.
868 The \fIautorefresh\fP parameter triggers an
869 automatic refresh for caption and hardstatus strings after the
870 specified number of seconds. Only the last line of output is used
871 for substitution.
873 If both the \fIlifespan\fP and the \fIautorefresh\fP parameters
874 are zero, the backtick program is expected to stay in the
875 background and generate output once in a while.
876 In this case, the command is executed right away and screen stores
877 the last line of output. If a new line gets printed screen will
878 automatically refresh the hardstatus or the captions.
880 The second form of the command deletes the backtick command
881 with the numerical id \fIid\fP.
883 .ne 3
884 .BR "bce " [ on | off ]
886 Change background-color-erase setting. If \*Qbce\*U is set to on, all
887 characters cleared by an erase/insert/scroll/clear operation
888 will be displayed in the current background color. Otherwise
889 the default background color is used.
891 .ne 3
892 .B bell_msg
893 .RI [ message ]
895 When a bell character is sent to a background window,
896 .I screen
897 displays a notification in the message line.
898 The notification message can be re-defined by this command.
899 Each occurrence of `%' in \fImessage\fP is replaced by
900 the number of the window to which a bell has been sent,
901 and each occurrence of `^G' is replaced by the definition for bell
902 in your termcap (usually an audible bell).
903 The default message is
905         'Bell in window %n'
907 An empty message can be supplied to the \*Qbell_msg\*U command to suppress
908 output of a message line (bell_msg "").
909 Without parameter, the current message is shown.
911 .ne 3
912 .BI "bind "
913 .RB [ -c
914 .IR class ]
915 .I key 
916 .RI [ command " [" args ]]
918 Bind a command to a key.
919 By default, most of the commands provided by
920 .I screen
921 are bound to one or more keys as indicated in the \*QDEFAULT KEY BINDINGS\*U
922 section, e.\|g. the
923 command to create a new window is bound to \*QC-c\*U and \*Qc\*U.
924 The \*Qbind\*U command can be used to redefine the key bindings and to
925 define new bindings.
926 The \fIkey\fP argument is either a single character, a two-character sequence
927 of the form \*Q^x\*U (meaning \*QC-x\*U), a backslash followed by an octal
928 number (specifying the ASCII code of the character), or a backslash followed
929 by a second character, such as \*Q\e^\*U or \*Q\e\e\*U.
930 The argument can also be quoted, if you like.
931 If no further argument is given, any previously established binding
932 for this key is removed.
933 The \fIcommand\fP argument can be any command listed in this section.
935 If a command class is specified via the \*Q-c\*U option, the key
936 is bound for the specified class. Use the \*Qcommand\*U command
937 to activate a class. Command classes can be used to create multiple
938 command keys or multi-character bindings.
940 Some examples:
943         bind ' ' windows
944         bind ^k
945         bind k
946         bind K kill
947         bind ^f screen telnet foobar
948         bind \e033 screen -ln -t root -h 1000 9 su
951 would bind the space key to the command that displays a list
952 of windows (so that the command usually invoked by \*QC-a C-w\*U
953 would also be available as \*QC-a space\*U). The next three lines
954 remove the default kill binding from \*QC-a C-k\*U and \*QC-a k\*U. 
955 \*QC-a K\*U is then bound to the kill command. Then it
956 binds \*QC-f\*U to the command \*Qcreate a window with a TELNET
957 connection to foobar\*U, and bind \*Qescape\*U to the command
958 that creates an non-login window with a.\|k.\|a. \*Qroot\*U in slot #9, with
959 a superuser shell and a scrollback buffer of 1000 lines.
962         bind -c demo1 0 select 10
963         bind -c demo1 1 select 11
964         bind -c demo1 2 select 12
965         bindkey "^B" command -c demo1
968 makes \*QC-b 0\*U select window 10, \*QC-b 1\*U window 11, etc.
971         bind -c demo2 0 select 10
972         bind -c demo2 1 select 11
973         bind -c demo2 2 select 12
974         bind - command -c demo2
977 makes \*QC-a - 0\*U select window 10, \*QC-a - 1\*U window 11, etc.
979 .ne 3
980 .B bindkey
981 .RB [ -d ]
982 .RB [ -m ]
983 .RB [ -a ]
984 .RB [[ -k | -t ]
985 .I string
986 .RI [ "cmd args" ]]
988 This command manages screen's input translation tables. Every
989 entry in one of the tables tells screen how to react if a certain
990 sequence of characters is encountered. There are three tables:
991 one that should contain actions programmed by the user, one for
992 the default actions used for terminal emulation and one for
993 screen's copy mode to do cursor movement. See section
994 \*QINPUT TRANSLATION\*U for a list of default key bindings.
996 If the
997 .B -d
998 option is given, bindkey modifies the default table,
999 .B -m
1000 changes the copy mode table
1001 and with neither option the user table is selected.
1002 The argument
1003 .I string
1004 is the sequence of characters to which an action is bound. This
1005 can either be a fixed string or a termcap keyboard capability
1006 name (selectable with the
1007 .B -k
1008 option).
1010 Some keys on a VT100 terminal can send a different
1011 string if application mode is turned on (e.g the cursor keys).
1012 Such keys have two entries in the translation table. You can
1013 select the application mode entry by specifying the
1014 .B -a
1015 option.
1018 .B -t
1019 option tells screen not to do inter-character timing. One cannot
1020 turn off the timing if a termcap capability is used.
1022 .I Cmd
1023 can be any of screen's commands with an arbitrary number of
1024 .IR args .
1026 .I cmd
1027 is omitted the key-binding is removed from the table.
1029 Here are some examples of keyboard bindings:
1032         bindkey -d
1034 Show all of the default key bindings. The application mode entries
1035 are marked with [A].
1038         bindkey -k k1 select 1
1040 Make the "F1" key switch to window one.
1043         bindkey -t foo stuff barfoo
1045 Make "foo" an abbreviation of the word "barfoo". Timeout is disabled
1046 so that users can type slowly.
1049         bindkey "\e024" mapdefault
1051 This key-binding makes \*Q^T\*U an escape character for key-bindings. If
1052 you did the above \*Qstuff barfoo\*U binding, you can enter the word
1053 \*Qfoo\*U by typing \*Q^Tfoo\*U. If you want to insert a \*Q^T\*U
1054 you have to press the key twice (i.e., escape the escape binding).
1057         bindkey -k F1 command
1059 Make the F11 (not F1!) key an alternative screen
1060 escape (besides ^A).
1062 .ne 3
1063 .B break
1064 .RI [ duration ]
1066 Send a break signal for \fIduration\fP*0.25 seconds to this window.
1067 For non-Posix systems the time interval may be rounded up to full seconds.
1068 Most useful if a character device is attached to the window rather than 
1069 a shell process (See also chapter \*QWINDOW TYPES\*U). The maximum duration of
1070 a break signal is limited to 15 seconds.
1072 .ne 3
1073 .B blanker
1075 Activate the screen blanker. First the screen is cleared. If no blanker
1076 program is defined, the cursor is turned off, otherwise, the 
1077 program is started and it's output is written to the screen.
1078 The screen blanker is killed with the first keypress, the read key
1079 is discarded.
1081 This command is normally used together with the \*Qidle\*U command.
1083 .ne 3
1084 .B blankerprg
1085 .RI [ "program args" ]
1087 Defines a blanker program. Disables the blanker program if no
1088 arguments are given.
1090 .ne 3
1091 .B breaktype
1092 .RI [ tcsendbreak | TIOCSBRK
1093 .RI | TCSBRK ]
1095 Choose one of the available methods of generating a break signal for
1096 terminal devices. This command should affect the current window only.
1097 But it still behaves identical to \*Qdefbreaktype\*U. This will be changed in
1098 the future.
1099 Calling \*Qbreaktype\*U with no parameter displays the break method for the
1100 current window.
1102 .ne 3
1103 .B bufferfile
1104 .RI [ exchange-file ]
1106 Change the filename used for reading and writing with the paste buffer.
1107 If the optional argument to the \*Qbufferfile\*U command is omitted, 
1108 the default setting (\*Q/tmp/screen-exchange\*U) is reactivated.
1109 The following example will paste the system's password file into 
1111 .I screen
1112 window (using the paste buffer, where a copy remains):
1115         C-a : bufferfile /etc/passwd
1116         C-a < C-a ]
1117         C-a : bufferfile
1120 .ne 3
1121 .BR "c1 " [ on | off ]
1123 Change c1 code processing. \*QC1 on\*U tells screen to treat
1124 the input characters between 128 and 159 as control functions.
1125 Such an 8-bit code is normally the same as ESC followed by the
1126 corresponding 7-bit code. The default setting is to process c1
1127 codes and can be changed with the \*Qdefc1\*U command. 
1128 Users with fonts that have usable characters in the
1129 c1 positions may want to turn this off.
1131 .ne 3
1132 .BR "caption always" | splitonly
1133 .RI [ string ]
1135 .B "caption string"
1136 .RI [ string ]
1138 This command controls the display of the window captions. Normally
1139 a caption is only used if more than one window is shown on the
1140 display (split screen mode). But if the type is set to
1141 .B always
1142 screen shows a caption even if only one window is displayed. The default
1144 .BR splitonly .
1146 The second form changes the text used for the caption. You can use
1147 all escapes from the \*QSTRING ESCAPES\*U chapter. Screen uses
1148 a default of `%3n %t'.
1150 You can mix both forms by providing a string as an additional argument.
1152 .ne 3
1153 .BI "charset " set
1155 Change the current character set slot designation and charset
1156 mapping.  The first four character of
1157 .I set
1158 are treated as charset designators while the fifth and sixth
1159 character must be in range '0' to '3' and set the GL/GR charset
1160 mapping. On every position a '.' may be used to indicate that
1161 the corresponding charset/mapping should not be changed
1162 (\fIset\fP is padded to six characters internally by appending '.'
1163 chars). New windows have "BBBB02" as default charset, unless a
1164 \*Qencoding\*U command is active.
1166 The current setting can be viewed with the \*Qinfo\*U command.
1168 .ne 3
1169 .B chdir
1170 .RI [ directory ]
1172 Change the \fIcurrent directory\fP of
1173 .I screen
1174 to the specified directory or, if called without an argument,
1175 to your home directory (the value of the environment variable $HOME).
1176 All windows that are created by means of the \*Qscreen\*U command
1177 from within \*Q.screenrc\*U or by means of \*QC-a : screen ...\*U
1178 or \*QC-a c\*U use this as their default directory.
1179 Without a chdir command, this would be the directory from which
1180 .I screen
1181 was invoked.
1182 Hardcopy and log files are always written to the \fIwindow's\fP default
1183 directory, \fInot\fP the current directory of the process running in the
1184 window.
1185 You can use this command multiple times in your .screenrc to start various
1186 windows in different default directories, but the last chdir value will
1187 affect all the windows you create interactively.
1189 .ne 3
1190 .B clear
1192 Clears the current window and saves its image to the scrollback buffer.
1194 .ne 3
1195 .B colon
1196 .RI [ prefix ]
1198 Allows you to enter \*Q.screenrc\*U command lines. Useful 
1199 for on-the-fly modification of key bindings, 
1200 specific window creation and changing settings. Note that the \*Qset\*U
1201 keyword no longer exists! Usually commands affect the current window rather 
1202 than default settings for future windows. Change defaults with commands
1203 starting with 'def...'. 
1205 If you consider this as the `Ex command mode' of 
1206 .IR screen ,
1207 you may regard \*QC-a esc\*U (copy mode) as its `Vi command mode'.
1208 .sp 
1209 .ne 3
1210 .B command
1211 .RB [ -c
1212 .IR class ]
1214 This command has the same effect as typing the screen escape
1215 character (^A). It is probably only useful for key bindings.
1216 If the \*Q-c\*U option is given, select the specified command
1217 class.  See also \*Qbind\*U and \*Qbindkey\*U.
1218 .sp 
1219 .ne 3
1220 .BR "compacthist " [ on | off ]
1222 This tells screen whether to suppress trailing blank lines when
1223 scrolling up text into the history buffer.
1224 .sp 
1225 .ne 3
1226 .BR "console " [ on | off ]
1228 Grabs or un-grabs the machines console output to a window.
1229 .IR Note :
1230 Only the owner of /dev/console can grab the console output.
1231 This command is only available if the machine supports the ioctl TIOCCONS.
1233 .ne 3
1234 .B copy
1236 Enter copy/scrollback mode. This allows you to copy text from the current
1237 window and its history into the paste buffer. In this mode a vi-like
1238 `full screen editor' is active:
1240 .IR "Movement keys" :
1242 .in +4n
1243 .ti -2n
1244 \fBh\fP, \fBj\fP, \fBk\fP, \fBl\fP move the cursor line by line or 
1245 column by column.
1247 .ti -2n
1248 \fB0\fP, \fB^\fP and \fB$\fP move to the leftmost column, to the first or last
1249 non-whitespace character on the line.
1251 .ti -2n
1252 \fBH\fP, \fBM\fP and \fBL\fP move the cursor to the leftmost column
1253 of the top, center or bottom line of the window. 
1255 .ti -2n
1256 \fB+\fP and \fB\-\fP positions one line up and down.
1258 .ti -2n
1259 \fBG\fP moves to the specified absolute line (default: end of buffer).
1260 .br 
1261 .ti -2n
1262 \fB|\fP moves to the specified absolute column.
1264 .ti -2n
1265 \fBw\fP, \fBb\fP, \fBe\fP move the cursor word by word.
1266 .br 
1267 .ti -2n
1268 \fBB\fP, \fBE\fP move the cursor WORD by WORD (as in vi).
1269 .br 
1270 .ti -2n
1271 .\"\fBf\fP,\fBt\fP, \fBF\fP, \fBT\fP move the cursor forward/backward to the next occurence of the target.
1272 \fBf/F\fP, \fBt/T\fP move the cursor forward/backward to the next occurence of the target. (eg, '3fy' will 
1273 move the cursor to the 3rd 'y' to the right.)
1275 .ti -2n
1276 \fB;\fP \fB,\fP Repeat the last f/F/t/T command in the same/opposite direction.
1278 .ti -2n
1279 \fBC-u\fP and \fBC-d\fP scroll the display up/down by the specified amount of 
1280 lines while preserving the cursor position. (Default: half screen-full). 
1282 .ti -2n
1283 \fBC-b\fP and \fBC-f\fP scroll the display up/down a full screen.
1285 .ti -2n
1286 \fBg\fP moves to the beginning of the buffer.
1288 .ti -2n
1289 \fB%\fP jumps to the specified percentage of the buffer.
1291 .ti -4n
1293 .IR Note :
1295 Emacs style movement keys can be customized by a .screenrc command.
1296 (E.\|g. markkeys "h=^B:l=^F:$=^E") There is no simple method for a full 
1297 emacs-style keymap, as this involves multi-character codes.
1300 .ti -4n
1301 .IR Marking :
1303 The copy range is specified by setting two marks. The text between these marks 
1304 will be highlighted. Press 
1306 .ti -2n
1307 \fBspace\fP to set the first or second mark
1308 respectively.
1310 .ti -2n
1311 \fBY\fP and \fBy\fP used to mark one whole line or to mark from 
1312 start of line.
1314 .ti -2n
1315 \fBW\fP marks exactly one word. 
1316 .br 
1317 .ti -4n
1318 .IR "Repeat count" :
1320 Any of these commands can be prefixed with a repeat count number by pressing 
1321 digits 
1323 .ti -2n
1324 \fB0\fP..\fB9\fP which
1325 is taken as a repeat count. 
1327 Example: \*QC-a C-[ H 10 j 5 Y\*U will copy lines
1328 11 to 15 into the paste buffer.
1330 .ti -4n
1331 .IR Searching :
1332 .ti -2n
1333 \fB/\fP \fIVi\fP-like search forward.
1334 .ti -2n
1335 \fB?\fP \fIVi\fP-like search backward.
1336 .ti -2n 
1337 \fBC-a s\fP \fIEmacs\fP style incremental search forward.
1338 .ti -2n
1339 \fBC-r\fP \fIEmacs\fP style reverse i-search.
1340 .ti -4n
1341 .IR Specials :
1343 There are however some keys that act differently than in
1344 .IR vi .
1345 .I Vi
1346 does not allow one to yank rectangular blocks of text, but
1347 .I screen
1348 does. Press 
1350 .ti -2n
1351 \fBc\fP or \fBC\fP to set the left or right margin respectively. If no repeat count is
1352 given, both default to the current cursor position. 
1354 Example: Try this on a rather full text screen: 
1355 \*QC-a [ M 20 l SPACE c 10 l 5 j C SPACE\*U.
1357 This moves one to the middle line of the screen, moves in 20 columns left,
1358 marks the beginning of the paste buffer, sets the left column, moves 5 columns
1359 down, sets the right column, and then marks the end of
1360 the paste buffer. Now try:
1362 \*QC-a [ M 20 l SPACE 10 l 5 j SPACE\*U
1364 and notice the difference in the amount of text copied.
1366 .ti -2n
1367 \fBJ\fP joins lines. It toggles between 4 modes: lines separated by a
1368 newline character (012), lines glued seamless, lines separated by a single
1369 whitespace and comma separated lines. Note that you can prepend the newline
1370 character with a carriage return character, by issuing a \*Qcrlf on\*U.
1372 .ti -2n
1373 \fBv\fP is for all the
1374 .I vi 
1375 users with \*Q:set numbers\*U \- it toggles the left margin between column 9
1376 and 1. Press 
1378 .ti -2n
1379 \fBa\fP before the final space key to toggle in append mode. Thus
1380 the contents of the paste buffer will not be overwritten, but is appended to.
1382 .ti -2n
1383 \fBA\fP toggles in append mode and sets a (second) mark.
1385 .ti -2n
1386 \fB>\fP sets the (second) mark and writes the contents of the paste buffer to
1387 the screen-exchange file (/tmp/screen-exchange per default) once copy-mode is 
1388 finished. 
1390 This example demonstrates how to dump the whole scrollback buffer 
1391 to that file: \*QC-A [ g SPACE G $ >\*U.
1393 .ti -2n
1394 \fBC-g\fP gives information about the current line and column.
1396 .ti -2n
1397 \fBx\fP exchanges the first mark and the current cursor position. You
1398 can use this to adjust an already placed mark.
1400 .ti -2n
1401 \fB@\fP does nothing. Does not even exit copy mode.
1403 .ti -2n
1404 All keys not described here exit copy mode.
1405 .in -4n
1407 .ne 3
1408 .B copy_reg
1409 .RI [ key ]
1411 No longer exists, use \*Qreadreg\*U instead.
1413 .ne 3
1414 .BR "crlf " [ on | off ]
1416 This affects the copying of text regions with the `C-a [' command. If it is set
1417 to `on', lines will be separated by the two character sequence `CR' - `LF'. 
1418 Otherwise (default) only `LF' is used.
1419 When no parameter is given, the state is toggled.
1421 .ne 3
1422 .BR "debug on" | off
1424 Turns runtime debugging on or off. If 
1425 .I screen
1426 has been compiled with option -DDEBUG debugging available and is turned on per 
1427 default. Note that this command only affects debugging output from the main 
1428 \*QSCREEN\*U process correctly. Debug output from attacher processes can only
1429 be turned off once and forever.
1431 .ne 3
1432 .BR "defc1 on" | off
1434 Same as the \fBc1\fP command except that the default setting for new
1435 windows is changed. Initial setting is `on'.
1437 .ne 3
1438 .BR "defautonuke on" | off
1440 Same as the \fBautonuke\fP command except that the default setting for new displays is changed. Initial setting is `off'.
1441 Note that you can use the special `AN' terminal capability if you
1442 want to have a dependency on the terminal type.
1444 .ne 3
1445 .BR "defbce on" | off
1447 Same as the \fBbce\fP command except that the default setting for new
1448 windows is changed. Initial setting is `off'.
1450 .ne 3
1451 .B defbreaktype
1452 .RI [ tcsendbreak | TIOCSBRK
1453 .RI | TCSBRK ]
1455 Choose one of the available methods of generating a break signal for
1456 terminal devices. The preferred methods are 
1457 .IR tcsendbreak " and " TIOCSBRK .
1458 The third, 
1459 .IR TCSBRK , 
1460 blocks the complete 
1461 .I screen
1462 session for the duration
1463 of the break, but it may be the only way to generate long breaks. 
1464 .IR Tcsendbreak " and " TIOCSBRK
1465 may or may not produce long breaks with spikes (e.g. 4 per
1466 second). This is not only system-dependent, this also differs between
1467 serial board drivers.
1468 Calling \*Qdefbreaktype\*U with no parameter displays the current setting.
1470 .ne 3
1471 .BR "defcharset " [ \fIset ]
1473 Like the \fBcharset\fP command except that the default setting for
1474 new windows is changed. Shows current default if called without
1475 argument.
1477 .ne 3
1478 .BI "defescape " xy
1480 Set the default command characters. This is equivalent to the 
1481 \*Qescape\*U except that it is useful multiuser sessions only. In a
1482 multiuser session \*Qescape\*U changes the command character of the
1483 calling user, where \*Qdefescape\*U changes the default command
1484 characters for users that will be added later.
1486 .ne 3
1487 .BR "defflow on" | off | auto 
1488 .RB [ interrupt ]
1490 Same as the \fBflow\fP command except that the default setting for new windows 
1491 is changed. Initial setting is `auto'.
1492 Specifying \*Qdefflow auto interrupt\*U is the same as the command-line options
1493 .B \-fa
1495 .BR \-i . 
1497 .ne 3
1498 .BR "defgr on" | off
1500 Same as the \fBgr\fP command except that the default setting for new
1501 windows is changed. Initial setting is `off'.
1503 .ne 3
1504 .BR "defhstatus " [ \fIstatus ]
1506 The hardstatus line that all new windows will get is set to
1507 .I status\fR.
1508 This command is useful to make the hardstatus of every window
1509 display the window number or title or the like.
1510 .I Status
1511 may contain the same directives as in the window messages, but
1512 the directive escape character is '^E' (octal 005) instead of '%'.
1513 This was done to make a misinterpretation of program generated
1514 hardstatus lines impossible.
1515 If the parameter
1516 .I status
1517 is omitted, the current default string is displayed.
1518 Per default the hardstatus line of new windows is empty.
1520 .ne 3
1521 .BI "defencoding " enc
1523 Same as the \fBencoding\fP command except that the default setting for new
1524 windows is changed. Initial setting is the encoding taken from the
1525 terminal.
1527 .ne 3
1528 .BR "deflog on" | off
1530 Same as the \fBlog\fP command except that the default setting for new windows 
1531 is changed. Initial setting is `off'.
1533 .ne 3
1534 .BR "deflogin on" | off
1536 Same as the \fBlogin\fP command except that the default setting for new windows 
1537 is changed. This is initialized with `on' as distributed (see config.h.in).
1539 .ne 3
1540 .BI "defmode " mode
1542 The mode of each newly allocated pseudo-tty is set to \fImode\fP.
1543 \fIMode\fP is an octal number.
1544 When no \*Qdefmode\*U command is given, mode 0622 is used.
1546 .ne 3
1547 .BR "defmonitor on" | off
1549 Same as the \fBmonitor\fP command except that the default setting for new 
1550 windows is changed. Initial setting is `off'.
1552 .ne 3
1553 .B defnonblock 
1554 .BR on | off | \fInumsecs
1556 Same as the \fBnonblock\fP command except that the default setting for
1557 displays is changed. Initial setting is `off'.
1559 .ne 3
1560 .BI "defobuflimit " limit
1562 Same as the \fBobuflimit\fP command except that the default setting for new displays is changed. Initial setting is 256 bytes.
1563 Note that you can use the special 'OL' terminal capability if you
1564 want to have a dependency on the terminal type.
1566 .ne 3
1567 .BI "defscrollback " num
1569 Same as the \fBscrollback\fP command except that the default setting for new 
1570 windows is changed. Initial setting is 100.
1572 .ne 3
1573 .BI "defshell " command
1575 Synonym to the \fBshell\fP command. See there.
1577 .ne 3
1578 .BR "defsilence on" | off
1580 Same as the \fBsilence\fP command except that the default setting for new
1581 windows is changed. Initial setting is `off'.
1583 .ne 3
1584 .BI "defslowpaste " msec"
1586 Same as the \fBslowpaste\fP command except that the default setting for new
1587 windows is changed. Initial setting is 0 milliseconds, meaning `off'.
1589 .ne 3
1590 .BR "defutf8 on" | off
1592 Same as the \fButf8\fP command except that the default setting for new
1593 windows is changed. Initial setting is `on' if screen was started with
1594 \*Q-U\*U, otherwise `off'.
1596 .ne 3
1597 .BR "defwrap on" | off
1599 Same as the \fBwrap\fP command except that the default setting for new 
1600 windows is changed. Initially line-wrap is on and can be toggled with the 
1601 \*Qwrap\*U command (\*QC-a r\*U) or by means of "C-a : wrap on|off".
1603 .ne 3
1604 .BR "defwritelock on" | off | auto
1606 Same as the \fBwritelock\fP command except that the default setting for new 
1607 windows is changed. Initially writelocks will off.
1609 .ne 3
1610 .BR "defzombie " [\fIkeys\fP]
1612 Synonym to the \fBzombie\fP command. Both currently change the default.
1613 See there.
1615 .ne 3
1616 .B detach
1617 .RB [ -h ]
1619 Detach the 
1620 .I screen
1621 session (disconnect it from the terminal and put it into the background).
1622 This returns you to the shell where you invoked
1623 .IR screen .
1624 A detached
1625 .I screen
1626 can be resumed by invoking
1627 .I screen
1628 with the
1629 .B \-r
1630 option (see also section \*QCOMMAND-LINE OPTIONS\*U). The
1631 .B \-h
1632 option tells screen to immediately close the connection to the
1633 terminal (\*Qhangup\*U).
1635 .ne 3
1636 .B dinfo
1638 Show what screen thinks about your terminal. Useful if you want to know
1639 why features like color or the alternate charset don't work.
1641 .ne 3
1642 .B displays
1644 Shows a tabular listing of all currently connected user front-ends (displays).
1645 This is most useful for multiuser sessions.
1647 .ne 3
1648 .BR "digraph " [ \fIpreset [ \fI unicode-value ] ]
1650 This command prompts the user for a digraph sequence. The next
1651 two characters typed are looked up in a builtin table and the
1652 resulting character is inserted in the input stream. For example,
1653 if the user enters 'a"', an a-umlaut will be inserted. If the
1654 first character entered is a 0 (zero),
1655 .I screen
1656 will treat the following characters (up to three) as an octal
1657 number instead.  The optional argument
1658 .I preset
1659 is treated as user input, thus one can create an \*Qumlaut\*U key.
1660 For example the command "bindkey ^K digraph '"'" enables the user
1661 to generate an a-umlaut by typing CTRL-K a.
1662 When a non-zero
1663 .I unicode-value
1664 is specified, a new digraph is created with the specified preset. The digraph is unset
1665 if a zero value is provided for the
1666 .I unicode-value.
1668 .ne 3
1669 .B dumptermcap
1671 Write the termcap entry for the virtual terminal optimized for the currently
1672 active window to the file \*Q.termcap\*U in the user's 
1673 \*Q$HOME/.screen\*U directory (or wherever 
1674 .I screen
1675 stores its sockets. See the \*QFILES\*U section below).
1676 This termcap entry is identical to the value of the environment variable
1677 $TERMCAP that is set up by
1678 .I screen
1679 for each window. For terminfo based systems you will need to run a converter
1680 like 
1681 .IR captoinfo
1682 and then compile the entry with 
1683 .IR tic .
1685 .ne 3
1686 .BR "echo " [ -n ]
1687 .I message
1689 The echo command may be used to annoy 
1690 .I screen
1691 users with a 'message of the
1692 day'. Typically installed in a global /local/etc/screenrc. 
1693 The option \*Q-n\*U may be used to suppress the line feed.
1694 See also \*Qsleep\*U.
1695 Echo is also useful for online checking of environment variables.
1697 .ne 3
1698 .BI "encoding " enc
1699 .RI [ enc ]
1701 Tell 
1702 .I screen 
1703 how to interpret the input/output. The first argument
1704 sets the encoding of the current window. Each window can emulate
1705 a different encoding. The optional second parameter overwrites
1706 the encoding of the connected terminal. It should never be
1707 needed as screen uses the locale setting to detect the encoding.
1708 There is also a way to select a terminal encoding depending on
1709 the terminal type by using the \*QKJ\*U termcap entry.
1711 Supported encodings are eucJP, SJIS, eucKR, eucCN, Big5, GBK, KOI8-R,
1712 CP1251, UTF-8, ISO8859-2, ISO8859-3, ISO8859-4, ISO8859-5, ISO8859-6,
1713 ISO8859-7, ISO8859-8, ISO8859-9, ISO8859-10, ISO8859-15, jis.
1715 See also \*Qdefencoding\*U, which changes the default setting of a new
1716 window.
1718 .ne 3
1719 .BI "escape " xy
1721 Set the command character to \fIx\fP and the character generating a literal
1722 command character (by triggering the \*Qmeta\*U command) to \fIy\fP (similar
1723 to the \-e option).
1724 Each argument is either a single character, a two-character sequence
1725 of the form \*Q^x\*U (meaning \*QC-x\*U), a backslash followed by an octal
1726 number (specifying the ASCII code of the character), or a backslash followed
1727 by a second character, such as \*Q\e^\*U or \*Q\e\e\*U.
1728 The default is \*Q^Aa\*U.
1730 .ne 3
1731 .B eval
1732 .I command1
1733 .RI [ command2
1734 .IR ... ]
1736 Parses and executes each argument as separate command.
1738 .ne 3
1739 .B exec
1740 .RI [[ fdpat ]
1741 .IR "newcommand " [ "args ..." ]]
1743 Run a unix subprocess (specified by an executable path \fInewcommand\fP and its 
1744 optional arguments) in the current window. The flow of data between 
1745 newcommands stdin/stdout/stderr, the process originally started in the window 
1746 (let us call it "application-process") and screen itself (window) is 
1747 controlled by the file descriptor pattern fdpat.
1748 This pattern is basically a three character sequence representing stdin, stdout
1749 and stderr of newcommand. A dot (.) connects the file descriptor
1751 .IR screen .
1752 An exclamation mark (!) causes the file
1753 descriptor to be connected to the application-process. A colon (:) combines
1754 both.
1755 User input will go to newcommand unless newcommand receives the 
1756 application-process' 
1757 output (fdpats first character is `!' or `:') or a pipe symbol (|) is added 
1758 (as a fourth character) to the end of fdpat.
1760 Invoking `exec' without arguments shows name and arguments of the currently
1761 running subprocess in this window. Only one subprocess a time can be running
1762 in each window.
1764 When a subprocess is running the `kill' command will affect it instead of the
1765 windows process.
1767 Refer to the postscript file `doc/fdpat.ps' for a confusing illustration
1768 of all 21 possible combinations. Each drawing shows the digits 2,1,0
1769 representing the three file descriptors of newcommand. The box marked
1770 `W' is the usual pty that has the application-process on its slave side.
1771 The box marked `P' is the secondary pty that now has
1772 .I screen
1773 at its master side.
1775 Abbreviations: 
1777 Whitespace between the word `exec' and fdpat and the command 
1778 can be omitted. Trailing dots and a fdpat consisting only of dots can be 
1779 omitted. A simple `|' is synonymous for the pattern `!..|'; the word exec can
1780 be omitted here and can always be replaced by `!'.
1782 Examples:
1784 exec ... /bin/sh
1786 exec /bin/sh
1788 !/bin/sh
1790 Creates another shell in the same window, while the original shell is still 
1791 running. Output of both shells is displayed and user input is sent to the new
1792 /bin/sh.
1794 exec !.. stty 19200
1796 exec ! stty 19200
1798 !!stty 19200
1800 Set the speed of the window's tty. If your stty command operates on stdout, 
1801 then add another `!'.
1803 exec !..| less
1805 |less
1807 This adds a pager to the window output. The special character `|' is needed to
1808 give the user control over the pager although it gets its input from the 
1809 window's process. This works, because
1810 .I less
1811 listens on stderr (a behavior that
1812 .I screen
1813 would not expect without the `|') 
1814 when its stdin is not a tty. 
1815 .I Less 
1816 versions newer than 177 fail miserably here; good old
1817 .I pg
1818 still works.
1820 !:sed -n s/.*Error.*/\e007/p
1822 Sends window output to both, the user and the sed command. The sed inserts an
1823 additional bell character (oct. 007) to the window output seen by
1824 .IR screen .
1825 This will cause "Bell in window x" messages, whenever the string "Error"
1826 appears in the window.
1828 .ne 3
1829 .B fit
1831 Change the window size to the size of the current region. This
1832 command is needed because screen doesn't adapt the window size
1833 automatically if the window is displayed more than once.
1835 .ne 3
1836 .B flow
1837 .RB [ on | off | "auto\fR]\fP"
1839 Sets the flow-control mode for this window.
1840 Without parameters it cycles the current window's flow-control setting from 
1841 "automatic" to "on" to "off".
1842 See the discussion on \*QFLOW-CONTROL\*U later on in this document for full 
1843 details and note, that this is subject to change in future releases.
1844 Default is set by `defflow'.
1846 .ne 3
1847 .BR "focus " [ up | down | top | bottom ]
1849 Move the input focus to the next region. This is done in a cyclic
1850 way so that the top region is selected after the bottom one. If
1851 no subcommand is given it defaults to `down'. `up' cycles in the
1852 opposite order, `top' and `bottom' go to the top and bottom
1853 region respectively. Useful bindings are (j and k as in vi)
1855     bind j focus down
1856     bind k focus up
1857     bind t focus top
1858     bind b focus bottom
1860 Note that \fBk\fP is traditionally bound to the \fIkill\fP command.
1862 .ne 3
1863 .BR "gr " [ on | off ]
1865 Turn GR charset switching on/off. Whenever screen sees an input
1866 character with the 8th bit set, it will use the charset stored in the
1867 GR slot and print the character with the 8th bit stripped. The
1868 default (see also \*Qdefgr\*U) is not to process GR switching because
1869 otherwise the ISO88591 charset would not work.
1871 .ne 3
1872 .B hardcopy
1873 .RB [ -h ]
1874 .RI [ file ]
1876 Writes out the currently displayed image to the file \fIfile\fP,
1877 or, if no filename is specified, to \fIhardcopy.n\fP in the
1878 default directory, where \fIn\fP is the number of the current window. 
1879 This either appends or overwrites the file if it exists. See below.
1880 If the option \fB-h\fP is specified, dump also the contents of the
1881 scrollback buffer.
1883 .ne 3
1884 .BR "hardcopy_append on" | off
1886 If set to "on", 
1887 .I screen
1888 will append to the "hardcopy.n" files created by the command \*QC-a h\*U, 
1889 otherwise these files are overwritten each time.
1890 Default is `off'.
1892 .ne 3
1893 .BI "hardcopydir "directory
1895 Defines a directory where hardcopy files will be placed. If unset, hardcopys
1896 are dumped in
1897 .IR screen 's
1898 current working directory.
1900 .ne 3
1901 .BR "hardstatus " [ on | off ]
1903 .BR "hardstatus \fR[\fBalways\fR]\fBlastline" | message | ignore
1904 .RI [ string ]
1906 .B "hardstatus string"
1907 .RI [ string ]
1909 This command configures the use and emulation of the terminal's
1910 hardstatus line. The first form
1911 toggles whether
1912 .I screen
1913 will use the hardware status line to display messages. If the
1914 flag is set to `off', these messages
1915 are overlaid in reverse video mode at the display line. The default
1916 setting is `on'.
1918 The second form tells 
1919 .I screen 
1920 what to do if the terminal doesn't
1921 have a hardstatus line (i.e. the termcap/terminfo capabilities
1922 "hs", "ts", "fs" and "ds" are not set). If the type
1923 \*Qlastline\*U is used, 
1924 .I screen 
1925 will reserve the last line of the
1926 display for
1927 the hardstatus. \*Qmessage\*U uses 
1928 .I screen's
1929 message mechanism and
1930 \*Qignore\*U tells 
1931 .I screen 
1932 never to display the hardstatus.
1933 If you prepend the word \*Qalways\*U to the type (e.g., \*Qalwayslastline\*U), 
1934 .I screen 
1935 will use the type even if the terminal supports a hardstatus.
1937 The third form specifies the contents of the hardstatus line.  '%h' is
1938 used as default string, i.e., the stored hardstatus of the current
1939 window (settable via \*QESC]0;<string>^G\*U or \*QESC_<string>ESC\e\*U)
1940 is displayed.  You can customize this to any string you like including
1941 the escapes from the \*QSTRING ESCAPES\*U chapter. If you leave out
1942 the argument
1943 .IR string ,
1944 the current string is displayed.
1946 You can mix the second and third form by providing the string as
1947 additional argument.
1949 .ne 3
1950 .B height
1951 .RB [ -w | -d ]
1952 .RI [ lines " [" cols ]]
1954 Set the display height to a specified number of lines. When no argument
1955 is given it toggles between 24 and 42 lines display. You can also
1956 specify a width if you want to change both values.
1958 .B -w
1959 option tells screen to leave the display size unchanged and just set
1960 the window size,
1961 .B -d
1962 vice versa.
1964 .ne 3
1965 .B help
1966 .RB [ -c
1967 .IR class ]
1969 Not really a online help, but 
1970 displays a help 
1971 .I screen 
1972 showing you all the key bindings.
1973 The first pages list all the internal commands followed by their current
1974 bindings.
1975 Subsequent pages will display the custom commands, one command per key.
1976 Press space when you're done reading each page, or return to exit early.
1977 All other characters are ignored. If the \*Q-c\*U option is given,
1978 display all bound commands for the specified command class.
1979 See also \*QDEFAULT KEY BINDINGS\*U section.
1981 .ne 3
1982 .B history
1984 Usually users work with a shell that allows easy access to previous commands.
1985 For example csh has the command \*Q!!\*U to repeat the last command executed. 
1986 .I Screen
1987 allows you to have a primitive way of re-calling \*Qthe command that
1988 started ...\*U: You just type the first letter of that command, then hit
1989 `C-a {' and
1990 .I screen
1991 tries to find a previous line that matches with the `prompt character' 
1992 to the left of the cursor. This line is pasted into this window's input queue.
1993 Thus you have a crude command history (made up by the visible window and its
1994 scrollback buffer). 
1996 .ne 3
1997 .BI "hstatus " status
1999 Change the window's hardstatus line to the string \fIstatus\fP.
2001 .ne 3
2002 .B idle
2003 .RI [ timeout
2004 .RI [ "cmd args" ]]
2006 Sets a command that is run after the specified number of seconds
2007 inactivity is reached. This command will normally be the \*Qblanker\*U
2008 command to create a screen blanker, but it can be any screen command.
2009 If no command is specified, only the timeout is set. A timeout of
2010 zero (ot the special timeout \fBoff\fP) disables the timer.
2011 If no arguments are given, the current settings are displayed.
2013 .ne 3
2014 .BR "ignorecase " [ on | off ]
2016 Tell screen to ignore the case of characters in searches. Default is
2017 `off'.
2019 .ne 3
2020 .B info
2022 Uses the message line to display some information about the current window:
2023 the cursor position in the form \*Q(column,row)\*U starting with \*Q(1,1)\*U,
2024 the terminal width and height plus the size of the scrollback buffer in lines, 
2025 like in \*Q(80,24)+50\*U, the current state of window XON/XOFF flow control
2026 is shown like this (See also section FLOW CONTROL):
2029   +flow     automatic flow control, currently on.
2030   -flow     automatic flow control, currently off.
2031   +(+)flow  flow control enabled. Agrees with automatic control.
2032   -(+)flow  flow control disabled. Disagrees with automatic control.
2033   +(-)flow  flow control enabled. Disagrees with automatic control.
2034   -(-)flow  flow control disabled. Agrees with automatic control.
2037 The current line wrap setting (`+wrap' indicates enabled, `\-wrap' not) is
2038 also shown. The flags `ins', `org', `app', `log', `mon' or `nored' are 
2039 displayed when the window is in insert mode, origin mode, 
2040 application-keypad mode, has output logging,
2041 activity monitoring or partial redraw enabled.
2043 The currently active character set (\fIG0\fP, \fIG1\fP, \fIG2\fP,
2044 or \fIG3\fP) and in square brackets the terminal character sets that are
2045 currently designated as \fIG0\fP through \fIG3\fP is shown. If the window
2046 is in UTF-8 mode, the string \*QUTF-8\*U is shown instead.
2048 Additional modes depending on the type of the window are displayed at the end of the status line (See also chapter \*QWINDOW TYPES\*U).
2050 If the state machine of the terminal emulator is in a non-default state,
2051 the info line is started with a string identifying the current state.
2053 For system information use the \*Qtime\*U command.
2055 .ne 3
2056 .BR ins_reg " [" \fIkey ]
2058 No longer exists, use \*Qpaste\*U instead.
2060 .ne 3
2061 .B kill
2063 Kill current window.
2064 .br 
2065 If there is an `exec' command running then it is killed. Otherwise the process
2066 (shell) running in the window receives a HANGUP condition, 
2067 the window structure is removed and 
2068 .I screen 
2069 (your display) switches to another
2070 window.  When the last window is destroyed, 
2071 .I screen
2072 exits.
2073 After a kill 
2074 .I screen 
2075 switches to the previously displayed window.
2077 Note:
2078 .I Emacs
2079 users should keep this command in mind, when killing a line.
2080 It is recommended not to use \*QC-a\*U as the
2081 .I screen
2082 escape key or to rebind kill to \*QC-a K\*U.
2084 .ne 3
2085 .B lastmsg
2087 Redisplay the last contents of the message/status line.
2088 Useful if you're typing when a message appears, because  the message goes 
2089 away when you press a key (unless your terminal has a hardware status line).
2090 Refer to the commands \*Qmsgwait\*U and \*Qmsgminwait\*U for fine tuning.
2092 .ne 3
2093 .B license
2095 Display the disclaimer page. This is done whenever
2096 .I screen
2097 is started without options, which should be often enough. See also 
2098 the \*Qstartup_message\*U command.
2100 .ne 3
2101 .B lockscreen
2103 Lock this display.
2104 Call a screenlock program (/local/bin/lck or /usr/bin/lock or a builtin if no
2105 other is available). Screen does not accept any command keys until this program
2106 terminates. Meanwhile processes in the windows may continue, as the windows 
2107 are in the `detached' state. The screenlock program may be changed through the
2108 environment variable $LOCKPRG (which must be set in the shell from which 
2109 .I screen
2110 is started) and is executed with the user's uid and gid.
2112 Warning: 
2113 When you leave other shells unlocked and you have no password set on           
2114 .IR screen ,
2115 the lock is void: One could easily re-attach from an unlocked
2116 shell. This feature should rather be called `lockterminal'.
2118 .ne 3
2119 .BR "log " [ on | off ]
2121 Start/stop writing output of the current window to a file 
2122 \*Qscreenlog.\fIn\fP\*U in the window's default directory, where \fIn\fP 
2123 is the number of the current window. This filename can be changed with
2124 the `logfile' command. If no parameter is given, the state
2125 of logging is toggled. The session log is appended to the previous contents 
2126 of the file if it already exists. The current contents and the contents 
2127 of the scrollback history are not included in the session log.
2128 Default is `off'.
2130 .ne 3
2131 .BI "logfile " filename
2133 .BI "logfile flush " secs
2135 Defines the name the log files will get. The default is
2136 \*Qscreenlog.%n\*U. The second form changes the number of seconds
2137 .I screen
2138 will wait before flushing the logfile buffer to the file-system. The
2139 default value is 10 seconds.
2141 .ne 3
2142 .BR "login " [ on | off ]
2144 Adds or removes the entry in the utmp database file for the current window.
2145 This controls if the window is `logged in'.
2146 When no parameter is given, the login state of the window is toggled.
2147 Additionally to that toggle, it is convenient having a `log in' and a `log out'
2148 key. E.\|g. `bind I login on' and `bind O login off' will map these
2149 keys to be C-a I and C-a O.
2150 The default setting (in config.h.in) should be \*Qon\*U for a 
2151 .I screen
2152 that runs under suid-root.
2153 Use the \*Qdeflogin\*U command to change the default login state for new 
2154 windows. Both commands are only present when 
2155 .I screen
2156 has been compiled with utmp support.
2158 .ne 3
2159 .BR "logtstamp " [ on | off ]
2161 .B "logtstamp after"
2162 .RI [ secs ]
2164 .B "logtstamp string"
2165 .RI [ string ]
2167 This command controls logfile time-stamp mechanism of 
2168 .I screen.
2170 time-stamps are turned \*Qon\*U, 
2171 .I screen 
2172 adds a string containing
2173 the current time to the logfile after two minutes of inactivity.
2174 When output continues and more than another two minutes have passed,
2175 a second time-stamp is added to document the restart of the
2176 output. You can change this timeout with the second form
2177 of the command. The third form is used for customizing the time-stamp
2178 string (`-- %n:%t -- time-stamp -- %M/%d/%y %c:%s --\\n' by
2179 default).
2181 .ne 3
2182 .B mapdefault
2184 Tell 
2185 .I screen 
2186 that the next input character should only be looked up
2187 in the default bindkey table. See also \*Qbindkey\*U.
2189 .ne 3
2190 .B mapnotnext
2192 Like mapdefault, but don't even look in the default bindkey table.
2194 .ne 3
2195 .B maptimeout
2196 .RI [ timo ]
2198 Set the inter-character timer for input sequence detection to a timeout
2200 .I timo
2201 ms. The default timeout is 300ms. Maptimeout with no arguments shows
2202 the current setting.
2203 See also \*Qbindkey\*U.
2205 .ne 3
2206 .BI "markkeys " string
2208 This is a method of changing the keymap used for copy/history mode.
2209 The string is made up of \fIoldchar\fP=\fInewchar\fP pairs which are
2210 separated by `:'. Example: The string \*QB=^B:F=^F\*U will change the 
2211 keys `C-b' and `C-f' to the vi style binding (scroll up/down fill page).
2212 This happens to be the default binding for `B' and `F'.
2213 The command \*Qmarkkeys h=^B:l=^F:$=^E\*U would set the mode for an emacs-style
2214 binding.
2215 If your terminal sends characters, that cause you to abort copy mode,
2216 then this command may help by binding these characters to do nothing.
2217 The no-op character is `@' and is used like this: \*Qmarkkeys
2218 @=L=H\*U if you do not want to use the `H' or `L' commands any longer.
2219 As shown in this example, multiple keys can be assigned to one function in a 
2220 single statement.
2222 .ne 3
2223 .BI "maxwin " num
2225 Set the maximum window number screen will create. Doesn't affect
2226 already existing windows. The number may only be decreased.
2228 .ne 3
2229 .B meta
2231 Insert the command character (C-a) in the current window's input stream.
2233 .ne 3
2234 .BR "monitor " [ on | off ]
2236 Toggles activity monitoring of windows.
2237 When monitoring is turned on and an affected window is switched into the
2238 background, you will receive the activity notification message in the
2239 status line at the first sign of output and the window will also be marked
2240 with an `@' in the window-status display.
2241 Monitoring is initially off for all windows.
2243 .ne 3
2244 .BI "msgminwait " sec
2246 Defines the time 
2247 .I screen 
2248 delays a new message when one message is currently displayed. 
2249 The default is 1 second.
2251 .ne 3
2252 .BI "msgwait " sec
2254 Defines the time a message is displayed if 
2255 .I screen
2256 is not disturbed by other activity. The default is 5 seconds.
2258 .ne 3
2259 .BR "multiuser on" | off
2261 Switch between singleuser and multiuser mode. Standard
2262 .I screen
2263 operation is singleuser. In multiuser mode the commands `acladd',
2264 `aclchg', `aclgrp' and `acldel'
2265 can be used to enable (and disable) other users accessing this 
2266 .I screen
2267 session. 
2269 .ne 3
2270 .BR "nethack on" | off
2272 Changes the kind of error messages used by
2273 .IR screen .
2274 When you are familiar with the game \*Qnethack\*U, you may enjoy the
2275 nethack-style messages which will often blur the facts a little, but are
2276 much funnier to read. Anyway, standard messages often tend to be unclear as
2277 well.
2279 This option is only 
2280 available if
2281 .I screen
2282 was compiled with the NETHACK flag defined. The
2283 default setting is then determined by the presence of the environment 
2284 variable $NETHACKOPTIONS.
2286 .ne 3
2287 .B next
2289 Switch to the next window.
2290 This command can be used repeatedly to cycle through the list of windows.
2292 .ne 3
2293 .B nonblock 
2294 .RB [ on | off | \fInumsecs ]
2296 Tell screen how to deal with user interfaces (displays) that cease to
2297 accept output. This can happen if a user presses ^S or a TCP/modem
2298 connection gets cut but no hangup is received. If nonblock is
2299 \fBoff\fP (this is the default) screen waits until the display
2300 restarts to accept the output. If nonblock is \fBon\fP, screen
2301 waits until the timeout is reached (\fBon\fP is treated as 1s). If the
2302 display still doesn't receive characters, screen will consider
2303 it \*Qblocked\*U and stop sending characters to it. If at
2304 some time it restarts to accept characters, screen will unblock
2305 the display and redisplay the updated window contents.
2307 .ne 3
2308 .BR "number " [ \fIn ]
2310 Change the current windows number. If the given number \fIn\fP is already 
2311 used by another window, both windows exchange their numbers. If no argument is
2312 specified, the current window number (and title) is shown.
2314 .ne 3
2315 .BR "obuflimit " [ \fIlimit ]
2317 If the output buffer contains more bytes than the specified limit, no
2318 more data will be
2319 read from the windows. The default value is 256. If you have a fast
2320 display (like xterm), you can set it to some higher value. If no
2321 argument is specified, the current setting is displayed.
2323 .ne 3
2324 .B only
2326 Kill all regions but the current one.
2328 .ne 3
2329 .B other
2331 Switch to the window displayed previously. If this window does no longer exist,
2332 \fIother\fP has the same effect as \fInext\fP.
2334 .ne 3
2335 .BR "partial on" | off
2337 Defines whether the display should be refreshed (as with \fIredisplay\fP) after
2338 switching to the current window. This command only affects the current window.
2339 To immediately affect all windows use the \fIallpartial\fP command.
2340 Default is `off', of course.  This default is fixed, as there is currently no 
2341 \fIdefpartial\fP command.
2343 .ne 3
2344 .BR "password " [ \fIcrypted_pw ]
2346 Present a crypted password in your \*Q.screenrc\*U file and
2347 .I screen
2348 will ask
2349 for it, whenever someone attempts to resume a detached. This is useful
2350 if you have privileged programs running under
2351 .I screen
2352 and you want to protect your session from reattach attempts by another user
2353 masquerading as your uid (i.e. any superuser.)
2354 If no crypted password is specified,
2355 .I screen
2356 prompts twice for typing a
2357 password and places its encryption in the paste buffer.
2358 Default is `none', this disables password checking.
2360 .ne 3
2361 .BR paste
2362 .RI [ registers " [" dest_reg ]]
2364 Write the (concatenated) contents of the specified registers to the stdin queue
2365 of the current window. The register '.' is treated as the
2366 paste buffer. If no parameter is given the user is prompted for a single 
2367 register to paste.
2368 The paste buffer can be filled with the \fIcopy\fP, \fIhistory\fP and 
2369 \fIreadbuf\fP commands. 
2370 Other registers can be filled with the \fIregister\fP, \fIreadreg\fP and 
2371 \fIpaste\fP commands.
2372 If \fIpaste\fP is called with a second argument, the contents of the specified
2373 registers is pasted into the named destination register rather than 
2374 the window. If '.' is used as the second argument, the displays paste buffer is
2375 the destination.
2376 Note, that \*Qpaste\*U uses a wide variety of resources: Whenever a second 
2377 argument is specified no current window is needed. When the source specification
2378 only contains registers (not the paste buffer) then there need not be a current 
2379 display (terminal attached), as the registers are a global resource. The 
2380 paste buffer exists once for every user.
2382 .ne 3
2383 .BR "pastefont " [ on | off ]
2385 Tell 
2386 .I screen 
2387 to include font information in the paste buffer. The
2388 default is not to do so. This command is especially useful for
2389 multi character fonts like kanji.
2391 .ne 3
2392 .B pow_break
2394 Reopen the window's terminal line and send a break condition. See `break'.
2396 .ne 3
2397 .B pow_detach
2399 Power detach. 
2400 Mainly the same as \fIdetach\fP, but also sends a HANGUP signal to
2401 the parent process of
2402 .IR screen .
2403 CAUTION: This will result in a logout, when 
2404 .I screen
2405 was started from your login shell.
2407 .ne 3
2408 .B pow_detach_msg
2409 .RI [ message ]
2411 The \fImessage\fP specified here is output whenever a `Power detach' was
2412 performed. It may be used as a replacement for a logout message or to reset 
2413 baud rate, etc. 
2414 Without parameter, the current message is shown.
2416 .ne 3
2417 .B prev
2419 Switch to the window with the next lower number.
2420 This command can be used repeatedly to cycle through the list of windows.
2422 .ne 3
2423 .B printcmd
2424 .RI [ cmd ]
2427 .I cmd
2428 is not an empty string, 
2429 .I screen 
2430 will not use the terminal capabilities
2431 \*Qpo/pf\*U if it detects an ansi print sequence
2432 .BR "ESC [ 5 i" ,
2433 but pipe the output into
2434 .IR cmd .
2435 This should normally be a command like \*Qlpr\*U or
2436 \*Q'cat > /tmp/scrprint'\*U.
2437 .B printcmd
2438 without a command displays the current setting.
2439 The ansi sequence
2440 .B "ESC \e"
2441 ends printing and closes the pipe.
2443 Warning: Be careful with this command! If other user have write
2444 access to your terminal, they will be able to fire off print commands.
2446 .ne 3
2447 .BR process " [" \fIkey ]
2449 Stuff the contents of the specified register into 
2450 .IR screen 's
2451 input queue. If no argument is given you are prompted for a
2452 register name. The text is parsed as if it had been typed in from the user's
2453 keyboard. This command can be used to bind multiple actions to a single key.
2455 .ne 3
2456 .B quit
2458 Kill all windows and terminate
2459 .IR screen .
2460 Note that on VT100-style terminals the keys C-4 and C-\e are identical.
2461 This makes the default bindings dangerous:
2462 Be careful not to type C-a C-4 when selecting window no. 4.
2463 Use the empty bind command (as in \*Qbind '^\e'\*U) to remove a key binding.
2465 .ne 3
2466 .B readbuf
2467 .RB [ -e
2468 .IR encoding ]
2469 .RI [ filename ]
2471 Reads the contents of the specified file into the paste buffer.
2472 You can tell screen the encoding of the file via the \fB-e\fP option.
2473 If no file is specified, the screen-exchange filename is used.
2474 See also \*Qbufferfile\*U command.
2476 .ne 3
2477 .B readreg 
2478 .RB [ -e
2479 .IR encoding ]
2480 .RI [ register " [" filename ]]
2482 Does one of two things, dependent on number of arguments: with zero or one
2483 arguments it it duplicates the paste buffer contents into the register specified
2484 or entered at the prompt. With two arguments it reads the contents of the named 
2485 file into the register, just as \fIreadbuf\fP reads the screen-exchange file
2486 into the paste buffer.
2487 You can tell screen the encoding of the file via the \fB-e\fP option.
2488 The following example will paste the system's password file into 
2489 the 
2490 .I screen 
2491 window (using register p, where a copy remains):
2494         C-a : readreg p /etc/passwd
2495         C-a : paste p
2498 .ne 3
2499 .B redisplay
2501 Redisplay the current window. Needed to get a full redisplay when in
2502 partial redraw mode.
2504 .ne 3
2505 .B register
2506 .RB [ -e
2507 .IR encoding ]
2508 .I "key string"
2510 Save the specified \fIstring\fP to the register \fIkey\fP.
2511 The encoding of the string can be specified via the \fB-e\fP option.
2512 See also the \*Qpaste\*U command.
2514 .ne 3
2515 .B "remove"
2517 Kill the current region. This is a no-op if there is only one region.
2519 .ne 3
2520 .B "removebuf"
2522 Unlinks the screen-exchange file used by the commands \*Qwritebuf\*U and 
2523 \*Qreadbuf\*U. 
2525 .ne 3
2526 .B "rendition bell" | monitor | so
2527 .RB "\fIattr\fR " [ \fIcolor ]
2529 Change the way
2530 .I screen
2531 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.
2532 The default for monitor is currently \*Q=b \*U (bold, active colors) and for bell \*Q=ub \*U (underline, bold and active colors).
2534 .ne 3
2535 .B "reset"
2536 .PP 
2537 Reset the virtual terminal to its \*Qpower-on\*U values. Useful when strange
2538 settings (like scroll regions or graphics character set) are left over from
2539 an application.
2541 .ne 3
2542 .B "resize"
2543 .PP 
2544 Resize the current region. The space will be removed from or added to
2545 the region below or if there's not enough space from the region above.
2547 resize +N       increase current region height by N
2549 resize -N       decrease current region height by N
2551 resize  N       set current region height to N
2553 resize  =       make all windows equally high
2555 resize  max     maximize current region height
2557 resize  min     minimize current region height
2560 .ne 3
2561 .B "screen \fP[\fI-opts\fP] [\fIn\fP] [\fIcmd\fP [\fIargs\fP]]"
2563 Establish a new window.
2564 The flow-control options (\fB\-f\fP, \fB\-fn\fP and \fB\-fa\fP),
2565 title (a.\|k.\|a.) option (\fB\-t\fP), login options (\fB-l\fP and \fB-ln\fP)
2566 , terminal type option (\fB-T\fP <term>), the all-capability-flag (\fB-a\fP)
2567 and scrollback option (\fB-h\fP <num>) may be specified with each command. 
2568 The option (\fB-M\fP) turns monitoring on for this window.
2569 The option (\fB-L\fP) turns output logging on for this window.
2570 If an optional number \fIn\fP in the range 0..9 is given, the window
2571 number \fIn\fP is assigned to the newly created window (or, if this
2572 number is already in-use, the next available number).
2573 If a command is specified after \*Qscreen\*U, this command (with the given
2574 arguments) is started in the window; otherwise, a shell is created.
2575 Thus, if your \*Q.screenrc\*U contains the lines
2578         # example for .screenrc:
2579         screen 1
2580         screen -fn -t foobar -L 2 telnet foobar
2583 .I screen
2584 creates a shell window (in window #1) and a window with a TELNET connection
2585 to the machine foobar (with no flow-control using the title \*Qfoobar\*U
2586 in window #2) and will write a logfile (\*Qscreenlog.2\*U) of the telnet 
2587 session.
2588 Note, that unlike previous versions of
2589 .I screen
2590 no additional default window is created when \*Qscreen\*U commands are 
2591 included in your \*Q.screenrc\*U file. When the initialization is completed,
2592 .I screen
2593 switches to the last window specified in your .screenrc file or, if none,
2594 opens a default window #0.
2596 Screen has built in some functionality of \*Qcu\*U and \*Qtelnet\*U.
2597 See also chapter \*QWINDOW TYPES\*U.
2599 .ne 3
2600 .B "scrollback \fP\fInum\fP"
2602 Set the size of the scrollback buffer for the current windows to \fInum\fP 
2603 lines. The default scrollback is 100 lines.
2604 See also the \*Qdefscrollback\*U command and use \*QC-a i\*U to view the 
2605 current setting.
2607 .ne 3
2608 .BR "select " [ \fIWindowID ]
2610 Switch to the window identified by \fIWindowID\fP.
2611 This can be a prefix of a window title (alphanumeric window name) or a
2612 window number.
2613 The parameter is optional and if omitted, you get prompted for an identifier. 
2614 When a new window is established, the first available number
2615 is assigned to this window.
2616 Thus, the first window can be activated by \*Qselect 0\*U.
2617 The number of windows is limited at compile-time by the MAXWIN
2618 configuration parameter.
2619 There are two special WindowIDs, \*Q-\*U selects the
2620 internal blank window and \*Q.\*U selects the current window. The
2621 latter is useful if used with screen's \*Q-X\*U option.
2624 .BR "sessionname " [ \fIname ]
2626 Rename the current session. Note, that for \*Qscreen -list\*U the
2627 name shows up with the process-id prepended. If the argument \*Qname\*U
2628 is omitted, the name of this session is displayed. Caution: The $STY 
2629 environment variables will still reflect the old name in pre-existing
2630 shells. This may result in 
2631 confusion. 
2632 The default is constructed from the tty and host names.
2634 .ne 3
2635 .B "setenv " 
2636 .RI [ var " [" string ]]
2638 Set the environment variable \fIvar\fP to value \fIstring\fP.
2639 If only \fIvar\fP is specified, the user will be prompted to enter a value.
2640 If no parameters are specified, the user will be prompted for both variable
2641 and value. The environment is inherited by all subsequently forked shells.
2643 .ne 3
2644 .BR "setsid " [ on | off ]
2646 Normally screen uses different sessions and process groups for
2647 the windows. If setsid is turned \fIoff\fP, this is not done
2648 anymore and all windows will be in the same process group as the
2649 screen backend process. This also breaks job-control, so be careful.
2650 The default is \fIon\fP, of course. This command is probably useful
2651 only in rare circumstances.
2653 .ne 3
2654 .B "shell \fIcommand\fP"
2656 Set the command to be used to create a new shell.
2657 This overrides the value of the environment variable $SHELL.
2658 This is useful if you'd like to run a tty-enhancer which is expecting to
2659 execute the program specified in $SHELL. If the command begins with
2660 a '-' character, the shell will be started as a login-shell.
2662 .ne 3
2663 .B "shelltitle \fItitle\fP"
2665 Set the title for all shells created during startup or by
2666 the C-A C-c command.
2667 For details about what a title is, see the discussion
2668 entitled \*QTITLES (naming windows)\*U.
2670 .ne 3
2671 .BR "silence " [ on | off "|\fIsec\fP]"
2673 Toggles silence monitoring of windows.
2674 When silence is turned on and an affected window is switched into the
2675 background, you will receive the silence notification message in the
2676 status line after a specified period of inactivity (silence). The default
2677 timeout can be changed with the `silencewait' command or by specifying a 
2678 number of seconds instead of `on' or `off'.
2679 Silence is initially off for all windows.
2681 .ne 3
2682 .BI "silencewait " sec
2684 Define the time that all windows monitored for silence should wait before
2685 displaying a message. Default 30 seconds.
2688 .B "sleep \fP\fInum\fP"
2690 This command will pause the execution of a .screenrc file for \fInum\fP seconds.
2691 Keyboard activity will end the sleep.
2692 It may be used to give users a chance to read the messages output by \*Qecho\*U.
2694 .ne 3
2695 .B "slowpaste \fImsec\fP"
2697 Define the speed at which text is inserted into the current window by the 
2698 paste ("C-a ]") command. 
2699 If the slowpaste value is nonzero text is written character by character.
2700 .I screen
2701 will make a pause of \fImsec\fP milliseconds after each single character write 
2702 to allow the application to process its input. Only use slowpaste if your 
2703 underlying system exposes flow control problems while pasting large amounts of 
2704 text. 
2706 .ne 3
2707 .BI "source " file
2709 Read and execute commands from file \fIfile\fP. Source commands may
2710 be nested to a maximum recursion level of ten. If file is not an
2711 absolute path and screen is already processing a source command, the
2712 parent directory of the running source command file is used to search
2713 for the new command file before screen's current directory.
2715 Note that termcap/terminfo/termcapinfo commands only work at
2716 startup and reattach time, so they must be reached via the
2717 default screenrc files to have an effect.
2719 .ne 3
2720 .B sorendition
2721 .RB [ "\fIattr\fR " [ \fIcolor ]]
2723 Change the way 
2724 .I screen 
2725 does highlighting for text marking and printing messages.
2726 See the \*QSTRING ESCAPES\*U chapter for the syntax of the modifiers.
2727 The default is currently \*Q=s dd\*U (standout, default colors).
2729 .ne 3
2730 .B split
2732 Split the current region into two new ones. All regions on the
2733 display are resized to make room for the new region. The blank
2734 window is displayed on the new region. Use the \*Qremove\*U or the
2735 \*Qonly\*U command to delete regions.
2736 Use \*Qfocus\*U to toggle between regions.
2738 .ne 3
2739 .B "startup_message on\fP|\fBoff"
2741 Select whether you want to see the copyright notice during startup.
2742 Default is `on', as you probably noticed.
2744 .ne 3
2745 .B stuff
2746 .I string
2748 Stuff the string
2749 .I string
2750 in the input buffer of the current window.
2751 This is like the \*Qpaste\*U command but with much less overhead.
2752 You cannot paste
2753 large buffers with the \*Qstuff\*U command. It is most useful for key
2754 bindings. See also \*Qbindkey\*U.
2756 .ne 3
2757 .B su
2758 .RB [ username " [" password
2759 .RB [ password2 ]]
2761 Substitute the user of a display. The command prompts for all parameters that
2762 are omitted. If passwords are specified as parameters, they have to be
2763 specified un-crypted. The first password is matched against the systems
2764 passwd database, the second password is matched against the 
2765 .I screen
2766 password as set with the commands \*Qacladd\*U or \*Qpassword\*U.
2767 \*QSu\*U may be useful for the 
2768 .I screen
2769 administrator to test multiuser setups.
2770 .\"                                             XXX removed in 3.8.0 XXX
2771 .\" but it is mainly used implicitly
2772 .\" by the \*Qconnect\*U command to identify users that access a remote session.
2773 When the identification fails, the user has access to the commands available
2774 for user
2775 .BR nobody .
2776 These are \*Qdetach\*U, \*Qlicense\*U, \*Qversion\*U, \*Qhelp\*U and
2777 \*Qdisplays\*U.
2779 .ne 3
2780 .B "suspend"
2782 Suspend
2783 .IR screen .
2784 The windows are in the `detached' state, while 
2785 .I screen
2786 is suspended. This feature relies on the shell being able to do job control.
2788 .ne 3
2789 .B "term \fIterm\fP"
2791 In each window's environment
2792 .I screen
2793 opens, the $TERM variable is set to \*Qscreen\*U by default. 
2794 But when no description for \*Qscreen\*U is installed in the local termcap
2795 or terminfo data base, you set $TERM to \- say \-
2796 \*Qvt100\*U. This won't do much harm, as 
2797 .I screen
2798 is VT100/ANSI compatible.
2799 The use of the \*Qterm\*U command is discouraged for non-default purpose.
2800 That is, one may want to specify special $TERM settings (e.g. vt100) for the
2801 next \*Qscreen rlogin othermachine\*U command. Use the command \*Qscreen -T vt100
2802 rlogin othermachine\*U rather than setting and resetting the default.
2804 .ne 3
2805 .BI termcap " term terminal-tweaks"
2806 .RI [ window-tweaks ]
2808 .BI terminfo " term terminal-tweaks"
2809 .RI [ window-tweaks ]
2811 .BI termcapinfo " term terminal-tweaks"
2812 .RI [ window-tweaks ]
2814 Use this command to modify your terminal's termcap entry without going
2815 through all the hassles involved in creating a custom termcap entry.
2816 Plus, you can optionally customize the termcap generated for the windows.
2817 You have to place these commands in one of the screenrc startup files, as
2818 they are meaningless once the terminal emulator is booted.  
2820 If your system works uses the terminfo database rather than termcap, 
2821 .I screen 
2822 will understand the `terminfo' command, which has the same effects as the
2823 `termcap' command.  Two separate commands are provided, as there are subtle
2824 syntactic differences, e.g. when parameter interpolation (using `%') is
2825 required. Note that termcap names of the capabilities have to be used
2826 with the `terminfo' command. 
2828 In many cases, where the arguments are valid in both terminfo and termcap
2829 syntax, you can use the command `termcapinfo', which is just a shorthand
2830 for a pair of `termcap' and `terminfo' commands with identical arguments.
2832 The first argument specifies which terminal(s) should be affected by this
2833 definition.
2834 You can specify multiple terminal names by separating them with `|'s.
2835 Use `*' to match all terminals and `vt*' to match all terminals that begin
2836 with \*Qvt\*U.
2838 Each \fItweak\fP argument contains one or more termcap defines (separated
2839 by `:'s) to be inserted at the start of the appropriate termcap entry,
2840 enhancing it or overriding existing values.
2841 The first tweak modifies your terminal's termcap, and contains definitions
2842 that your terminal uses to perform certain functions.
2843 Specify a null string to leave this unchanged (e.\|g. '').
2844 The second (optional) tweak modifies all the window termcaps, and should
2845 contain definitions that
2846 .I screen
2847 understands (see the \*QVIRTUAL TERMINAL\*U
2848 section).
2850 Some examples:
2852 termcap xterm*  LP:hs@
2854 Informs
2855 .I screen
2856 that all terminals that begin with `xterm' have firm auto-margins that
2857 allow the last position on the screen to be updated (LP), but they don't
2858 really have a status line (no 'hs' \- append `@' to turn entries off).
2859 Note that we assume `LP' for all terminal names that start with \*Qvt\*U,
2860 but only if you don't specify a termcap command for that terminal.
2862 termcap vt*  LP
2864 termcap vt102|vt220  Z0=\eE[?3h:Z1=\eE[?3l
2866 Specifies the firm-margined `LP' capability for all terminals that begin with
2867 `vt', and the second line will also add the escape-sequences to switch
2868 into (Z0) and back out of (Z1) 132-character-per-line mode if this is
2869 a VT102 or VT220.
2870 (You must specify Z0 and Z1 in your termcap to use the width-changing
2871 commands.)
2873 termcap vt100  ""  l0=PF1:l1=PF2:l2=PF3:l3=PF4
2875 This leaves your vt100 termcap alone and adds the function key labels to
2876 each window's termcap entry.
2878 termcap h19|z19  am@:im=\eE@:ei=\eEO  dc=\eE[P
2880 Takes a h19 or z19 termcap and turns off auto-margins (am@) and enables the
2881 insert mode (im) and end-insert (ei) capabilities (the `@' in the `im'
2882 string is after the `=', so it is part of the string).
2883 Having the `im' and `ei' definitions put into your terminal's termcap will
2884 cause
2885 .I screen
2886 to automatically advertise the character-insert capability in
2887 each window's termcap.
2888 Each window will also get the delete-character capability (dc) added to its
2889 termcap, which
2890 .I screen
2891 will translate into a line-update for the terminal
2892 (we're pretending it doesn't support character deletion).
2894 If you would like to fully specify each window's termcap entry, you should
2895 instead set the $SCREENCAP variable prior to running
2896 .IR screen .
2897 See the discussion on the \*QVIRTUAL TERMINAL\*U in this manual, and the termcap(5)
2898 man page for more information on termcap definitions.
2900 .ne 3
2901 .B time
2902 .RI [ string ]
2904 Uses the message line to display the time of day, the host name, and the load
2905 averages over 1, 5, and 15 minutes (if this is available on your system).
2906 For window specific information use \*Qinfo\*U.
2908 If a string is specified, it changes the format of the time report like it is
2909 described in the \*QSTRING ESCAPES\*U chapter. Screen uses a default of
2910 "%c:%s %M %d %H%? %l%?".
2912 .ne 3
2913 .BR "title " [ \fIwindowtitle ]
2915 Set the name of the current window to \fIwindowtitle\fP. If no name is 
2916 specified,
2917 .I screen
2918 prompts for one. This command was known as `aka' in previous
2919 releases.
2921 .ne 3
2922 .BI "unsetenv " var
2924 Unset an environment variable.
2926 .ne 3
2927 .B utf8
2928 .RB [ on | off
2929 .RB [ on | off ]]
2931 Change the encoding used in the current window. If utf8 is enabled, the
2932 strings sent to the window will be UTF-8 encoded and vice versa. Omitting the
2933 parameter toggles the setting. If a second parameter is given, the display's
2934 encoding is also changed (this should rather be done with screen's \*Q-U\*U
2935 option).
2936 See also \*Qdefutf8\*U, which changes the default setting of a new
2937 window.
2939 .ne 3
2940 .B vbell 
2941 .RB [ on | off ]
2943 Sets the visual bell setting for this window. Omitting the parameter
2944 toggles the setting. If vbell is switched on, but your terminal does not 
2945 support a visual bell, a `vbell-message' is displayed in the status line when
2946 the bell character (^G) is received.
2947 Visual bell support of a terminal is defined by the termcap variable `vb' 
2948 (terminfo: 'flash'). 
2950 Per default, vbell is off, thus the audible bell is used. 
2951 See also `bell_msg'.
2953 .ne 3
2954 .B vbell_msg
2955 .RI [ message ]
2957 Sets the visual bell message. \fImessage\fP is printed to the status line if
2958 the window receives a bell character (^G), vbell is set to \*Qon\*U, but the 
2959 terminal does not support a visual bell.
2960 The default message is \*QWuff, Wuff!!\*U.
2961 Without parameter, the current message is shown.
2963 .ne 3
2964 .BI "vbellwait " sec
2966 Define a delay in seconds after each display of 
2967 .IR screen 's
2968 visual bell message. The default is 1 second.
2970 .ne 3
2971 .B verbose
2972 .RB [ on | off ]
2974 If verbose is switched on, the command name is echoed, whenever a window
2975 is created (or resurrected from zombie state). Default is off.
2976 Without parameter, the current setting is shown.
2978 .ne 3
2979 .B version
2981 Print the current version and the compile date in the status line.
2983 .ne 3
2984 .BI "wall " "message"
2986 Write a message to all displays. The message will appear in the terminal's
2987 status line.
2989 .ne 3
2990 .B width
2991 .RB [ -w | -d ]
2992 .RI [ cols " [" lines ]]
2994 Toggle the window width between 80 and 132 columns or set it to \fIcols\fP 
2995 columns if an argument is specified. 
2996 This requires a capable terminal and the termcap entries \*QZ0\*U and \*QZ1\*U.
2997 See the \*Qtermcap\*U command for more information. You can also specify
2998 a new height if you want to change both values.
3000 .B -w
3001 option tells screen to leave the display size unchanged and just set
3002 the window size,
3003 .B -d
3004 vice versa.
3006 .ne 3
3007 .B windowlist
3008 .RB [ -b ]
3009 .RB [ -m ]
3011 .B windowlist
3012 .B string
3013 .RI [ string ]
3015 .B windowlist
3016 .B title
3017 .RI [ title ]
3019 Display all windows in a table for visual window selection. The
3020 desired window can be selected via the standard movement keys (see
3021 the \*Qcopy\*U command) and activated via the return key.
3022 If the 
3023 .B -b
3024 option is given, screen will switch to the blank window before
3025 presenting the list, so that the current window is also selectable.
3027 .B -m
3028 option changes the order of the windows, instead of sorting by
3029 window numbers screen uses its internal most-recently-used list.
3031 The table format can be changed with the \fBstring\fP and
3032 \fBtitle\fP option, the title is displayed as table heading, while
3033 the lines are made by using the string setting. The default
3034 setting is \*QNum Name%=Flags\*U for the title and \*Q%3n %t%=%f\*U
3035 for the lines.
3036 See the \*QSTRING ESCAPES\*U chapter for more codes (e.g. color
3037 settings).
3039 .ne 3
3040 .B windows
3042 Uses the message line to display a list of all the windows.
3043 Each window is listed by number with the name of process that has been
3044 started in the window (or its title);
3045 the current window is marked with a `*';
3046 the previous window is marked with a `-';
3047 all the windows that are \*Qlogged in\*U are marked with a `$';
3048 a background window that has received a bell is marked with a `!';
3049 a background window that is being monitored and has had activity occur
3050 is marked with an `@';
3051 a window which has output logging turned on is marked with `(L)'; 
3052 windows occupied by other users are marked with `&';
3053 windows in the zombie state are marked with `Z'.
3054 If this list is too long to fit on the terminal's status line only the
3055 portion around the current window is displayed.
3057 .ne 3
3058 .BR "wrap " [ on | off ]
3060 Sets the line-wrap setting for the current window.
3061 When line-wrap is on, the second consecutive printable character output at
3062 the last column of a line will wrap to the start of the following line.
3063 As an added feature, backspace (^H) will also wrap through the left margin
3064 to the previous line.
3065 Default is `on'.
3067 .ne 3
3068 .B writebuf
3069 .RB [ -e
3070 .IR encoding ]
3071 .RI [ filename ]
3073 Writes the contents of the paste buffer to the specified file, or the public accessible screen-exchange
3074 file if no filename is given. This is thought of as a primitive means of communication between
3075 .I screen
3076 users on the same host. If an encoding is specified the paste buffer
3077 is recoded on the fly to match the encoding.
3078 The filename can be set with the \fIbufferfile\fP
3079 command and defaults to \*Q/tmp/screen-exchange\*U.
3081 .ne 3
3082 .BR "writelock " [ on | "off\fR|\fBauto\fR]"
3084 In addition to access control lists, not all users may be able to write to
3085 the same window at once. Per default, writelock is in `auto' mode and
3086 grants exclusive input permission to the user who is the first to switch
3087 to the particular window. When he leaves the window, other users may obtain
3088 the writelock (automatically). The writelock of the current window is disabled
3089 by the command \*Qwritelock off\*U. If the user issues the command 
3090 \*Qwritelock on\*U he keeps the exclusive write permission while switching
3091 to other windows.
3093 .ne 3
3094 .B xoff
3096 .B xon
3098 Insert a CTRL-s / CTRL-q character to the stdin queue of the
3099 current window.
3101 .ne 3
3102 .B zmodem
3103 .RB [ off\fR|\fPauto\fR|\fPcatch\fR|\fPpass ]
3105 .B "zmodem sendcmd"
3106 .RI [ string ]
3108 .B "zmodem recvcmd"
3109 .RI [ string ]
3111 Define zmodem support for screen. Screen understands two different
3112 modes when it detects a zmodem request: \*Qpass\*U and \*Qcatch\*U.
3113 If the mode is set to \*Qpass\*U, screen will relay all data
3114 to the attacher until the end of the transmission is reached.
3115 In \*Qcatch\*U mode screen acts as a zmodem endpoint and starts
3116 the corresponding rz/sz commands. If the mode is set to \*Qauto\*U,
3117 screen will use \*Qcatch\*U if the window is a tty (e.g. a serial line),
3118 otherwise it will use \*Qpass\*U.
3120 You can define the templates screen uses in \*Qcatch\*U mode
3121 via the second and the third form.
3123 Note also that this is an experimental feature.
3125 .ne 3
3126 .BR "zombie " [\fIkeys\fP [ onerror ] ]
3128 .BR "defzombie " [\fIkeys\fP]
3130 Per default
3131 .I screen 
3132 windows are removed from the window list as soon as
3133 the windows process (e.g. shell) exits. When a string of two keys is 
3134 specified to the zombie command, `dead' windows will remain in the list.
3135 The \fBkill\fP command may be used to remove such a window. Pressing the 
3136 first key in the dead window has the same effect. When pressing the second 
3137 key, 
3138 .I screen 
3139 will attempt to resurrect the window. The process that was 
3140 initially running in the window will be launched again. Calling \fBzombie\fP
3141 without parameters will clear the zombie setting, thus making windows disappear 
3142 when their process exits.
3144 As the zombie-setting is manipulated globally for all windows, this command 
3145 should only be called \fBdefzombie\fP. Until we need this as a per window 
3146 setting, the commands \fBzombie\fP and \fBdefzombie\fP are synonymous.
3148 Optionally you can put the word \*Qonerror\*U after the keys. This will cause screen
3149 to monitor exit status of the process running in the window. If it exits normally ('0'), 
3150 the window disappears. Any other exit value causes the window to become a zombie.
3152 .SH "THE MESSAGE LINE"
3153 .I Screen
3154 displays informational messages and other diagnostics in a \fImessage line\fP.
3155 While this line is distributed to appear at the bottom of the screen,
3156 it can be defined to appear at the top of the screen during compilation.
3157 If your terminal has a status line defined in its termcap,
3158 .I screen
3159 will use this for displaying its messages, otherwise a line of the
3160 current screen will
3161 be temporarily overwritten and output will be momentarily interrupted. The
3162 message line is automatically removed after a few seconds delay, but it
3163 can also be removed early (on terminals without a status line) by beginning
3164 to type.
3166 The message line facility can be used by an application running in
3167 the current window by means of the ANSI \fIPrivacy message\fP
3168 control sequence.
3169 For instance, from within the shell, try something like:
3171 echo '<esc>^Hello world from window '$WINDOW'<esc>\e\e'
3173 where '<esc>' is an \fIescape\fP, '^' is a literal up-arrow,
3174 and '\e\e' turns into a single backslash.
3176 .SH "WINDOW TYPES"
3177 Screen provides three different window types. New windows are created with 
3178 .IR screen 's
3179 .B screen
3180 command (see also the entry in chapter \*QCUSTOMIZATION\*U). The first
3181 parameter to the 
3182 .B screen
3183 command defines which type of window is created. The different window types are
3184 all special cases of the normal type. They have been added in order
3185 to allow 
3186 .I screen 
3187 to be used efficiently as a console multiplexer with 100 or more windows.
3189 .IP \(bu 3
3190 The normal window contains a shell (default, if no parameter is given) or any
3191 other system command that could be executed from a shell (e.g.  
3192 .BR slogin ,
3193 etc...) 
3195 .IP \(bu
3196 If a tty (character special device) name (e.g. \*Q/dev/ttya\*U)
3197 is specified as the first parameter, then the window is directly connected to
3198 this device. 
3199 This window type is similar to \*Qscreen cu -l /dev/ttya\*U.
3200 Read and write access is required on the device node, an exclusive open is
3201 attempted on the node to mark the connection line as busy.
3202 An optional parameter is allowed consisting of a comma separated list of flags
3203 in the notation used by stty(1):
3205 .IP <baud_rate>         
3206 Usually 300, 1200, 9600 or 19200. This affects transmission as well as receive speed.
3207 .IP "cs8 or cs7"
3208 Specify the transmission of eight (or seven) bits per byte.
3209 .IP "ixon or -ixon"
3210 Enables (or disables) software flow-control (CTRL-S/CTRL-Q) for sending data.
3211 .IP "ixoff or -ixon"
3212 Enables (or disables) software flow-control for receiving data.
3213 .IP "istrip or -istrip"
3214 Clear (or keep) the eight bit in each received byte.
3216 You may want to specify as many of these options as applicable. Unspecified
3217 options cause the terminal driver to make up the parameter values of the
3218 connection.  These values are system dependent and may be in defaults or values
3219 saved from a previous connection.
3221 For tty windows, the 
3222 .B info
3223 command shows some of the modem control lines
3224 in the status line. These may include `RTS', `CTS', 'DTR', `DSR', `CD' and more.
3225 This depends on the available ioctl()'s and system header files as well as the
3226 on the physical capabilities of the serial board. 
3227 Signals that are logical low (inactive) have their name preceded by
3228 an exclamation mark (!), otherwise the signal is logical high (active).
3229 Signals not supported by the hardware but available to the ioctl() interface
3230 are usually shown low. 
3232 When the CLOCAL status bit is true, the whole set of modem signals is placed 
3233 inside curly braces ({ and }).
3234 When the CRTSCTS or TIOCSOFTCAR bit is set, the signals `CTS' or `CD' 
3235 are shown in parenthesis, respectively. 
3238 For tty windows, the command
3239 .B break
3240 causes the Data transmission line (TxD) to go low for a specified period of
3241 time. This is expected to be interpreted as break signal on the other side.
3242 No data is sent and no modem control line is changed when a 
3243 .B break
3244 is issued.
3246 .IP \(bu
3247 If the first parameter is \*Q//telnet\*U, the second parameter is expected to
3248 be a host name, and an optional third parameter may specify a TCP port number
3249 (default decimal 23).  Screen will connect to a server listening on the remote
3250 host and use the telnet protocol to communicate with that server.
3253 For telnet windows, the command
3254 .B info
3255 shows details about the connection in square brackets ([ and ]) at the end of
3256 the status line. 
3258 .IP b
3259 BINARY. The connection is in binary mode.
3260 .IP e
3261 ECHO. Local echo is disabled.
3262 .IP c
3263 SGA. The connection is in `character mode' (default: `line mode').
3264 .IP t
3265 TTYPE. The terminal type has been requested by the remote host.
3266 Screen sends the name \*Qscreen\*U unless instructed otherwise (see also
3267 the command `term').
3268 .IP w
3269 NAWS. The remote site is notified about window size changes.
3270 .IP f
3271 LFLOW. The remote host will send flow control information.
3272 (Ignored at the moment.)
3274 Additional flags for debugging are x, t and n (XDISPLOC, TSPEED and
3275 NEWENV).
3277 For telnet windows, the command
3278 .B break
3279 sends the telnet code IAC BREAK (decimal 243) to the remote host.
3282 This window type is only available if
3283 .I screen
3284 was compiled with the BUILTIN_TELNET option defined.
3288 .SH "STRING ESCAPES"
3289 Screen provides an escape mechanism to insert information like the
3290 current time into messages or file names. The escape character
3291 is '%' with one exception: inside of a window's hardstatus '^%' ('^E')
3292 is used instead.
3294 Here is the full list of supported escapes:
3295 .IP %
3296 the escape character itself
3297 .IP a
3298 either 'am' or 'pm'
3299 .IP A
3300 either 'AM' or 'PM'
3301 .IP c
3302 current time HH:MM in 24h format
3303 .IP C
3304 current time HH:MM in 12h format
3305 .IP d
3306 day number
3307 .IP D
3308 weekday name
3309 .IP f
3310 flags of the window
3311 .IP F
3312 sets %? to true if the window has the focus
3313 .IP h
3314 hardstatus of the window
3315 .IP H
3316 hostname of the system
3317 .IP l
3318 current load of the system
3319 .IP m
3320 month number
3321 .IP M
3322 month name
3323 .IP n
3324 window number
3325 .IP S
3326 session name
3327 .IP s
3328 seconds
3329 .IP t
3330 window title
3331 .IP u
3332 all other users on this window
3333 .IP w
3334 all window numbers and names. With '-' qualifier: up to the current
3335 window; with '+' qualifier: starting with the window after the current
3336 one.
3337 .IP W
3338 all window numbers and names except the current one
3339 .IP y
3340 last two digits of the year number
3341 .IP Y
3342 full year number
3343 .IP ?
3344 the part to the next '%?' is displayed only if a '%' escape
3345 inside the part expands to a non-empty string
3346 .IP :
3347 else part of '%?'
3348 .IP =
3349 pad the string to the display's width (like TeX's hfill). If a
3350 number is specified, pad to the percentage of the window's width.
3351 A '0' qualifier tells screen to treat the number as absolute position.
3352 You can specify to pad relative to the last absolute pad position
3353 by adding a '+' qualifier or to pad relative to the right margin
3354 by using '-'. The padding truncates the string if the specified
3355 position lies before the current position. Add the 'L' qualifier
3356 to change this.
3357 .IP <
3358 same as '%=' but just do truncation, do not fill with spaces
3359 .IP >
3360 mark the current text position for the next truncation. When
3361 screen needs to do truncation, it tries to do it in a way that
3362 the marked position gets moved to the specified percentage of
3363 the output area. (The area starts from the last absolute pad
3364 position and ends with the position specified by the truncation
3365 operator.) The 'L' qualifier tells screen to mark the truncated
3366 parts with '...'.
3367 .IP {
3368 attribute/color modifier string terminated by the next \*Q}\*U
3369 .IP `
3370 Substitute with the output of a 'backtick' command. The length
3371 qualifier is misused to identify one of the commands.
3373 The 'c' and 'C' escape may be qualified with a '0' to make 
3374 .I screen 
3375 use zero instead of space as fill character. The '0' qualifier
3376 also makes the '=' escape use absolute positions. The 'n' and '='
3377 escapes understand
3378 a length qualifier (e.g. '%3n'), 'D' and 'M' can be prefixed with 'L'
3379 to generate long names, 'w' and 'W' also show the window flags
3380 if 'L' is given.
3382 An attribute/color modifier is is used to change the attributes or the
3383 color settings. Its format
3384 is \*Q[attribute modifier] [color description]\*U. The attribute modifier
3385 must be prefixed by a change type indicator if it can be confused with
3386 a color description. The following change types are known:
3387 .IP +
3388 add the specified set to the current attributes
3389 .IP -
3390 remove the set from the current attributes
3391 .IP !
3392 invert the set in the current attributes
3393 .IP =
3394 change the current attributes to the specified set
3396 The attribute set can either be specified as a hexadecimal number or
3397 a combination of the following letters:
3398 .IP d
3400 .PD 0
3401 .IP u
3402 underline
3403 .IP b
3404 bold
3405 .IP r
3406 reverse
3407 .IP s
3408 standout
3409 .IP B
3410 blinking
3413 Colors are coded either as a hexadecimal number or two letters specifying
3414 the desired background and foreground color (in that order). The following
3415 colors are known:
3416 .IP k
3417 black
3418 .PD 0
3419 .IP r
3421 .IP g
3422 green
3423 .IP y
3424 yellow
3425 .IP b
3426 blue
3427 .IP m
3428 magenta
3429 .IP c
3430 cyan
3431 .IP w
3432 white
3433 .IP d
3434 default color
3435 .IP .
3436 leave color unchanged
3439 The capitalized versions of the letter specify bright colors. You can also
3440 use the pseudo-color 'i' to set just the brightness and leave the color
3441 unchanged.
3443 A one digit/letter color description is treated as foreground or
3444 background color dependent on the current attributes: if reverse mode is
3445 set, the background color is changed instead of the foreground color.
3446 If you don't like this, prefix the color with a \*Q.\*U. If you want
3447 the same behavior for two-letter color descriptions, also prefix them
3448 with a \*Q.\*U.
3450 As a special case, \*Q%{-}\*U restores the attributes and colors that
3451 were set before the last change was made (i.e., pops one level of the
3452 color-change stack).
3454 Examples:
3455 .IP "\*QG\*U"
3456 set color to bright green
3457 .IP "\*Q+b r\*U"
3458 use bold red
3459 .IP "\*Q= yd\*U"
3460 clear all attributes, write in default color on yellow background.
3461 .IP "%-Lw%{= BW}%50>%n%f* %t%{-}%+Lw%<"
3462 The available windows centered at the current window and truncated to
3463 the available width. The current window is displayed white on blue.
3464 This can be used with \*Qhardstatus alwayslastline\*U.
3465 .IP "%?%F%{.R.}%?%3n %t%? [%h]%?"
3466 The window number and title and the window's hardstatus, if one is set.
3467 Also use a red background if this is the active focus. Useful for
3468 \*Qcaption string\*U.
3469 .SH "FLOW-CONTROL"
3470 Each window has a flow-control setting that determines how
3471 .I screen
3472 deals with
3473 the XON and XOFF characters (and perhaps the interrupt character).
3474 When flow-control is turned off,
3475 .I screen
3476 ignores the XON and XOFF characters,
3477 which allows the user to send them to the current program by simply typing
3478 them (useful for the \fIemacs\fP editor, for instance).
3479 The trade-off is that it will take longer for output from a \*Qnormal\*U
3480 program to pause in response to an XOFF.
3481 With flow-control turned on, XON and XOFF characters are used to immediately
3482 pause the output of the current window.
3483 You can still send these characters to the current program, but you must use
3484 the appropriate two-character
3485 .I screen
3486 commands (typically \*QC-a q\*U (xon)
3487 and \*QC-a s\*U (xoff)).
3488 The xon/xoff commands are also useful for typing C-s and C-q past a terminal
3489 that intercepts these characters.
3491 Each window has an initial flow-control value set with either the
3492 .B \-f
3493 option or the \*Qdefflow\*U .screenrc command. Per default the windows
3494 are set to automatic flow-switching.
3495 It can then be toggled between the three states 'fixed on', 'fixed off'
3496 and 'automatic' interactively with the \*Qflow\*U command bound to "C-a f".
3498 The automatic flow-switching mode deals with
3499 flow control using the TIOCPKT mode (like \*Qrlogin\*U does). If
3500 the tty driver does not support TIOCPKT,
3501 .I screen
3502 tries to find out
3503 the right mode based on the current setting of the application
3504 keypad \- when it is enabled, flow-control is turned off and visa versa.
3505 Of course, you can still manipulate flow-control manually when needed.
3507 If you're running with flow-control enabled and find that pressing the
3508 interrupt key (usually C-c) does not interrupt the display until another
3509 6-8 lines have scrolled by, try running
3510 .I screen
3511 with the \*Qinterrupt\*U
3512 option (add the \*Qinterrupt\*U flag to the \*Qflow\*U command in
3513 your .screenrc, or use the
3514 .B \-i
3515 command-line option).
3516 This causes the output that
3517 .I screen
3518 has accumulated from the interrupted program to be flushed.
3519 One disadvantage is that the virtual terminal's memory contains the
3520 non-flushed version of the output, which in rare cases can cause
3521 minor inaccuracies in the output.
3522 For example, if you switch screens and return, or update the screen
3523 with \*QC-a l\*U you would see the version of the output you would
3524 have gotten without \*Qinterrupt\*U being on.
3525 Also, you might need to turn off flow-control (or use auto-flow mode to turn
3526 it off automatically) when running a program that expects you to type the
3527 interrupt character as input, as it is possible to interrupt
3528 the output of the virtual terminal to your physical terminal when flow-control
3529 is enabled.
3530 If this happens, a simple refresh of the screen with \*QC-a l\*U will
3531 restore it.
3532 Give each mode a try, and use whichever mode you find more comfortable.
3535 .SH "TITLES (naming windows)"
3536 You can customize each window's name in the window display (viewed with the
3537 \*Qwindows\*U command (C-a w)) by setting it with one of
3538 the title commands.
3539 Normally the name displayed is the actual command name of the program
3540 created in the window.
3541 However, it is sometimes useful to distinguish various programs of the same
3542 name or to change the name on-the-fly to reflect the current state of
3543 the window.
3545 The default name for all shell windows can be set with the \*Qshelltitle\*U
3546 command in the .screenrc file, while all other windows are created with
3547 a \*Qscreen\*U command and thus can have their name set with the
3548 .B \-t
3549 option.
3550 Interactively, there is the title-string escape-sequence
3551 (<esc>k\fIname\fP<esc>\e) and the \*Qtitle\*U command (C-a A).
3552 The former can be output from an application to control the window's name
3553 under software control, and the latter will prompt for a name when typed.
3554 You can also bind pre-defined names to keys with the \*Qtitle\*U command
3555 to set things quickly without prompting.
3557 Finally,
3558 .I screen
3559 has a shell-specific heuristic that is enabled by setting the window's name
3560 to \*Q\fIsearch|name\fP\*U and arranging to have a null title escape-sequence
3561 output as a part of your prompt.
3562 The \fIsearch\fP portion specifies an end-of-prompt search string, while
3563 the \fIname\fP portion specifies the default shell name for the window.
3564 If the \fIname\fP ends in a `:'
3565 .I screen
3566 will add what it believes to be the current command running in the window
3567 to the end of the window's shell name (e.\|g. \*Q\fIname:cmd\fP\*U).
3568 Otherwise the current command name supersedes the shell name while it is
3569 running.
3571 Here's how it works:  you must modify your shell prompt to output a null
3572 title-escape-sequence (<esc>k<esc>\e) as a part of your prompt.
3573 The last part of your prompt must be the same as the string you specified
3574 for the \fIsearch\fP portion of the title.
3575 Once this is set up,
3576 .I screen
3577 will use the title-escape-sequence to clear the previous command name and
3578 get ready for the next command.
3579 Then, when a newline is received from the shell, a search is made for the
3580 end of the prompt.
3581 If found, it will grab the first word after the matched string and use it
3582 as the command name.
3583 If the command name begins with either '!', '%', or '^'
3584 .I screen
3585 will use the first word on the following line (if found) in preference to
3586 the just-found name.
3587 This helps csh users get better command names when using job control or
3588 history recall commands.
3590 Here's some .screenrc examples:
3592 screen -t top 2 nice top
3594 Adding this line to your .screenrc would start a nice-d version of the
3595 \*Qtop\*U command in window 2 named \*Qtop\*U rather than \*Qnice\*U.
3598         shelltitle '> |csh'
3599         screen 1
3602 These commands would start a shell with the given shelltitle.
3603 The title specified is an auto-title that would expect the prompt and
3604 the typed command to look something like the following:
3606 /usr/joe/src/dir> trn
3608 (it looks after the '> ' for the command name).
3609 The window status would show the name \*Qtrn\*U while the command was
3610 running, and revert to \*Qcsh\*U upon completion.
3612 bind R screen -t '% |root:' su
3614 Having this command in your .screenrc would bind the key
3615 sequence \*QC-a R\*U to the \*Qsu\*U command and give it an
3616 auto-title name of \*Qroot:\*U.
3617 For this auto-title to work, the screen could look something
3618 like this:
3621         % !em
3622         emacs file.c
3625 Here the user typed the csh history command \*Q!em\*U which ran the
3626 previously entered \*Qemacs\*U command.
3627 The window status would show \*Qroot:emacs\*U during the execution
3628 of the command, and revert to simply \*Qroot:\*U at its completion.
3631         bind o title
3632         bind E title ""
3633         bind u title (unknown)
3636 The first binding doesn't have any arguments, so it would prompt you
3637 for a title. when you type \*QC-a o\*U.
3638 The second binding would clear an auto-title's current setting (C-a E).
3639 The third binding would set the current window's title to \*Q(unknown)\*U
3640 (C-a u).
3642 One thing to keep in mind when adding a null title-escape-sequence to
3643 your prompt is that some shells (like the csh) count all the non-control
3644 characters as part of the prompt's length.
3645 If these invisible characters aren't a multiple of 8 then backspacing over
3646 a tab will result in an incorrect display.
3647 One way to get around this is to use a prompt like this:
3649 set prompt='^[[0000m^[k^[\e% '
3651 The escape-sequence \*Q<esc>[0000m\*U not only normalizes the character
3652 attributes, but all the zeros round the length of the invisible characters
3653 up to 8.
3654 Bash users will probably want to echo the escape sequence in the
3655 PROMPT_COMMAND:
3657 PROMPT_COMMAND='printf "\e033k\e033\e134"'
3659 (I used \*Q\134\*U to output a `\e' because of a bug in bash v1.04).
3662 .SH "THE VIRTUAL TERMINAL"
3663 Each window in a 
3664 .I screen
3665 session emulates a VT100 terminal, with some extra functions added. The
3666 VT100 emulator is hard-coded, no other terminal types can be emulated.
3668 Usually
3669 .I screen
3670 tries to emulate as much of the VT100/ANSI standard
3671 as possible. But if your terminal lacks certain capabilities,
3672 the emulation may not be complete. In these cases
3673 .I screen
3674 has to tell the applications that some of the features
3675 are missing. This is no problem on machines using termcap,
3676 because
3677 .I screen
3678 can use the $TERMCAP variable to
3679 customize the standard
3680 .I screen
3681 termcap.
3683 But if you do a
3684 rlogin on another machine or your machine supports only
3685 terminfo this method fails. Because of this,
3686 .I screen
3687 offers a way to deal with these cases. 
3688 Here is how it works:
3690 When 
3691 .I screen
3692 tries to figure out a terminal name for itself,
3693 it first looks
3694 for an entry named \*Qscreen.<term>\*U, where <term> is
3695 the contents of your $TERM variable.
3696 If no such entry exists,
3697 .I screen
3698 tries \*Qscreen\*U (or \*Qscreen-w\*U if the terminal is wide
3699 (132 cols or more)).
3700 If even this entry cannot be found, \*Qvt100\*U is used as a
3701 substitute.
3703 The idea is that if you have a terminal which doesn't
3704 support an important feature (e.g. delete char or clear to EOS)
3705 you can build a new termcap/terminfo entry for
3706 .I screen
3707 (named \*Qscreen.<dumbterm>\*U) in which this capability
3708 has been disabled. If this entry is installed on your
3709 machines you are able to do
3710 a rlogin and still keep the correct termcap/terminfo entry.
3711 The terminal name is put in the $TERM variable
3712 of all new windows.
3713 .I Screen
3714 also sets the $TERMCAP variable reflecting the capabilities
3715 of the virtual terminal emulated. Notice that, however, on machines
3716 using the terminfo database this variable has no effect.
3717 Furthermore, the variable $WINDOW is set to the window number
3718 of each window.
3720 The actual set of capabilities supported by the virtual terminal
3721 depends on the capabilities supported by the physical terminal.
3722 If, for instance, the physical terminal does not support underscore mode,
3723 .I screen
3724 does not put the `us' and `ue' capabilities into the window's $TERMCAP
3725 variable, accordingly.
3726 However, a minimum number of capabilities must be supported by a
3727 terminal in order to run
3728 .IR screen ;
3729 namely scrolling, clear screen, and direct cursor addressing
3730 (in addition,
3731 .I screen
3732 does not run on hardcopy terminals or on terminals that over-strike).
3734 Also, you can customize the $TERMCAP value used by
3735 .I screen
3736 by using the \*Qtermcap\*U .screenrc command, or
3737 by defining the variable $SCREENCAP prior to startup.
3738 When the is latter defined, its value will be copied verbatim into each
3739 window's $TERMCAP variable.
3740 This can either be the full terminal definition, or a filename where the
3741 terminal \*Qscreen\*U (and/or \*Qscreen-w\*U) is defined.
3743 Note that 
3744 .I screen
3745 honors the \*Qterminfo\*U .screenrc command if the system uses the
3746 terminfo database rather than termcap.
3748 When the boolean `G0' capability is present in the termcap entry
3749 for the terminal on which
3750 .I screen
3751 has been called, the terminal emulation of
3752 .I screen
3753 supports multiple character sets.
3754 This allows an application to make use of, for instance,
3755 the VT100 graphics character set or national character sets.
3756 The following control functions from ISO 2022 are supported:
3757 \fIlock shift G0\fP (\fISI\fP), \fIlock shift G1\fP (\fISO\fP),
3758 \fIlock shift G2\fP, \fIlock shift G3\fP, \fIsingle shift G2\fP,
3759 and \fIsingle shift G3\fP.
3760 When a virtual terminal is created or reset, the ASCII character
3761 set is designated as \fIG0\fP through \fIG3\fP.
3762 When the `G0' capability is present,
3763 .I screen
3764 evaluates the capabilities
3765 `S0', `E0', and `C0' if present. `S0' is the sequence the terminal uses
3766 to enable and start the graphics character set rather than \fISI\fP. 
3767 `E0' is the corresponding replacement for \fISO\fP. `C0' gives a character
3768 by character translation string that is used during semi-graphics mode. This 
3769 string is built like the `acsc' terminfo capability.
3771 When the `po' and `pf' capabilities are present in the terminal's
3772 termcap entry, applications running in a
3773 .I screen
3774 window can send output to the printer port of the terminal.
3775 This allows a user to have an application in one window
3776 sending output to a printer connected to the terminal, while all
3777 other windows are still active (the printer port is enabled
3778 and disabled again for each chunk of output).
3779 As a side-effect, programs running in different windows can
3780 send output to the printer simultaneously.
3781 Data sent to the printer is not displayed in the window.  The 
3782 .I info
3783 command displays a line starting `PRIN' while the printer is active.
3785 .I Screen
3786 maintains a hardstatus line for every window. If a window
3787 gets selected, the display's hardstatus will be updated to match
3788 the window's hardstatus line. If the display has no hardstatus
3789 the line will be displayed as a standard 
3790 .I screen 
3791 message.
3792 The hardstatus line can be changed with the ANSI Application
3793 Program Command (APC): \*QESC_<string>ESC\e\*U. As a convenience
3794 for xterm users the sequence \*QESC]0..2;<string>^G\*U is
3795 also accepted.
3797 Some capabilities are only put into the $TERMCAP
3798 variable of the virtual terminal if they can be efficiently
3799 implemented by the physical terminal.
3800 For instance, `dl' (delete line) is only put into the $TERMCAP
3801 variable if the terminal supports either delete line itself or
3802 scrolling regions. Note that this may provoke confusion, when 
3803 the session is reattached on a different terminal, as the value
3804 of $TERMCAP cannot be modified by parent processes.
3806 The "alternate screen" capability is not enabled by default.
3807 Set the \fBaltscreen\fP .screenrc command to enable it.
3809 The following is a list of control sequences recognized by
3810 .IR screen .
3811 \*Q(V)\*U and \*Q(A)\*U indicate VT100-specific and ANSI- or
3812 ISO-specific functions, respectively.
3814 .ta 22n
3815 .TP 27
3816 .B "ESC E"
3817 Next Line
3818 .TP 27
3819 .B "ESC D"
3820 Index
3821 .TP 27
3822 .B "ESC M"
3823 Reverse Index
3824 .TP 27
3825 .B "ESC H"
3826 Horizontal Tab Set
3827 .TP 27
3828 .B "ESC Z"
3829 Send VT100 Identification String
3830 .TP 27
3831 .BR "ESC 7" "   (V)"
3832 Save Cursor and Attributes
3833 .TP 27
3834 .BR "ESC 8" "   (V)"
3835 Restore Cursor and Attributes
3836 .TP 27
3837 .BR "ESC [s" "  (A)"
3838 Save Cursor and Attributes
3839 .TP 27
3840 .BR "ESC [u" "  (A)"
3841 Restore Cursor and Attributes
3842 .TP 27
3843 .B "ESC c"
3844 Reset to Initial State
3845 .TP 27
3846 .B "ESC g"
3847 Visual Bell
3848 .TP 27
3849 .B "ESC \fPPn\fB p"
3850 Cursor Visibility (97801)
3851 .TP 27
3852 \h'\w'ESC 'u'Pn = \fB6\fP
3853 Invisible
3854 .TP 27
3855 \h'\w'ESC Pn = 'u'\fB7\fP
3856 Visible
3857 .TP 27
3858 .BR "ESC =" "   (V)"
3859 Application Keypad Mode
3860 .TP 27
3861 .BR "ESC >" "   (V)"
3862 Numeric Keypad Mode
3863 .TP 27
3864 .BR "ESC # 8" " (V)"
3865 Fill Screen with E's
3866 .TP 27
3867 .BR "ESC \e" "  (A)"
3868 String Terminator
3869 .TP 27
3870 .BR "ESC ^" "   (A)"
3871 Privacy Message String (Message Line)
3872 .TP 27
3873 .B "ESC !"
3874 Global Message String (Message Line)
3875 .TP 27
3876 .B "ESC k"
3877 A.\|k.\|a. Definition String
3878 .TP 27
3879 .BR "ESC P" "   (A)"
3880 Device Control String.
3881 Outputs a string directly to the host
3882 terminal without interpretation.
3883 .TP 27
3884 .BR "ESC _" "   (A)"
3885 Application Program Command (Hardstatus)
3886 .TP 27
3887 .BR "ESC ] 0 ; string ^G" "     (A)"
3888 Operating System Command (Hardstatus, xterm title hack)
3889 .TP 27
3890 .BR "ESC ] 83 ; cmd ^G" "       (A)"
3891 Execute screen command. This only works if multi-user support is
3892 compiled into screen. The pseudo-user \*Q:window:\*U is used to
3893 check the access control list. Use \*Qaddacl :window: -rwx #?\*U to
3894 create a user with no rights and allow only the needed commands.
3895 .TP 27
3896 .BR "Control-N" "       (A)"
3897 Lock Shift G1 (SO)
3898 .TP 27
3899 .BR "Control-O" "       (A)"
3900 Lock Shift G0 (SI)
3901 .TP 27
3902 .BR "ESC n" "   (A)"
3903 Lock Shift G2
3904 .TP 27
3905 .BR "ESC o" "   (A)"
3906 Lock Shift G3
3907 .TP 27
3908 .BR "ESC N" "   (A)"
3909 Single Shift G2
3910 .TP 27
3911 .BR "ESC O" "   (A)"
3912 Single Shift G3
3913 .TP 27
3914 .BR "ESC ( \fPPcs" "    (A)"
3915 Designate character set as G0
3916 .TP 27
3917 .BR "ESC ) \fPPcs" "    (A)"
3918 Designate character set as G1
3919 .TP 27
3920 .BR "ESC * \fPPcs" "    (A)"
3921 Designate character set as G2
3922 .TP 27
3923 .BR "ESC + \fPPcs" "    (A)"
3924 Designate character set as G3
3925 .TP 27
3926 .B "ESC [ \fPPn\fB ; \fPPn\fB H"
3927 Direct Cursor Addressing
3928 .TP 27
3929 .B "ESC [ \fPPn\fB ; \fPPn\fB f"
3930 same as above
3931 .TP 27
3932 .B "ESC [ \fPPn\fB J"
3933 Erase in Display
3934 .TP 27
3935 \h'\w'ESC [ 'u'Pn = None or \fB0\fP
3936 From Cursor to End of Screen
3937 .TP 27
3938 \h'\w'ESC [ Pn = 'u'\fB1\fP
3939 From Beginning of Screen to Cursor
3940 .TP 27
3941 \h'\w'ESC [ Pn = 'u'\fB2\fP
3942 Entire Screen
3943 .TP 27
3944 .B "ESC [ \fPPn\fB K"
3945 Erase in Line
3946 .TP 27
3947 \h'\w'ESC [ 'u'Pn = None or \fB0\fP
3948 From Cursor to End of Line
3949 .TP 27
3950 \h'\w'ESC [ Pn = 'u'\fB1\fP
3951 From Beginning of Line to Cursor
3952 .TP 27
3953 \h'\w'ESC [ Pn = 'u'\fB2\fP
3954 Entire Line
3955 .TP 27
3956 .B "ESC [ \fPPn\fB X"
3957 Erase character
3958 .TP 27
3959 .B "ESC [ \fPPn\fB A"
3960 Cursor Up
3961 .TP 27
3962 .B "ESC [ \fPPn\fB B"
3963 Cursor Down
3964 .TP 27
3965 .B "ESC [ \fPPn\fB C"
3966 Cursor Right
3967 .TP 27
3968 .B "ESC [ \fPPn\fB D"
3969 Cursor Left
3970 .TP 27
3971 .B "ESC [ \fPPn\fB E"
3972 Cursor next line
3973 .TP 27
3974 .B "ESC [ \fPPn\fB F"
3975 Cursor previous line
3976 .TP 27
3977 .B "ESC [ \fPPn\fB G"
3978 Cursor horizontal position
3979 .TP 27
3980 .B "ESC [ \fPPn\fB `"
3981 same as above
3982 .TP 27
3983 .B "ESC [ \fPPn\fB d"
3984 Cursor vertical position
3985 .TP 27
3986 .B "ESC [ \fPPs\fB ;\fP...\fB; \fPPs\fB m"
3987 Select Graphic Rendition
3988 .TP 27
3989 \h'\w'ESC [ 'u'Ps = None or \fB0\fP
3990 Default Rendition
3991 .TP 27
3992 \h'\w'ESC [ Ps = 'u'\fB1\fP
3993 Bold
3994 .TP 27
3995 \h'\w'ESC [ Ps = 'u'\fB2\fP     (A)
3996 Faint
3997 .TP 27
3998 \h'\w'ESC [ Ps = 'u'\fB3\fP     (A)
3999 \fIStandout\fP Mode (ANSI: Italicized)
4000 .TP 27
4001 \h'\w'ESC [ Ps = 'u'\fB4\fP
4002 Underlined
4003 .TP 27
4004 \h'\w'ESC [ Ps = 'u'\fB5\fP
4005 Blinking
4006 .TP 27
4007 \h'\w'ESC [ Ps = 'u'\fB7\fP
4008 Negative Image
4009 .TP 27
4010 \h'\w'ESC [ Ps = 'u'\fB22\fP    (A)
4011 Normal Intensity
4012 .TP 27
4013 \h'\w'ESC [ Ps = 'u'\fB23\fP    (A)
4014 \fIStandout\fP Mode off (ANSI: Italicized off)
4015 .TP 27
4016 \h'\w'ESC [ Ps = 'u'\fB24\fP    (A)
4017 Not Underlined
4018 .TP 27
4019 \h'\w'ESC [ Ps = 'u'\fB25\fP    (A)
4020 Not Blinking
4021 .TP 27
4022 \h'\w'ESC [ Ps = 'u'\fB27\fP    (A)
4023 Positive Image
4024 .TP 27
4025 \h'\w'ESC [ Ps = 'u'\fB30\fP    (A)
4026 Foreground Black
4027 .TP 27
4028 \h'\w'ESC [ Ps = 'u'\fB31\fP    (A)
4029 Foreground Red
4030 .TP 27
4031 \h'\w'ESC [ Ps = 'u'\fB32\fP    (A)
4032 Foreground Green
4033 .TP 27
4034 \h'\w'ESC [ Ps = 'u'\fB33\fP    (A)
4035 Foreground Yellow
4036 .TP 27
4037 \h'\w'ESC [ Ps = 'u'\fB34\fP    (A)
4038 Foreground Blue
4039 .TP 27
4040 \h'\w'ESC [ Ps = 'u'\fB35\fP    (A)
4041 Foreground Magenta
4042 .TP 27
4043 \h'\w'ESC [ Ps = 'u'\fB36\fP    (A)
4044 Foreground Cyan
4045 .TP 27
4046 \h'\w'ESC [ Ps = 'u'\fB37\fP    (A)
4047 Foreground White
4048 .TP 27
4049 \h'\w'ESC [ Ps = 'u'\fB39\fP    (A)
4050 Foreground Default
4051 .TP 27
4052 \h'\w'ESC [ Ps = 'u'\fB40\fP    (A)
4053 Background Black
4054 .TP 27
4055 \h'\w'ESC [ Ps = 'u'\fB...\fP
4057 .TP 27
4058 \h'\w'ESC [ Ps = 'u'\fB49\fP    (A)
4059 Background Default
4060 .TP 27
4061 .B "ESC [ \fPPn\fB g"
4062 Tab Clear
4063 .TP 27
4064 \h'\w'ESC [ 'u'Pn = None or \fB0\fP
4065 Clear Tab at Current Position
4066 .TP 27
4067 \h'\w'ESC [ Ps = 'u'\fB3\fP
4068 Clear All Tabs
4069 .TP 27
4070 .BR "ESC [ \fPPn\fB ; \fPPn\fB r" "     (V)"
4071 Set Scrolling Region
4072 .TP 27
4073 .BR "ESC [ \fPPn\fB I" "        (A)"
4074 Horizontal Tab
4075 .TP 27
4076 .BR "ESC [ \fPPn\fB Z" "        (A)"
4077 Backward Tab
4078 .TP 27
4079 .BR "ESC [ \fPPn\fB L" "        (A)"
4080 Insert Line
4081 .TP 27
4082 .BR "ESC [ \fPPn\fB M" "        (A)"
4083 Delete Line
4084 .TP 27
4085 .BR "ESC [ \fPPn\fB @" "        (A)"
4086 Insert Character
4087 .TP 27
4088 .BR "ESC [ \fPPn\fB P" "        (A)"
4089 Delete Character
4090 .TP 27
4091 .B "ESC [ \fPPn\fB S"
4092 Scroll Scrolling Region Up
4093 .TP 27
4094 .B "ESC [ \fPPn\fB T"
4095 Scroll Scrolling Region Down
4096 .TP 27
4097 .B "ESC [ \fPPn\fB ^"
4098 same as above
4099 .TP 27
4100 .B "ESC [ \fPPs\fB ;\fP...\fB; \fPPs\fB h"
4101 Set Mode
4102 .TP 27
4103 .B "ESC [ \fPPs\fB ;\fP...\fB; \fPPs\fB l"
4104 Reset Mode
4105 .TP 27
4106 \h'\w'ESC [ 'u'Ps = \fB4\fP     (A)
4107 Insert Mode
4108 .TP 27
4109 \h'\w'ESC [ Ps = 'u'\fB20\fP    (A)
4110 \fIAutomatic Linefeed\fP Mode
4111 .TP 27
4112 \h'\w'ESC [ Ps = 'u'\fB34\fP
4113 Normal Cursor Visibility
4114 .TP 27
4115 \h'\w'ESC [ Ps = 'u'\fB?1\fP    (V)
4116 Application Cursor Keys
4117 .TP 27
4118 \h'\w'ESC [ Ps = 'u'\fB?3\fP    (V)
4119 Change Terminal Width to 132 columns
4120 .TP 27
4121 \h'\w'ESC [ Ps = 'u'\fB?5\fP    (V)
4122 Reverse Video
4123 .TP 27
4124 \h'\w'ESC [ Ps = 'u'\fB?6\fP    (V)
4125 \fIOrigin\fP Mode
4126 .TP 27
4127 \h'\w'ESC [ Ps = 'u'\fB?7\fP    (V)
4128 \fIWrap\fP Mode
4129 .TP 27
4130 \h'\w'ESC [ Ps = 'u'\fB?9\fP
4131 X10 mouse tracking
4132 .TP 27
4133 \h'\w'ESC [ Ps = 'u'\fB?25\fP   (V)
4134 Visible Cursor
4135 .TP 27
4136 \h'\w'ESC [ Ps = 'u'\fB?47\fP
4137 Alternate Screen (old xterm code)
4138 .TP 27
4139 \h'\w'ESC [ Ps = 'u'\fB?1000\fP (V)
4140 VT200 mouse tracking
4141 .TP 27
4142 \h'\w'ESC [ Ps = 'u'\fB?1047\fP
4143 Alternate Screen (new xterm code)
4144 .TP 27
4145 \h'\w'ESC [ Ps = 'u'\fB?1049\fP
4146 Alternate Screen (new xterm code)
4147 .TP 27
4148 .BR "ESC [ 5 i" "       (A)"
4149 Start relay to printer (ANSI Media Copy)
4150 .TP 27
4151 .BR "ESC [ 4 i" "       (A)"
4152 Stop relay to printer (ANSI Media Copy)
4153 .TP 27
4154 .B "ESC [ 8 ; \fPPh\fB ; \fPPw\fB t"
4155 Resize the window to `Ph' lines and `Pw' columns (SunView special)
4156 .TP 27
4157 .B "ESC [ c"
4158 Send VT100 Identification String
4159 .TP 27
4160 .B "ESC [ x"
4161 Send Terminal Parameter Report
4162 .TP 27
4163 .B "ESC [ > c"
4164 Send VT220 Secondary Device Attributes String
4165 .TP 27
4166 .B "ESC [ 6 n"
4167 Send Cursor Position Report
4170 .SH "INPUT TRANSLATION"
4171 In order to do a full VT100 emulation 
4172 .I screen
4173 has to detect
4174 that a sequence of characters in the input stream was generated
4175 by a keypress on the user's keyboard and insert the VT100
4176 style escape sequence. \fIScreen\fP has a very flexible way of doing
4177 this by making it possible to map arbitrary commands on arbitrary
4178 sequences of characters. For standard VT100 emulation the command
4179 will always insert a string in the input buffer of the window
4180 (see also command \fBstuff\fP in the command table).
4181 Because the sequences generated by a keypress can
4182 change after a reattach from a different terminal type, it is
4183 possible to bind commands to the termcap name of the keys.
4184 \fIScreen\fP will insert the correct binding after each
4185 reattach. See the \fBbindkey\fP command for further details on the
4186 syntax and examples.
4188 Here is the table of the default key bindings. (A) means that the
4189 command is executed if the keyboard is switched into application
4190 mode.
4192 .ta 18n 34n 50n
4194 Key name        Termcap name    Command
4195 \l'54n'
4196 .ta 22n 34n 50n
4197 Cursor up       ku      stuff \e033[A
4198                 stuff \e033OA   (A)
4199 Cursor down     kd      stuff \e033[B
4200                 stuff \e033OB   (A)
4201 Cursor right    kr      stuff \e033[C
4202                 stuff \e033OC   (A)
4203 Cursor left     kl      stuff \e033[D
4204                 stuff \e033OD   (A)
4205 Function key 0  k0      stuff \e033[10~
4206 Function key 1  k1      stuff \e033OP
4207 Function key 2  k2      stuff \e033OQ
4208 Function key 3  k3      stuff \e033OR
4209 Function key 4  k4      stuff \e033OS
4210 Function key 5  k5      stuff \e033[15~
4211 Function key 6  k6      stuff \e033[17~
4212 Function key 7  k7      stuff \e033[18~
4213 Function key 8  k8      stuff \e033[19~
4214 Function key 9  k9      stuff \e033[20~
4215 Function key 10 k;      stuff \e033[21~
4216 Function key 11 F1      stuff \e033[23~
4217 Function key 12 F2      stuff \e033[24~
4218 Home    kh      stuff \e033[1~
4219 End     kH      stuff \e033[4~
4220 Insert  kI      stuff \e033[2~
4221 Delete  kD      stuff \e033[3~
4222 Page up kP      stuff \e033[5~
4223 Page down       kN      stuff \e033[6~
4224 Keypad 0        f0      stuff 0
4225                 stuff \e033Op   (A)
4226 Keypad 1        f1      stuff 1
4227                 stuff \e033Oq   (A)
4228 Keypad 2        f2      stuff 2
4229                 stuff \e033Or   (A)
4230 Keypad 3        f3      stuff 3
4231                 stuff \e033Os   (A)
4232 Keypad 4        f4      stuff 4
4233                 stuff \e033Ot   (A)
4234 Keypad 5        f5      stuff 5
4235                 stuff \e033Ou   (A)
4236 Keypad 6        f6      stuff 6
4237                 stuff \e033Ov   (A)
4238 Keypad 7        f7      stuff 7
4239                 stuff \e033Ow   (A)
4240 Keypad 8        f8      stuff 8
4241                 stuff \e033Ox   (A)
4242 Keypad 9        f9      stuff 9
4243                 stuff \e033Oy   (A)
4244 Keypad +        f+      stuff +
4245                 stuff \e033Ok   (A)
4246 Keypad -        f-      stuff -
4247                 stuff \e033Om   (A)
4248 Keypad *        f*      stuff *
4249                 stuff \e033Oj   (A)
4250 Keypad /        f/      stuff /
4251                 stuff \e033Oo   (A)
4252 Keypad =        fq      stuff =
4253                 stuff \e033OX   (A)
4254 Keypad .        f.      stuff .
4255                 stuff \e033On   (A)
4256 Keypad ,        f,      stuff ,
4257                 stuff \e033Ol   (A)
4258 Keypad enter    fe      stuff \e015
4259                 stuff \e033OM   (A)
4263 .SH SPECIAL TERMINAL CAPABILITIES
4264 The following table describes all terminal capabilities
4265 that are recognized by 
4266 .I screen
4267 and are not in the termcap(5) manual.
4268 You can place these capabilities in your termcap entries (in
4269 `/etc/termcap') or use them with the commands `termcap', `terminfo' and
4270 `termcapinfo' in your screenrc files. It is often not possible to place
4271 these capabilities in the terminfo database.
4273 .ta 5n
4274 .TP 13
4275 .BI LP "        (bool)"
4276 Terminal has VT100 style margins (`magic margins'). Note that
4277 this capability is obsolete because 
4278 .I screen
4279 uses the standard 'xn' instead.
4280 .TP 13
4281 .BI Z0 "        (str)"
4282 Change width to 132 columns.
4283 .TP 13
4284 .BI Z1 "        (str)"
4285 Change width to 80 columns.
4286 .TP 13
4287 .BI WS "        (str)"
4288 Resize display. This capability has the desired width and height as
4289 arguments. \fISunView(tm)\fP example: '\eE[8;%d;%dt'.
4290 .TP 13
4291 .BI NF "        (bool)"
4292 Terminal doesn't need flow control. Send ^S and ^Q direct to
4293 the application. Same as 'flow off'. The opposite of this
4294 capability is 'nx'.
4295 .TP 13
4296 .BI G0 "        (bool)"
4297 Terminal can deal with ISO 2022 font selection sequences.
4298 .TP 13
4299 .BI S0 "        (str)"
4300 Switch charset 'G0' to the specified charset. Default
4301 is '\eE(%.'.
4302 .TP 13
4303 .BI E0 "        (str)"
4304 Switch charset 'G0' back to standard charset. Default
4305 is '\eE(B'.
4306 .TP 13
4307 .BI C0 "        (str)"
4308 Use the string as a conversion table for font '0'. See
4309 the 'ac' capability for more details.
4310 .TP 13
4311 .BI CS "        (str)"
4312 Switch cursor-keys to application mode.
4313 .TP 13
4314 .BI CE "        (str)"
4315 Switch cursor-keys back to normal mode.
4316 .TP 13
4317 .BI AN "        (bool)"
4318 Turn on autonuke. See the 'autonuke' command for more details.
4319 .TP 13
4320 .BI OL "        (num)"
4321 Set the output buffer limit. See the 'obuflimit' command for more details.
4322 .TP 13
4323 .BI KJ "        (str)"
4324 Set the encoding of the terminal. See the 'encoding' command for
4325 valid encodings.
4326 .TP 13
4327 .BI AF "        (str)"
4328 Change character foreground color in an ANSI conform way. This
4329 capability will almost always be set to '\eE[3%dm' ('\eE[3%p1%dm'
4330 on terminfo machines).
4331 .TP 13
4332 .BI AB "        (str)"
4333 Same as 'AF', but change background color.
4334 .TP 13
4335 .BI AX "        (bool)"
4336 Does understand ANSI set default fg/bg color (\eE[39m / \eE[49m).
4337 .TP 13
4338 .BI XC "        (str)"
4339 Describe a translation of characters to strings depending on the
4340 current font. More details follow in the next section.
4341 .TP 13
4342 .BI XT "        (bool)"
4343 Terminal understands special xterm sequences (OSC, mouse tracking).
4344 .TP 13
4345 .BI C8 "        (bool)"
4346 Terminal needs bold to display high-intensity colors (e.g. Eterm).
4347 .TP 13
4348 .BI TF "        (bool)"
4349 Add missing capabilities to the termcap/info entry. (Set by default).
4351 .SH CHARACTER TRANSLATION
4352 \fIScreen\fP has a powerful mechanism to translate characters to arbitrary
4353 strings depending on the current font and terminal type.
4354 Use this feature if you want to work with a common standard character
4355 set (say ISO8851-latin1) even on terminals that scatter the more
4356 unusual characters over several national language font pages.
4358 Syntax:
4360     \fBXC=\fP\fI<charset-mapping>\fP{\fB,,\fP\fI<charset-mapping>\fP}
4361     \fI<charset-mapping>\fP := \fI<designator><template>\fP{\fB,\fP\fI<mapping>\fP}
4362     \fI<mapping>\fP := \fI<char-to-be-mapped><template-arg>\fP
4365 The things in braces may be repeated any number of times.
4367 A \fI<charset-mapping>\fP tells 
4368 .I screen
4369 how to map characters
4370 in font \fI<designator>\fP ('B': Ascii, 'A': UK, 'K': German, etc.)
4371 to strings. Every \fI<mapping>\fP describes to what string a single
4372 character will be translated. A template mechanism is used, as 
4373 most of the time the codes have a lot in common (for example
4374 strings to switch to and from another charset). Each occurrence
4375 of '%' in \fI<template>\fP gets substituted with the \fI<template-arg>\fP
4376 specified together with the character. If your strings are not
4377 similar at all, then use '%' as a template and place the full
4378 string in \fI<template-arg>\fP. A quoting mechanism was added to make
4379 it possible to use a real '%'. The '\e' character quotes the
4380 special characters '\e', '%', and ','.
4382 Here is an example:
4384     termcap hp700 'XC=B\eE(K%\eE(B,\e304[,\e326\e\e\e\e,\e334]'
4386 This tells
4387 .I screen
4388 how to translate ISOlatin1 (charset 'B')
4389 upper case umlaut characters on a hp700 terminal that has a
4390 German charset. '\e304' gets translated to '\eE(K[\eE(B' and so on.
4391 Note that this line gets parsed *three* times before the internal
4392 lookup table is built, therefore a lot of quoting is needed to
4393 create a single '\e'.
4395 Another extension was added to allow more emulation: If a mapping
4396 translates the unquoted '%' char, it will be sent to the terminal
4397 whenever 
4398 .I screen
4399 switches to the corresponding \fI<designator>\fP. In this
4400 special case the template is assumed to be just '%' because
4401 the charset switch sequence and the character mappings normally
4402 haven't much in common.
4404 This example shows one use of the extension:
4406     termcap xterm 'XC=K%,%\eE(B,[\e304,\e\e\e\e\e326,]\e334'
4408 Here, a part of the German ('K') charset is emulated on an xterm.
4409 If 
4410 .I screen
4411 has to change to the 'K' charset, '\eE(B' will be sent
4412 to the terminal, i.e. the ASCII charset is used instead. The
4413 template is just '%', so the mapping is straightforward: '['
4414 to '\e304', '\e' to '\e326', and ']' to '\e334'.
4416 .SH ENVIRONMENT
4417 .PD 0
4418 .IP COLUMNS 15
4419 Number of columns on the terminal (overrides termcap entry).
4420 .IP HOME
4421 Directory in which to look for .screenrc.
4422 .IP LINES 
4423 Number of lines on the terminal (overrides termcap entry).
4424 .IP LOCKPRG
4425 Screen lock program.
4426 .IP NETHACKOPTIONS
4427 Turns on nethack option.
4428 .IP PATH
4429 Used for locating programs to run.
4430 .IP SCREENCAP
4431 For customizing a terminal's TERMCAP value.
4432 .IP SCREENDIR
4433 Alternate socket directory.
4434 .IP SCREENRC
4435 Alternate user screenrc file.
4436 .IP SHELL
4437 Default shell program for opening windows (default \*Q/bin/sh\*U).
4438 .IP STY
4439 Alternate socket name.
4440 .IP SYSSCREENRC
4441 Alternate system screenrc file.
4442 .IP TERM
4443 Terminal name.
4444 .IP TERMCAP
4445 Terminal description.
4446 .IP WINDOW
4447 Window number of a window (at creation time).
4449 .SH FILES
4450 .PD 0
4451 .IP .../screen-4.?.??/etc/screenrc 34
4452 .IP .../screen-4.?.??/etc/etcscreenrc
4453 Examples in the 
4454 .I screen
4455 distribution package for private and global initialization files.
4456 .IP $SYSSCREENRC 
4457 .IP /usr/local/etc/screenrc
4458 .I screen
4459 initialization commands
4460 .IP $SCREENRC
4461 .IP $HOME/.screenrc
4462 Read in after /usr/local/etc/screenrc
4463 .IP $SCREENDIR/S-<login>
4464 .IP /local/screens/S-<login>
4465 Socket directories (default)
4466 .IP /usr/tmp/screens/S-<login>
4467 Alternate socket directories.
4468 .IP "<socket directory>/.termcap"
4469 Written by the "termcap" output function
4470 .IP /usr/tmp/screens/screen-exchange
4472 .IP /tmp/screen-exchange
4473 .I screen
4474 `interprocess communication buffer'
4475 .IP hardcopy.[0-9]
4476 Screen images created by the hardcopy function
4477 .IP screenlog.[0-9]
4478 Output log files created by the log function
4479 .IP /usr/lib/terminfo/?/*
4481 .IP /etc/termcap
4482 Terminal capability databases
4483 .IP /etc/utmp
4484 Login records
4485 .IP $LOCKPRG
4486 Program that locks a terminal.
4489 .SH "SEE ALSO"
4490 termcap(5), utmp(5), vi(1), captoinfo(1), tic(1)
4493 .SH AUTHORS
4494 Originally created by Oliver Laumann, this latest version was
4495 produced by Wayne Davison, Juergen Weigert and Michael Schroeder.
4497 .SH COPYLEFT
4499 Copyright (C) 1993-2003
4500         Juergen Weigert (jnweiger@immd4.informatik.uni-erlangen.de)
4501         Michael Schroeder (mlschroe@immd4.informatik.uni-erlangen.de)
4502 Copyright (C) 1987 Oliver Laumann
4505 This program is free software; you can redistribute it and/or modify
4506 it under the terms of the GNU General Public License as published by
4507 the Free Software Foundation; either version 2, or (at your option)
4508 any later version.
4510 This program is distributed in the hope that it will be useful,
4511 but WITHOUT ANY WARRANTY; without even the implied warranty of
4512 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
4513 GNU General Public License for more details.
4515 You should have received a copy of the GNU General Public License
4516 along with this program (see the file COPYING); if not, write to the
4517 Free Software Foundation, Inc.,
4518 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA
4520 .SH CONTRIBUTORS
4522 Ken Beal (kbeal@amber.ssd.csd.harris.com),
4523 Rudolf Koenig (rfkoenig@immd4.informatik.uni-erlangen.de),
4524 Toerless Eckert (eckert@immd4.informatik.uni-erlangen.de), 
4525 Wayne Davison (davison@borland.com),
4526 Patrick Wolfe (pat@kai.com, kailand!pat),
4527 Bart Schaefer (schaefer@cse.ogi.edu),
4528 Nathan Glasser (nathan@brokaw.lcs.mit.edu),
4529 Larry W. Virden (lvirden@cas.org),
4530 Howard Chu (hyc@hanauma.jpl.nasa.gov),
4531 Tim MacKenzie (tym@dibbler.cs.monash.edu.au),
4532 Markku Jarvinen (mta@{cc,cs,ee}.tut.fi),
4533 Marc Boucher (marc@CAM.ORG),
4534 Doug Siebert (dsiebert@isca.uiowa.edu),
4535 Ken Stillson (stillson@tsfsrv.mitre.org),
4536 Ian Frechett (frechett@spot.Colorado.EDU),
4537 Brian Koehmstedt (bpk@gnu.ai.mit.edu),
4538 Don Smith (djs6015@ultb.isc.rit.edu),
4539 Frank van der Linden (vdlinden@fwi.uva.nl),
4540 Martin Schweikert (schweik@cpp.ob.open.de),
4541 David Vrona (dave@sashimi.lcu.com),
4542 E. Tye McQueen (tye%spillman.UUCP@uunet.uu.net),
4543 Matthew Green (mrg@eterna.com.au),
4544 Christopher Williams (cgw@pobox.com),
4545 Matt Mosley (mattm@access.digex.net),
4546 Gregory Neil Shapiro (gshapiro@wpi.WPI.EDU),
4547 Johannes Zellner (johannes@zellner.org),
4548 Pablo Averbuj (pablo@averbuj.com).
4552 .SH VERSION
4553 This is version 4.0.2. Its roots are a merge of a custom version
4554 2.3PR7 by Wayne Davison
4555 and several enhancements to Oliver Laumann's version 2.0. Note that all versions
4556 numbered 2.x are copyright by Oliver Laumann. 
4558 .SH AVAILABILITY
4559 The latest official release of 
4560 .I screen
4561 available via anonymous ftp from gnudist.gnu.org, nic.funet.fi or any other 
4562 .I GNU 
4563 distribution site. The home site of
4564 .I screen
4565 is ftp.uni-erlangen.de, in the directory
4566 pub/utilities/screen. The subdirectory `private' contains the latest beta
4567 testing release. If you want to help, send a note to
4568 screen@uni-erlangen.de.
4570 .SH BUGS
4572 .IP \(bu 3
4573 `dm' (delete mode) and `xs' are not handled
4574 correctly (they are ignored). `xn' is treated as a magic-margin
4575 indicator.
4576 .IP \(bu
4577 .I Screen
4578 has no clue about double-high or double-wide characters.         
4579 But this is the only area where 
4580 .I vttest
4581 is allowed to fail.
4582 .IP \(bu
4583 It is not possible to change the environment variable $TERMCAP when 
4584 reattaching under a different terminal type.
4585 .IP \(bu
4586 The support of terminfo based systems is very limited. Adding extra
4587 capabilities to $TERMCAP may not have any effects.
4588 .IP \(bu
4589 .I Screen
4590 does not make use of hardware tabs.
4591 .IP \(bu
4592 .I Screen
4593 must be installed as set-uid with owner root on most systems in order
4594 to be able to correctly change the owner of the tty device file for
4595 each window.
4596 Special permission may also be required to write the file \*Q/etc/utmp\*U.
4597 .IP \(bu
4598 Entries in \*Q/etc/utmp\*U are not removed when
4599 .I screen
4600 is killed with SIGKILL.
4601 This will cause some programs (like "w" or "rwho")
4602 to advertise that a user is logged on who really isn't.
4603 .IP \(bu
4604 .I Screen
4605 may give a strange warning when your tty has no utmp entry.
4606 .IP \(bu
4607 When the modem line was hung up, 
4608 .I screen
4609 may not automatically detach (or quit)
4610 unless the device driver is configured to send a HANGUP signal. 
4611 To detach a 
4612 .I screen
4613 session use the -D or -d command line option.
4614 .IP \(bu
4615 If a password is set, the command line options -d and -D still detach a 
4616 session without asking.
4617 .IP \(bu
4618 Both \*Qbreaktype\*U and \*Qdefbreaktype\*U change the break generating
4619 method used by all terminal devices. The first should change a window
4620 specific setting, where the latter should change only the default for new 
4621 windows.
4622 .IP \(bu
4623 When attaching to a multiuser session, the user's .screenrc file is not
4624 sourced. Each user's personal settings have to be included in the .screenrc
4625 file from which the session is booted, or have to be changed manually.
4626 .IP \(bu
4627 A weird imagination is most useful to gain full advantage of all the features.
4628 .IP \(bu
4629 Send bug-reports, fixes, enhancements, t-shirts, money, beer & pizza to
4630 .BR screen@uni-erlangen.de .