src/doc/screen.info-5

   1 This is screen.info, produced by makeinfo version 4.5 from
   2 ./screen.texinfo.
   3
   4 INFO-DIR-SECTION General Commands
   5 START-INFO-DIR-ENTRY
   6 * Screen: (screen).             Full-screen window manager.
   7 END-INFO-DIR-ENTRY
   8
   9    This file documents the `Screen' virtual terminal manager.
  10
  11    Copyright (c) 1993-2003 Free Software Foundation, Inc.
  12
  13    Permission is granted to make and distribute verbatim copies of this
  14 manual provided the copyright notice and this permission notice are
  15 preserved on all copies.
  16
  17    Permission is granted to copy and distribute modified versions of
  18 this manual under the conditions for verbatim copying, provided that
  19 the entire resulting derived work is distributed under the terms of a
  20 permission notice identical to this one.
  21
  22    Permission is granted to copy and distribute translations of this
  23 manual into another language, under the above conditions for modified
  24 versions, except that this permission notice may be stated in a
  25 translation approved by the Foundation.
  26
  27 \x1f
  28 File: screen.info,  Node: Files,  Next: Credits,  Prev: Environment,  Up: Top
  29
  30 Files Referenced
  31 ****************
  32
  33 `.../screen-4.?.??/etc/screenrc'
  34 `.../screen-4.?.??/etc/etcscreenrc'
  35      Examples in the `screen' distribution package for private and
  36      global initialization files.
  37
  38 ``$SYSSCREENRC''
  39 `/local/etc/screenrc'
  40      `screen' initialization commands
  41
  42 ``$SCREENRC''
  43 ``$HOME'/.iscreenrc'
  44 ``$HOME'/.screenrc'
  45      Read in after /local/etc/screenrc
  46
  47 ``$SCREENDIR'/S-LOGIN'
  48
  49 `/local/screens/S-LOGIN'
  50      Socket directories (default)
  51
  52 `/usr/tmp/screens/S-LOGIN'
  53      Alternate socket directories.
  54
  55 `SOCKET DIRECTORY/.termcap'
  56      Written by the `dumptermcap' command
  57
  58 `/usr/tmp/screens/screen-exchange or'
  59 `/tmp/screen-exchange'
  60      `screen' interprocess communication buffer
  61
  62 `hardcopy.[0-9]'
  63      Screen images created by the hardcopy command
  64
  65 `screenlog.[0-9]'
  66      Output log files created by the log command
  67
  68 `/usr/lib/terminfo/?/* or'
  69 `/etc/termcap'
  70      Terminal capability databases
  71
  72 `/etc/utmp'
  73      Login records
  74
  75 ``$LOCKPRG''
  76      Program for locking the terminal.
  77
  78 \x1f
  79 File: screen.info,  Node: Credits,  Next: Bugs,  Prev: Files,  Up: Top
  80
  81 Credits
  82 *******
  83
  84 Authors
  85 =======
  86
  87    Originally created by Oliver Laumann, this latest version was
  88 produced by Wayne Davison, Juergen Weigert and Michael Schroeder.
  89
  90 Contributors
  91 ============
  92
  93           Ken Beal (kbeal@amber.ssd.csd.harris.com),
  94           Rudolf Koenig (rfkoenig@informatik.uni-erlangen.de),
  95           Toerless Eckert (eckert@informatik.uni-erlangen.de),
  96           Wayne Davison (davison@borland.com),
  97           Patrick Wolfe (pat@kai.com, kailand!pat),
  98           Bart Schaefer (schaefer@cse.ogi.edu),
  99           Nathan Glasser (nathan@brokaw.lcs.mit.edu),
 100           Larry W. Virden (lvirden@cas.org),
 101           Howard Chu (hyc@hanauma.jpl.nasa.gov),
 102           Tim MacKenzie (tym@dibbler.cs.monash.edu.au),
 103           Markku Jarvinen (mta@{cc,cs,ee}.tut.fi),
 104           Marc Boucher (marc@CAM.ORG),
 105           Doug Siebert (dsiebert@isca.uiowa.edu),
 106           Ken Stillson (stillson@tsfsrv.mitre.org),
 107           Ian Frechett (frechett@spot.Colorado.EDU),
 108           Brian Koehmstedt (bpk@gnu.ai.mit.edu),
 109           Don Smith (djs6015@ultb.isc.rit.edu),
 110           Frank van der Linden (vdlinden@fwi.uva.nl),
 111           Martin Schweikert (schweik@cpp.ob.open.de),
 112           David Vrona (dave@sashimi.lcu.com),
 113           E. Tye McQueen (tye%spillman.UUCP@uunet.uu.net),
 114           Matthew Green (mrg@eterna.com.au),
 115           Christopher Williams (cgw@pobox.com),
 116           Matt Mosley (mattm@access.digex.net),
 117           Gregory Neil Shapiro (gshapiro@wpi.WPI.EDU),
 118           Jason Merrill (jason@jarthur.Claremont.EDU),
 119           Johannes Zellner (johannes@zellner.org),
 120           Pablo Averbuj (pablo@averbuj.com).
 121
 122 Version
 123 =======
 124
 125    This manual describes version 4.0.2 of the `screen' program. Its
 126 roots are a merge of a custom version 2.3PR7 by Wayne Davison and
 127 several enhancements to Oliver Laumann's version 2.0.  Note that all
 128 versions numbered 2.x are copyright by Oliver Laumann.
 129
 130    See also *Note Availability::.
 131
 132 \x1f
 133 File: screen.info,  Node: Bugs,  Next: Installation,  Prev: Credits,  Up: Top
 134
 135 Bugs
 136 ****
 137
 138    Just like any other significant piece of software, `screen' has a
 139 few bugs and missing features.  Please send in a bug report if you have
 140 found a bug not mentioned here.
 141
 142 * Menu:
 143
 144 * Known Bugs::                  Problems we know about.
 145 * Reporting Bugs::              How to contact the maintainers.
 146 * Availability::                Where to find the lastest screen version.
 147
 148 \x1f
 149 File: screen.info,  Node: Known Bugs,  Next: Reporting Bugs,  Up: Bugs
 150
 151 Known Bugs
 152 ==========
 153
 154    * `dm' (delete mode) and `xs' are not handled correctly (they are
 155      ignored).  `xn' is treated as a magic-margin indicator.
 156
 157    * `screen' has no clue about double-high or double-wide characters.
 158      But this is the only area where `vttest' is allowed to fail.
 159
 160    * It is not possible to change the environment variable `$TERMCAP'
 161      when reattaching under a different terminal type.
 162
 163    * The support of terminfo based systems is very limited. Adding extra
 164      capabilities to `$TERMCAP' may not have any effects.
 165
 166    * `screen' does not make use of hardware tabs.
 167
 168    * `screen' must be installed setuid root on most systems in order to
 169      be able to correctly change the owner of the tty device file for
 170      each window.  Special permission may also be required to write the
 171      file `/etc/utmp'.
 172
 173    * Entries in `/etc/utmp' are not removed when `screen' is killed
 174      with SIGKILL.  This will cause some programs (like "w" or "rwho")
 175      to advertise that a user is logged on who really isn't.
 176
 177    * `screen' may give a strange warning when your tty has no utmp
 178      entry.
 179
 180    * When the modem line was hung up, `screen' may not automatically
 181      detach (or quit) unless the device driver sends a HANGUP signal.
 182      To detach such a `screen' session use the -D or -d command line
 183      option.
 184
 185    * If a password is set, the command line options -d and -D still
 186      detach a session without asking.
 187
 188    * Both `breaktype' and `defbreaktype' change the break generating
 189      method used by all terminal devices. The first should change a
 190      window specific setting, where the latter should change only the
 191      default for new windows.
 192
 193    * When attaching to a multiuser session, the user's `.screenrc' file
 194      is not sourced. Each users personal settings have to be included
 195      in the `.screenrc' file from which the session is booted, or have
 196      to be changed manually.
 197
 198    * A weird imagination is most useful to gain full advantage of all
 199      the features.
 200
 201 \x1f
 202 File: screen.info,  Node: Reporting Bugs,  Next: Availability,  Prev: Known Bugs,  Up: Bugs
 203
 204 Reporting Bugs
 205 ==============
 206
 207    If you find a bug in `Screen', please send electronic mail to
 208 `screen@uni-erlangen.de', and also to `bug-gnu-utils@prep.ai.mit.edu'.
 209 Include the version number of `Screen' which you are using.  Also
 210 include in your message the hardware and operating system, the compiler
 211 used to compile, a description of the bug behavior, and the conditions
 212 that triggered the bug. Please recompile `screen' with the `-DDEBUG'
 213 options enabled, reproduce the bug, and have a look at the debug output
 214 written to the directory `/tmp/debug'. If necessary quote suspect
 215 passages from the debug output and show the contents of your `config.h'
 216 if it matters.
 217
 218 \x1f
 219 File: screen.info,  Node: Availability,  Prev: Reporting Bugs,  Up: Bugs
 220
 221 Availability
 222 ============
 223
 224    `Screen' is available under the `GNU' copyleft.
 225
 226    The latest official release of `screen' available via anonymous ftp
 227 from `prep.ai.mit.edu', `nic.funet.fi' or any other `GNU' distribution
 228 site.  The home site of `screen' is `ftp.uni-erlangen.de
 229 (131.188.3.71)', in the directory `pub/utilities/screen'.  The
 230 subdirectory `private' contains the latest beta testing release.  If
 231 you want to help, send a note to screen@uni-erlangen.de.
 232
 233 \x1f
 234 File: screen.info,  Node: Installation,  Next: Concept Index,  Prev: Bugs,  Up: Top
 235
 236 Installation
 237 ************
 238
 239    Since `screen' uses pseudo-ttys, the select system call, and
 240 UNIX-domain sockets/named pipes, it will not run under a system that
 241 does not include these features of 4.2 and 4.3 BSD UNIX.
 242
 243 * Menu:
 244
 245 * Socket Directory::            Where screen stores its handle.
 246 * Compiling Screen::
 247
 248 \x1f
 249 File: screen.info,  Node: Socket Directory,  Next: Compiling Screen,  Up: Installation
 250
 251 Socket Directory
 252 ================
 253
 254    The socket directory defaults either to `$HOME/.screen' or simply to
 255 `/tmp/screens' or preferably to `/usr/local/screens' chosen at
 256 compile-time. If `screen' is installed setuid root, then the
 257 administrator should compile screen with an adequate (not NFS mounted)
 258 `SOCKDIR'. If `screen' is not running setuid-root, the user can specify
 259 any mode 700 directory in the environment variable `$SCREENDIR'.
 260
 261 \x1f
 262 File: screen.info,  Node: Compiling Screen,  Prev: Socket Directory,  Up: Installation
 263
 264 Compiling Screen
 265 ================
 266
 267    To compile and install screen:
 268
 269    The `screen' package comes with a `GNU Autoconf' configuration
 270 script. Before you compile the package run
 271
 272                            `sh ./configure'
 273  This will create a `config.h' and `Makefile' for your
 274 machine.  If `configure' fails for some reason, then look at the
 275 examples and comments found in the `Makefile.in' and `config.h.in'
 276 templates.  Rename `config.status' to `config.status.MACHINE' when you
 277 want to keep configuration data for multiple architectures. Running `sh
 278 ./config.status.MACHINE' recreates your configuration significantly
 279 faster than rerunning `configure'.
 280 Read through the "User Configuration" section of `config.h', and verify
 281 that it suits your needs.  A comment near the top of this section
 282 explains why it's best to install screen setuid to root.  Check for the
 283 place for the global `screenrc'-file and for the socket directory.
 284 Check the compiler used in `Makefile', the prefix path where to install
 285 `screen'. Then run
 286
 287                                 `make'
 288  If `make' fails to produce one of the files `term.h', `comm.h'
 289 or `tty.c', then use `FILENAME.X.dist' instead.  For additional
 290 information about installation of `screen' refer to the file
 291 `INSTALLATION', coming with this package.
 292
 293 \x1f
 294 File: screen.info,  Node: Concept Index,  Next: Command Index,  Prev: Installation,  Up: Top
 295
 296 Concept Index
 297 *************
 298
 299 * Menu:
 300
 301 * .screenrc:                             Startup Files.
 302 * availability:                          Availability.
 303 * binding:                               Key Binding.
 304 * bug report:                            Reporting Bugs.
 305 * bugs:                                  Bugs.
 306 * capabilities:                          Special Capabilities.
 307 * command character:                     Command Character.
 308 * command line options:                  Invoking Screen.
 309 * command summary:                       Command Summary.
 310 * compiling screen:                      Compiling Screen.
 311 * control sequences:                     Control Sequences.
 312 * copy and paste:                        Copy and Paste.
 313 * customization:                         Customization.
 314 * environment:                           Environment.
 315 * escape character:                      Command Character.
 316 * files:                                 Files.
 317 * flow control:                          Flow Control.
 318 * input translation:                     Input Translation.
 319 * installation:                          Installation.
 320 * introduction:                          Getting Started.
 321 * invoking:                              Invoking Screen.
 322 * key binding:                           Key Binding.
 323 * marking:                               Copy.
 324 * message line:                          Message Line.
 325 * multiuser session:                     Multiuser Session.
 326 * options:                               Invoking Screen.
 327 * overview:                              Overview.
 328 * regions:                               Regions.
 329 * screenrc:                              Startup Files.
 330 * scrollback:                            Copy.
 331 * socket directory:                      Socket Directory.
 332 * string escapes:                        String Escapes.
 333 * terminal capabilities:                 Special Capabilities.
 334 * title:                                 Naming Windows.
 335 * window types:                          Window Types.
 336
 337 \x1f
 338 File: screen.info,  Node: Command Index,  Next: Keystroke Index,  Prev: Concept Index,  Up: Top
 339
 340 Command Index
 341 *************
 342
 343    This is a list of all the commands supported by `screen'.
 344
 345 * Menu:
 346
 347 * acladd:                                Acladd.
 348 * aclchg:                                Aclchg.
 349 * acldel:                                Acldel.
 350 * aclgrp:                                Aclgrp.
 351 * aclumask:                              Umask.
 352 * activity:                              Monitor.
 353 * addacl:                                Acladd.
 354 * allpartial:                            Redisplay.
 355 * altscreen:                             Redisplay.
 356 * at:                                    At.
 357 * attrcolor:                             Attrcolor.
 358 * autodetach:                            Detach.
 359 * autonuke:                              Autonuke.
 360 * backtick:                              Backtick.
 361 * bce:                                   Character Processing.
 362 * bell_msg:                              Bell.
 363 * bind:                                  Bind.
 364 * bindkey:                               Bindkey.
 365 * blanker:                               Screen Saver.
 366 * blankerprg:                            Screen Saver.
 367 * break:                                 Break.
 368 * breaktype:                             Break.
 369 * bufferfile:                            Screen Exchange.
 370 * c1:                                    Character Processing.
 371 * caption:                               Caption.
 372 * chacl:                                 Aclchg.
 373 * charset:                               Character Processing.
 374 * chdir:                                 Chdir.
 375 * clear:                                 Clear.
 376 * colon:                                 Colon.
 377 * command:                               Command Character.
 378 * compacthist:                           Scrollback.
 379 * console:                               Console.
 380 * copy:                                  Copy.
 381 * copy_reg:                              Registers.
 382 * crlf:                                  Line Termination.
 383 * debug:                                 Debug.
 384 * defautonuke:                           Autonuke.
 385 * defbce:                                Character Processing.
 386 * defbreaktype:                          Break.
 387 * defc1:                                 Character Processing.
 388 * defcharset:                            Character Processing.
 389 * defencoding:                           Character Processing.
 390 * defescape:                             Command Character.
 391 * defflow:                               Flow.
 392 * defgr:                                 Character Processing.
 393 * defhstatus:                            Hardstatus.
 394 * deflog:                                Log.
 395 * deflogin:                              Login.
 396 * defmode:                               Mode.
 397 * defmonitor:                            Monitor.
 398 * defnonblock:                           Nonblock.
 399 * defobuflimit:                          Obuflimit.
 400 * defscrollback:                         Scrollback.
 401 * defshell:                              Shell.
 402 * defsilence:                            Silence.
 403 * defslowpaste:                          Paste.
 404 * defutf8:                               Character Processing.
 405 * defwrap:                               Wrap.
 406 * defwritelock:                          Writelock.
 407 * defzombie:                             Zombie.
 408 * detach:                                Detach.
 409 * digraph:                               Digraph.
 410 * dinfo:                                 Info.
 411 * displays:                              Displays.
 412 * dumptermcap:                           Dump Termcap.
 413 * echo:                                  echo.
 414 * encoding:                              Character Processing.
 415 * escape:                                Command Character.
 416 * eval:                                  Eval.
 417 * exec:                                  Exec.
 418 * fit:                                   Fit.
 419 * flow:                                  Flow.
 420 * focus:                                 Focus.
 421 * gr:                                    Character Processing.
 422 * hardcopy:                              Hardcopy.
 423 * hardcopy_append:                       Hardcopy.
 424 * hardcopydir:                           Hardcopy.
 425 * hardstatus:                            Hardware Status Line.
 426 * height:                                Window Size.
 427 * help:                                  Help.
 428 * history:                               History.
 429 * hstatus:                               Hardstatus.
 430 * idle:                                  Screen Saver.
 431 * ignorecase:                            Searching.
 432 * info:                                  Info.
 433 * ins_reg:                               Registers.
 434 * kill:                                  Kill.
 435 * lastmsg:                               Last Message.
 436 * license:                               License.
 437 * lockscreen:                            Lock.
 438 * log:                                   Log.
 439 * logfile:                               Log.
 440 * login:                                 Login.
 441 * logtstamp:                             Log.
 442 * mapdefault:                            Bindkey Control.
 443 * mapnotnext:                            Bindkey Control.
 444 * maptimeout:                            Bindkey Control.
 445 * markkeys:                              Copy Mode Keys.
 446 * maxwin:                                Maxwin.
 447 * meta:                                  Command Character.
 448 * monitor:                               Monitor.
 449 * msgminwait:                            Message Wait.
 450 * msgwait:                               Message Wait.
 451 * multiuser:                             Multiuser.
 452 * nethack:                               Nethack.
 453 * next:                                  Next and Previous.
 454 * nonblock:                              Nonblock.
 455 * number:                                Number.
 456 * obuflimit:                             Obuflimit.
 457 * only:                                  Only.
 458 * other:                                 Other Window.
 459 * partial:                               Redisplay.
 460 * password:                              Detach.
 461 * paste:                                 Paste.
 462 * pastefont:                             Paste.
 463 * pow_break:                             Break.
 464 * pow_detach:                            Power Detach.
 465 * pow_detach_msg:                        Power Detach.
 466 * prev:                                  Next and Previous.
 467 * printcmd:                              Printcmd.
 468 * process:                               Registers.
 469 * quit:                                  Quit.
 470 * readbuf:                               Screen Exchange.
 471 * readreg:                               Paste.
 472 * redisplay:                             Redisplay.
 473 * register:                              Registers.
 474 * remove:                                Remove.
 475 * removebuf:                             Screen Exchange.
 476 * reset:                                 Reset.
 477 * resize:                                Resize.
 478 * screen:                                Screen Command.
 479 * scrollback:                            Scrollback.
 480 * select:                                Select.
 481 * sessionname:                           Session Name.
 482 * setenv:                                Setenv.
 483 * setsid:                                Setsid.
 484 * shell:                                 Shell.
 485 * shelltitle:                            Shell.
 486 * silence:                               Silence.
 487 * silencewait:                           Silence.
 488 * sleep:                                 sleep.
 489 * slowpaste:                             Paste.
 490 * sorendition:                           Sorendition.
 491 * source:                                Source.
 492 * split:                                 Split.
 493 * startup_message:                       Startup Message.
 494 * stuff:                                 Paste.
 495 * su:                                    Su.
 496 * suspend:                               Suspend.
 497 * term:                                  Term.
 498 * termcap:                               Termcap Syntax.
 499 * termcapinfo:                           Termcap Syntax.
 500 * terminfo:                              Termcap Syntax.
 501 * time:                                  Time.
 502 * title:                                 Title Command.
 503 * umask:                                 Umask.
 504 * unsetenv:                              Setenv.
 505 * utf8:                                  Character Processing.
 506 * vbell:                                 Bell.
 507 * vbell_msg:                             Bell.
 508 * vbellwait:                             Bell.
 509 * verbose:                               Verbose.
 510 * version:                               Version.
 511 * wall:                                  Wall.
 512 * width:                                 Window Size.
 513 * windowlist:                            Windowlist.
 514 * windows:                               Windows.
 515 * wrap:                                  Wrap.
 516 * writebuf:                              Screen Exchange.
 517 * writelock:                             Writelock.
 518 * xoff:                                  XON/XOFF.
 519 * xon:                                   XON/XOFF.
 520 * zmodem:                                Zmodem.
 521 * zombie:                                Zombie.
 522
 523 \x1f
 524 File: screen.info,  Node: Keystroke Index,  Prev: Command Index,  Up: Top
 525
 526 Keystroke Index
 527 ***************
 528
 529    This is a list of the default key bindings.
 530
 531    The leading escape character (*note Command Character::) has been
 532 omitted from the key sequences, since it is the same for all bindings.
 533
 534 * Menu:
 535
 536 * ":                                     Windowlist.
 537 * ':                                     Select.
 538 * *:                                     Displays.
 539 * .:                                     Dump Termcap.
 540 * 0...9:                                 Select.
 541 * ::                                     Colon.
 542 * <:                                     Screen Exchange.
 543 * =:                                     Screen Exchange.
 544 * >:                                     Screen Exchange.
 545 * ?:                                     Help.
 546 * [:                                     Copy.
 547 * ]:                                     Paste.
 548 * a:                                     Command Character.
 549 * A:                                     Title Command.
 550 * C:                                     Clear.
 551 * c:                                     Screen Command.
 552 * C-[:                                   Copy.
 553 * C-\:                                   Quit.
 554 * C-]:                                   Paste.
 555 * C-a:                                   Other Window.
 556 * C-c:                                   Screen Command.
 557 * C-d:                                   Detach.
 558 * C-f:                                   Flow.
 559 * C-g:                                   Bell.
 560 * C-h:                                   Hardcopy.
 561 * C-i:                                   Info.
 562 * C-k:                                   Kill.
 563 * C-l:                                   Redisplay.
 564 * C-m:                                   Last Message.
 565 * C-n:                                   Next and Previous.
 566 * C-p:                                   Next and Previous.
 567 * C-q:                                   XON/XOFF.
 568 * C-r:                                   Wrap.
 569 * C-s:                                   XON/XOFF.
 570 * C-t:                                   Time.
 571 * C-v:                                   Digraph.
 572 * C-w:                                   Windows.
 573 * C-x:                                   Lock.
 574 * C-z:                                   Suspend.
 575 * D:                                     Power Detach.
 576 * d:                                     Detach.
 577 * ESC:                                   Copy.
 578 * f:                                     Flow.
 579 * F:                                     Fit.
 580 * H:                                     Log.
 581 * h:                                     Hardcopy.
 582 * i:                                     Info.
 583 * k:                                     Kill.
 584 * l:                                     Redisplay.
 585 * L:                                     Login.
 586 * m:                                     Last Message.
 587 * M:                                     Monitor.
 588 * N:                                     Number.
 589 * n:                                     Next and Previous.
 590 * p:                                     Next and Previous.
 591 * q:                                     XON/XOFF.
 592 * Q:                                     Only.
 593 * r:                                     Wrap.
 594 * s:                                     XON/XOFF.
 595 * S:                                     Split.
 596 * SPC:                                   Next and Previous.
 597 * t:                                     Time.
 598 * TAB:                                   Focus.
 599 * v:                                     Version.
 600 * W:                                     Window Size.
 601 * w:                                     Windows.
 602 * X:                                     Remove.
 603 * x:                                     Lock.
 604 * Z:                                     Reset.
 605 * z:                                     Suspend.
 606 * {:                                     History.
 607
 608