home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / unix / volume26 / screen-3.5 / part09 < prev    next >
Text File  |  1993-07-25  |  86KB  |  2,633 lines

  1. Newsgroups: comp.sources.unix
  2. From: mlschroe@immd4.informatik.uni-erlangen.de (Michael Schroeder)
  3. Subject: v26i308: screen-3.5 - screen manager with VT100/ANSI terminal emulation, V3.5, Part09/10
  4. Sender: unix-sources-moderator@gw.home.vix.com
  5. Approved: vixie@gw.home.vix.com
  6.  
  7. Submitted-By: mlschroe@immd4.informatik.uni-erlangen.de (Michael Schroeder)
  8. Posting-Number: Volume 26, Issue 308
  9. Archive-Name: screen-3.5/part09
  10.  
  11. #! /bin/sh
  12. # This is a shell archive.  Remove anything before this line, then unpack
  13. # it by saving it into a file and typing "sh file".  To overwrite existing
  14. # files, type "sh file -c".  You can also feed this as standard input via
  15. # unshar, or by typing "sh <file", e.g..  If this archive is complete, you
  16. # will see the following message at the end:
  17. #        "End of archive 9 (of 10)."
  18. # Contents:  doc/screen.1
  19. # Wrapped by vixie@gw.home.vix.com on Sun Jul 25 12:57:26 1993
  20. PATH=/bin:/usr/bin:/usr/ucb ; export PATH
  21. if test -f 'doc/screen.1' -a "${1}" != "-c" ; then 
  22.   echo shar: Will not clobber existing file \"'doc/screen.1'\"
  23. else
  24. echo shar: Extracting \"'doc/screen.1'\" \(82010 characters\)
  25. sed "s/^X//" >'doc/screen.1' <<'END_OF_FILE'
  26. X.if n .ds Q \&"
  27. X.if n .ds U \&"
  28. X.if t .ds Q ``
  29. X.if t .ds U ''
  30. X.TH SCREEN 1 "13 May 1993"
  31. X.UC 4
  32. X.SH NAME
  33. Xscreen \- screen manager with VT100/ANSI terminal emulation
  34. X
  35. X
  36. X.SH SYNOPSIS
  37. X.B screen
  38. X[
  39. X.B \-\fIoptions\fP
  40. X] [
  41. X.B \fIcmd\fP
  42. X[
  43. X.B \fIargs\fP
  44. X] ]
  45. X.br
  46. X.B screen \-r
  47. X[ [\fIpid.\fP]\fItty\fP[\fI.host\fP] ]
  48. X.ta .5i 1.8i
  49. X
  50. X
  51. X.SH DESCRIPTION
  52. X.I Screen
  53. Xis a full-screen window manager that
  54. Xmultiplexes a physical terminal between several processes (typically
  55. Xinteractive shells).
  56. XEach virtual terminal provides the functions
  57. Xof a DEC VT100 terminal and, in addition, several control functions
  58. Xfrom the ANSI X3.64 (ISO 6429) and ISO 2022 standards
  59. X(e.\|g. insert/delete line and support for multiple character sets).
  60. XThere is a scrollback history buffer for each virtual terminal and a 
  61. Xcopy-and-paste mechanism that allows moving text regions between
  62. Xwindows.
  63. X.PP 
  64. XThe name of this program was changed to
  65. X.I iScreen
  66. Xto be able to distinguish it from Oliver Laumann's original 
  67. X.I screen
  68. Xprogram. Despite that fact, this manual will continue to use the name
  69. X.IR screen .
  70. XThis is because the binary is often installed as 'screen'.
  71. X.PP
  72. XWhen
  73. X.I screen
  74. Xis called, it creates a single window with a shell in it (or the specified
  75. Xcommand) and then gets out of your way so that you can use the program as you
  76. Xnormally would.
  77. XThen, at any time, you can create new (full-screen) windows with other programs
  78. Xin them (including more shells), kill existing windows, view a list of 
  79. Xwindows, turn output logging on and off, copy-and-paste text between
  80. Xwindows, view the scrollback history, switch between windows
  81. Xin whatever manner you wish, etc.
  82. XWhen a program terminates,
  83. X.I screen
  84. Xkills the window that contained it.
  85. XIf this window was in the foreground, the display switches to the previous
  86. Xwindow; if none are left,
  87. X.I screen
  88. Xexits.
  89. X.PP
  90. XEverything you type is sent to the program running in the current window.
  91. XThe only exception to this is the one keystroke that is used to initiate
  92. Xa command to the window manager.
  93. XBy default, each command begins with a control-a (abbreviated C-a from
  94. Xnow on), and is followed by one other keystroke.
  95. XThe command character and all the key bindings can be fully customized
  96. Xto be anything you like, though they are always two characters in length.
  97. X.PP
  98. XThe standard way to create a new window is to type \*QC-a c\*U.
  99. XThis creates a new window running a shell and switches to that
  100. Xwindow immediately, regardless of the state of the process running
  101. Xin the current window.
  102. XSimilarly, you can create a new window with a custom command in it by
  103. Xfirst binding the command to a keystroke (in your .screenrc file) and
  104. Xthen using it just like the \*QC-a c\*U command.
  105. XIn addition, new windows can be created by running a command like:
  106. X.IP
  107. Xscreen emacs prog.c
  108. X.PP
  109. Xfrom a shell prompt within a previously created window.
  110. XThis will not run another copy of 
  111. X.IR screen ,
  112. Xbut will instead supply the
  113. Xcommand name and its arguments to the window manager who will use it to
  114. Xcreate the new window.
  115. XThe above example would start the emacs editor (editing prog.c) and switch
  116. Xto its window.
  117. X.PP
  118. XIf \*Q/etc/utmp\*U is writable by
  119. X.IR screen ,
  120. Xan appropriate record will be written to this file for each window, and
  121. Xremoved when the window is terminated.
  122. XThis is useful for working with \*Qtalk\*U, \*Qscript\*U, \*Qshutdown\*U,
  123. X\*Qrsend\*U, \*Qsccs\*U and other similar programs that use the utmp
  124. Xfile to determine who you are. As long as 
  125. X.I screen
  126. Xis active on your terminal,
  127. Xthe terminal's own record is removed from the utmp file. See also \*QC-a L\*U.
  128. X
  129. X
  130. X.SH GETTING STARTED
  131. XBefore you begin to use
  132. X.I screen
  133. Xyou'll need to make sure you have correctly selected your terminal type,
  134. Xjust as you would for any other termcap/terminfo program.
  135. X(You can do this by using
  136. X.IR tset
  137. Xfor example.)
  138. X.PP
  139. XIf you're impatient and want to get started without doing a lot more reading,
  140. Xyou should remember this one command:  \*QC-a ?\*U.
  141. XTyping these two characters will display a list of the available
  142. X.I screen
  143. Xcommands and their bindings. Each keystroke is discussed in
  144. Xthe section \*QDEFAULT KEY BINDINGS\*U. The manual section \*QCUSTOMIZATION\*U 
  145. Xdeals with the contents of your .screenrc.
  146. X.PP
  147. XIf possible, choose a version of your terminal's termcap that has automatic
  148. Xmargins turned \fIoff\fP.
  149. XThis will ensure an accurate and optimal update of the screen
  150. Xin all circumstances.
  151. XThe next best thing is an auto-margin terminal that allows the last position
  152. Xon the screen to be updated without scrolling the screen (such as a vt100).
  153. XThis also allows the entire screen to be updated.
  154. XLastly, if all you've got is a \*Qtrue\*U auto-margin terminal
  155. X.I screen
  156. Xwill be content to use it, but updating a character put into the last position
  157. Xon the screen may not be possible until the screen scrolls or the character
  158. Xis moved into a safe position in some other way.
  159. XThis delay can be shortened by using a terminal with insert-character
  160. Xcapability.
  161. X.PP
  162. XIf your terminal is of the second type (firm-margined `am'), you will
  163. Xwant to let
  164. X.I screen
  165. Xknow about this, since a normal termcap doesn't distinguish this type of
  166. Xautomatic margins from a \*Qtrue\*U `am' terminal.
  167. XYou do this by specifying the `LP' capability in your termcap
  168. X(see the \*Qtermcap\*U .screenrc command), or by using the
  169. X.B \-L
  170. Xcommand-line option.
  171. X.I Screen
  172. Xneeds this information to correctly update the screen. Note that a `xv' together
  173. Xwith an `am' flag effects like `LP'.
  174. X.PP
  175. XIf you are using a \*Qtrue\*U auto-margin terminal (no `LP') at low baud
  176. Xrates, you may want to turn on a more optimal output mode by including the
  177. Xflag `OP' in your termcap entry, or by specifying the
  178. X.B \-O
  179. Xcommand-line option.
  180. XThe trade-off is that
  181. X.I screen
  182. Xwill no-longer accurately emulate the vt100's line-end quirks (e.\|g. the
  183. Xscreen will scroll after putting \fIone\fP character in the last screen
  184. Xposition).
  185. X
  186. X
  187. X.SH "COMMAND-LINE OPTIONS"
  188. XScreen has the following command-line options:
  189. X.TP 5
  190. X.B \-a
  191. Xinclude \fIall\fP capabilities (with some minor exceptions) in each
  192. Xwindow's termcap, even if
  193. X.I screen
  194. Xmust redraw parts of the display in order to implement a function.
  195. X.TP 5
  196. X.B \-A
  197. XAdapt the sizes of all windows to the size of the current terminal. 
  198. XBy default,
  199. X.I screen
  200. Xtries to restore its old window sizes when attaching to resizeable terminals
  201. X(those with \*QWS\*U in its description, e.g. suncmd or some xterm). 
  202. X.TP 5
  203. X.BI "\-c " file
  204. Xoverride the default configuration file from \*Q$HOME/.screenrc\*U
  205. Xto \fIfile\fP.
  206. X.TP 5
  207. X.BR \-d | \-D " [" \fIpid.tty.host ]
  208. Xdoes not start
  209. X.IR screen ,
  210. Xbut detaches the elsewhere running 
  211. X.I screen
  212. Xsession. It has the same effect as typing \*QC-a d\*U from 
  213. X.I screen's
  214. Xcontrolling terminal. \fB\-D\fP is the equivalent to the power detach key.
  215. XIf no session can be detached, this option is ignored. 
  216. XThe combination \*Qscreen \-D \-r\*U can be used to `transport' the elsewhere 
  217. Xrunning session to this terminal and logout there. 
  218. XNote: It is a good idea to have the status of your sessions checked by means of
  219. X\*Qscreen \-list\*U.
  220. X.TP 5
  221. X.BI "\-e " xy
  222. Xspecifies the command character to be \fIx\fP and the character generating a
  223. Xliteral command character to \fIy\fP (when typed after the command character).
  224. XThe default is \*QC-a\*U and `a', which can be specified as \*Q-e^Aa\*U.
  225. XSee the \*Qescape\*U .screenrc command for more details.
  226. X.TP 5
  227. X.BR \-f\fP ", " \-fn ", and " \-fa
  228. Xturns flow-control on, off, or \*Qautomatic switching mode\*U.
  229. XThis can also be defined through the \*Qdefflow\*U .screenrc command.
  230. X.TP 5
  231. X.BI "\-h " num
  232. XSpecifies the history scrollback buffer to be \fInum\fP lines high.
  233. X.TP 5
  234. X.B \-i
  235. Xwill cause the interrupt key (usually C-c) to interrupt the display
  236. Ximmediately when flow-control is on.
  237. XSee the \*Qdefflow\*U .screenrc command for details.
  238. XThe use of this option is discouraged.
  239. X.TP 5
  240. X.BR \-l " and " \-ln
  241. Xturns login mode on or off (for /etc/utmp updating).
  242. XThis can also be defined through the \*Qdeflogin\*U .screenrc command.
  243. X.TP 5
  244. X.BR \-ls " and " \-list
  245. Xdoes not start
  246. X.IR screen ,
  247. Xbut prints a list of
  248. X.I pid.tty.host
  249. Xstrings identifying your 
  250. X.I screen
  251. Xsessions.
  252. XSessions marked `detached' can be resumed with \*Qscreen -r\*U. Those marked 
  253. X`attached' are running and have a controlling terminal. Sessions marked as
  254. X`dead' should be thoroughly checked and removed. Ask your system administrator
  255. Xif you are not sure. Remove sessions with the \fB-wipe\fP option.
  256. X.TP 5
  257. X.B \-L
  258. Xtells 
  259. X.I screen
  260. Xyour auto-margin terminal has a writable last-position on
  261. Xthe screen.
  262. XThis can also be set in your .screenrc by specifying `LP' in a \*Qtermcap\*U
  263. Xcommand.
  264. X.TP 5
  265. X.B \-m
  266. Xcauses 
  267. X.I screen
  268. Xto ignore the $STY environment variable. With \*Qscreen -m\*U creation of
  269. Xa new session is enforced, regardless whether 
  270. X.I screen
  271. Xis called from within another 
  272. X.I screen
  273. Xsession or not.
  274. X.TP 5
  275. X.B \-O
  276. Xselects a more optimal output mode for your terminal rather than true vt100
  277. Xemulation (only affects auto-margin terminals without `LP').
  278. XThis can also be set in your .screenrc by specifying `OP' in a \*Qtermcap\*U
  279. Xcommand.
  280. X.TP 5
  281. X.BR \-r " [" \fIpid.tty.host ]
  282. Xresumes a detached
  283. X.I screen
  284. Xsession.
  285. XNo other options (except \*Q-d -r\*U or \*Q-D -r\*U) may be specified, though
  286. Xan optional prefix of [\fIpid.\fP]\fItty.host\fP
  287. Xmay be needed to distinguish between multiple detached
  288. X.I screen
  289. Xsessions.
  290. X.TP 5
  291. X.B \-R
  292. Xattempts to resume the first detached 
  293. X.I screen
  294. Xsession it finds.
  295. XIf successful, all other command-line options are ignored.
  296. XIf no detached session exists, starts a new session using the specified
  297. Xoptions, just as if
  298. X.B \-R
  299. Xhad not been specified. The option is set by default if screen is run as
  300. Xa login-shell.
  301. X.TP 5
  302. X.B \-s
  303. Xsets the default shell to the program specified, instead of the value
  304. Xin the environment variable $SHELL (or \*Q/bin/sh\*U if not defined).
  305. XThis can also be defined through the \*Qshell\*U .screenrc command.
  306. X.TP 5
  307. X.BI "\-S " sessionname
  308. XWhen creating a new session, this option can be used to specify a
  309. Xmeaningful name for the session. This name identifies the session for
  310. X\*Qscreen -list\*U and \*Qscreen -r\*U actions. It substitutes the 
  311. Xdefault [\fItty.host\fP] suffix.
  312. X.TP 5
  313. X.BI "\-t " name
  314. Xsets the title (a.\|k.\|a.) for the default shell or specified program.
  315. XSee also the \*Qshellaka\*U .screenrc command.
  316. X.TP 5
  317. X.B \-v
  318. XPrint version number.
  319. X.TP 5
  320. X.B \-wipe
  321. Xdoes the same as \*Qscreen -ls\*U, but removes destroyed sessions instead of 
  322. Xmarking them as `dead'.
  323. X.TP 5
  324. X.B \-x
  325. XAttach to a not detached screen session. (Multi display mode).
  326. X
  327. X
  328. X.SH "DEFAULT KEY BINDINGS"
  329. X.ta 12n 26n
  330. XAs mentioned, each
  331. X.I screen
  332. Xcommand consists of a
  333. X\*QC-a\*U followed by one other character.
  334. XFor your convenience, all commands that are bound to lower-case letters are
  335. Xalso bound to their control character counterparts (with the exception
  336. Xof \*QC-a a\*U; see below), thus, \*QC-a c\*U as well as \*QC-a C-c\*U can
  337. Xbe used to create a window. See section \*QCUSTOMIZATION\*U for a description 
  338. Xof the command.
  339. X.PP
  340. X.TP 26n
  341. XThe following table shows the default key bindings:
  342. X.IP "\fBC-a '\fP"
  343. X.PD 0
  344. X.IP "\fBC-a ""\fP    (select)"
  345. X.PD
  346. XPrompt for a window name or number to switch to.
  347. X.IP "\fBC-a 0\fP    (select 0)"
  348. X.PD 0
  349. X.IP "\fB ... \fP       ..."
  350. X.IP "\fBC-a 9\fP    (select 9)"
  351. X.PD
  352. XSwitch to window number 0 \- 9.
  353. X.IP "\fBC-a C-a\fP    (other)"
  354. XToggle to the window displayed previously.
  355. X.IP "\fBC-a a\fP    (meta)"
  356. XSend the command character (C-a) to window. See \fIescape\fP command.
  357. X.IP "\fBC-a A\fP    (aka)"
  358. XAllow the user to enter an a.\|k.\|a (also-known-as) for the current window.
  359. X.IP "\fBC-a b\fP"
  360. X.PD 0
  361. X.IP "\fBC-a C-b\fP    (break)"
  362. X.PD
  363. XSend a break to window.
  364. X.IP "\fBC-a B\fP    (pow_break)"
  365. XReopen the terminal line and send a break.
  366. X.IP "\fBC-a c\fP"
  367. X.PD 0
  368. X.IP "\fBC-a C-c\fP    (screen)"
  369. X.PD
  370. XCreate a new window with a shell and switch to that window.
  371. X.IP "\fBC-a C\fP    (clear)"
  372. XClear the screen.
  373. X.IP "\fBC-a d\fP"
  374. X.PD 0
  375. X.IP "\fBC-a C-d\fP    (detach)"
  376. X.PD
  377. XDetach
  378. X.I screen
  379. Xfrom this terminal.
  380. X.IP "\fBC-a D D\fP    (pow_detach)"
  381. XDetach and logout.
  382. X.IP "\fBC-a f\fP"
  383. X.PD 0
  384. X.IP "\fBC-a C-f\fP    (flow)"
  385. X.PD
  386. XToggle flow \fIon\fP, \fIoff\fP or \fIauto\fP.
  387. X.IP "\fBC-a C-g\fP    (vbell)"
  388. XToggles 
  389. X.I screen's
  390. Xvisual bell mode. 
  391. X.IP "\fBC-a h\fP"
  392. X.PD 0
  393. X.IP "\fBC-a C-h\fP    (hardcopy)"
  394. X.PD
  395. XWrite a hardcopy of the current window to the file \*Qhardcopy.\fIn\fP\*U.
  396. X.IP "\fBC-a H\fP    (log)"
  397. XBegins/ends logging of the current window to the file \*Qscreenlog.\fIn\fP\*U.
  398. X.IP "\fBC-a i\fP"
  399. X.PD 0
  400. X.IP "\fBC-a C-i\fP    (info)"
  401. X.PD
  402. XShow info about this window.
  403. X.IP "\fBC-a I\fP    (login on)"
  404. XCreate utmp entry for this window.
  405. X.IP "\fBC-a k\fP"
  406. X.PD 0
  407. X.IP "\fBC-a C-k\fP    (kill)"
  408. X.PD
  409. XDestroy current window.
  410. X.IP "\fBC-a l\fP"
  411. X.PD 0
  412. X.IP "\fBC-a C-l\fP    (redisplay)"
  413. X.PD
  414. XFully refresh current window.
  415. X.IP "\fBC-a L\fP    (login)"
  416. XToggle this windows login slot.
  417. X.IP "\fBC-a m\fP"
  418. X.PD 0
  419. X.IP "\fBC-a C-m\fP    (lastmsg)"
  420. X.PD
  421. XRepeat the last message displayed in the message line.
  422. X.IP "\fBC-a M\fP    (monitor)"
  423. XToggles monitoring of the current window.
  424. X.IP "\fBC-a space\fP"
  425. X.PD 0
  426. X.IP "\fBC-a n\fP"
  427. X.IP "\fBC-a C-n\fP    (next)"
  428. X.PD
  429. XSwitch to the next window.
  430. X.IP "\fBC-a O\fP    (login off)"
  431. XRemove utmp login slot for this window.
  432. X.IP "\fBC-a backspace\fP"
  433. X.PD 0
  434. X.IP "\fBC-a p\fP"
  435. X.IP "\fBC-a C-p\fP    (prev)"
  436. X.PD
  437. XSwitch to the previous window (opposite of \fBC-a n\fP).
  438. X.IP "\fBC-a q\fP"
  439. X.PD 0
  440. X.IP "\fBC-a C-q\fP    (xon)"
  441. X.PD
  442. XSend a control-q to the current window.
  443. X.IP "\fBC-a r\fP"
  444. X.PD 0
  445. X.IP "\fBC-a C-r\fP    (wrap)"
  446. X.PD
  447. XToggle the current window's line-wrap setting (turn the current window's
  448. Xautomatic margins on and off).
  449. X.IP "\fBC-a s\fP"
  450. X.PD 0
  451. X.IP "\fBC-a C-s\fP    (xoff)"
  452. X.PD
  453. XSend a control-s to the current window.
  454. X.IP "\fBC-a t\fP"
  455. X.PD 0
  456. X.IP "\fBC-a C-t\fP    (time)"
  457. X.PD
  458. XShow system information.
  459. X.IP "\fBC-a v\fP"
  460. X.PD 0
  461. X.IP "\fBC-a C-v\fP    (version)"
  462. X.PD
  463. XDisplay the version and compilation date.
  464. X.IP "\fBC-a w\fP"
  465. X.PD 0
  466. X.IP "\fBC-a C-w\fP    (windows)"
  467. X.PD
  468. XShow a list of window.
  469. X.IP "\fBC-a W\fP    (width)"
  470. XToggle 80/132 columns.
  471. X.IP "\fBC-a x\fP"
  472. X.PD 0
  473. X.IP "\fBC-a C-x\fP    (lockscreen)"
  474. X.PD
  475. XLock this terminal.
  476. X.IP "\fBC-a z\fP"
  477. X.PD 0
  478. X.IP "\fBC-a C-z\fP    (suspend)"
  479. X.PD
  480. XSuspend
  481. X.IR screen .
  482. X.IP "\fBC-a Z\fP    (reset)"
  483. XReset the virtual terminal to its \*Qpower-on\*U values.
  484. X.IP "\fBC-a .\fP    (dumptermcap)"
  485. XWrite out a \*Q.termcap\*U file.
  486. X.IP "\fBC-a ?\fP    (help)"
  487. XShow key bindings.
  488. X.IP "\fBC-a C-\e\fP    (quit)"
  489. XKill all windows and terminate
  490. X.IR screen .
  491. X.IP "\fBC-a :\fP    (colon)"
  492. XEnter command line mode.
  493. X.IP "\fBC-a [\fP"
  494. X.PD 0
  495. X.IP "\fBC-a C-[\fP"
  496. X.IP "\fBC-a esc\fP    (copy)"
  497. X.PD
  498. XEnter copy/scrollback mode. 
  499. X.IP "\fBC-a ]\fP"
  500. X.PD 0
  501. X.IP "\fBC-a C-]\fP    (paste)"
  502. X.PD
  503. XWrite the contents of the paste buffer to the stdin queue of the
  504. Xcurrent window.
  505. X.IP "\fBC-a {\fP
  506. X.PD 0
  507. X.IP "\fBC-a }\fP    (history)"
  508. X.PD
  509. XCopy and paste a previous (command) line.
  510. X.IP "\fBC-a >\fP    (writebuf)"
  511. XWrite pastebuffer to a file.
  512. X.IP "\fBC-a <\fP    (readbuf)"
  513. XReads the screen-exchange file into the pastebuffer.
  514. X.IP "\fBC-a =\fP    (removebuf)"
  515. XRemoves the file used by \fBC-a <\fP and \fPC-a >\fP.
  516. X.IP "\fBC-a ,\fP    (license)"
  517. XShows where screen comes from, where it went to and why you can use it.
  518. X
  519. X
  520. X.SH CUSTOMIZATION
  521. XThe \*Qsocket directory\*U defaults either to $HOME/.screen or preferably
  522. Xto /local/screens. If
  523. X.I screen
  524. Xis installed setuid-root, then the administrator
  525. Xshould compile screen with an adequate (not NFS mounted) socket directory. If
  526. X.I screen
  527. Xis not running setuid-root, the user can specify any mode 777 directory
  528. Xin the environment variable $SCREENDIR.
  529. X.PP
  530. XWhen
  531. X.I screen
  532. Xis invoked, it executes initialization commands from the files
  533. X\*Q/local/etc/screenrc\*U and
  534. X\*Q.screenrc\*U in the user's home directory. These are the \*Qprogrammer's
  535. Xdefaults\*U that can be overridden in the following ways: For the 
  536. Xglobal screenrc file 
  537. X.I screen
  538. Xsearches for the environment variable $SYSSCREENRC. The user specific
  539. Xscreenrc file is searched in $ISCREENRC, then $SCREENRC, then $HOME/.iscreenrc
  540. Xand finally defaults to $HOME/.screenrc. The command line option \fB-c\fP takes
  541. Xprecedence over the user specific screenrc file.
  542. XCommands in these files are used to set options, bind functions to
  543. Xkeys, and to automatically establish one or more extra windows at the
  544. Xbeginning of your
  545. X.I screen
  546. Xsession.
  547. XCommands are listed one per line, with empty lines being ignored.
  548. XA command's arguments are separated by tabs or spaces, and may be
  549. Xsurrounded by single or double quotes.
  550. XA `#' turns the rest of the line into a comment, except in quotes.
  551. XUnintelligible lines are warned about and ignored.
  552. XCommands may contain references to environment variables. The 
  553. Xsyntax is the shell-like "$VAR " or "${VAR}". Note that this causes 
  554. Xincompatibilities with previous 
  555. X.I screen
  556. Xversions, as now the '$'-sign has to be protected with '\e' if no
  557. Xvariable substitution shall be performed.
  558. X.PP
  559. XCustomization can also be done 'on-line'. To enter the command mode type
  560. X`C-a :'. Note that commands starting with \*Qdef\*U change default values,
  561. Xwhile others change current settings.
  562. X.PP
  563. XThe following initialization commands are available:
  564. X.sp 
  565. X.ne 3
  566. X.BI acladd " username"
  567. X.PP
  568. XEnable a user to access this screen session. Multi user mode only.
  569. X.sp
  570. X.ne 3
  571. X.BI acldel " username"
  572. X.PP
  573. XRemove a user from screens access control list. Multi user mode only.
  574. X.sp
  575. X.ne 3
  576. X.BI activity " message"
  577. X.PP
  578. XWhen any activity occurs in a background window that is being monitored,
  579. X.I screen
  580. Xdisplays a notification in the message line.
  581. XThe notification message can be re-defined by means of the \*Qactivity\*U
  582. Xcommand.
  583. XEach occurrence of `%' in \fImessage\fP is replaced by
  584. Xthe number of the window in which activity has occurred,
  585. Xand each occurrence of `~' is replaced by the definition for bell
  586. Xin your termcap (usually an audible bell).
  587. XThe default message is
  588. X.sp
  589. X    'Activity in window %'
  590. X.sp
  591. XNote that monitoring is off for all windows by default, but can be altered
  592. Xby use of the \*Qmonitor\*U command (C-a M).
  593. X.sp
  594. X.ne 3
  595. X.BR "aka " [ \fIwindowalias ]
  596. X.PP
  597. XSet the name of the current window to \fIwindowalias\fP. If no name is 
  598. Xspecified, screen prompts for one.
  599. X.sp
  600. X.ne 3
  601. X.BR "allpartial on" | off
  602. X.PP
  603. XIf set to on, only the current cursor line is refreshed on window change.
  604. XThis affects all windows and is useful for slow terminal lines. The 
  605. Xprevious setting of full/partial refresh for each window is restored
  606. Xwith \*Qallpartial off\*U.
  607. X.sp
  608. X.ne 3
  609. X.BR "autodetach on" | off
  610. X.PP
  611. XSets whether 
  612. X.I screen
  613. Xwill automatically detach upon hangup, which
  614. Xsaves all your running programs until they are resumed with a
  615. X.B "screen -r"
  616. Xcommand.
  617. XWhen turned off, a hangup signal will terminate 
  618. X.I screen
  619. Xand all the processes it contains. Autodetach is on by default.
  620. X.sp
  621. X.ne 3
  622. X.BR "autonuke on" | off
  623. X.PP
  624. XSets whether a clear screen sequence should nuke all the output
  625. Xthat has not been written to the terminal. See also
  626. X\*Qobuflimit\*U.
  627. X.sp
  628. X.ne 3
  629. X.BI "bell " message
  630. X.PP
  631. XWhen a bell character is sent to a background window,
  632. X.I screen
  633. Xdisplays a notification in the message line.
  634. XThe notification message can be re-defined by means of the \*Qbell\*U
  635. Xcommand.
  636. XEach occurrence of `%' in \fImessage\fP is replaced by
  637. Xthe number of the window to which a bell has been sent,
  638. Xand each occurrence of `~' is replaced by the definition for bell
  639. Xin your termcap (usually an audible bell).
  640. XThe default message is
  641. X.sp
  642. X    'Bell in window %'
  643. X.sp
  644. XAn empty message can be supplied to the \*Qbell\*U command to suppress
  645. Xoutput of a message line (bell "").
  646. X.sp
  647. X.ne 3
  648. X.BI "bind " key 
  649. X.RI [ command " [" args ]]
  650. X.PP
  651. XBind a command to a key.
  652. XBy default, most of the commands provided by
  653. X.I screen
  654. Xare bound to one or more keys as indicated in the \*QDEFAULT KEY BINDINGS\*U
  655. Xsection, e.\|g. the
  656. Xcommand to create a new window is bound to \*QC-c\*U and \*Qc\*U.
  657. XThe \*Qbind\*U command can be used to redefine the key bindings and to
  658. Xdefine new bindings.
  659. XThe \fIkey\fP argument is either a single character, a two-character sequence
  660. Xof the form \*Q^x\*U (meaning \*QC-x\*U), a backslash followed by an octal
  661. Xnumber (specifying the ASCII code of the character), or a backslash followed
  662. Xby a second character, such as \*Q\e^\*U or \*Q\e\e\*U.
  663. XThe argument can also be quoted, if you like.
  664. XIf no further argument is given, any previously established binding
  665. Xfor this key is removed.
  666. XThe \fIcommand\fP argument can be any command listed in this section.
  667. X.PP
  668. XSome examples:
  669. X.PP
  670. X.nf
  671. X    bind ' ' windows
  672. X    bind ^f screen telnet foobar
  673. X    bind \e033 screen -ln -t root -h 1000 9 su
  674. X.fi
  675. X.PP
  676. Xwould bind the space key to the command that displays a list
  677. Xof windows (so that the command usually invoked by \*QC-a C-w\*U
  678. Xwould also be available as \*QC-a space\*U),
  679. Xbind \*QC-f\*U to the command \*Qcreate a window with a TELNET
  680. Xconnection to foobar\*U, and bind \*Qescape\*U to the command
  681. Xthat creates an non-login window with a.\|k.\|a. \*Qroot\*U in slot #9, with
  682. Xa super-user shell and a scrollback buffer of 1000 lines.
  683. X.sp
  684. X.ne 3
  685. X.B break
  686. X.RI [ duration ]
  687. X.PP
  688. XSend a break signal for \fIduration\fP*0.25 seconds to this window.
  689. XMost useful if a character device is
  690. Xattached to the window rather than a shell process.
  691. X.sp
  692. X.ne 3
  693. X.B bufferfile
  694. X.RI [ exchange-file ]
  695. X.PP
  696. XChange the filename used for reading and writing with the copybuffer.
  697. XIf the optional argument to the \*Qbufferfile\*U command is omitted, 
  698. Xthe default setting (\*Q/tmp/screen-exchange\*U) is reactivated.
  699. XThe following example will paste the system's password file into 
  700. Xthe screen window:
  701. X.PP
  702. X.nf
  703. X    C-a : bufferfile /etc/passwd
  704. X    C-a < C-a ]
  705. X    C-a : bufferfile
  706. X.fi
  707. X.sp
  708. X.ne 3
  709. X.B chdir
  710. X.RI [ directory ]
  711. X.PP
  712. XChange the \fIcurrent directory\fP of
  713. X.I screen
  714. Xto the specified directory or, if called without an argument,
  715. Xto your home directory (the value of the environment variable $HOME).
  716. XAll windows that are created by means of the \*Qscreen\*U command
  717. Xfrom within \*Q.screenrc\*U or by means of \*QC-a : screen ...\*U
  718. Xor \*QC-a c\*U use this as their default directory.
  719. XWithout a chdir command, this would be the directory from which
  720. X.I screen
  721. Xwas invoked.
  722. XHardcopy and log files are always written to the \fIwindow's\fP default
  723. Xdirectory, \fInot\fP the current directory of the process running in the
  724. Xwindow.
  725. XYou can use this command multiple times in your .screenrc to start various
  726. Xwindows in different default directories, but the last chdir value will
  727. Xaffect all the windows you create interactively.
  728. X.sp
  729. X.ne 3
  730. X.B clear
  731. X.PP
  732. XClears the current window and saves its image to the scrollback buffer.
  733. X.sp
  734. X.ne 3
  735. X.B colon
  736. X.PP
  737. XAllows you to enter \*Q.screenrc\*U command lines. Useful 
  738. Xfor on-the-fly modification of key bindings, 
  739. Xspecific window creation and changing settings. Note that the \*Qset\*U
  740. Xkeyword no longer exists! Usually commands affect the current window rather 
  741. Xthan default settings for future windows. Change defaults with commands
  742. Xstarting with 'def...'. 
  743. X
  744. XIf you consider this as the `Ex command mode' of 
  745. X.IR screen ,
  746. Xyou may regard \*QC-a esc\*U (copy mode) as its `Vi command mode'.
  747. X.sp 
  748. X.ne 3
  749. X.BR console [ on | off ]
  750. X.PP
  751. XGrabs or ungrabs the machines console output to a window.
  752. X.sp
  753. X.ne 3
  754. X.B copy
  755. X.PP
  756. XEnter copy/scrollback mode. This allows you to copy text from the current
  757. Xwindow and its history into the paste buffer. In this mode a vi-like
  758. X`full screen editor' is active:
  759. X.br
  760. X.IR "Movement keys" :
  761. X.br
  762. X.in +4n
  763. X.ti -2n
  764. X\fBh\fP, \fBj\fP, \fBk\fP, \fBl\fP move the cursor line by line or 
  765. Xcolumn by column.
  766. X.br
  767. X.ti -2n
  768. X\fB0\fP, \fB^\fP and \fB$\fP move to the leftmost column, to the first or last
  769. Xnon-whitespace character on the line.
  770. X.br
  771. X.ti -2n
  772. X\fBH\fP, \fBM\fP and \fBL\fP move the cursor to the leftmost column
  773. Xof the top, center or bottom line of the window. 
  774. X.br
  775. X.ti -2n
  776. X\fB+\fP and \fB\-\fP positions one line up and down.
  777. X.br
  778. X.ti -2n
  779. X\fBG\fP moves to the specified absolute line (default: end of buffer).
  780. X.br 
  781. X.ti -2n
  782. X\fB|\fP moves to the specified absolute column.
  783. X.br
  784. X.ti -2n
  785. X\fBw\fP, \fBb\fP, \fBe\fP move the cursor word by word.
  786. X.br 
  787. X.ti -2n
  788. X\fBC-u\fP and \fBC-d\fP scroll the display up/down by the specified amount of 
  789. Xlines while preserving the cursor position. (Default: half screen-full). 
  790. X.br
  791. X.ti -2n
  792. X\fBC-b\fP and \fBC-f\fP scroll the display up/down a full screen.
  793. X.br
  794. X.ti -2n
  795. X\fBg\fP moves to the beginning of the buffer.
  796. X.br
  797. X.ti -2n
  798. X\fB%\fP jumps to the specified percentage of the buffer.
  799. X.br
  800. X.ti -4n
  801. X
  802. X.IR Note :
  803. X.br
  804. XEmacs style movement keys can be customized by a .screenrc command. 
  805. X(E.\|g. markkeys "h=^B:l=^F:$=^E") There is no simple method for a full 
  806. Xemacs-style keymap, as this involves multi-character codes.
  807. X
  808. X.br
  809. X.ti -4n
  810. X.IR Marking :
  811. X.br
  812. XThe copy range is specified by setting two marks. The text between these marks 
  813. Xwill be highlighted. Press 
  814. X.br
  815. X.ti -2n
  816. X\fBspace\fP to set the first or second mark
  817. Xrespectively.
  818. X.br
  819. X.ti -2n
  820. X\fBY\fP and \fBy\fP used to mark one whole line or to mark from 
  821. Xstart of line.
  822. X.br
  823. X.ti -2n
  824. X\fBW\fP marks exactly one word. 
  825. X.br 
  826. X.ti -4n
  827. X.IR "Repeat count" :
  828. X.br
  829. XAny of these commands can be prefixed with a repeat count number by pressing 
  830. Xdigits 
  831. X.br
  832. X.ti -2n
  833. X\fB0\fP..\fB9\fP which
  834. Xis taken as a repeat count. 
  835. X.br
  836. XExample: \*QC-a C-[ H 10 j 5 Y\*U will copy lines
  837. X11 to 15 into the pastebuffer.
  838. X.br
  839. X.ti -4n
  840. X.IR Searching :
  841. X.ti -2n
  842. X\fB/\fP \fIVi\fP-like search forward.
  843. X.ti -2n
  844. X\fB?\fP \fIVi\fP-like search backward.
  845. X.ti -2n 
  846. X\fBC-a s\fP \fIEmacs\fP style incremental search forward.
  847. X.ti -2n
  848. X\fBC-r\fP \fIEmacs\fP style reverse i-search.
  849. X.ti -4n
  850. X.IR Specials :
  851. X.br
  852. XThere are however some keys that act differently than in
  853. X.IR vi .
  854. X.I Vi
  855. Xdoes not allow one to yank rectangular blocks of text, but
  856. X.I screen
  857. Xdoes. Press 
  858. X.br
  859. X.ti -2n
  860. X\fBc\fP or \fBC\fP to set the left or right margin respectively. If no repeat count is
  861. Xgiven, both default to the current cursor position. 
  862. X.br
  863. XExample: Try this on a rather full text screen: 
  864. X\*QC-a [ M 20 l SPACE c 10 l 5 j C SPACE\*U.
  865. X
  866. XThis moves one to the middle line of the screen, moves in 20 columns left,
  867. Xmarks the beginning of the copybuffer, sets the left column, moves 5 columns
  868. Xdown, sets the right column, and then marks the end of
  869. Xthe copybuffer. Now try:
  870. X.br
  871. X\*QC-a [ M 20 l SPACE 10 l 5 j SPACE\*U
  872. X
  873. Xand notice the difference in the amount of text copied.
  874. X.br
  875. X.ti -2n
  876. X\fBJ\fP joins lines. It toggles between 
  877. X3 modes: lines separated by a newline character (012), lines glued seamless,
  878. Xlines separated by a single whitespace. Note that you can prepend the newline
  879. Xcharacter with a carriage return character, by issuing a \*Qcrlf on\*U.
  880. X.br
  881. X.ti -2n
  882. X\fBv\fP is for all the
  883. X.I vi 
  884. Xusers with \*Q:set numbers\*U \- it toggles the left margin between column 9
  885. Xand 1. Press 
  886. X.br
  887. X.ti -2n
  888. X\fBa\fP before the final space key to toggle in append mode. Thus
  889. Xthe contents of the pastebuffer will not be overwritten, but is appended to.
  890. X.br
  891. X.ti -2n
  892. X\fBA\fP toggles in append mode and sets a (second) mark.
  893. X.br
  894. X.ti -2n
  895. X\fB>\fP sets the (second) mark and writes the contents of the copybuffer to
  896. Xthe screen-exchange file (/tmp/screen-exchange per default) once copy-mode is 
  897. Xfinished. 
  898. X.br
  899. XThis example demonstrates how to dump the whole scrollback buffer 
  900. Xto that file: \*QC-A [ g SPACE G $ >\*U.
  901. X.br
  902. X.ti -2n
  903. X\fBC-g\fP gives information about the current line and column.
  904. X.br
  905. X.ti -2n
  906. X\fB@\fP does nothing. Does not even exit copy mode.
  907. X.in -4n
  908. X.sp
  909. X.ne 3
  910. X.B copy_reg
  911. X.RI [ key ]
  912. X.PP
  913. XStore the current copybuffer contents in a register referenced by \fIkey\fP.
  914. XIf the name is omitted you will be prompted to press the key.
  915. X.sp
  916. X.ne 3
  917. X.BR "crlf on" | off
  918. X.PP
  919. XThis affects the copying of text regions with the `C-a [' command. If it is set
  920. Xto `on', lines will be separated by the two character sequence `CR' - `LF'. 
  921. XOtherwise (default) only `LF' is used.
  922. X.sp
  923. X.ne 3
  924. X.BR "defautonuke on" | off
  925. X.PP
  926. XSame as the \fBautonuke\fP command except that the default setting for new displays is changed. Initial setting is `off'.
  927. XNote that you can use the special 'AN' terminal capability if you
  928. Xwant to have a dependency on the terminal type.
  929. X.sp
  930. X.ne 3
  931. X.BR "defflow on" | off | auto 
  932. X.RB [ interrupt ]
  933. X.PP
  934. XSame as the \fBflow\fP command except that the default setting for new windows 
  935. Xis changed. Initial setting is `auto'.
  936. XSpecifying \*Qdefflow auto interrupt\*U is the same as the command-line options
  937. X.B \-fa
  938. Xand
  939. X.BR \-i . 
  940. X.sp
  941. X.ne 3
  942. X.BR "deflogin on" | off
  943. X.PP
  944. XSame as the \fBlogin\fP command except that the default setting for new windows 
  945. Xis changed. This is initialised with `on' as distributed (see config.h.in).
  946. X.sp
  947. X.ne 3
  948. X.BI "defmode " mode
  949. X.PP
  950. XThe mode of each newly allocated pseudo-tty is set to \fImode\fP.
  951. X\fIMode\fP is an octal number.
  952. XWhen no \*Qdefmode\*U command is given, mode 0622 is used.
  953. X.sp
  954. X.ne 3
  955. X.BR "defmonitor on" | off
  956. X.PP
  957. XSame as the \fBmonitor\fP command except that the default setting for new 
  958. Xwindows is changed. Initial setting is `off'.
  959. X.sp
  960. X.ne 3
  961. X.BI "defobuflimit " limit
  962. X.PP
  963. XSame as the \fBobuflimit\fP command except that the default setting for new displays is changed. Initial setting is 256 bytes.
  964. XNote that you can use the special 'OL' terminal capability if you
  965. Xwant to have a dependency on the terminal type.
  966. X.sp
  967. X.ne 3
  968. X.BI "defscrollback " num
  969. X.PP
  970. XSame as the \fBscrollback\fP command except that the default setting for new 
  971. Xwindows is changed. Initial setting is 100.
  972. X.sp
  973. X.ne 3
  974. X.BR "defwrap on" | off
  975. X.PP
  976. XSame as the \fBwrap\fP command except that the default setting for new 
  977. Xwindows is changed. Initially line-wrap is on and can be toggled with the 
  978. X\*Qwrap\*U command (\*QC-a r\*U) or by means of "C-a : wrap on|off".
  979. X.sp
  980. X.ne 3
  981. X.B detach
  982. X.PP
  983. XDetach the 
  984. X.I screen
  985. Xsession (disconnect it from the terminal and put it into the background).
  986. XThis returns you to the shell where you invoked
  987. X.IR screen .
  988. XA detached
  989. X.I screen
  990. Xcan be resumed by invoking
  991. X.I screen
  992. Xwith the
  993. X.B \-r
  994. Xoption. (See also section \*QCOMMAND-LINE OPTIONS\*U.)
  995. X.sp
  996. X.ne 3
  997. X.B dumptermcap
  998. X.PP
  999. XWrite the termcap entry for the virtual terminal optimized for the currently
  1000. Xactive window to the file \*Q.termcap\*U in the user's 
  1001. X\*Q$HOME/.screen\*U directory (or wherever 
  1002. X.I screen
  1003. Xstores its sockets. See the \*QFILES\*U section below).
  1004. XThis termcap entry is identical to the value of the environment variable
  1005. X$TERMCAP that is set up by
  1006. X.I screen
  1007. Xfor each window. For terminfo based systems you will need to run a converter
  1008. Xlike 
  1009. X.IR captoinfo
  1010. Xand then compile the entry with 
  1011. X.IR tic .
  1012. X.sp
  1013. X.ne 3
  1014. X.BR "echo " [ -n ]
  1015. X.I message
  1016. X.PP
  1017. XThe echo command may be used to annoy 
  1018. X.I screen
  1019. Xusers with a 'message of the
  1020. Xday'. Typically installed in a global /local/etc/screenrc. See also
  1021. X\*Qsleep\*U.
  1022. XEcho is also useful for online checking of environment variables.
  1023. X.sp
  1024. X.ne 3
  1025. X.BI "escape " xy
  1026. X.PP
  1027. XSet the command character to \fIx\fP and the character generating a literal
  1028. Xcommand character to \fIy\fP (just like in the \-e option).
  1029. XEach argument is either a single character, a two-character sequence
  1030. Xof the form \*Q^x\*U (meaning \*QC-x\*U), a backslash followed by an octal
  1031. Xnumber (specifying the ASCII code of the character), or a backslash followed
  1032. Xby a second character, such as \*Q\e^\*U or \*Q\e\e\*U.
  1033. XThe default is \*Q^Aa\*U.
  1034. X.sp
  1035. X.ne 3
  1036. X.B exec
  1037. X.RI [[ fdpat ]
  1038. X.IR "newcommand " [ "args ..." ]]
  1039. X.PP
  1040. XRun a subprocess (newcommand) in the current window. The flow of data between 
  1041. Xnewcommands stdin/stdout/stderr, the process already running (shell) and 
  1042. Xscreen itself (window) is controlled by the filedescriptor pattern fdpat.
  1043. XThis pattern is basically a three character sequence representing stdin, stdout
  1044. Xand stderr of newcommand. A dot (.) connects the file descriptor
  1045. Xto screen. An exclamation mark (!) causes the file
  1046. Xdescriptor to be connected to the already running process. A colon (:) combines
  1047. Xboth.
  1048. XUser input will go to newcommand unless newcommand requests the old process' 
  1049. Xoutput (fdpats first character is `!' or `:') or a pipe (|) is added to 
  1050. Xthe end of fdpat.
  1051. X.br
  1052. XInvoking `exec' without arguments shows name and arguments of the currently
  1053. Xrunning subprocess in this window.
  1054. X.br
  1055. XWhen a subprocess is running the `kill' command will affect it instead of the
  1056. Xwindows process.
  1057. X.br
  1058. XRefer to the postscript file `fdpat.ips' for illustration of all 21 possible
  1059. Xcombinations. Each drawing shows the numbers 210 representing the three
  1060. Xfile descriptors of newcommand. The box marked `W' is usual pty that has 
  1061. Xthe old process (shell) on its slave side. The box marked `P' is the 
  1062. Xsecondary pty that now has screen at its master side.
  1063. X.sp
  1064. XAbbreviations: 
  1065. X.br
  1066. XWhitespace between the word `exec' and fdpat and the command 
  1067. Xcan be omitted. Trailing dots and a fdpat consisting only of dots can be 
  1068. Xomitted. A simple `|' is synonymous for the pattern `!..|'; the word exec can
  1069. Xbe ommitted here and can always be replaced by `!'.
  1070. X.sp
  1071. XExamples:
  1072. X.IP
  1073. Xexec ... /bin/sh
  1074. X.br
  1075. Xexec /bin/sh
  1076. X.br
  1077. X!/bin/sh
  1078. X.PP
  1079. XCreates another shell in the same window, while the orignal shell is still 
  1080. Xrunning. Output of both shells is displayed and user input is sent to the new
  1081. X/bin/sh.
  1082. X.IP
  1083. Xexec !.. stty 19200
  1084. X.br
  1085. Xexec ! stty 19200
  1086. X.br
  1087. X!!stty 19200
  1088. X.PP
  1089. XSet the speed of the windows tty. If your stty command operates on stdout, then
  1090. Xadd another `!'.
  1091. X.IP
  1092. Xexec !..| less
  1093. X.br
  1094. X|less
  1095. X.PP
  1096. XThis adds a pager to the window output. The special character `|' is needed to
  1097. Xgive the user controll over the pager although it gets its input from the 
  1098. Xoriginal process.
  1099. X.IP
  1100. X!:sed -n s/.*Error.*/\e007/p
  1101. X.PP
  1102. XSends window output to both, the user and the sed command. The sed inserts an
  1103. Xadditional bell character (oct. 007) to the window output seen by screen.
  1104. XThis will cause "Bell in window x" messages, whenever the string "Error"
  1105. Xappears in the window.
  1106. X.sp
  1107. X.ne 3
  1108. X.B flow
  1109. X.RB [ on | off | "auto\fR]\fP"
  1110. X.PP
  1111. XSets the flow-control mode for this window.
  1112. XWithout parameters it cycles the current window's flow-control setting from 
  1113. X"automatic" to "on" to "off".
  1114. XSee the discussion on \*QFLOW-CONTROL\*U later on in this document for full 
  1115. Xdetails and note, that this is subject to change in future releases.
  1116. XDefault is set by `defflow'.
  1117. X.sp
  1118. X.ne 3
  1119. X.B hardcopy
  1120. X.PP
  1121. XWrites out the currently displayed image to a file \fIhardcopy.n\fP
  1122. Xin the window's default directory, where \fIn\fP is the number
  1123. Xof the current window. 
  1124. XThis either appends or overwrites the file if it exists. See below.
  1125. X.sp
  1126. X.ne 3
  1127. X.BR "hardcopy_append on" | off
  1128. X.PP
  1129. XIf set to "on", 
  1130. X.I screen
  1131. Xwill append to the "hardcopy.n" files created by the command \*QC-a h\*U, 
  1132. Xotherwise these files are overwritten each time.
  1133. XDefault is `off'.
  1134. X.sp
  1135. X.ne 3
  1136. X.BI "hardcopydir "directory
  1137. X.PP
  1138. XDefines a directory where hardcopy files will be placed. If unset hardcopys
  1139. Xare dumped in screens current working directory.
  1140. X.sp
  1141. X.ne 3
  1142. X.BR "hardstatus " [ on | off ]
  1143. X.PP
  1144. XToggles the use of the terminal's hardware status line. If "on", 
  1145. X.I screen
  1146. Xwill use this facility to display one line messages. Otherwise these messages
  1147. Xare overlayed in reverse video mode at the display line. Note that the 
  1148. Xhardstatus feature can only be used if the termcap/terminfo capabilities
  1149. X"hs", "ts", "fs" and "ds" are set properly. Default is `on'.
  1150. X.sp
  1151. X.ne 3
  1152. X.BR "height " [ \fIlines\fP ]
  1153. X.PP
  1154. XSet the display height to a specified number of lines. When no argument
  1155. Xis given it toggles between 24 and 42 lines display.
  1156. X.sp
  1157. X.ne 3
  1158. X.B help
  1159. X.PP
  1160. XNot really a online help, but 
  1161. Xdisplays a help screen showing you all the key bindings.
  1162. XThe first pages list all the internal commands followed by their current
  1163. Xbindings.
  1164. XSubsequent pages will display the custom commands, one command per key.
  1165. XPress space when you're done reading each page, or return to exit early.
  1166. XAll other characters are ignored, except for the command character, which will
  1167. Xexit the help display and begin a command.
  1168. XSee also \*QDEFAULT KEY BINDINGS\*U section.
  1169. X.sp
  1170. X.ne 3
  1171. X.B history
  1172. X.PP
  1173. XUsually users work with a shell that allows easy access to previous commands.
  1174. XFor example csh has the command \*Q!!\*U to repeat the last command executed. 
  1175. X.I Screen
  1176. Xallows you to have a primitive way of re-calling \*Qthe command that
  1177. Xstarted ...\*U: You just type the first letter of that command, then hit
  1178. X`C-a {' and
  1179. X.I screen
  1180. Xtries to find a previous line that matches with the `prompt character' 
  1181. Xto the left of the cursor. This line is pasted into this window's input queue.
  1182. XThus you have a crude command history (made up by the visible window and its
  1183. Xscrollback buffer). 
  1184. X.sp
  1185. X.ne 3
  1186. X.B info
  1187. X.PP
  1188. XUses the message line to display some information about the current window:
  1189. Xthe cursor position in the form \*Q(column,row)\*U starting with \*Q(1,1)\*U,
  1190. Xthe terminal width and height plus the size of the scrollback buffer in lines, 
  1191. Xlike in \*U(80,24)+50\*U, various flag settings (flow-control, insert mode,
  1192. Xorigin mode, wrap mode, application-keypad mode, output logging, activity
  1193. Xmonitoring and redraw (`+' indicates enabled, `\-' not)),
  1194. Xthe currently active character set (\fIG0\fP, \fIG1\fP, \fIG2\fP,
  1195. Xor \fIG3\fP), and in square brackets the terminal character sets that are
  1196. Xcurrently designated as \fIG0\fP through \fIG3\fP.
  1197. XFor system information use the \*Qtime\*U command.
  1198. X.sp
  1199. X.ne 3
  1200. X.BR ins_reg " [" \fIkey ]
  1201. X.PP
  1202. XPaste contents of register \fIkey\fP in current windows input stream. See also
  1203. Xthe \*Qcopy_reg\*U and \*Qregister\*U commands. 
  1204. X.sp
  1205. X.ne 3
  1206. X.B kill
  1207. X.PP
  1208. XKill current window.
  1209. X.br 
  1210. XIf there is an `exec' command running then it is killed. Otherwise the process
  1211. X(shell) running in the window receives a HANGUP condition, the window structure
  1212. Xis removed and screen switches to the previously displayed window.
  1213. XWhen the last window is destroyed, 
  1214. X.I screen
  1215. Xexits.
  1216. XNote:
  1217. X.I Emacs
  1218. Xusers should keep this command in mind, when killing a line.
  1219. XIt is recommended not to use \*QC-a\*U as the
  1220. X.I screen
  1221. Xescape key or to rebind kill to \*QC-a K\*U.
  1222. X.sp
  1223. X.ne 3
  1224. X.B lastmsg
  1225. X.PP
  1226. XRedisplay the last contents of the message/status line.
  1227. XUseful if you're typing when a message appears, because  the message goes 
  1228. Xaway when you press a key (unless your terminal has a hardware status line).
  1229. XRefer to the commands \*Qmsgwait\*U and \*Qmsgminwait\*U for fine tuning.
  1230. X.sp
  1231. X.ne 3
  1232. X.B license
  1233. X.PP
  1234. XDisplay the disclaimer page. This is done whenever
  1235. X.I screen
  1236. Xis started without options, which should be often enough. See also 
  1237. Xthe \*Qstartup_message\*U command.
  1238. X.sp
  1239. X.ne 3
  1240. X.B lockscreen
  1241. X.PP
  1242. XLock this display.
  1243. XCall a screenlock program (/local/bin/lck or /usr/bin/lock or a builtin if no
  1244. Xother is available). Screen does not accept any command keys until this program
  1245. Xterminates. Meanwhile processes in the windows may continue, as the windows 
  1246. Xare in the `detached' state. The screenlock program may be changed through the
  1247. Xenvironment variable $LOCKPRG (which must be set in the shell from which 
  1248. X.I screen
  1249. Xis started) and is executed with the user's uid and gid.
  1250. X.sp
  1251. X.ne 3
  1252. X.BR "log " [ on | off ]
  1253. X.PP
  1254. XStart/stop writing output of the current window to a file 
  1255. X\*Qscreenlog.\fIn\fP\*U in the window's default directory, where \fIn\fP 
  1256. Xis the number of the current window. If no parameter is given, the state
  1257. Xof logging is toggled. The session log is appended to the previous contents 
  1258. Xof the file if it already exists. The current contents and the contents 
  1259. Xof the scrollback history are not included in the session log.
  1260. XDefault is `off'.
  1261. X.sp
  1262. X.ne 3
  1263. X.BI "logdir "directory
  1264. X.PP
  1265. XDefines a directory where logfiles will be placed. If unset logfiles are written
  1266. Xin screens current working directory.
  1267. X.sp
  1268. X.ne 3
  1269. X.BR "login " [ on | off ]
  1270. X.PP
  1271. XAdds or removes the entry in the utmp database file for the current window.
  1272. XThis controls if the window is `logged in'.
  1273. XWhen no parameter is given, the login state of the window is toggled.
  1274. XAdditionally to that toggle, it is convenient having a `log in' and a `log out'
  1275. Xkey. E.\|g. `bind I login on' and `bind O login off' will map these
  1276. Xkeys to be C-a I and C-a O.
  1277. XThe default setting (in config.h.in) should be \*Qon\*U for a 
  1278. X.I screen
  1279. Xthat runs under suid-root.
  1280. XUse the \*Qdeflogin\*U command to change the default login state for new 
  1281. Xwindows.
  1282. X.sp
  1283. X.ne 3
  1284. X.BI "markkeys " string
  1285. X.PP
  1286. XThis is a method of changing the keymap used for copy/history mode.
  1287. XThe string is made up of \fIoldchar\fP=\fInewchar\fP pairs which are
  1288. Xseparated by `:'. Example: The string \*QB=^B:F=^F\*U will change the 
  1289. Xkeys `C-b' and `C-f' to the vi style binding (scroll up/down fill page).
  1290. XThis happens to be the default binding for `B' and `F'.
  1291. XThe command \*Qmarkkeys h=^B:l=^F:$=^E\*U would set the mode for an emacs-style
  1292. Xbinding.
  1293. X.sp
  1294. X.ne 3
  1295. X.B meta
  1296. X.PP
  1297. XInsert the command character (C-a) in the current window's input stream.
  1298. X.sp
  1299. X.ne 3
  1300. X.BR "monitor " [ on | off ]
  1301. X.PP
  1302. XToggles activity monitoring of windows.
  1303. XWhen monitoring is turned on and an affected window is switched into the
  1304. Xbackground, you will receive the activity notification message in the
  1305. Xstatus line at the first sign of output and the window will also be marked
  1306. Xwith an `@' in the window-status display.
  1307. XMonitoring is initially off for all windows.
  1308. X.sp
  1309. X.ne 3
  1310. X.BI "msgminwait " sec
  1311. X.PP
  1312. XDefines the time 
  1313. X.I screen 
  1314. Xdelays a new message when one message is currently displayed. 
  1315. XThe default is 1 second.
  1316. X.sp
  1317. X.ne 3
  1318. X.BI "msgwait " sec
  1319. X.PP
  1320. XDefines the time a message is displayed if 
  1321. X.I screen
  1322. Xis not disturbed by other activity. The default is 5 seconds.
  1323. X.sp
  1324. X.ne 3
  1325. X.BR "multiuser on" | off
  1326. X.PP
  1327. XSwitch between singleuser and multiuser mode. Standard screen operation
  1328. Xis singleuser. In multiuser mode the commands `acladd' and `acldel' can be
  1329. Xused to enable (and disable) other users to access this screen. 
  1330. X.sp
  1331. X.ne 3
  1332. X.BR "nethack on" | off
  1333. X.PP
  1334. XChanges the kind of error messages used by
  1335. X.IR screen .
  1336. XWhen you are familiar with the game \*Qnethack\*U, you may enjoy the
  1337. Xnethack-style messages which will often blur the facts a little, but are
  1338. Xmuch funnier to read. Anyway, standard messages often tend to be unclear as
  1339. Xwell.
  1340. X.br
  1341. XThis option is only 
  1342. Xavailable if screen was compiled with the NETHACK flag defined. The
  1343. Xdefault setting is then determined by the presence of the environment 
  1344. Xvariable $NETHACKOPTIONS.
  1345. X.sp
  1346. X.ne 3
  1347. X.B next
  1348. X.PP
  1349. XSwitch to the next window.
  1350. XThis command can be used repeatedly to cycle through the list of windows.
  1351. X.sp
  1352. X.ne 3
  1353. X.BR "obuflimit " [ \fIlimit ]
  1354. X.PP
  1355. XIf the output buffer contains more bytes than the specified limit, no
  1356. Xmore data will be
  1357. Xread from the windows. The default value is 256. If you have a fast
  1358. Xdisplay (like xterm), you can set it to some higher value. If no
  1359. Xargument is specified, the current setting is displayed.
  1360. X.sp
  1361. X.ne 3
  1362. X.B other
  1363. X.PP
  1364. XSwitch to the window displayed previously.
  1365. XNote that this function defaults to the command character typed twice,
  1366. Xunless overridden; for instance, if you use the option \*Q\fB\-e]x\fP\*U,
  1367. Xthis function becomes \*Q]]\*U, not \*Q]C-a\*U.
  1368. X.sp
  1369. X.ne 3
  1370. X.BR "partial on" | off
  1371. X.PP
  1372. XDefines whether the display should be refreshed (as done with "C-a l") after
  1373. Xswitching to the current window. This command only affects the current window.
  1374. XTo affect all windows use the \fIallpartial\fP command.
  1375. XDefault is `off', of course.
  1376. X.sp
  1377. X.ne 3
  1378. X.BR "password " [ \fIcrypted_pw ]
  1379. X.PP
  1380. XPresent a crypted password in your \*Q.screenrc\*U file and screen will ask
  1381. Xfor it, whenever someone attempts to resume a detached. This is useful
  1382. Xif you have privileged programs running under
  1383. X.I screen
  1384. Xand you want to protect your session from reattach attempts by another user
  1385. Xmasquerading as your uid (i.e. any superuser.)
  1386. XIf no crypted password is specified, screen prompts twice for typing a 
  1387. Xpassword and places its encryption in the copybuffer.
  1388. XDefault is `none', this disables password checking.
  1389. X.sp
  1390. X.ne 3
  1391. X.B "paste"
  1392. X.PP
  1393. XWrite the contents of the paste buffer to the stdin queue of the current window.
  1394. XThe paste buffer can be filled with the \fIcopy\fP, \fIhistory\fP and 
  1395. X\fIreadbuf\fP commands. 
  1396. X.sp
  1397. X.ne 3
  1398. X.B pow_break
  1399. X.PP
  1400. XReopen the window's terminal line and send a break condition. See `break'.
  1401. X.sp
  1402. X.ne 3
  1403. X.B pow_detach
  1404. X.PP
  1405. XPower detach. 
  1406. XMainly the same as \fIdetach\fP, but also sends a HANGUP signal to
  1407. Xthe parent process of
  1408. X.IR screen .
  1409. XCAUTION: This will result in a logout, when 
  1410. X.I screen
  1411. Xwas started from your login shell.
  1412. X.sp
  1413. X.ne 3
  1414. X.BI "pow_detach_msg " message
  1415. X.PP
  1416. XThe \fImessage\fP specified here is output whenever a `Power detach' was
  1417. Xperformed. It may be used as a replacement for a logout message or to reset 
  1418. Xbaud rate, etc. 
  1419. X.sp
  1420. X.ne 3
  1421. X.B prev
  1422. X.PP
  1423. XSwitch to the window with the next lower number.
  1424. XThis command can be used repeatedly to cycle through the list of windows.
  1425. X.sp
  1426. X.ne 3
  1427. X.BR process " [" \fIkey ]
  1428. X.PP
  1429. XStuff the contents of the specified register into \fIscreen\fP's
  1430. Xinput queue. If no argument is given you are prompted for a
  1431. Xregister name. This command can be used to bind multiple actions
  1432. Xto a single key.
  1433. X.sp
  1434. X.ne 3
  1435. X.B quit
  1436. X.PP
  1437. XKill all windows and terminate
  1438. X.IR screen .
  1439. XNote that on vt100-style terminals the keys C-4 and C-\e are identical.
  1440. XThis makes the default bindings dangerous:
  1441. XBe careful not to type C-a C-4 when selecting window no. 4.
  1442. XUse the empty bind command (as in \*Qbind '\e'\*U) to remove a key binding.
  1443. X.sp
  1444. X.ne 3
  1445. X.B readbuf
  1446. X.PP
  1447. XReads the contents of the current screen-exchange file into the copy buffer. 
  1448. XSee also \*Qbufferfile\*U command.
  1449. X.sp
  1450. X.ne 3
  1451. X.B redisplay
  1452. X.PP
  1453. XRedisplay the current window. Needed to get a full redisplay when in
  1454. Xpartial redraw mode.
  1455. X.sp
  1456. X.ne 3
  1457. X.BI "register " "key string"
  1458. X.PP
  1459. XSave the specified \fIstring\fP to the register \fIkey\fP. See also the
  1460. X\*Qins_reg\*U command.
  1461. X.sp
  1462. X.ne 3
  1463. X.B "removebuf"
  1464. X.PP
  1465. XUnlinks the screen-exchange file used by the commands \*Qwritebuf\*U and 
  1466. X\*Qreadbuf\*U. 
  1467. X.sp
  1468. X.ne 3
  1469. X.B "reset"
  1470. X.PP 
  1471. XReset the virtual terminal to its \*Qpower-on\*U values. Useful when strange
  1472. Xsettings (like scroll regions or graphics character set) are left over from
  1473. Xan application.
  1474. X.sp
  1475. X.ne 3
  1476. X.B "screen \fP[\fI-opts\fP] [\fIn\fP] [\fIcmd\fP [\fIargs\fP]]"
  1477. X.PP
  1478. XEstablish a new window.
  1479. XThe flow-control options (\fB\-f\fP, \fB\-fn\fP and \fB\-fa\fP),
  1480. Xtitle (a.\|k.\|a.) option (\fB\-t\fP), login options (\fB-l\fP and \fB-ln\fP)
  1481. X, terminal type option (\fB-T <term>\fP) and scrollback option (\fB-h\fP <num>)
  1482. Xmay be specified for each command.
  1483. XIf an optional number \fIn\fP in the range 0..9 is given, the window
  1484. Xnumber \fIn\fP is assigned to the newly created window (or, if this
  1485. Xnumber is already in-use, the next available number).
  1486. XIf a command is specified after \*Qscreen\*U, this command (with the given
  1487. Xarguments) is started in the window; otherwise, a shell is created.
  1488. XThus, if your \*Q.screenrc\*U contains the lines
  1489. X.sp
  1490. X.nf
  1491. X    # example for .screenrc:
  1492. X    screen 1
  1493. X    screen -fn -t foobar 2 telnet foobar
  1494. X.fi
  1495. X.sp
  1496. X.I screen
  1497. Xcreates a shell window (in window #1) and a window with a TELNET connection
  1498. Xto the machine foobar (with no flow-control using the a.\|k.\|a. \*Qfoobar\*U
  1499. Xin window #2). Note, that unlike previous versions of
  1500. X.I screen
  1501. Xno default window is created when \*Qscreen\*U commands are included in your
  1502. X\*Q.screenrc\*U file.
  1503. XWhen the initialization is completed,
  1504. X.I screen
  1505. Xswitches to the last window specified in your .screenrc file or, if none,
  1506. Xopens a default window #0.
  1507. X.sp
  1508. X.ne 3
  1509. X.B "scrollback \fP\fInum\fP"
  1510. X.PP
  1511. XSet the size of the scrollback buffer for the current windows to \fInum\fP 
  1512. Xlines. The default scrollback is 100 lines.
  1513. XSee also the \*Qdefscrollback\*U command and use \*QC-a i\*U to view the 
  1514. Xcurrent setting.
  1515. X.sp
  1516. X.ne 3
  1517. X.BR "select " [ \fP\fIn\fP ]
  1518. X.PP
  1519. XSwitch to the window with the number \fIn\fP.
  1520. XIf no window number is specified, you get prompted for an
  1521. Xidentifier. This can be an a.k.a. or a number.
  1522. XWhen a new window is established, the first available number
  1523. Xis assigned to this window.
  1524. XThus, the first window can be activated by \*QC-a 0\*U (there can be no more
  1525. Xthan 10 windows present simultaneously).
  1526. X.sp
  1527. X.ne
  1528. X.B "sessionname \fP[\fIname\fP]"
  1529. X.PP
  1530. XRename the current session. Note, that for \*Qscreen -list\*U the
  1531. Xname shows up with the process-id prepended. If the argument \*Qname\*U
  1532. Xis omitted, the name of this session is displayed. Caution: The $STY 
  1533. Xenvironment variables still reflects the old name. This may result in 
  1534. Xconfusion. 
  1535. XThe default is constructed from the tty and host names.
  1536. X.sp
  1537. X.ne 3
  1538. X.B "setenv \fIvar\fP \fIstring\fP"
  1539. X.PP
  1540. XSet the environment variable \fIvar\fP to value \fIstring\fP.
  1541. XThe environment is inherited by all subsequently forked shells.
  1542. X.sp
  1543. X.ne 3
  1544. X.B "shell \fIcommand\fP"
  1545. X.PP
  1546. XSet the command to be used to create a new shell.
  1547. XThis overrides the value of the environment variable $SHELL.
  1548. XThis is useful if you'd like to run a tty-enhancer which is expecting to
  1549. Xexecute the program specified in $SHELL. If the command begins with
  1550. Xa '-' character, the shell will be started as a login-shell.
  1551. X.sp
  1552. X.ne 3
  1553. X.B "shellaka \fIa.\|k.\|a.\fP"
  1554. X.PP
  1555. XSet the a.\|k.\|a. for all shells created during startup or by
  1556. Xthe C-A C-c command.
  1557. XFor details about what an a.\|k.\|a.\| is, see the discussion
  1558. Xentitled \*QALSO KNOWN AS\*U.
  1559. X.sp
  1560. X.ne 3
  1561. X.BR "silence " [ on | off "|\fIsec\fP]"
  1562. X.PP
  1563. XToggles silence monitoring of windows.
  1564. XWhen silence is turned on and an affected window is switched into the
  1565. Xbackground, you will receive the silence notification message in the
  1566. Xstatus line after a specified period of inactivity (silence). The default
  1567. Xtimeout can be changed with the `silencewait' command or by specifying a 
  1568. Xnumber of seconds instead of `on' or `off'.
  1569. XSilence is initially off for all windows.
  1570. X.sp
  1571. X.ne 3
  1572. X.BI "silencewait " sec
  1573. X.PP
  1574. XDefine the time that all windows monitored for silence should wait before
  1575. Xdisplaying a message. Default 30 seconds.
  1576. X.sp
  1577. X.ne
  1578. X.B "sleep \fP\fInum\fP"
  1579. X.PP
  1580. XThis command will pause the execution of a .screenrc file for \fInum\fP seconds.
  1581. XKeyboard activity will end the sleep.
  1582. XIt may be used to give users a chance to read the messages output by \*Qecho\*U.
  1583. X.sp
  1584. X.ne 3
  1585. X.B "slowpaste \fIusec\fP"
  1586. X.PP
  1587. XDefine the speed at which text is inserted by the paste ("C-a ]") command. 
  1588. XFor each 80 characters (IOSIZE) pasted 
  1589. X.I screen
  1590. Xwill make a pause of \fIusec\fP milliseconds to allow the application the
  1591. Xprocessing of input. Use slowpaste if your underlying system
  1592. Xhas difficulties performing large pastes (e.\|g. a VAX).
  1593. X.sp
  1594. X.ne 3
  1595. X.B "startup_message on\fP|\fBoff"
  1596. X.PP
  1597. XSelect whether you want to see the copyright notice during startup.
  1598. XDefault is `on', as you propably noticed.
  1599. X.sp
  1600. X.ne 3
  1601. X.B "suspend"
  1602. X.PP
  1603. XSuspend
  1604. X.IR screen .
  1605. XThe windows are in the `detached' state, while 
  1606. X.IR screen
  1607. Xis suspended. This feature relies on the shell being able to do job control.
  1608. X.sp
  1609. X.ne 3
  1610. X.B "term \fIterm\fP"
  1611. X.PP
  1612. XIn each window's environment
  1613. X.I screen
  1614. Xopens, the $TERM variable is set to \*Qscreen\*U by default. 
  1615. XBut when no description for \*Qscreen\*U is installed in the local termcap
  1616. Xor terminfo data base, you set $TERM to \- say \-
  1617. X\*Qvt100\*U. This won't do much harm, as 
  1618. X.I screen
  1619. Xis VT100/ANSI compatible.
  1620. XThe use of the \*Qterm\*U command is discouraged for non-default purpose.
  1621. XThat is, one may want to specify special $TERM settings (e.g. vt100) for the
  1622. Xnext \*Qscreen rlogin othermachine\*U command. Use the command \*Qscreen -T vt100
  1623. Xrlogin othermachine\*U rather than setting (\*Qterm vt100\*U) and resetting
  1624. X(\*Qterm screen\*U) the default before and after the \*Qscreen\*U command.
  1625. X.sp
  1626. X.ne 3
  1627. X.BI termcap " term terminal-tweaks"
  1628. X.RI [ window-tweaks ]
  1629. X.br
  1630. X.BI terminfo " term terminal-tweaks"
  1631. X.RI [ window-tweaks ]
  1632. X.PP
  1633. XUse this command to modify your terminal's termcap entry without going through
  1634. Xall the hassles involved in creating a custom termcap entry.
  1635. XPlus, you can optionally customize the termcap generated for the windows.
  1636. XIf your system works with terminfo-database rather than with
  1637. Xtermcap,
  1638. X.I screen
  1639. Xwill understand the `terminfo' command, which has the same effects as
  1640. Xthe `termcap' command. Thus users can write one .screenrc file that handles
  1641. Xboth cases, although terminfo syntax is slightly different
  1642. Xfrom termcap syntax.
  1643. X.PP
  1644. XThe first argument specifies which terminal(s) should be affected by this
  1645. Xdefinition.
  1646. XYou can specify multiple terminal names by separating them with `|'s.
  1647. XUse `*' to match all terminals and `vt*' to match all terminals that begin
  1648. Xwith \*Qvt\*U.
  1649. X.PP
  1650. XEach \fItweak\fP argument contains one or more termcap defines (separated
  1651. Xby `:'s) to be inserted at the start of the appropriate termcap entry,
  1652. Xenhancing it or overriding existing values.
  1653. XThe first tweak modifies your terminal's termcap, and contains definitions
  1654. Xthat your terminal uses to perform certain functions.
  1655. XSpecify a null string to leave this unchanged (e.\|g. '').
  1656. XThe second (optional) tweak modifies all the window termcaps, and should
  1657. Xcontain definitions that screen understands (see the \*QVIRTUAL TERMINAL\*U
  1658. Xsection).
  1659. X.PP
  1660. XSome examples:
  1661. X.IP
  1662. Xtermcap xterm*  LP:hs@
  1663. X.PP
  1664. XInforms
  1665. X.I screen
  1666. Xthat all terminals that begin with `xterm' have firm auto-margins that
  1667. Xallow the last position on the screen to be updated (LP), but they don't
  1668. Xreally have a status line (no 'hs' \- append `@' to turn entries off).
  1669. XNote that we assume `LP' for all terminal names that start with \*Qvt\*U,
  1670. Xbut only if you don't specify a termcap command for that terminal.
  1671. X.IP
  1672. Xtermcap vt*  LP
  1673. Xtermcap vt102|vt220  Z0=\eE[?3h:Z1=\eE[?3l
  1674. X.PP
  1675. XSpecifies the firm-margined `LP' capability for all terminals that begin with
  1676. X`vt', and the second line will also add the escape-sequences to switch
  1677. Xinto (Z0) and back out of (Z1) 132-character-per-line mode if this is
  1678. Xa vt102 or vt220.
  1679. X(You must specify Z0 and Z1 in your termcap to use the width-changing
  1680. Xcommands.)
  1681. X.IP
  1682. Xtermcap vt100  ""  l0=PF1:l1=PF2:l2=PF3:l3=PF4
  1683. X.PP
  1684. XThis leaves your vt100 termcap alone and adds the function key labels to
  1685. Xeach window's termcap entry.
  1686. X.IP
  1687. Xtermcap h19|z19  am@:im=\eE@:ei=\eEO  dc=\eE[P
  1688. X.PP
  1689. XTakes a h19 or z19 termcap and turns off auto-margins (am@) and enables the
  1690. Xinsert mode (im) and end-insert (ei) capabilities (the `@' in the `im'
  1691. Xstring is after the `=', so it is part of the string).
  1692. XHaving the `im' and `ei' definitions put into your terminal's termcap will
  1693. Xcause screen to automatically advertise the character-insert capability in
  1694. Xeach window's termcap.
  1695. XEach window will also get the delete-character capability (dc) added to its
  1696. Xtermcap, which screen will translate into a line-update for the terminal
  1697. X(we're pretending it doesn't support character deletion).
  1698. X.PP
  1699. XIf you would like to fully specify each window's termcap entry, you should
  1700. Xinstead set the $SCREENCAP variable prior to running
  1701. X.IR screen .
  1702. XSee the discussion on the \*QVIRTUAL TERMINAL\*U in this manual, and the termcap(5)
  1703. Xman page for more information on termcap definitions.
  1704. X.sp
  1705. X.ne 3
  1706. X.B time
  1707. X.PP
  1708. XUses the message line to display the time of day, the host name, and the load
  1709. Xaverages over 1, 5, and 15 minutes (if this is available on your system).
  1710. XFor window specific information use \*Qinfo\*U.
  1711. X.sp
  1712. X.ne 3
  1713. X.BI "unsetenv " var
  1714. X.PP
  1715. XUnset an environment variable.
  1716. X.sp
  1717. X.ne 3
  1718. X.BR "vbell on" | off
  1719. X.PP
  1720. XIf your terminal does not support
  1721. Xa visual bell, a `vbell-message' is displayed in the status line. 
  1722. XSets the visual bell setting for this window. If your terminal does not support
  1723. Xa visual bell, a `vbell-message' is displayed in the status line.
  1724. XRefer to the termcap variable `vb' (terminfo: 'flash'). 
  1725. X.sp
  1726. X.ne 3
  1727. X.BI "vbell_msg " message
  1728. X.PP
  1729. XSets the visual bell message. \fImessage\fP is printed to the status line if
  1730. Xthe window receives a bell character (^G) and vbell is set to \*Qon\*U.
  1731. XThe default message is \*QWuff, Wuff!!\*U.
  1732. X.sp
  1733. X.ne 3
  1734. X.BI "vbellwait " sec
  1735. X.PP
  1736. XDefine a delay in seconds after each display of 
  1737. X.IR screen 's
  1738. Xvisual bell message. The default is 1 second.
  1739. X.sp
  1740. X.ne 3
  1741. X.B version
  1742. X.PP
  1743. XPrint the current version and the compile date in the status line.
  1744. X.sp
  1745. X.ne 3
  1746. X.BR "width " [ \fInum ]
  1747. X.PP
  1748. XToggle the window width between 80 and 132 columns or set it to \fInum\fP 
  1749. Xcolumns if an argument is specified. 
  1750. XThis requires a capable terminal and the termcap entries \*QZ0\*U and \*QZ1\*U.
  1751. XSee the \*Qtermcap\*U command for more information.
  1752. X.sp
  1753. X.ne 3
  1754. X.B windows
  1755. X.PP
  1756. XUses the message line to display a list of all the windows.
  1757. XEach window is listed by number with the name of process that has been
  1758. Xstarted in the window (or its a.\|k.\|a.);
  1759. Xthe current window is marked with a `*';
  1760. Xthe previous window is marked with a `-';
  1761. Xall the windows that are \*Qlogged in\*U are marked with a `$';
  1762. Xa background window that has received a bell is marked with a `!';
  1763. Xa background window that is being monitored and has had activity occur
  1764. Xis marked with an `@';
  1765. Xa window which has output logging turned on is marked with `(L)'.
  1766. X.sp
  1767. X.ne 3
  1768. X.BR "wrap " [ on | off ]
  1769. X.PP
  1770. XSets the line-wrap setting for the current window.
  1771. XWhen line-wrap is on, the second consecutive printable character output at
  1772. Xthe last column of a line will wrap to the start of the following line.
  1773. XAs an added feature, backspace (^H) will also wrap through the left margin
  1774. Xto the previous line.
  1775. XDefault is `on'.
  1776. X.sp
  1777. X.ne 3
  1778. X.B writebuf
  1779. X.PP
  1780. XWrites the contents of the paste buffer to a public accessible screen-exchange
  1781. Xfile. This is thought of as a primitive means of communication between
  1782. X.I screen
  1783. Xusers on the same host. The filename can be set with the \fIbufferfile\fP 
  1784. Xcommand and defaults to \*Q/tmp/screen-exchange\*U.
  1785. X.sp
  1786. X.ne 3
  1787. X.B xoff
  1788. X.br
  1789. X.B xon
  1790. X.PP
  1791. XInsert a CTRL-s / CTRL-q character to the stdin queue of the
  1792. Xcurrent window.
  1793. X
  1794. X
  1795. X.SH "THE MESSAGE LINE"
  1796. X.I Screen
  1797. Xdisplays informational messages and other diagnostics in a \fImessage line\fP.
  1798. XWhile this line is distributed to appear at the bottom of the screen,
  1799. Xit can be defined to appear at the top of the screen during compilation.
  1800. XIf your terminal has a status line defined in its termcap, screen will use
  1801. Xthis for displaying its messages, otherwise a line of the current screen will
  1802. Xbe temporarily overwritten and output will be momentarily interrupted. The
  1803. Xmessage line is automatically removed after a few seconds delay, but it
  1804. Xcan also be removed early (on terminals without a status line) by beginning
  1805. Xto type.
  1806. X.PP
  1807. XThe message line facility can be used by an application running in
  1808. Xthe current window by means of the ANSI \fIPrivacy message\fP
  1809. Xcontrol sequence.
  1810. XFor instance, from within the shell, try something like:
  1811. X.IP
  1812. Xecho '<esc>^Hello world from window '$WINDOW'<esc>\e\e'
  1813. X.PP
  1814. Xwhere '<esc>' is an \fIescape\fP, '^' is a literal up-arrow,
  1815. Xand '\e\e' turns into a single backslash.
  1816. X
  1817. X
  1818. X.SH "FLOW-CONTROL"
  1819. XEach window has a flow-control setting that determines how screen deals with
  1820. Xthe XON and XOFF characters (and perhaps the interrupt character).
  1821. XWhen flow-control is turned off, screen ignores the XON and XOFF characters,
  1822. Xwhich allows the user to send them to the current program by simply typing
  1823. Xthem (useful for the \fIemacs\fP editor, for instance).
  1824. XThe trade-off is that it will take longer for output from a \*Qnormal\*U
  1825. Xprogram to pause in response to an XOFF.
  1826. XWith flow-control turned on, XON and XOFF characters are used to immediately
  1827. Xpause the output of the current window.
  1828. XYou can still send these characters to the current program, but you must use
  1829. Xthe appropriate two-character screen commands (typically \*QC-a q\*U (xon)
  1830. Xand \*QC-a s\*U (xoff)).
  1831. XThe xon/xoff commands are also useful for typing C-s and C-q past a terminal
  1832. Xthat intercepts these characters.
  1833. X.PP
  1834. XEach window has an initial flow-control value set with either the
  1835. X.B \-f
  1836. Xoption or the \*Qdefflow\*U .screenrc command. Per default the windows
  1837. Xare set to automatic flow-switching.
  1838. XIt can then be toggled between the three states 'fixed on', 'fixed off' and
  1839. X'automatic' interactively with the \*Qflow\*U command bound to "C-a f".
  1840. X.PP
  1841. XThe automatic flow-switching mode deals with
  1842. Xflow control using the TIOCPKT mode (like \*Qrlogin\*U does). If
  1843. Xthe tty driver does not support TIOCPKT, screen tries to find out
  1844. Xthe right mode based on the current setting of the application
  1845. Xkeypad \- when it is enabled, flow-control is turned off and visa versa.
  1846. XOf course, you can still manipulate flow-control manually when needed.
  1847. X.PP
  1848. XIf you're running with flow-control enabled and find that pressing the
  1849. Xinterrupt key (usually C-c) does not interrupt the display until another
  1850. X6-8 lines have scrolled by, try running screen with the \*Qinterrupt\*U
  1851. Xoption (add the \*Qinterrupt\*U flag to the \*Qflow\*U command in
  1852. Xyour .screenrc, or use the
  1853. X.B \-i
  1854. Xcommand-line option).
  1855. XThis causes the output that
  1856. X.I screen
  1857. Xhas accumulated from the interrupted program to be flushed.
  1858. XOne disadvantage is that the virtual terminal's memory contains the
  1859. Xnon-flushed version of the output, which in rare cases can cause
  1860. Xminor inaccuracies in the output.
  1861. XFor example, if you switch screens and return, or update the screen
  1862. Xwith \*QC-a l\*U you would see the version of the output you would
  1863. Xhave gotten without \*Qinterrupt\*U being on.
  1864. XAlso, you might need to turn off flow-control (or use auto-flow mode to turn
  1865. Xit off automatically) when running a program that expects you to type the
  1866. Xinterrupt character as input, as it is possible to interrupt
  1867. Xthe output of the virtual terminal to your physical terminal when flow-control
  1868. Xis enabled.
  1869. XIf this happens, a simple refresh of the screen with \*QC-a l\*U will
  1870. Xrestore it.
  1871. XGive each mode a try, and use whichever mode you find more comfortable.
  1872. X
  1873. X
  1874. X.SH "ALSO KNOWN AS (A.\|K.\|A.\|)"
  1875. XYou can customize each window's name in the window display (viewed with the
  1876. X\*Qwindows\*U command (C-a w)) by setting it with one of
  1877. Xthe a.\|k.\|a. commands.
  1878. XNormally the name displayed is the actual command name of the program
  1879. Xcreated in the window.
  1880. XHowever, it is sometimes useful to distinguish various programs of the same
  1881. Xname or to change the name on-the-fly to reflect the current state of
  1882. Xthe window.
  1883. X.PP
  1884. XThe default name for all shell windows can be set with the \*Qshellaka\*U
  1885. Xcommand in the .screenrc file, while all other windows are created with
  1886. Xa \*Qscreen\*U command and thus can have their name set with the
  1887. X.B \-t
  1888. Xoption.
  1889. XInteractively, there is the AKA-string escape-sequence
  1890. X(<esc>k\fIname\fP<esc>\e) and the \*Qaka\*U command (C-a A).
  1891. XThe former can be output from an application to control the window's name
  1892. Xunder software control, and the latter will prompt for a name when typed.
  1893. XYou can also bind pre-defined names to keys with the \*Qaka\*U command
  1894. Xto set things quickly without prompting.
  1895. X.PP
  1896. XFinally,
  1897. X.I screen
  1898. Xhas a shell-specific heuristic that is enabled by setting the window's name
  1899. Xto \*Q\fIsearch|name\fP\*U and arranging to have a null aka escape-sequence
  1900. Xoutput as a part of your prompt.
  1901. XThe \fIsearch\fP portion specifies an end-of-prompt search string, while
  1902. Xthe \fIname\fP portion specifies the default shell name for the window.
  1903. XIf the \fIname\fP ends in a `:'
  1904. X.I screen
  1905. Xwill add what it believes to be the current command running in the window
  1906. Xto the end of the window's shell name (e.\|g. \*Q\fIname:cmd\fP\*U).
  1907. XOtherwise the current command name supersedes the shell name while it is
  1908. Xrunning.
  1909. X.PP
  1910. XHere's how it works:  you must modify your shell prompt to output a null
  1911. Xaka escape-sequence (<esc>k<esc>\e) as a part of your prompt.
  1912. XThe last part of your prompt must be the same as the string you specified
  1913. Xfor the \fIsearch\fP portion of the a.\|k.\|a.
  1914. XOnce this is set up,
  1915. X.I screen
  1916. Xwill use the aka escape-sequence to clear the previous command name and
  1917. Xget ready for the next command.
  1918. XThen, when a newline is received from the shell, a search is made for the
  1919. Xend of the prompt.
  1920. XIf found, it will grab the first word after the matched string and use it
  1921. Xas the command name.
  1922. XIf the command name begins with either '!', '%', or '^'
  1923. X.I screen
  1924. Xwill use the first word on the following line (if found) in preference to
  1925. Xthe just-found name.
  1926. XThis helps csh users get better command names when using job control or
  1927. Xhistory recall commands.
  1928. X.PP
  1929. XHere's some .screenrc examples:
  1930. X.IP
  1931. Xscreen -t top 2 nice top
  1932. X.PP
  1933. XAdding this line to your .screenrc would start a nice-d version of the
  1934. X\*Qtop\*U command in window 2 name \*Qtop\*U rather than \*Qnice\*U.
  1935. X.sp
  1936. X.nf
  1937. X    shellaka '> |csh'
  1938. X    screen 1
  1939. X.fi
  1940. X.sp
  1941. XThese commands would start a shell with the given shellaka.
  1942. XThe a.\|k.\|a. specified is an auto-aka that would expect the prompt and
  1943. Xthe typed command to look something like the following:
  1944. X.IP
  1945. X/usr/joe/src/dir> trn
  1946. X.PP
  1947. X(it looks after the '> ' for the command name).
  1948. XThe window status would show the name \*Qtrn\*U while the command was
  1949. Xrunning, and revert to \*Qcsh\*U upon completion.
  1950. X.IP
  1951. Xbind R screen -t '% |root:' su
  1952. X.PP
  1953. XHaving this command in your .screenrc would bind the key
  1954. Xsequence \*QC-a R\*U to the \*Qsu\*U command and give it an
  1955. Xauto-aka name of \*Qroot:\*U.
  1956. XFor this auto-aka to work, the screen could look something
  1957. Xlike this:
  1958. X.sp
  1959. X.nf
  1960. X    % !em
  1961. X    emacs file.c
  1962. X.fi
  1963. X.sp
  1964. XHere the user typed the csh history command \*Q!em\*U which ran the
  1965. Xpreviously entered \*Qemacs\*U command.
  1966. XThe window status would show \*Qroot:emacs\*U during the execution
  1967. Xof the command, and revert to simply \*Qroot:\*U at its completion.
  1968. X.PP
  1969. X.nf
  1970. X    bind o aka
  1971. X    bind E aka ""
  1972. X    bind u aka (unknown)
  1973. X.fi
  1974. X.sp
  1975. XThe first binding doesn't have any arguments, so it would prompt you
  1976. Xfor an a.\|k.\|a. when you type \*QC-a o\*U.
  1977. XThe second binding would clear an auto-aka's current setting (C-a E).
  1978. XThe third binding would set the current window's a.\|k.\|a. to \*Q(unknown)\*U
  1979. X(C-a u).
  1980. X.PP
  1981. XOne thing to keep in mind when adding a null aka escape-sequence to
  1982. Xyour prompt is that some shells (like the csh) count all the non-control
  1983. Xcharacters as part of the prompt's length.
  1984. XIf these invisible characters aren't a multiple of 8 then backspacing over
  1985. Xa tab will result in an incorrect display.
  1986. XOne way to get around this is to use a prompt like this:
  1987. X.IP
  1988. Xset prompt='^[[0000m^[k^[\e% '
  1989. X.PP
  1990. XThe escape-sequence \*Q<esc>[0000m\*U not only normalizes the character
  1991. Xattributes, but all the zeros round the length of the invisible characters
  1992. Xup to 8.
  1993. XBash users will probably want to echo the escape sequence in the
  1994. XPROMPT_COMMAND:
  1995. X.IP
  1996. XPROMPT_COMMAND='echo -n -e "\e033k\e033\e134"'
  1997. X.PP
  1998. X(I used \*Q\134\*U to output a `\e' because of a bug in bash v1.04).
  1999. X
  2000. X
  2001. X.SH "THE VIRTUAL TERMINAL"
  2002. XUsually
  2003. X.I screen
  2004. Xtries to emulate as much of the VT100/ANSI standard
  2005. Xas possible. But if your terminal lacks certain capabilities,
  2006. Xthe emulation may not be complete. In these cases
  2007. X.I screen
  2008. Xhas to tell the applications that some of the features
  2009. Xare missing. This is no problem on machines using termcap,
  2010. Xbecause
  2011. X.I screen
  2012. Xcan use the $TERMCAP variable to
  2013. Xcustomize the standard screen termcap.
  2014. X.PP
  2015. XBut if you do a
  2016. Xrlogin on another machine or your machine supports only
  2017. Xterminfo this method fails. Because of this,
  2018. X.I screen
  2019. Xoffers a way to deal with these cases. 
  2020. XHere is how it works:
  2021. X.PP
  2022. XWhen 
  2023. X.I screen
  2024. Xtries to figure out a terminal name for itself,
  2025. Xit first looks
  2026. Xfor an entry named \*Qscreen.<term>\*U, where <term> is
  2027. Xthe contents of your $TERM variable.
  2028. XIf no such entry exists,
  2029. X.I screen
  2030. Xtries \*Qscreen\*U (or \*Qscreen-w\*U if the terminal is wide
  2031. X(132 cols or more)).
  2032. XIf even this entry cannot be found, \*Qvt100\*U is used as a
  2033. Xsubstitute.
  2034. X.PP
  2035. XThe idea is that if you have a terminal which doesn't
  2036. Xsupport an important feature (e.g. delete char or clear to EOS)
  2037. Xyou can build a new termcap/terminfo entry for
  2038. X.I screen
  2039. X(named \*Qscreen.<dumbterm>\*U) in which this capability
  2040. Xhas been disabled. If this entry is installed on your
  2041. Xmachines you are able to do
  2042. Xa rlogin and still keep the correct termcap/terminfo entry.
  2043. XThe terminal name is put in the $TERM variable
  2044. Xof all new windows.
  2045. X.I Screen
  2046. Xalso sets the $TERMCAP variable reflecting the capabilities
  2047. Xof the virtual terminal emulated. Notice that, however, on machines
  2048. Xusing the terminfo database this variable has no effect.
  2049. XFurthermore, the variable $WINDOW is set to the window number
  2050. Xof each window.
  2051. X.PP
  2052. XThe actual set of capabilities supported by the virtual terminal
  2053. Xdepends on the capabilities supported by the physical terminal.
  2054. XIf, for instance, the physical terminal does not support underscore mode,
  2055. X.I screen
  2056. Xdoes not put the `us' and `ue' capabilities into the window's $TERMCAP
  2057. Xvariable, accordingly.
  2058. XHowever, a minimum number of capabilities must be supported by a
  2059. Xterminal in order to run
  2060. X.IR screen ;
  2061. Xnamely scrolling, clear screen, and direct cursor addressing
  2062. X(in addition,
  2063. X.I screen
  2064. Xdoes not run on hardcopy terminals or on terminals that over-strike).
  2065. X.PP
  2066. XAlso, you can customize the $TERMCAP value used by
  2067. X.I screen
  2068. Xby using the \*Qtermcap\*U .screenrc command, or
  2069. Xby defining the variable $SCREENCAP prior to startup.
  2070. XWhen the is latter defined, its value will be copied verbatim into each
  2071. Xwindow's $TERMCAP variable.
  2072. XThis can either be the full terminal definition, or a filename where the
  2073. Xterminal \*Qscreen\*U (and/or \*Qscreen-w\*U) is defined.
  2074. X.PP
  2075. XNote that 
  2076. X.I screen
  2077. Xhonors the \*Qterminfo\*U .screenrc command if the system uses the
  2078. Xterminfo database rather than termcap.
  2079. X.PP
  2080. XWhen the boolean `G0' capability is present in the termcap entry
  2081. Xfor the terminal on which
  2082. X.I screen
  2083. Xhas been called, the terminal emulation of
  2084. X.I screen
  2085. Xsupports multiple character sets.
  2086. XThis allows an application to make use of, for instance,
  2087. Xthe VT100 graphics character set or national character sets.
  2088. XThe following control functions from ISO 2022 are supported:
  2089. X\fIlock shift G0\fP (\fISI\fP), \fIlock shift G1\fP (\fISO\fP),
  2090. X\fIlock shift G2\fP, \fIlock shift G3\fP, \fIsingle shift G2\fP,
  2091. Xand \fIsingle shift G3\fP.
  2092. XWhen a virtual terminal is created or reset, the ASCII character
  2093. Xset is designated as \fIG0\fP through \fIG3\fP.
  2094. XWhen the `G0' capability is present, screen evaluates the capabilities
  2095. X`S0', `E0', and `C0' if present. `S0' is the sequence the terminal uses
  2096. Xto enable and start the graphics character set rather than \fISI\fP. 
  2097. X`E0' is the corresponding replacement for \fISO\fP. `C0' gives a character
  2098. Xby character translation string that is used during semi-graphics mode. This 
  2099. Xstring is built like the `acsc' terminfo capability.
  2100. X.PP
  2101. XWhen the `po' and `pf' capabilities are present in the terminal's
  2102. Xtermcap entry, applications running in a
  2103. X.I screen
  2104. Xwindow can send output to the printer port of the terminal.
  2105. XThis allows a user to have an application in one window
  2106. Xsending output to a printer connected to the terminal, while all
  2107. Xother windows are still active (the printer port is enabled
  2108. Xand disabled again for each chunk of output).
  2109. XAs a side-effect, programs running in different windows can
  2110. Xsend output to the printer simultaneously.
  2111. XData sent to the printer is not displayed in the window.
  2112. X.PP
  2113. XSome capabilities are only put into the $TERMCAP
  2114. Xvariable of the virtual terminal if they can be efficiently
  2115. Ximplemented by the physical terminal.
  2116. XFor instance, `dl' (delete line) is only put into the $TERMCAP
  2117. Xvariable if the terminal supports either delete line itself or
  2118. Xscrolling regions. Note that this may provoke confusion, when 
  2119. Xthe session is reattached on a different terminal, as the value
  2120. Xof $TERMCAP cannot be modified by parent processes.
  2121. X.PP
  2122. XThe following is a list of control sequences recognized by
  2123. X.IR screen .
  2124. X\*Q(V)\*U and \*Q(A)\*U indicate VT100-specific and ANSI- or
  2125. XISO-specific functions, respectively.
  2126. X.PP
  2127. X.ta 22n
  2128. X.TP 27
  2129. X.B "ESC E"
  2130. XNext Line
  2131. X.TP 27
  2132. X.B "ESC D"
  2133. XIndex
  2134. X.TP 27
  2135. X.B "ESC M"
  2136. XReverse Index
  2137. X.TP 27
  2138. X.B "ESC H"
  2139. XHorizontal Tab Set
  2140. X.TP 27
  2141. X.B "ESC Z"
  2142. XSend VT100 Identification String
  2143. X.TP 27
  2144. X.BR "ESC 7" "    (V)"
  2145. XSave Cursor and Attributes
  2146. X.TP 27
  2147. X.BR "ESC 8" "    (V)"
  2148. XRestore Cursor and Attributes
  2149. X.TP 27
  2150. X.BR "ESC [s" "    (A)"
  2151. XSave Cursor and Attributes
  2152. X.TP 27
  2153. X.BR "ESC [u" "    (A)"
  2154. XRestore Cursor and Attributes
  2155. X.TP 27
  2156. X.B "ESC c"
  2157. XReset to Initial State
  2158. X.TP 27
  2159. X.BR "ESC =" "    (V)"
  2160. XApplication Keypad Mode
  2161. X.TP 27
  2162. X.BR "ESC >" "    (V)"
  2163. XNumeric Keypad Mode
  2164. X.TP 27
  2165. X.BR "ESC # 8" "    (V)"
  2166. XFill Screen with E's
  2167. X.TP 27
  2168. X.BR "ESC \e" "    (A)"
  2169. XString Terminator
  2170. X.TP 27
  2171. X.BR "ESC ^" "    (A)"
  2172. XPrivacy Message String (Message Line)
  2173. X.TP 27
  2174. X.B "ESC !"
  2175. XGlobal Message String (Message Line)
  2176. X.TP 27
  2177. X.B "ESC k"
  2178. XA.\|k.\|a. Definition String
  2179. X.TP 27
  2180. X.BR "ESC P" "    (A)"
  2181. XDevice Control String.
  2182. XOutputs a string directly to the host
  2183. Xterminal without interpretation.
  2184. X.TP 27
  2185. X.BR "ESC _" "    (A)"
  2186. XApplication Program Command (not used)
  2187. X.TP 27
  2188. X.BR "ESC ]" "    (A)"
  2189. XOperating System Command (not used)
  2190. X.TP 27
  2191. X.BR "Control-N" "    (A)"
  2192. XLock Shift G1 (SO)
  2193. X.TP 27
  2194. X.BR "Control-O" "    (A)"
  2195. XLock Shift G0 (SI)
  2196. X.TP 27
  2197. X.BR "ESC n" "    (A)"
  2198. XLock Shift G2
  2199. X.TP 27
  2200. X.BR "ESC o" "    (A)"
  2201. XLock Shift G3
  2202. X.TP 27
  2203. X.BR "ESC N" "    (A)"
  2204. XSingle Shift G2
  2205. X.TP 27
  2206. X.BR "ESC O" "    (A)"
  2207. XSingle Shift G3
  2208. X.TP 27
  2209. X.BR "ESC ( \fPPcs" "    (A)"
  2210. XDesignate character set as G0
  2211. X.TP 27
  2212. X.BR "ESC ) \fPPcs" "    (A)"
  2213. XDesignate character set as G1
  2214. X.TP 27
  2215. X.BR "ESC * \fPPcs" "    (A)"
  2216. XDesignate character set as G2
  2217. X.TP 27
  2218. X.BR "ESC + \fPPcs" "    (A)"
  2219. XDesignate character set as G3
  2220. X.TP 27
  2221. X.B "ESC [ \fPPn\fB ; \fPPn\fB H"
  2222. XDirect Cursor Addressing
  2223. X.TP 27
  2224. X.B "ESC [ \fPPn\fB ; \fPPn\fB f"
  2225. XDirect Cursor Addressing
  2226. X.TP 27
  2227. X.B "ESC [ \fPPn\fB J"
  2228. XErase in Display
  2229. X.TP 27
  2230. X\h'\w'ESC [ 'u'Pn = None or \fB0\fP
  2231. XFrom Cursor to End of Screen
  2232. X.TP 27
  2233. X\h'\w'ESC [ Pn = 'u'\fB1\fP
  2234. XFrom Beginning of Screen to Cursor
  2235. X.TP 27
  2236. X\h'\w'ESC [ Pn = 'u'\fB2\fP
  2237. XEntire Screen
  2238. X.TP 27
  2239. X.B "ESC [ \fPPn\fB K"
  2240. XErase in Line
  2241. X.TP 27
  2242. X\h'\w'ESC [ 'u'Pn = None or \fB0\fP
  2243. XFrom Cursor to End of Line
  2244. X.TP 27
  2245. X\h'\w'ESC [ Pn = 'u'\fB1\fP
  2246. XFrom Beginning of Line to Cursor
  2247. X.TP 27
  2248. X\h'\w'ESC [ Pn = 'u'\fB2\fP
  2249. XEntire Line
  2250. X.TP 27
  2251. X.B "ESC [ \fPPn\fB A"
  2252. XCursor Up
  2253. X.TP 27
  2254. X.B "ESC [ \fPPn\fB B"
  2255. XCursor Down
  2256. X.TP 27
  2257. X.B "ESC [ \fPPn\fB C"
  2258. XCursor Right
  2259. X.TP 27
  2260. X.B "ESC [ \fPPn\fB D"
  2261. XCursor Left
  2262. X.TP 27
  2263. X.B "ESC [ \fPPs\fB ;\fP...\fB; \fPPs\fB m"
  2264. XSelect Graphic Rendition
  2265. X.TP 27
  2266. X\h'\w'ESC [ 'u'Ps = None or \fB0\fP
  2267. XDefault Rendition
  2268. X.TP 27
  2269. X\h'\w'ESC [ Ps = 'u'\fB1\fP
  2270. XBold
  2271. X.TP 27
  2272. X\h'\w'ESC [ Ps = 'u'\fB2\fP    (A)
  2273. XFaint
  2274. X.TP 27
  2275. X\h'\w'ESC [ Ps = 'u'\fB3\fP    (A)
  2276. X\fIStandout\fP Mode (ANSI: Italicized)
  2277. X.TP 27
  2278. X\h'\w'ESC [ Ps = 'u'\fB4\fP
  2279. XUnderlined
  2280. X.TP 27
  2281. X\h'\w'ESC [ Ps = 'u'\fB5\fP
  2282. XBlinking
  2283. X.TP 27
  2284. X\h'\w'ESC [ Ps = 'u'\fB7\fP
  2285. XNegative Image
  2286. X.TP 27
  2287. X\h'\w'ESC [ Ps = 'u'\fB22\fP    (A)
  2288. XNormal Intensity
  2289. X.TP 27
  2290. X\h'\w'ESC [ Ps = 'u'\fB23\fP    (A)
  2291. X\fIStandout\fP Mode off (ANSI: Italicized off)
  2292. X.TP 27
  2293. X\h'\w'ESC [ Ps = 'u'\fB24\fP    (A)
  2294. XNot Underlined
  2295. X.TP 27
  2296. X\h'\w'ESC [ Ps = 'u'\fB25\fP    (A)
  2297. XNot Blinking
  2298. X.TP 27
  2299. X\h'\w'ESC [ Ps = 'u'\fB27\fP    (A)
  2300. XPositive Image
  2301. X.TP 27
  2302. X.B "ESC [ \fPPn\fB g"
  2303. XTab Clear
  2304. X.TP 27
  2305. X\h'\w'ESC [ 'u'Pn = None or \fB0\fP
  2306. XClear Tab at Current Position
  2307. X.TP 27
  2308. X\h'\w'ESC [ Ps = 'u'\fB3\fP
  2309. XClear All Tabs
  2310. X.TP 27
  2311. X.BR "ESC [ \fPPn\fB ; \fPPn\fB r" "    (V)"
  2312. XSet Scrolling Region
  2313. X.TP 27
  2314. X.BR "ESC [ \fPPn\fB I" "    (A)"
  2315. XHorizontal Tab
  2316. X.TP 27
  2317. X.BR "ESC [ \fPPn\fB Z" "    (A)"
  2318. XBackward Tab
  2319. X.TP 27
  2320. X.BR "ESC [ \fPPn\fB L" "    (A)"
  2321. XInsert Line
  2322. X.TP 27
  2323. X.BR "ESC [ \fPPn\fB M" "    (A)"
  2324. XDelete Line
  2325. X.TP 27
  2326. X.BR "ESC [ \fPPn\fB @" "    (A)"
  2327. XInsert Character
  2328. X.TP 27
  2329. X.BR "ESC [ \fPPn\fB P" "    (A)"
  2330. XDelete Character
  2331. X.TP 27
  2332. X.B "ESC [ \fPPs\fB ;\fP...\fB; \fPPs\fB h"
  2333. XSet Mode
  2334. X.TP 27
  2335. X.B "ESC [ \fPPs\fB ;\fP...\fB; \fPPs\fB l"
  2336. XReset Mode
  2337. X.TP 27
  2338. X\h'\w'ESC [ 'u'Ps = \fB4\fP    (A)
  2339. XInsert Mode
  2340. X.TP 27
  2341. X\h'\w'ESC [ Ps = 'u'\fB?1\fP    (V)
  2342. XApplication Cursor Keys
  2343. X.TP 27
  2344. X\h'\w'ESC [ Ps = 'u'\fB?3\fP    (V)
  2345. XChange Terminal Width to 132 columns
  2346. X.TP 27
  2347. X\h'\w'ESC [ Ps = 'u'\fB?5\fP    (V)
  2348. XVisible Bell (\fIOn\fP followed by \fIOff\fP)
  2349. X.TP 27
  2350. X\h'\w'ESC [ Ps = 'u'\fB?6\fP    (V)
  2351. X\fIOrigin\fP Mode
  2352. X.TP 27
  2353. X\h'\w'ESC [ Ps = 'u'\fB?7\fP    (V)
  2354. X\fIWrap\fP Mode
  2355. X.TP 27
  2356. X.BR "ESC [ 5 i" "    (A)"
  2357. XStart relay to printer (ANSI Media Copy)
  2358. X.TP 27
  2359. X.BR "ESC [ 4 i" "    (A)"
  2360. XStop relay to printer (ANSI Media Copy)
  2361. X.TP 27
  2362. X.B "ESC [ 8 ; \fPPh\fB ; \fPPw\fB t"
  2363. XResize the window to `Ph' lines and `Pw' columns (SunView special)
  2364. X.TP 27
  2365. X.B "ESC [ c"
  2366. XSend VT100 Identification String
  2367. X.TP 27
  2368. X.B "ESC [ 6 n"
  2369. XSend Cursor Position Report
  2370. X
  2371. X
  2372. X.SH SPECIAL TERMINAL CAPABILITIES
  2373. XThe following table describes all terminal capabilities
  2374. Xthat are recognized by \fIscreen\fP and are not in the
  2375. Xtermcap(5) manual.
  2376. X.PP
  2377. X.ta 5n
  2378. X.TP 13
  2379. X.BI LP "    (bool)"
  2380. XTerminal has vt100 style margins (`magic margins'). Note that
  2381. Xthis capability is obsolete because \fIscreen\fP uses 'xn'
  2382. Xinstead.
  2383. X.TP 13
  2384. X.BI Z0 "    (str)"
  2385. XChange width to 132 columns.
  2386. X.TP 13
  2387. X.BI Z1 "    (str)"
  2388. XChange width to 80 columns.
  2389. X.TP 13
  2390. X.BI WS "    (str)"
  2391. XResize display. This capability has the desired width and height as
  2392. Xarguments. \fISunView(tm)\fP example: '\eE[8;%d;%dt'.
  2393. X.TP 13
  2394. X.BI B8 "    (str)"
  2395. XTell \fIscreen\fP to look out for characters with 8th bit set. If such
  2396. Xa character is found \fIscreen\fP processes the specified string
  2397. Xand than outputs the character with the 8th bit stripped off.
  2398. XNote that the string can contain any esc-sequences known to
  2399. X\fIscreen\fP, too. (Example: Single Shift G2 = \eEN.)
  2400. X.TP 13
  2401. X.BI OP "    (bool)"
  2402. XDon't do a full vt100 style margin emulation. Same as the -O option.
  2403. X.TP 13
  2404. X.BI NF "    (bool)"
  2405. XTerminal doesn't need flow control. Send ^S and ^Q direct to
  2406. Xthe application. Same as 'flow off'. The opposite of this
  2407. Xcapability is 'xo'.
  2408. X.TP 13
  2409. X.BI G0 "    (bool)"
  2410. XTerminal can deal with ISO2022 font selection sequences.
  2411. X.TP 13
  2412. X.BI S0 "    (str)"
  2413. XSwitch charset 'G0' to the specified charset. Default
  2414. Xis '\eE(%d'.
  2415. X.TP 13
  2416. X.BI E0 "    (str)"
  2417. XSwitch charset 'G0' back to standard charset. Default
  2418. Xis '\eE(B'.
  2419. X.TP 13
  2420. X.BI C0 "    (str)"
  2421. XUse the string as a conversion table for font '0'. See
  2422. Xthe 'ac' capability for more details.
  2423. X.TP 13
  2424. X.BI CS "    (str)"
  2425. XSwitch cursorkeys to application mode.
  2426. X.TP 13
  2427. X.BI CE "    (str)"
  2428. XSwitch cursorkeys back to normal mode.
  2429. X.TP 13
  2430. X.BI AN "    (bool)"
  2431. XTurn on autonuke. See the 'autonuke' command for more details.
  2432. X.TP 13
  2433. X.BI OL "    (num)"
  2434. XSet the output buffer limit. See the 'obuflimit' command for more details.
  2435. X
  2436. X
  2437. X.SH ENVIRONMENT
  2438. X.PD 0
  2439. X.IP COLUMNS 15
  2440. XNumber of columns on the terminal (overrides termcap entry).
  2441. X.IP HOME
  2442. XDirectory in which to look for .screenrc.
  2443. X.IP ISCREENRC
  2444. XAlternate user screenrc file.
  2445. X.IP LINES 
  2446. XNumber of lines on the terminal (overrides termcap entry).
  2447. X.IP LOCKPRG
  2448. XScreen lock program.
  2449. X.IP NETHACKOPTIONS
  2450. XTurns on nethack option.
  2451. X.IP PATH
  2452. XUsed for locating programs to run.
  2453. X.IP SCREENCAP
  2454. XFor customizing a terminal's TERMCAP value.
  2455. X.IP SCREENDIR
  2456. XAlternate socket directory.
  2457. X.IP SCREENRC
  2458. XAlternate user screenrc file.
  2459. X.IP SHELL
  2460. XDefault shell program for opening windows (default \*Q/bin/sh\*U).
  2461. X.IP STY
  2462. XAlternate socket name.
  2463. X.IP SYSSCREENRC
  2464. XAlternate system screenrc file.
  2465. X.IP TERM
  2466. XTerminal name.
  2467. X.IP TERMCAP
  2468. XTerminal description.
  2469. X
  2470. X
  2471. X.SH FILES
  2472. X.PD 0
  2473. X.IP $SYSSCREENRC 28
  2474. X.IP /local/etc/screenrc
  2475. X\fIscreen\fP initialization commands
  2476. X.IP $ISCREENRC
  2477. X.IP $SCREENRC
  2478. X.IP $HOME/.iscreenrc
  2479. X.IP $HOME/.screenrc
  2480. XRead in after /local/etc/screenrc
  2481. X.IP $ISCREENDIR/S-<login>
  2482. X.IP $SCREENDIR/S-<login>
  2483. X.IP /local/screens/S-<login>
  2484. XSocket directories (default)
  2485. X.IP /usr/tmp/screens/S-<login>
  2486. XAlternate socket directories.
  2487. X.IP "<socket directory>/.termcap"
  2488. XWritten by the "termcap" output function
  2489. X.IP /usr/tmp/screens/screen-exchange
  2490. Xor
  2491. X.IP /tmp/screen-exchange
  2492. X\fIscreen\fP `interprocess communication buffer'
  2493. X.IP hardcopy.[0-9]
  2494. XScreen images created by the hardcopy function
  2495. X.IP screenlog.[0-9]
  2496. XOutput log files created by the log function
  2497. X.IP /usr/lib/terminfo/?/*
  2498. Xor
  2499. X.IP /etc/termcap
  2500. XTerminal capability databases
  2501. X.IP /etc/utmp
  2502. XLogin records
  2503. X.IP $LOCKPRG
  2504. XProgram that locks a terminal.
  2505. X
  2506. X
  2507. X.SH "SEE ALSO"
  2508. Xtermcap(5), utmp(5), vi(1), captoinfo(1), tic(1)
  2509. X
  2510. X
  2511. X.SH AUTHORS
  2512. XOriginally created by Oliver Laumann, this latest version was
  2513. Xproduced by Wayne Davison, Juergen Weigert and Michael Schroeder.
  2514. X
  2515. X.SH COPYLEFT
  2516. XCopyright (C) 1993
  2517. X    Juergen Weigert (jnweiger@immd4.informatik.uni-erlangen.de)
  2518. X    Michael Schroeder (mlschroe@immd4.informatik.uni-erlangen.de)
  2519. XCopyright (C) 1987 Oliver Laumann
  2520. X.PP
  2521. XThis program is free software; you can redistribute it and/or modify
  2522. Xit under the terms of the GNU General Public License as published by
  2523. Xthe Free Software Foundation; either version 2, or (at your option)
  2524. Xany later version.
  2525. X.PP
  2526. XThis program is distributed in the hope that it will be useful,
  2527. Xbut WITHOUT ANY WARRANTY; without even the implied warranty of
  2528. XMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  2529. XGNU General Public License for more details.
  2530. X.PP
  2531. XYou should have received a copy of the GNU General Public License
  2532. Xalong with this program (see the file COPYING); if not, write to the
  2533. XFree Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  2534. X
  2535. X.SH CONTRIBUTORS
  2536. X.nf
  2537. XKen Beal (kbeal@amber.ssd.csd.harris.com),
  2538. XRudolf Koenig (rfkoenig@immd4.informatik.uni-erlangen.de),
  2539. XToerless Eckert (eckert@immd4.informatik.uni-erlangen.de), 
  2540. XWayne Davison (davison@borland.com),
  2541. XPatrick Wolfe (pat@kai.com, kailand!pat),
  2542. XBart Schaefer (schaefer@cse.ogi.edu),
  2543. XNathan Glasser (nathan@brokaw.lcs.mit.edu),
  2544. XLarry W. Virden (lvirden@cas.org),
  2545. XHoward Chu (hyc@hanauma.jpl.nasa.gov),
  2546. XTim MacKenzie (tym@dibbler.cs.monash.edu.au),
  2547. XMarkku Jarvinen (mta@{cc,cs,ee}.tut.fi),
  2548. XMarc Boucher (marc@CAM.ORG),
  2549. XDoug Siebert (dsiebert@isca.uiowa.edu),
  2550. XKen Stillson (stillson@tsfsrv.mitre.org),
  2551. XIan Frechett (frechett@spot.Colorado.EDU),
  2552. XBrian Koehmstedt (bpk@gnu.ai.mit.edu),
  2553. XDon Smith (djs6015@ultb.isc.rit.edu),
  2554. XFrank van der Linden (vdlinden@fwi.uva.nl),
  2555. XMartin Schweikert (schweik@cpp.ob.open.de),
  2556. XDavid Vrona (dave@sashimi.lcu.com),
  2557. XE. Tye McQueen (tye%spillman.UUCP@uunet.uu.net),
  2558. XMatthew Green (phone@coombs.anu.edu.au),
  2559. XChristopher Williams (cgw@unt.edu),
  2560. XMatt Mosley (mattm@access.digex.net),
  2561. XGregory Neil Shapiro (gshapiro@wpi.WPI.EDU).
  2562. X.fi
  2563. X
  2564. X
  2565. X.SH VERSION
  2566. XThis is version 3.3. Its roots are a merge of a custom version
  2567. X2.3PR7 by Wayne Davison
  2568. Xand several enhancements to Oliver Laumann's version 2.0. Note that all versions
  2569. Xnumbered 2.x are copyright by Oliver Laumann. 
  2570. X
  2571. X
  2572. X.SH BUGS
  2573. X.PD
  2574. X.IP \(bu 3
  2575. X`dm' (delete mode) and `xs' are not handled
  2576. Xcorrectly (they are ignored). `xn' is treated as a magic-margin
  2577. Xindicator.
  2578. X.IP \(bu
  2579. XThe \fIGR\fP set of ISO 2022 is not supported.
  2580. X.IP \(bu
  2581. XThere is no keyboard input translation to VT100 sequences.
  2582. X.IP \(bu
  2583. XIt is not possible to change the environment variable $TERMCAP when 
  2584. Xreattaching under a different terminal type.
  2585. X.IP \(bu
  2586. XThe support of terminfo based systems is very limited. Adding extra
  2587. Xcapabilities to $TERMCAP may not have any effects.
  2588. X.IP \(bu
  2589. X.I Screen
  2590. Xdoes not make use of hardware tabs.
  2591. X.IP \(bu
  2592. X.I Screen
  2593. Xmust be installed as set-uid with owner root in order to be able
  2594. Xto correctly change the owner of the tty device file for each
  2595. Xwindow.
  2596. XSpecial permission may also be required to write the file \*Q/etc/utmp\*U.
  2597. X.IP \(bu
  2598. XEntries in \*Q/etc/utmp\*U are not removed when
  2599. X.I screen
  2600. Xis killed with SIGKILL.
  2601. XThis will cause some programs (like "w" or "rwho")
  2602. Xto advertise that a user is logged on who really isn't.
  2603. X.IP \(bu
  2604. X.I Screen
  2605. Xmay give a strange warning when your tty has no utmp entry.
  2606. X.IP \(bu
  2607. XSend bugreports, fixes, enhancements, t-shirts, money, beer & pizza to
  2608. X.BR screen@uni-erlangen.de .
  2609. X
  2610. END_OF_FILE
  2611. if test 82010 -ne `wc -c <'doc/screen.1'`; then
  2612.     echo shar: \"'doc/screen.1'\" unpacked with wrong size!
  2613. fi
  2614. # end of 'doc/screen.1'
  2615. fi
  2616. echo shar: End of archive 9 \(of 10\).
  2617. cp /dev/null ark9isdone
  2618. MISSING=""
  2619. for I in 1 2 3 4 5 6 7 8 9 10 ; do
  2620.     if test ! -f ark${I}isdone ; then
  2621.     MISSING="${MISSING} ${I}"
  2622.     fi
  2623. done
  2624. if test "${MISSING}" = "" ; then
  2625.     echo You have unpacked all 10 archives.
  2626.     rm -f ark[1-9]isdone ark[1-9][0-9]isdone
  2627. else
  2628.     echo You still need to unpack the following archives:
  2629.     echo "        " ${MISSING}
  2630. fi
  2631. ##  End of shell archive.
  2632. exit 0
  2633.