{ "content": [ { "type": "text", "text": "# screen (man)\n\n## NAME\n\nscreen - screen manager with VT100/ANSI terminal emulation\n\n## SYNOPSIS\n\nscreen [ -options ] [ cmd [ args ] ]\nscreen -r [[pid.]tty[.host]]\nscreen -r sessionowner/[[pid.]tty[.host]]\n\n## DESCRIPTION\n\nScreen is a full-screen window manager that multiplexes a physical terminal between several\nprocesses (typically interactive shells). Each virtual terminal provides the functions of a\nDEC VT100 terminal and, in addition, several control functions from the ISO 6429 (ECMA 48,\nANSI X3.64) and ISO 2022 standards (e.g. insert/delete line and support for multiple charac‐\nter sets). There is a scrollback history buffer for each virtual terminal and a copy-and-\npaste mechanism that allows moving text regions between windows.\n\n## TLDR\n\n> Hold a session open on a remote server. Manage multiple windows with a single SSH connection.\n\n- Start a new screen session:\n `screen`\n- Start a new named screen session:\n `screen -S {{session_name}}`\n- Start a new daemon and log the output to `screenlog.x`:\n `screen -dmLS {{session_name}} {{command}}`\n- Show open screen sessions:\n `screen -ls`\n- Reattach to an open screen:\n `screen -r {{session_name}}`\n- Detach from inside a screen:\n ``\n- Kill the current screen session:\n ``\n- Kill a detached screen:\n `screen -X -S {{session_name}} quit`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **GETTING STARTED**\n- **COMMAND-LINE OPTIONS** (40 subsections)\n- **DEFAULT KEY BINDINGS** (52 subsections)\n- **CUSTOMIZATION** (103 subsections)\n- **THE MESSAGE LINE**\n- **WINDOW TYPES**\n- **STRING ESCAPES**\n- **FLOW-CONTROL**\n- **THE VIRTUAL TERMINAL**\n- **INPUT TRANSLATION**\n- **SPECIAL TERMINAL CAPABILITIES** (21 subsections)\n- **CHARACTER TRANSLATION**\n- **ENVIRONMENT**\n- **FILES**\n- **AUTHORS**\n- **COPYLEFT**\n- **CONTRIBUTORS**\n- **AVAILABILITY**\n- **BUGS**\n- **SEE ALSO** (1 subsections)\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "screen", "section": "", "mode": "man", "summary": "screen - screen manager with VT100/ANSI terminal emulation", "synopsis": "screen [ -options ] [ cmd [ args ] ]\nscreen -r [[pid.]tty[.host]]\nscreen -r sessionowner/[[pid.]tty[.host]]", "tldr_summary": "Hold a session open on a remote server. Manage multiple windows with a single SSH connection.", "tldr_examples": [ { "description": "Start a new screen session", "command": "screen" }, { "description": "Start a new named screen session", "command": "screen -S {{session_name}}" }, { "description": "Start a new daemon and log the output to `screenlog.x`", "command": "screen -dmLS {{session_name}} {{command}}" }, { "description": "Show open screen sessions", "command": "screen -ls" }, { "description": "Reattach to an open screen", "command": "screen -r {{session_name}}" }, { "description": "Detach from inside a screen", "command": "" }, { "description": "Kill the current screen session", "command": "" }, { "description": "Kill a detached screen", "command": "screen -X -S {{session_name}} quit" } ], "tldr_source": "official", "flags": [ { "flag": "-a", "long": null, "arg": null, "description": "screen must redraw parts of the display in order to implement a function." }, { "flag": "-A", "long": null, "arg": null, "description": "tries to restore its old window sizes when attaching to resizable terminals (those with WS in its description, e.g. suncmd or some xterm)." }, { "flag": "-c", "long": null, "arg": null, "description": "override the default configuration file from $HOME/.screenrc to file." }, { "flag": "-D", "long": null, "arg": null, "description": "does not start screen, but detaches the elsewhere running screen session. It has the same effect as typing C-a d from screen's controlling terminal. -D is the equivalent to the power detach key. If no session can be detached, this option is ignored. In combi‐ nation with the -r/-R option more powerful effects can be achieved:" }, { "flag": "-r", "long": null, "arg": null, "description": "" }, { "flag": "-R", "long": null, "arg": null, "description": "" }, { "flag": "-d", "long": null, "arg": null, "description": "more than one session is available." }, { "flag": "-r", "long": null, "arg": null, "description": "" }, { "flag": "-R", "long": null, "arg": null, "description": "necessary detach and logout remotely first. If it was not running create it and no‐ tify the user. This is the author's favorite." }, { "flag": "-D", "long": null, "arg": null, "description": "Note: It is always a good idea to check the status of your sessions by means of screen -list." }, { "flag": "-e", "long": null, "arg": null, "description": "specifies the command character to be x and the character generating a literal command character to y (when typed after the command character). The default is C-a and `a', which can be specified as -e^Aa. When creating a screen session, this option sets the default command character. In a multiuser session all users added will start off with this command character. But when attaching to an already running session, this option changes only the command character of the attaching user. This option is equivalent to either the commands defescape or escape respectively." }, { "flag": "-f", "long": null, "arg": null, "description": "turns flow-control on, off, or automatic switching mode. This can also be defined through the defflow .screenrc command." }, { "flag": "-h", "long": null, "arg": null, "description": "Specifies the history scrollback buffer to be num lines high." }, { "flag": "-i", "long": null, "arg": null, "description": "flow-control is on. See the defflow .screenrc command for details. The use of this op‐ tion is discouraged." }, { "flag": "-l", "long": null, "arg": null, "description": "turns login mode on or off (for /run/utmp updating). This can also be defined through the deflogin .screenrc command." }, { "flag": "-L", "long": null, "arg": null, "description": "" }, { "flag": "-m", "long": null, "arg": null, "description": "session is enforced, regardless whether screen is called from within another screen ses‐ sion or not. This flag has a special meaning in connection with the `-d' option:" }, { "flag": "-m", "long": null, "arg": null, "description": "This is useful for system startup scripts." }, { "flag": "-m", "long": null, "arg": null, "description": "exits if the session terminates." }, { "flag": "-O", "long": null, "arg": null, "description": "affects auto-margin terminals without `LP'). This can also be set in your .screenrc by specifying `OP' in a termcap command." }, { "flag": "-p", "long": null, "arg": null, "description": "Preselect a window. This is useful when you want to reattach to a specific window or you want to send a command via the -X option to a specific window. As with screen's select command, - selects the blank window. As a special case for reattach, = brings up the windowlist on the blank window, while a + will create a new window. The command will not be executed if the specified window could not be found." }, { "flag": "-q", "long": null, "arg": null, "description": "lows: 9 indicates a directory without sessions. 10 indicates a directory with running but not attachable sessions. 11 (or more) indicates 1 (or more) usable sessions. In combination with -r the exit value is as follows: 10 indicates that there is no session to resume. 12 (or more) indicates that there are 2 (or more) sessions to resume and you should specify which one to choose. In all other cases -q has no effect." }, { "flag": "-Q", "long": null, "arg": null, "description": "windows. The commands will send the response to the stdout of the querying process. If there was an error in the command, then the querying process will exit with a non-zero status. The commands that can be queried now are: echo info lastmsg number select time title windows" }, { "flag": "-r", "long": null, "arg": null, "description": "" }, { "flag": "-r", "long": null, "arg": null, "description": "resumes a detached screen session. No other options (except combinations with -d/-D) may be specified, though an optional prefix of [pid.]tty.host may be needed to distin‐ guish between multiple detached screen sessions. The second form is used to connect to another user's screen session which runs in multiuser mode. This indicates that screen should look for sessions in another user's directory. This requires setuid-root." }, { "flag": "-R", "long": null, "arg": null, "description": "screen is detached. Otherwise lists available sessions. -RR attempts to resume the youngest (in terms of creation time) detached screen session it finds. If successful, all other command-line options are ignored. If no detached session exists, starts a new session using the specified options, just as if -R had not been specified. The option is set by default if screen is run as a login-shell (actually screen uses -xRR in that case). For combinations with the -d/-D option see there. Note: Time-based session se‐ lection is a Debian addition." }, { "flag": "-s", "long": null, "arg": null, "description": "sets the default shell to the program specified, instead of the value in the environment variable $SHELL (or /bin/sh if not defined). This can also be defined through the shell .screenrc command. See also there." }, { "flag": "-S", "long": null, "arg": null, "description": "When creating a new session, this option can be used to specify a meaningful name for the session. This name identifies the session for screen -list and screen -r actions. It substitutes the default [tty.host] suffix. This name should not be longer then 80 sym‐ bols." }, { "flag": "-t", "long": null, "arg": null, "description": "sets the title (a.k.a.) for the default shell or specified program. See also the shelltitle .screenrc command." }, { "flag": "-T", "long": null, "arg": null, "description": "Set the $TERM environment variable using the specified term as opposed to the default setting of screen." }, { "flag": "-U", "long": null, "arg": null, "description": "stands UTF-8 encoded characters. It also sets the default encoding for new windows to `utf8'." }, { "flag": "-v", "long": null, "arg": null, "description": "" }, { "flag": "-x", "long": null, "arg": null, "description": "from within itself. But when cascading multiple screens, loops are not detected; take care." }, { "flag": "-S", "long": null, "arg": null, "description": "specify the screen session if you have several screen sessions running. You can use the -d or -r option to tell screen to look only for attached or detached screen sessions. Note that this command doesn't work if the session is password protected." }, { "flag": "-4", "long": null, "arg": null, "description": "" }, { "flag": "-6", "long": null, "arg": null, "description": "" }, { "flag": "-i", "long": null, "arg": null, "description": "" } ], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 4, "subsections": [] }, { "name": "SYNOPSIS", "lines": 6, "subsections": [] }, { "name": "DESCRIPTION", "lines": 56, "subsections": [] }, { "name": "GETTING STARTED", "lines": 22, "subsections": [] }, { "name": "COMMAND-LINE OPTIONS", "lines": 2, "subsections": [ { "name": "-a", "lines": 2, "flag": "-a" }, { "name": "-A", "lines": 3, "flag": "-A" }, { "name": "-c _", "lines": 2, "flag": "-c" }, { "name": "-d -D", "lines": 5, "flag": "-D" }, { "name": "-d -r", "lines": 1, "flag": "-r" }, { "name": "-d -R", "lines": 1, "flag": "-R" }, { "name": "-d -RR", "lines": 2, "flag": "-d" }, { "name": "-D -r", "lines": 1, "flag": "-r" }, { "name": "-D -R", "lines": 3, "flag": "-R" }, { "name": "-D -RR", "lines": 3, "flag": "-D" }, { "name": "-e _", "lines": 8, "flag": "-e" }, { "name": "-f -fn -fa", "lines": 3, "flag": "-f" }, { "name": "-h _", "lines": 2, "flag": "-h" }, { "name": "-i", "lines": 3, "flag": "-i" }, { "name": "-l -ln", "lines": 3, "flag": "-l" }, { "name": "-ls", "lines": 1 }, { "name": "-list", "lines": 10 }, { "name": "-L", "lines": 1, "flag": "-L" }, { "name": "-Logfile _", "lines": 3 }, { "name": "-m", "lines": 3, "flag": "-m" }, { "name": "-d -m", "lines": 2, "flag": "-m" }, { "name": "-D -m", "lines": 2, "flag": "-m" }, { "name": "-O", "lines": 3, "flag": "-O" }, { "name": "-p _", "lines": 6, "flag": "-p" }, { "name": "-q", "lines": 6, "flag": "-q" }, { "name": "-Q", "lines": 14, "flag": "-Q" }, { "name": "-r", "lines": 1, "flag": "-r" }, { "name": "-r _", "lines": 6, "flag": "-r" }, { "name": "-R", "lines": 8, "flag": "-R" }, { "name": "-s _", "lines": 4, "flag": "-s" }, { "name": "-S _", "lines": 5, "flag": "-S" }, { "name": "-t _", "lines": 3, "flag": "-t" }, { "name": "-T _", "lines": 3, "flag": "-T" }, { "name": "-U", "lines": 3, "flag": "-U" }, { "name": "-v", "lines": 1, "flag": "-v" }, { "name": "-wipe", "lines": 5 }, { "name": "-x", "lines": 3, "flag": "-x" }, { "name": "-X -S", "lines": 5, "flag": "-S" }, { "name": "-4", "lines": 1, "flag": "-4" }, { "name": "-6", "lines": 1, "flag": "-6" } ] }, { "name": "DEFAULT KEY BINDINGS", "lines": 9, "subsections": [ { "name": "C-a ' (select)", "lines": 12 }, { "name": "C-a tab (focus)", "lines": 3 }, { "name": "C-a C-a (other)", "lines": 9 }, { "name": "C-a a (meta)", "lines": 3 }, { "name": "C-a A (title)", "lines": 3 }, { "name": "C-a b, (break)", "lines": 1 }, { "name": "C-a C-b", "lines": 4 }, { "name": "C-a c, (screen)", "lines": 3 }, { "name": "C-a C (clear)", "lines": 1 }, { "name": "C-a d, (detach)", "lines": 4 }, { "name": "C-a f, (flow)", "lines": 2 }, { "name": "C-a F (fit)", "lines": 2 }, { "name": "C-a C-g (vbell)", "lines": 2 }, { "name": "C-a h (hardcopy)", "lines": 3 }, { "name": "C-a H (log)", "lines": 3 }, { "name": "C-a i, (info)", "lines": 2 }, { "name": "C-a k, (kill)", "lines": 1 }, { "name": "C-a C-k", "lines": 1 }, { "name": "C-a l, (redisplay)", "lines": 2 }, { "name": "C-a L (login)", "lines": 4 }, { "name": "C-a m, (lastmsg)", "lines": 3 }, { "name": "C-a M (monitor)", "lines": 2 }, { "name": "C-a space, (next)", "lines": 1 }, { "name": "C-a C-n", "lines": 1 }, { "name": "C-a N (number)", "lines": 3 }, { "name": "C-a backspace, (prev)", "lines": 2 }, { "name": "C-a C-p", "lines": 1 }, { "name": "C-a q, (xon)", "lines": 2 }, { "name": "C-a Q (only)", "lines": 4 }, { "name": "C-a r, (wrap)", "lines": 5 }, { "name": "C-a s, (xoff)", "lines": 2 }, { "name": "C-a S (split)", "lines": 4 }, { "name": "C-a t, (time)", "lines": 1 }, { "name": "C-a C-t", "lines": 1 }, { "name": "C-a v (version)", "lines": 2 }, { "name": "C-a C-v (digraph)", "lines": 1 }, { "name": "C-a w, (windows)", "lines": 1 }, { "name": "C-a C-w", "lines": 1 }, { "name": "C-a W (width)", "lines": 3 }, { "name": "C-a X (remove)", "lines": 3 }, { "name": "C-a z, (suspend)", "lines": 3 }, { "name": "C-a Z (reset)", "lines": 3 }, { "name": "C-a . (dumptermcap)", "lines": 2 }, { "name": "C-a ? (help)", "lines": 1 }, { "name": "C-a \\ (quit)", "lines": 2 }, { "name": "C-a : (colon)", "lines": 1 }, { "name": "C-a [, (copy)", "lines": 11 }, { "name": "C-a > (writebuf)", "lines": 2 }, { "name": "C-a < (readbuf)", "lines": 3 }, { "name": "C-a = (removebuf)", "lines": 2 }, { "name": "C-a , (license)", "lines": 3 }, { "name": "C-a _ (silence)", "lines": 13 } ] }, { "name": "CUSTOMIZATION", "lines": 101, "subsections": [ { "name": "allpartial [ on | off ]", "lines": 6 }, { "name": "altscreen [ on | off ]", "lines": 54 }, { "name": "autodetach [ on | off ]", "lines": 4 }, { "name": "autonuke [ on | off ]", "lines": 21 }, { "name": "bce [ on | off ]", "lines": 118 }, { "name": "blanker", "lines": 29 }, { "name": "bumpleft", "lines": 2 }, { "name": "bumpright", "lines": 2 }, { "name": "c1 [ on | off ]", "lines": 45 }, { "name": "cjkwidth [ on | off ]", "lines": 2 }, { "name": "clear", "lines": 2 }, { "name": "collapse", "lines": 18 }, { "name": "compacthist [ on | off ]", "lines": 3 }, { "name": "console [ on | off ]", "lines": 4 }, { "name": "copy", "lines": 6 }, { "name": "left arrow", "lines": 2 }, { "name": "down arrow", "lines": 2 }, { "name": "up arrow", "lines": 2 }, { "name": "right arrow", "lines": 1 }, { "name": "0 (zero)", "lines": 127 }, { "name": "crlf [ on | off ]", "lines": 4 }, { "name": "debug [ on | off ]", "lines": 5 }, { "name": "defc1 [ on | off ]", "lines": 3 }, { "name": "defautonuke [ on | off ]", "lines": 4 }, { "name": "defbce [ on | off ]", "lines": 17 }, { "name": "defdynamictitle [ on | off ]", "lines": 10 }, { "name": "defflow [ on | off | auto [ interrupt ]]", "lines": 2 }, { "name": "-fa -i", "lines": 1, "flag": "-i" }, { "name": "defgr [ on | off ]", "lines": 17 }, { "name": "deflog [ on | off ]", "lines": 3 }, { "name": "deflogin [ on | off ]", "lines": 8 }, { "name": "defmonitor [ on | off]", "lines": 3 }, { "name": "defmousetrack [ on | off ]", "lines": 23 }, { "name": "defsilence [ on | off ]", "lines": 8 }, { "name": "defutf8 [ on | off ]", "lines": 3 }, { "name": "defwrap [ on | off ]", "lines": 4 }, { "name": "defwritelock [ on | off | auto ]", "lines": 10 }, { "name": "dinfo", "lines": 3 }, { "name": "displays", "lines": 86 }, { "name": "dumptermcap", "lines": 6 }, { "name": "dynamictitle [ on | off ]", "lines": 100 }, { "name": "fit", "lines": 3 }, { "name": "flow [ on | off | auto]", "lines": 5 }, { "name": "focus [ next | prev | up | down | left | right | top | bottom ]", "lines": 41 }, { "name": "gr [ on | off ]", "lines": 18 }, { "name": "hardcopy_append [ on | off ]", "lines": 8 }, { "name": "hardstatus [ on | off ]", "lines": 1 }, { "name": "hardstatus [ always ] firstline | lastline | message | ignore [ string ]", "lines": 1 }, { "name": "hardstatus string [ string ]", "lines": 36 }, { "name": "history", "lines": 20 }, { "name": "ignorecase [ on | off ]", "lines": 3 }, { "name": "info", "lines": 39 }, { "name": "kill", "lines": 10 }, { "name": "lastmsg", "lines": 19 }, { "name": "layout next", "lines": 2 }, { "name": "layout prev", "lines": 8 }, { "name": "layout show", "lines": 33 }, { "name": "layout autosave [ on | off]", "lines": 20 }, { "name": "license", "lines": 3 }, { "name": "lockscreen", "lines": 10 }, { "name": "log [ on | off ]", "lines": 15 }, { "name": "login [ on | off ]", "lines": 12 }, { "name": "logtstamp string", "lines": 9 }, { "name": "mapdefault", "lines": 3 }, { "name": "mapnotnext", "lines": 25 }, { "name": "meta", "lines": 2 }, { "name": "monitor [ on | off ]", "lines": 5 }, { "name": "mousetrack [ on | off ]", "lines": 15 }, { "name": "multiuser [ on | off ]", "lines": 4 }, { "name": "nethack [ on | off ]", "lines": 7 }, { "name": "next", "lines": 3 }, { "name": "nonblock [ on | off | numsecs ]", "lines": 21 }, { "name": "only", "lines": 2 }, { "name": "other", "lines": 3 }, { "name": "partial [ on | off ]", "lines": 28 }, { "name": "pastefont [ on | off ]", "lines": 3 }, { "name": "pow_break", "lines": 2 }, { "name": "pow_detach", "lines": 10 }, { "name": "prev", "lines": 19 }, { "name": "quit", "lines": 23 }, { "name": "redisplay", "lines": 7 }, { "name": "remove", "lines": 2 }, { "name": "removebuf", "lines": 2 }, { "name": "rendition [ bell | monitor | silence | so ] attr [ color ]", "lines": 5 }, { "name": "reset", "lines": 112 }, { "name": "setsid [ on | off ]", "lines": 19 }, { "name": "silence [ on | off | sec ]", "lines": 25 }, { "name": "sort", "lines": 34 }, { "name": "startup_message [ on | off ]", "lines": 3 }, { "name": "status [ top | up | down | bottom ] [ left | right ]", "lines": 20 }, { "name": "suspend", "lines": 95 }, { "name": "unbindall", "lines": 8 }, { "name": "utf8 [ on | off [ on | off ]]", "lines": 6 }, { "name": "vbell [ on | off ]", "lines": 18 }, { "name": "verbose [ on | off ]", "lines": 4 }, { "name": "version", "lines": 14 }, { "name": "windowlist [ -b ] [ -m ] [ -g ]", "lines": 64 }, { "name": "windows [ string ]", "lines": 12 }, { "name": "wrap [ on | off ]", "lines": 13 }, { "name": "writelock [ on | off | auto]", "lines": 7 }, { "name": "xoff", "lines": 1 }, { "name": "xon", "lines": 2 }, { "name": "zmodem [ off | auto | catch | pass ]", "lines": 40 } ] }, { "name": "THE MESSAGE LINE", "lines": 18, "subsections": [] }, { "name": "WINDOW TYPES", "lines": 96, "subsections": [] }, { "name": "STRING ESCAPES", "lines": 134, "subsections": [] }, { "name": "FLOW-CONTROL", "lines": 132, "subsections": [] }, { "name": "THE VIRTUAL TERMINAL", "lines": 318, "subsections": [] }, { "name": "INPUT TRANSLATION", "lines": 100, "subsections": [] }, { "name": "SPECIAL TERMINAL CAPABILITIES", "lines": 6, "subsections": [ { "name": "LP _(bool)", "lines": 2 }, { "name": "Z0 _(str)", "lines": 1 }, { "name": "Z1 _(str)", "lines": 1 }, { "name": "WS _(str)", "lines": 2 }, { "name": "NF _(bool)", "lines": 2 }, { "name": "G0 _(bool)", "lines": 1 }, { "name": "S0 _(str)", "lines": 1 }, { "name": "E0 _(str)", "lines": 1 }, { "name": "C0 _(str)", "lines": 2 }, { "name": "CS _(str)", "lines": 1 }, { "name": "CE _(str)", "lines": 1 }, { "name": "AN _(bool)", "lines": 1 }, { "name": "OL _(num)", "lines": 1 }, { "name": "KJ _(str)", "lines": 2 }, { "name": "AF _(str)", "lines": 2 }, { "name": "AB _(str)", "lines": 1 }, { "name": "AX _(bool)", "lines": 1 }, { "name": "XC _(str)", "lines": 2 }, { "name": "XT _(bool)", "lines": 1 }, { "name": "C8 _(bool)", "lines": 1 }, { "name": "TF _(bool)", "lines": 1 } ] }, { "name": "CHARACTER TRANSLATION", "lines": 45, "subsections": [] }, { "name": "ENVIRONMENT", "lines": 17, "subsections": [] }, { "name": "FILES", "lines": 20, "subsections": [] }, { "name": "AUTHORS", "lines": 5, "subsections": [] }, { "name": "COPYLEFT", "lines": 30, "subsections": [] }, { "name": "CONTRIBUTORS", "lines": 35, "subsections": [] }, { "name": "AVAILABILITY", "lines": 5, "subsections": [] }, { "name": "BUGS", "lines": 43, "subsections": [] }, { "name": "SEE ALSO", "lines": 1, "subsections": [ { "name": "termcap(5), utmp(5), vi(1), captoinfo(1), tic(1), tty(4), pty(7)", "lines": 1 } ] } ], "sections": { "NAME": { "content": "screen - screen manager with VT100/ANSI terminal emulation\n\n\n", "subsections": [] }, "SYNOPSIS": { "content": "screen [ -options ] [ cmd [ args ] ]\nscreen -r [[pid.]tty[.host]]\nscreen -r sessionowner/[[pid.]tty[.host]]\n\n\n", "subsections": [] }, "DESCRIPTION": { "content": "Screen is a full-screen window manager that multiplexes a physical terminal between several\nprocesses (typically interactive shells). Each virtual terminal provides the functions of a\nDEC VT100 terminal and, in addition, several control functions from the ISO 6429 (ECMA 48,\nANSI X3.64) and ISO 2022 standards (e.g. insert/delete line and support for multiple charac‐\nter sets). There is a scrollback history buffer for each virtual terminal and a copy-and-\npaste mechanism that allows moving text regions between windows.\n\nWhen screen is called, it creates a single window with a shell in it (or the specified com‐\nmand) and then gets out of your way so that you can use the program as you normally would.\nThen, at any time, you can create new (full-screen) windows with other programs in them (in‐\ncluding more shells), kill existing windows, view a list of windows, turn output logging on\nand off, copy-and-paste text between windows, view the scrollback history, switch between\nwindows in whatever manner you wish, etc. All windows run their programs completely indepen‐\ndent of each other. Programs continue to run when their window is currently not visible and\neven when the whole screen session is detached from the user's terminal. When a program ter‐\nminates, screen (per default) kills the window that contained it. If this window was in the\nforeground, the display switches to the previous window; if none are left, screen exits.\nShells usually distinguish between running as login-shell or sub-shell. Screen runs them as\nsub-shells, unless told otherwise (See shell .screenrc command).\n\nEverything you type is sent to the program running in the current window. The only exception\nto this is the one keystroke that is used to initiate a command to the window manager. By\ndefault, each command begins with a control-a (abbreviated C-a from now on), and is followed\nby one other keystroke. The command character and all the key bindings can be fully cus‐\ntomized to be anything you like, though they are always two characters in length.\n\nScreen does not understand the prefix C- to mean control, although this notation is used in\nthis manual for readability. Please use the caret notation (^A instead of C-a) as arguments\nto e.g. the escape command or the -e option. Screen will also print out control characters\nin caret notation.\n\nThe standard way to create a new window is to type C-a c. This creates a new window running\na shell and switches to that window immediately, regardless of the state of the process run‐\nning in the current window. Similarly, you can create a new window with a custom command in\nit by first binding the command to a keystroke (in your .screenrc file or at the C-a : com‐\nmand line) and then using it just like the C-a c command. In addition, new windows can be\ncreated by running a command like:\n\nscreen emacs prog.c\n\nfrom a shell prompt within a previously created window. This will not run another copy of\nscreen, but will instead supply the command name and its arguments to the window manager\n(specified in the $STY environment variable) who will use it to create the new window. The\nabove example would start the emacs editor (editing prog.c) and switch to its window. - Note\nthat you cannot transport environment variables from the invoking shell to the application\n(emacs in this case), because it is forked from the parent screen process, not from the in‐\nvoking shell.\n\nIf /run/utmp is writable by screen, an appropriate record will be written to this file for\neach window, and removed when the window is terminated. This is useful for working with\ntalk, script, shutdown, rsend, sccs and other similar programs that use the utmp file to de‐\ntermine who you are. As long as screen is active on your terminal, the terminal's own record\nis removed from the utmp file. See also C-a L.\n\n\n", "subsections": [] }, "GETTING STARTED": { "content": "Before you begin to use screen you'll need to make sure you have correctly selected your ter‐\nminal type, just as you would for any other termcap/terminfo program. (You can do this by\nusing test for example.)\n\nIf you're impatient and want to get started without doing a lot more reading, you should re‐\nmember this one command: C-a ?. Typing these two characters will display a list of the\navailable screen commands and their bindings. Each keystroke is discussed in the section DE‐\nFAULT KEY BINDINGS. The manual section CUSTOMIZATION deals with the contents of your\n.screenrc.\n\nIf your terminal is a true auto-margin terminal (it doesn't allow the last position on the\nscreen to be updated without scrolling the screen) consider using a version of your termi‐\nnal's termcap that has automatic margins turned off. This will ensure an accurate and optimal\nupdate of the screen in all circumstances. Most terminals nowadays have magic margins (auto‐\nmatic margins plus usable last column). This is the VT100 style type and perfectly suited for\nscreen. If all you've got is a true auto-margin terminal screen will be content to use it,\nbut updating a character put into the last position on the screen may not be possible until\nthe screen scrolls or the character is moved into a safe position in some other way. This de‐\nlay can be shortened by using a terminal with insert-character capability.\n\n\n", "subsections": [] }, "COMMAND-LINE OPTIONS": { "content": "Screen has the following command-line options:\n", "subsections": [ { "name": "-a", "content": "screen must redraw parts of the display in order to implement a function.\n", "flag": "-a" }, { "name": "-A", "content": "tries to restore its old window sizes when attaching to resizable terminals (those with\nWS in its description, e.g. suncmd or some xterm).\n", "flag": "-A" }, { "name": "-c _", "content": "override the default configuration file from $HOME/.screenrc to file.\n", "flag": "-c" }, { "name": "-d -D", "content": "does not start screen, but detaches the elsewhere running screen session. It has the\nsame effect as typing C-a d from screen's controlling terminal. -D is the equivalent to\nthe power detach key. If no session can be detached, this option is ignored. In combi‐\nnation with the -r/-R option more powerful effects can be achieved:\n", "flag": "-D" }, { "name": "-d -r", "content": "", "flag": "-r" }, { "name": "-d -R", "content": "", "flag": "-R" }, { "name": "-d -RR", "content": "more than one session is available.\n", "flag": "-d" }, { "name": "-D -r", "content": "", "flag": "-r" }, { "name": "-D -R", "content": "necessary detach and logout remotely first. If it was not running create it and no‐\ntify the user. This is the author's favorite.\n", "flag": "-R" }, { "name": "-D -RR", "content": "Note: It is always a good idea to check the status of your sessions by means of screen\n-list.\n", "flag": "-D" }, { "name": "-e _", "content": "specifies the command character to be x and the character generating a literal command\ncharacter to y (when typed after the command character). The default is C-a and `a',\nwhich can be specified as -e^Aa. When creating a screen session, this option sets the\ndefault command character. In a multiuser session all users added will start off with\nthis command character. But when attaching to an already running session, this option\nchanges only the command character of the attaching user. This option is equivalent to\neither the commands defescape or escape respectively.\n", "flag": "-e" }, { "name": "-f -fn -fa", "content": "turns flow-control on, off, or automatic switching mode. This can also be defined\nthrough the defflow .screenrc command.\n", "flag": "-f" }, { "name": "-h _", "content": "Specifies the history scrollback buffer to be num lines high.\n", "flag": "-h" }, { "name": "-i", "content": "flow-control is on. See the defflow .screenrc command for details. The use of this op‐\ntion is discouraged.\n", "flag": "-i" }, { "name": "-l -ln", "content": "turns login mode on or off (for /run/utmp updating). This can also be defined through\nthe deflogin .screenrc command.\n", "flag": "-l" }, { "name": "-ls", "content": "" }, { "name": "-list", "content": "does not start screen, but prints a list of pid.tty.host strings and creation timestamps\nidentifying your screen sessions. Sessions marked `detached' can be resumed with screen\n-r. Those marked `attached' are running and have a controlling terminal. If the session\nruns in multiuser mode, it is marked `multi'. Sessions marked as `unreachable' either\nlive on a different host or are `dead'. An unreachable session is considered dead, when\nits name matches either the name of the local host, or the specified parameter, if any.\nSee the -r flag for a description how to construct matches. Sessions marked as `dead'\nshould be thoroughly checked and removed. Ask your system administrator if you are not\nsure. Remove sessions with the -wipe option.\n" }, { "name": "-L", "content": "", "flag": "-L" }, { "name": "-Logfile _", "content": "By default logfile name is screenlog.0. You can set new logfile name with the -Logfile\noption.\n" }, { "name": "-m", "content": "session is enforced, regardless whether screen is called from within another screen ses‐\nsion or not. This flag has a special meaning in connection with the `-d' option:\n", "flag": "-m" }, { "name": "-d -m", "content": "This is useful for system startup scripts.\n", "flag": "-m" }, { "name": "-D -m", "content": "exits if the session terminates.\n", "flag": "-m" }, { "name": "-O", "content": "affects auto-margin terminals without `LP'). This can also be set in your .screenrc by\nspecifying `OP' in a termcap command.\n", "flag": "-O" }, { "name": "-p _", "content": "Preselect a window. This is useful when you want to reattach to a specific window or you\nwant to send a command via the -X option to a specific window. As with screen's select\ncommand, - selects the blank window. As a special case for reattach, = brings up the\nwindowlist on the blank window, while a + will create a new window. The command will not\nbe executed if the specified window could not be found.\n", "flag": "-p" }, { "name": "-q", "content": "lows: 9 indicates a directory without sessions. 10 indicates a directory with running\nbut not attachable sessions. 11 (or more) indicates 1 (or more) usable sessions. In\ncombination with -r the exit value is as follows: 10 indicates that there is no session\nto resume. 12 (or more) indicates that there are 2 (or more) sessions to resume and you\nshould specify which one to choose. In all other cases -q has no effect.\n", "flag": "-q" }, { "name": "-Q", "content": "windows. The commands will send the response to the stdout of the querying process. If\nthere was an error in the command, then the querying process will exit with a non-zero\nstatus.\n\nThe commands that can be queried now are:\necho\ninfo\nlastmsg\nnumber\nselect\ntime\ntitle\nwindows\n", "flag": "-Q" }, { "name": "-r", "content": "", "flag": "-r" }, { "name": "-r _", "content": "resumes a detached screen session. No other options (except combinations with -d/-D)\nmay be specified, though an optional prefix of [pid.]tty.host may be needed to distin‐\nguish between multiple detached screen sessions. The second form is used to connect to\nanother user's screen session which runs in multiuser mode. This indicates that screen\nshould look for sessions in another user's directory. This requires setuid-root.\n", "flag": "-r" }, { "name": "-R", "content": "screen is detached. Otherwise lists available sessions. -RR attempts to resume the\nyoungest (in terms of creation time) detached screen session it finds. If successful,\nall other command-line options are ignored. If no detached session exists, starts a new\nsession using the specified options, just as if -R had not been specified. The option is\nset by default if screen is run as a login-shell (actually screen uses -xRR in that\ncase). For combinations with the -d/-D option see there. Note: Time-based session se‐\nlection is a Debian addition.\n", "flag": "-R" }, { "name": "-s _", "content": "sets the default shell to the program specified, instead of the value in the environment\nvariable $SHELL (or /bin/sh if not defined). This can also be defined through the shell\n.screenrc command. See also there.\n", "flag": "-s" }, { "name": "-S _", "content": "When creating a new session, this option can be used to specify a meaningful name for\nthe session. This name identifies the session for screen -list and screen -r actions. It\nsubstitutes the default [tty.host] suffix. This name should not be longer then 80 sym‐\nbols.\n", "flag": "-S" }, { "name": "-t _", "content": "sets the title (a.k.a.) for the default shell or specified program. See also the\nshelltitle .screenrc command.\n", "flag": "-t" }, { "name": "-T _", "content": "Set the $TERM environment variable using the specified term as opposed to the default\nsetting of screen.\n", "flag": "-T" }, { "name": "-U", "content": "stands UTF-8 encoded characters. It also sets the default encoding for new windows to\n`utf8'.\n", "flag": "-U" }, { "name": "-v", "content": "", "flag": "-v" }, { "name": "-wipe", "content": "does the same as screen -ls, but removes destroyed sessions instead of marking them as\n`dead'. An unreachable session is considered dead, when its name matches either the\nname of the local host, or the explicitly given parameter, if any. See the -r flag for\na description how to construct matches.\n" }, { "name": "-x", "content": "from within itself. But when cascading multiple screens, loops are not detected; take\ncare.\n", "flag": "-x" }, { "name": "-X -S", "content": "specify the screen session if you have several screen sessions running. You can use the\n-d or -r option to tell screen to look only for attached or detached screen sessions.\nNote that this command doesn't work if the session is password protected.\n\n", "flag": "-S" }, { "name": "-4", "content": "", "flag": "-4" }, { "name": "-6", "content": "", "flag": "-6" } ] }, "DEFAULT KEY BINDINGS": { "content": "As mentioned, each screen command consists of a C-a followed by one other character. For\nyour convenience, all commands that are bound to lower-case letters are also bound to their\ncontrol character counterparts (with the exception of C-a a; see below), thus, C-a c as well\nas C-a C-c can be used to create a window. See section CUSTOMIZATION for a description of the\ncommand.\n\nThe following table shows the default key bindings. The trailing commas in boxes with multi‐\nple keystroke entries are separators, not part of the bindings.\n───────────────────────────────────────────────────────────────", "subsections": [ { "name": "C-a ' (select)", "content": "or number to switch to.\n───────────────────────────────────────────────────────────────\nC-a \" (windowlist -b) Present a list of all\nwindows for selection.\n───────────────────────────────────────────────────────────────\nC-a digit (select 0-9) Switch to window number 0\n- 9\n───────────────────────────────────────────────────────────────\nC-a - (select -) Switch to window number 0\n- 9, or to the blank win‐\ndow.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a tab (focus)", "content": "the next region. See\nalso split, remove, only.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a C-a (other)", "content": "played previously. Note\nthat this binding de‐\nfaults to the command\ncharacter typed twice,\nunless overridden. For\ninstance, if you use the\noption -e]x, this command\nbecomes ]].\n───────────────────────────────────────────────────────────────" }, { "name": "C-a a (meta)", "content": "ter (C-a) to window. See\nescape command.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a A (title)", "content": "name for the current win‐\ndow.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a b, (break)", "content": "" }, { "name": "C-a C-b", "content": "───────────────────────────────────────────────────────────────\nC-a B (powbreak) Reopen the terminal line\nand send a break.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a c, (screen)", "content": "C-a C-c a shell and switch to\nthat window.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a C (clear)", "content": "───────────────────────────────────────────────────────────────" }, { "name": "C-a d, (detach)", "content": "C-a C-d terminal.\n───────────────────────────────────────────────────────────────\nC-a D D (powdetach) Detach and logout.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a f, (flow)", "content": "C-a C-f auto.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a F (fit)", "content": "current region size.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a C-g (vbell)", "content": "bell mode.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a h (hardcopy)", "content": "current window to the\nfile hardcopy.n.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a H (log)", "content": "the current window to the\nfile screenlog.n.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a i, (info)", "content": "C-a C-i dow.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a k, (kill)", "content": "" }, { "name": "C-a C-k", "content": "───────────────────────────────────────────────────────────────" }, { "name": "C-a l, (redisplay)", "content": "C-a C-l window.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a L (login)", "content": "slot. Available only if\nscreen is configured to\nupdate the utmp database.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a m, (lastmsg)", "content": "C-a C-m displayed in the message\nline.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a M (monitor)", "content": "current window.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a space, (next)", "content": "C-a n, dow." }, { "name": "C-a C-n", "content": "───────────────────────────────────────────────────────────────" }, { "name": "C-a N (number)", "content": "tle) of the current win‐\ndow.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a backspace, (prev)", "content": "C-a C-h, window (opposite of C-a\nC-a p, n)." }, { "name": "C-a C-p", "content": "───────────────────────────────────────────────────────────────" }, { "name": "C-a q, (xon)", "content": "C-a C-q current window.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a Q (only)", "content": "the current one. See\nalso split, remove, fo‐\ncus.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a r, (wrap)", "content": "C-a C-r dow's line-wrap setting\n(turn the current win‐\ndow's automatic margins\non and off).\n───────────────────────────────────────────────────────────────" }, { "name": "C-a s, (xoff)", "content": "C-a C-s; current window.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a S (split)", "content": "horizontally into two new\nones. See also only, re‐\nmove, focus.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a t, (time)", "content": "" }, { "name": "C-a C-t", "content": "───────────────────────────────────────────────────────────────" }, { "name": "C-a v (version)", "content": "compilation date.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a C-v (digraph)", "content": "" }, { "name": "C-a w, (windows)", "content": "" }, { "name": "C-a C-w", "content": "───────────────────────────────────────────────────────────────" }, { "name": "C-a W (width)", "content": "───────────────────────────────────────────────────────────────\nC-a x or C-a C-x (lockscreen) Lock this terminal.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a X (remove)", "content": "See also split, only, fo‐\ncus.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a z, (suspend)", "content": "C-a C-z system must support BSD-\nstyle job-control.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a Z (reset)", "content": "nal to its power-on val‐\nues.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a . (dumptermcap)", "content": "file.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a ? (help)", "content": "───────────────────────────────────────────────────────────────" }, { "name": "C-a \\ (quit)", "content": "minate screen.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a : (colon)", "content": "───────────────────────────────────────────────────────────────" }, { "name": "C-a [, (copy)", "content": "C-a C-[, mode.\nC-a esc\n───────────────────────────────────────────────────────────────\nC-a C-], (paste .) Write the contents of the\nC-a ] paste buffer to the stdin\nqueue of the current win‐\ndow.\n───────────────────────────────────────────────────────────────\nC-a {, (history) Copy and paste a previous\nC-a } (command) line.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a > (writebuf)", "content": "file.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a < (readbuf)", "content": "file into the paste\nbuffer.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a = (removebuf)", "content": "C-a < and C-a >.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a , (license)", "content": "from, where it went to\nand why you can use it.\n───────────────────────────────────────────────────────────────" }, { "name": "C-a _ (silence)", "content": "current window for inac‐\ntivity.\n───────────────────────────────────────────────────────────────\nC-a | (split -v) Split the current region\nvertically into two new\nones.\n───────────────────────────────────────────────────────────────\nC-a * (displays) Show a listing of all\ncurrently attached dis‐\nplays.\n───────────────────────────────────────────────────────────────\n\n" } ] }, "CUSTOMIZATION": { "content": "The socket directory defaults either to $HOME/.screen or simply to /tmp/screens or preferably\nto /run/screen chosen at compile-time. If screen is installed setuid-root, then the adminis‐\ntrator should compile screen with an adequate (not NFS mounted) socket directory. If screen\nis not running setuid-root, the user can specify any mode 700 directory in the environment\nvariable $SCREENDIR.\n\nWhen screen is invoked, it executes initialization commands from the files /etc/screenrc and\ndefaults that can be overridden in the following ways: for the global screenrc file screen\nsearches for the environment variable $SYSSCREENRC (this override feature may be disabled at\ncompile-time). The user specific screenrc file is searched in $SCREENRC, then\n$HOME/.screenrc. The command line option -c takes precedence over the above user screenrc\nfiles.\n\nCommands in these files are used to set options, bind functions to keys, and to automatically\nestablish one or more windows at the beginning of your screen session. Commands are listed\none per line, with empty lines being ignored. A command's arguments are separated by tabs or\nspaces, and may be surrounded by single or double quotes. A `#' turns the rest of the line\ninto a comment, except in quotes. Unintelligible lines are warned about and ignored. Com‐\nmands may contain references to environment variables. The syntax is the shell-like \"$VAR \"\nor \"${VAR}\". Note that this causes incompatibility with previous screen versions, as now the\n'$'-character has to be protected with '\\' if no variable substitution shall be performed. A\nstring in single-quotes is also protected from variable substitution.\n\nTwo configuration files are shipped as examples with your screen distribution: etc/screenrc\nand etc/etcscreenrc. They contain a number of useful examples for various commands.\n\nCustomization can also be done 'on-line'. To enter the command mode type `C-a :'. Note that\ncommands starting with def change default values, while others change current settings.\n\nThe following commands are available:\n\nacladd usernames [crypted-pw]\n\naddacl usernames\n\nEnable users to fully access this screen session. Usernames can be one user or a comma sepa‐\nrated list of users. This command enables to attach to the screen session and performs the\nequivalent of `aclchg usernames +rwx \"#?\"'. executed. To add a user with restricted access,\nuse the `aclchg' command below. If an optional second parameter is supplied, it should be a\ncrypted password for the named user(s). `Addacl' is a synonym to `acladd'. Multi user mode\nonly.\n\naclchg usernames permbits list\n\nchacl usernames permbits list\n\nChange permissions for a comma separated list of users. Permission bits are represented as\n`r', `w' and `x'. Prefixing `+' grants the permission, `-' removes it. The third parameter is\na comma separated list of commands and/or windows (specified either by number or title). The\nspecial list `#' refers to all windows, `?' to all commands. if usernames consists of a sin‐\ngle `*', all known users are affected.\n\nA command can be executed when the user has the `x' bit for it. The user can type input to a\nwindow when he has its `w' bit set and no other user obtains a writelock for this window.\nOther bits are currently ignored. To withdraw the writelock from another user in window 2:\n`aclchg username -w+w 2'. To allow read-only access to the session: `aclchg username -w\n\"#\"'. As soon as a user's name is known to screen he can attach to the session and (per de‐\nfault) has full permissions for all command and windows. Execution permission for the acl\ncommands, `at' and others should also be removed or the user may be able to regain write per‐\nmission. Rights of the special username nobody cannot be changed (see the su command).\n`Chacl' is a synonym to `aclchg'. Multi user mode only.\n\nacldel username\n\nRemove a user from screen's access control list. If currently attached, all the user's dis‐\nplays are detached from the session. He cannot attach again. Multi user mode only.\n\naclgrp username [groupname]\n\nCreates groups of users that share common access rights. The name of the group is the user‐\nname of the group leader. Each member of the group inherits the permissions that are granted\nto the group leader. That means, if a user fails an access check, another check is made for\nthe group leader. A user is removed from all groups the special value none is used for\ngroupname. If the second parameter is omitted all groups the user is in are listed.\n\naclumask [[ users ] +bits | [ users ] -bits... ]\n\numask [[ users ] +bits | [ users ] -bits... ]\n\nThis specifies the access other users have to windows that will be created by the caller of\nthe command. Users may be no, one or a comma separated list of known usernames. If no users\nare specified, a list of all currently known users is assumed. Bits is any combination of\naccess control bits allowed defined with the aclchg command. The special username ? prede‐\nfines the access that not yet known users will be granted to any window initially. The spe‐\ncial username ?? predefines the access that not yet known users are granted to any command.\nRights of the special username nobody cannot be changed (see the su command). `Umask' is a\nsynonym to `aclumask'.\n\nactivity message\n\nWhen any activity occurs in a background window that is being monitored, screen displays a\nnotification in the message line. The notification message can be re-defined by means of the\nactivity command. Each occurrence of `%' in message is replaced by the number of the window\nin which activity has occurred, and each occurrence of `^G' is replaced by the definition for\nbell in your termcap (usually an audible bell). The default message is\n\n'Activity in window %n'\n\nNote that monitoring is off for all windows by default, but can be altered by use of the mon‐\nitor command (C-a M).\n", "subsections": [ { "name": "allpartial [ on | off ]", "content": "If set to on, only the current cursor line is refreshed on window change. This affects all\nwindows and is useful for slow terminal lines. The previous setting of full/partial refresh\nfor each window is restored with allpartial off. This is a global flag that immediately\ntakes effect on all windows overriding the partial settings. It does not change the default\nredraw behavior of newly created windows.\n" }, { "name": "altscreen [ on | off ]", "content": "If set to on, \"alternate screen\" support is enabled in virtual terminals, just like in xterm.\nInitial setting is `off'.\n\nat [identifier][#|*|%] command [args ... ]\n\nExecute a command at other displays or windows as if it had been entered there. At changes\nthe context (the `current window' or `current display' setting) of the command. If the first\nparameter describes a non-unique context, the command will be executed multiple times. If the\nfirst parameter is of the form `identifier*' then identifier is matched against user names.\nThe command is executed once for each display of the selected user(s). If the first parameter\nis of the form `identifier%' identifier is matched against displays. Displays are named after\nthe ttys they attach. The prefix `/dev/' or `/dev/tty' may be omitted from the identifier.\nIf identifier has a `#' or nothing appended it is matched against window numbers and titles.\nOmitting an identifier in front of the `#', `*' or `%'-character selects all users, displays\nor windows because a prefix-match is performed. Note that on the affected display(s) a short\nmessage will describe what happened. Permission is checked for initiator of the at command,\nnot for the owners of the affected display(s). Note that the '#' character works as a com‐\nment introducer when it is preceded by whitespace. This can be escaped by prefixing a '\\'.\nPermission is checked for the initiator of the at command, not for the owners of the affected\ndisplay(s).\n\nCaveat: When matching against windows, the command is executed at least once per window. Com‐\nmands that change the internal arrangement of windows (like other) may be called again. In\nshared windows the command will be repeated for each attached display. Beware, when issuing\ntoggle commands like login! Some commands (e.g. process) require that a display is associ‐\nated with the target windows. These commands may not work correctly under at looping over\nwindows.\n\nattrcolor attrib [attribute/color-modifier]\n\nThis command can be used to highlight attributes by changing the color of the text. If the\nattribute attrib is in use, the specified attribute/color modifier is also applied. If no\nmodifier is given, the current one is deleted. See the STRING ESCAPES chapter for the syntax\nof the modifier. Screen understands two pseudo-attributes, i stands for high-intensity fore‐\nground color and I for high-intensity background color.\n\nExamples:\n\nattrcolor b \"R\"\n\nChange the color to bright red if bold text is to be printed.\n\nattrcolor u \"-u b\"\n\nUse blue text instead of underline.\n\nattrcolor b \".I\"\n\nUse bright colors for bold text. Most terminal emulators do this already.\n\nattrcolor i \"+b\"\n\nMake bright colored text also bold.\n" }, { "name": "autodetach [ on | off ]", "content": "Sets whether screen will automatically detach upon hangup, which saves all your running pro‐\ngrams until they are resumed with a screen -r command. When turned off, a hangup signal will\nterminate screen and all the processes it contains. Autodetach is on by default.\n" }, { "name": "autonuke [ on | off ]", "content": "Sets whether a clear screen sequence should nuke all the output that has not been written to\nthe terminal. See also obuflimit.\n\nbacktick id lifespan autorefresh cmd args...\n\nbacktick id\n\nProgram the backtick command with the numerical id id. The output of such a command is used\nfor substitution of the %` string escape. The specified lifespan is the number of seconds the\noutput is considered valid. After this time, the command is run again if a corresponding\nstring escape is encountered. The autorefresh parameter triggers an automatic refresh for\ncaption and hardstatus strings after the specified number of seconds. Only the last line of\noutput is used for substitution.\n\nIf both the lifespan and the autorefresh parameters are zero, the backtick program is ex‐\npected to stay in the background and generate output once in a while. In this case, the com‐\nmand is executed right away and screen stores the last line of output. If a new line gets\nprinted screen will automatically refresh the hardstatus or the captions.\n\nThe second form of the command deletes the backtick command with the numerical id id.\n" }, { "name": "bce [ on | off ]", "content": "Change background-color-erase setting. If bce is set to on, all characters cleared by an\nerase/insert/scroll/clear operation will be displayed in the current background color. Other‐\nwise the default background color is used.\n\nbellmsg [message]\n\nWhen a bell character is sent to a background window, screen displays a notification in the\nmessage line. The notification message can be re-defined by this command. Each occurrence\nof `%' in message is replaced by the number of the window to which a bell has been sent, and\neach occurrence of `^G' is replaced by the definition for bell in your termcap (usually an\naudible bell). The default message is\n\n'Bell in window %n'\n\nAn empty message can be supplied to the bellmsg command to suppress output of a message line\n(bellmsg \"\"). Without parameter, the current message is shown.\n\nbind [class] key [command [args]]\n\nBind a command to a key. By default, most of the commands provided by screen are bound to\none or more keys as indicated in the DEFAULT KEY BINDINGS section, e.g. the command to create\na new window is bound to C-c and c. The bind command can be used to redefine the key bind‐\nings and to define new bindings. The key argument is either a single character, a two-char‐\nacter sequence of the form ^x (meaning C-x), a backslash followed by an octal number (speci‐\nfying the ASCII code of the character), or a backslash followed by a second character, such\nas \\^ or \\\\. The argument can also be quoted, if you like. If no further argument is given,\nany previously established binding for this key is removed. The command argument can be any\ncommand listed in this section.\n\nIf a command class is specified via the -c option, the key is bound for the specified class.\nUse the command command to activate a class. Command classes can be used to create multiple\ncommand keys or multi-character bindings.\n\nSome examples:\n\nbind ' ' windows\nbind ^k\nbind k\nbind K kill\nbind ^f screen telnet foobar\nbind \\033 screen -ln -t root -h 1000 9 su\n\nwould bind the space key to the command that displays a list of windows (so that the command\nusually invoked by C-a C-w would also be available as C-a space). The next three lines remove\nthe default kill binding from C-a C-k and C-a k. C-a K is then bound to the kill command.\nThen it binds C-f to the command create a window with a TELNET connection to foobar, and bind\nescape to the command that creates an non-login window with a.k.a. root in slot #9, with a\nsuperuser shell and a scrollback buffer of 1000 lines.\n\nbind -c demo1 0 select 10\nbind -c demo1 1 select 11\nbind -c demo1 2 select 12\nbindkey \"^B\" command -c demo1\n\nmakes C-b 0 select window 10, C-b 1 window 11, etc.\n\nbind -c demo2 0 select 10\nbind -c demo2 1 select 11\nbind -c demo2 2 select 12\nbind - command -c demo2\n\nmakes C-a - 0 select window 10, C-a - 1 window 11, etc.\n\nbindkey [-d] [-m] [-a] [[-k|-t] string [cmd-args]]\n\nThis command manages screen's input translation tables. Every entry in one of the tables\ntells screen how to react if a certain sequence of characters is encountered. There are three\ntables: one that should contain actions programmed by the user, one for the default actions\nused for terminal emulation and one for screen's copy mode to do cursor movement. See section\nINPUT TRANSLATION for a list of default key bindings.\n\nIf the -d option is given, bindkey modifies the default table, -m changes the copy mode table\nand with neither option the user table is selected. The argument string is the sequence of\ncharacters to which an action is bound. This can either be a fixed string or a termcap key‐\nboard capability name (selectable with the -k option).\n\nSome keys on a VT100 terminal can send a different string if application mode is turned on\n(e.g the cursor keys). Such keys have two entries in the translation table. You can select\nthe application mode entry by specifying the -a option.\n\nThe -t option tells screen not to do inter-character timing. One cannot turn off the timing\nif a termcap capability is used.\n\nCmd can be any of screen's commands with an arbitrary number of args. If cmd is omitted the\nkey-binding is removed from the table.\n\nHere are some examples of keyboard bindings:\n\nbindkey -d\n\nShow all of the default key bindings. The application mode entries are marked with [A].\n\nbindkey -k k1 select 1\n\nMake the \"F1\" key switch to window one.\n\nbindkey -t foo stuff barfoo\n\nMake \"foo\" an abbreviation of the word \"barfoo\". Timeout is disabled so that users can type\nslowly.\n\nbindkey \"\\024\" mapdefault\n\nThis key-binding makes ^T an escape character for key-bindings. If you did the above stuff\nbarfoo binding, you can enter the word foo by typing ^Tfoo. If you want to insert a ^T you\nhave to press the key twice (i.e., escape the escape binding).\n\nbindkey -k F1 command\n\nMake the F11 (not F1!) key an alternative screen escape (besides ^A).\n\nbreak [duration]\n\nSend a break signal for duration*0.25 seconds to this window. For non-Posix systems the time\ninterval may be rounded up to full seconds. Most useful if a character device is attached to\nthe window rather than a shell process (See also chapter WINDOW TYPES). The maximum duration\nof a break signal is limited to 15 seconds.\n" }, { "name": "blanker", "content": "Activate the screen blanker. First the screen is cleared. If no blanker program is defined,\nthe cursor is turned off, otherwise, the program is started and it's output is written to the\nscreen. The screen blanker is killed with the first keypress, the read key is discarded.\n\nThis command is normally used together with the idle command.\n\nblankerprg [program-args]\n\nDefines a blanker program. Disables the blanker program if an empty argument is given. Shows\nthe currently set blanker program if no arguments are given.\n\nbreaktype [tcsendbreak|TIOCSBRK|TCSBRK]\n\nChoose one of the available methods of generating a break signal for terminal devices. This\ncommand should affect the current window only. But it still behaves identical to defbreak‐\ntype. This will be changed in the future. Calling breaktype with no parameter displays the\nbreak method for the current window.\n\nbufferfile [exchange-file]\n\nChange the filename used for reading and writing with the paste buffer. If the optional ar‐\ngument to the bufferfile command is omitted, the default setting (/tmp/screen-exchange) is\nreactivated. The following example will paste the system's password file into the screen\nwindow (using the paste buffer, where a copy remains):\n\nC-a : bufferfile /etc/passwd\nC-a < C-a ]\nC-a : bufferfile\n" }, { "name": "bumpleft", "content": "Swaps window with previous one on window list.\n" }, { "name": "bumpright", "content": "Swaps window with next one on window list.\n" }, { "name": "c1 [ on | off ]", "content": "Change c1 code processing. C1 on tells screen to treat the input characters between 128 and\n159 as control functions. Such an 8-bit code is normally the same as ESC followed by the\ncorresponding 7-bit code. The default setting is to process c1 codes and can be changed with\nthe defc1 command. Users with fonts that have usable characters in the c1 positions may want\nto turn this off.\n\ncaption [ top | bottom ] always|splitonly[string]\n\ncaption string [string]\n\nThis command controls the display of the window captions. Normally a caption is only used if\nmore than one window is shown on the display (split screen mode). But if the type is set to\nalways screen shows a caption even if only one window is displayed. The default is splitonly.\n\nThe second form changes the text used for the caption. You can use all escapes from the\nSTRING ESCAPES chapter. Screen uses a default of `%3n %t'.\n\nYou can mix both forms by providing a string as an additional argument.\n\nYou can have the caption displayed either at the top or bottom of the window. The default is\nbottom.\n\ncharset set\n\nChange the current character set slot designation and charset mapping. The first four char‐\nacter of set are treated as charset designators while the fifth and sixth character must be\nin range '0' to '3' and set the GL/GR charset mapping. On every position a '.' may be used to\nindicate that the corresponding charset/mapping should not be changed (set is padded to six\ncharacters internally by appending '.' chars). New windows have \"BBBB02\" as default charset,\nunless a encoding command is active.\nThe current setting can be viewed with the info command.\n\nchdir [directory]\n\nChange the current directory of screen to the specified directory or, if called without an\nargument, to your home directory (the value of the environment variable $HOME). All windows\nthat are created by means of the screen command from within .screenrc or by means of C-a :\nscreen ... or C-a c use this as their default directory. Without a chdir command, this\nwould be the directory from which screen was invoked.\n\nHardcopy and log files are always written to the window's default directory, not the current\ndirectory of the process running in the window. You can use this command multiple times in\nyour .screenrc to start various windows in different default directories, but the last chdir\nvalue will affect all the windows you create interactively.\n" }, { "name": "cjkwidth [ on | off ]", "content": "Treat ambiguous width characters as full/half width.\n" }, { "name": "clear", "content": "Clears the current window and saves its image to the scrollback buffer.\n" }, { "name": "collapse", "content": "Reorders window on window list, removing number gaps between them.\n\ncolon [prefix]\n\nAllows you to enter .screenrc command lines. Useful for on-the-fly modification of key bind‐\nings, specific window creation and changing settings. Note that the set keyword no longer ex‐\nists! Usually commands affect the current window rather than default settings for future win‐\ndows. Change defaults with commands starting with 'def...'.\n\nIf you consider this as the `Ex command mode' of screen, you may regard C-a esc (copy mode)\nas its `Vi command mode'.\n\ncommand [ -c class\"]\"\n\nThis command has the same effect as typing the screen escape character (^A). It is probably\nonly useful for key bindings. If the -c option is given, select the specified command class.\nSee also bind and bindkey.\n" }, { "name": "compacthist [ on | off ]", "content": "This tells screen whether to suppress trailing blank lines when scrolling up text into the\nhistory buffer.\n" }, { "name": "console [ on | off ]", "content": "Grabs or un-grabs the machines console output to a window. Note: Only the owner of /dev/con‐\nsole can grab the console output. This command is only available if the machine supports the\nioctl TIOCCONS.\n" }, { "name": "copy", "content": "Enter copy/scrollback mode. This allows you to copy text from the current window and its his‐\ntory into the paste buffer. In this mode a vi-like `full screen editor' is active:\nThe editor's movement keys are:\n\n────────────────────────────────────────────────────────────────\nh, C-h, move the cursor left." }, { "name": "left arrow", "content": "────────────────────────────────────────────────────────────────\nj, C-n, move the cursor down." }, { "name": "down arrow", "content": "────────────────────────────────────────────────────────────────\nk, C-p, move the cursor up." }, { "name": "up arrow", "content": "────────────────────────────────────────────────────────────────\nl ('el'), move the cursor right." }, { "name": "right arrow", "content": "────────────────────────────────────────────────────────────────" }, { "name": "0 (zero)", "content": "────────────────────────────────────────────────────────────────\n+ and - positions one line up and down.\n────────────────────────────────────────────────────────────────\nH, M and L move the cursor to the leftmost column of the\ntop, center or bottom line of the window.\n────────────────────────────────────────────────────────────────\n| moves to the specified absolute column.\n────────────────────────────────────────────────────────────────\ng or home moves to the beginning of the buffer.\n────────────────────────────────────────────────────────────────\nG or end moves to the specified absolute line (default:\nend of buffer).\n────────────────────────────────────────────────────────────────\n% jumps to the specified percentage of the buffer.\n────────────────────────────────────────────────────────────────\n^ or $ move to the leftmost column, to the first or\nlast non-whitespace character on the line.\n────────────────────────────────────────────────────────────────\nw, b, and e move the cursor word by word.\n────────────────────────────────────────────────────────────────\nB, E move the cursor WORD by WORD (as in vi).\n────────────────────────────────────────────────────────────────\nf/F, t/T move the cursor forward/backward to the next oc‐\ncurrence of the target. (eg, '3fy' will move the\ncursor to the 3rd 'y' to the right.)\n────────────────────────────────────────────────────────────────\n; and , Repeat the last f/F/t/T command in the same/op‐\nposite direction.\n────────────────────────────────────────────────────────────────\nC-e and C-y scroll the display up/down by one line while\npreserving the cursor position.\n────────────────────────────────────────────────────────────────\nC-u and C-d scroll the display up/down by the specified\namount of lines while preserving the cursor po‐\nsition. (Default: half screen-full).\n────────────────────────────────────────────────────────────────\nC-b and C-f scroll the display up/down a full screen.\n────────────────────────────────────────────────────────────────\n\n\nNote: Emacs style movement keys can be customized by a .screenrc command. (E.g. markkeys\n\"h=^B:l=^F:$=^E\") There is no simple method for a full emacs-style keymap, as this involves\nmulti-character codes.\n\nSome keys are defined to do mark and replace operations.\n\nThe copy range is specified by setting two marks. The text between these marks will be high‐\nlighted. Press:\n\nspace or enter to set the first or second mark respectively. If mousetrack is set to\n`on', marks can also be set using left mouse click.\n\nY and y used to mark one whole line or to mark from start of line.\n\nW marks exactly one word.\n\nAny of these commands can be prefixed with a repeat count number by pressing digits\n\n0..9 which is taken as a repeat count.\n\nExample: C-a C-[ H 10 j 5 Y will copy lines 11 to 15 into the paste buffer.\n\nThe following search keys are defined:\n\n/ Vi-like search forward.\n\n? Vi-like search backward.\n\nC-a s Emacs style incremental search forward.\n\nC-r Emacs style reverse i-search.\n\nn Find next search pattern.\n\nN Find previous search pattern.\n\n\nThere are however some keys that act differently than in vi. Vi does not allow one to yank\nrectangular blocks of text, but screen does. Press: c or C to set the left or right margin\nrespectively. If no repeat count is given, both default to the current cursor position.\n\nExample: Try this on a rather full text screen:\n\nC-a [ M 20 l SPACE c 10 l 5 j C SPACE.\n\nThis moves one to the middle line of the screen, moves in 20 columns left, marks the begin‐\nning of the paste buffer, sets the left column, moves 5 columns down, sets the right column,\nand then marks the end of the paste buffer. Now try:\n\nC-a [ M 20 l SPACE 10 l 5 j SPACE\n\nand notice the difference in the amount of text copied.\n\nJ joins lines. It toggles between 4 modes: lines separated by a newline character (012),\nlines glued seamless, lines separated by a single whitespace and comma separated lines. Note\nthat you can prepend the newline character with a carriage return character, by issuing a\ncrlf on.\n\nv or V is for all the vi users with :set numbers - it toggles the left margin between column\n9 and 1. Press\n\na before the final space key to toggle in append mode. Thus the contents of the paste buffer\nwill not be overwritten, but is appended to.\n\nA toggles in append mode and sets a (second) mark.\n\n> sets the (second) mark and writes the contents of the paste buffer to the screen-exchange\nfile (/tmp/screen-exchange per default) once copy-mode is finished.\n\nThis example demonstrates how to dump the whole scrollback buffer to that file: C-A [ g SPACE\nG $ >.\n\nC-g gives information about the current line and column.\n\nx or o exchanges the first mark and the current cursor position. You can use this to adjust\nan already placed mark.\n\nC-l ('el') will redraw the screen.\n\n@ does nothing. Does not even exit copy mode.\n\nAll keys not described here exit copy mode.\n\ncopyreg [key]\n\nNo longer exists, use readreg instead.\n" }, { "name": "crlf [ on | off ]", "content": "This affects the copying of text regions with the `C-a [' command. If it is set to `on',\nlines will be separated by the two character sequence `CR' - `LF'. Otherwise (default) only\n`LF' is used. When no parameter is given, the state is toggled.\n" }, { "name": "debug [ on | off ]", "content": "Turns runtime debugging on or off. If screen has been compiled with option -DDEBUG debugging\navailable and is turned on per default. Note that this command only affects debugging output\nfrom the main SCREEN process correctly. Debug output from attacher processes can only be\nturned off once and forever.\n" }, { "name": "defc1 [ on | off ]", "content": "Same as the c1 command except that the default setting for new windows is changed. Initial\nsetting is `on'.\n" }, { "name": "defautonuke [ on | off ]", "content": "Same as the autonuke command except that the default setting for new displays is changed.\nInitial setting is `off'. Note that you can use the special `AN' terminal capability if you\nwant to have a dependency on the terminal type.\n" }, { "name": "defbce [ on | off ]", "content": "Same as the bce command except that the default setting for new windows is changed. Initial\nsetting is `off'.\n\ndefbreaktype [tcsendbreak|TIOCSBRK|TCSBRK]\n\nChoose one of the available methods of generating a break signal for terminal devices. The\npreferred methods are tcsendbreak and TIOCSBRK. The third, TCSBRK, blocks the complete\nscreen session for the duration of the break, but it may be the only way to generate long\nbreaks. Tcsendbreak and TIOCSBRK may or may not produce long breaks with spikes (e.g. 4 per\nsecond). This is not only system-dependent, this also differs between serial board drivers.\nCalling defbreaktype with no parameter displays the current setting.\n\ndefcharset [set]\n\nLike the charset command except that the default setting for new windows is changed. Shows\ncurrent default if called without argument.\n" }, { "name": "defdynamictitle [ on | off ]", "content": "Set default behaviour for new windows regarding if screen should change window title when\nseeing proper escape sequence. See also \"TITLES (naming windows)\" section.\n\ndefescape xy\n\nSet the default command characters. This is equivalent to the escape except that it is useful\nmultiuser sessions only. In a multiuser session escape changes the command character of the\ncalling user, where defescape changes the default command characters for users that will be\nadded later.\n" }, { "name": "defflow [ on | off | auto [ interrupt ]]", "content": "Same as the flow command except that the default setting for new windows is changed. Initial\nsetting is `auto'. Specifying defflow auto interrupt is the same as the command-line options" }, { "name": "-fa -i", "content": "", "flag": "-i" }, { "name": "defgr [ on | off ]", "content": "Same as the gr command except that the default setting for new windows is changed. Initial\nsetting is `off'.\n\ndefhstatus [status]\n\nThe hardstatus line that all new windows will get is set to status. This command is useful\nto make the hardstatus of every window display the window number or title or the like. Sta‐\ntus may contain the same directives as in the window messages, but the directive escape char‐\nacter is '^E' (octal 005) instead of '%'. This was done to make a misinterpretation of pro‐\ngram generated hardstatus lines impossible. If the parameter status is omitted, the current\ndefault string is displayed. Per default the hardstatus line of new windows is empty.\n\ndefencoding enc\n\nSame as the encoding command except that the default setting for new windows is changed. Ini‐\ntial setting is the encoding taken from the terminal.\n" }, { "name": "deflog [ on | off ]", "content": "Same as the log command except that the default setting for new windows is changed. Initial\nsetting is `off'.\n" }, { "name": "deflogin [ on | off ]", "content": "Same as the login command except that the default setting for new windows is changed. This is\ninitialized with `on' as distributed (see config.h.in).\n\ndefmode mode\n\nThe mode of each newly allocated pseudo-tty is set to mode. Mode is an octal number. When\nno defmode command is given, mode 0622 is used.\n" }, { "name": "defmonitor [ on | off]", "content": "Same as the monitor command except that the default setting for new windows is changed. Ini‐\ntial setting is `off'.\n" }, { "name": "defmousetrack [ on | off ]", "content": "Same as the mousetrack command except that the default setting for new windows is changed.\nInitial setting is `off'.\n\ndefnonblock [ on | off | numsecs]\n\nSame as the nonblock command except that the default setting for displays is changed. Initial\nsetting is `off'.\n\ndefobuflimit limit\n\nSame as the obuflimit command except that the default setting for new displays is changed.\nInitial setting is 256 bytes. Note that you can use the special 'OL' terminal capability if\nyou want to have a dependency on the terminal type.\n\ndefscrollback num\n\nSame as the scrollback command except that the default setting for new windows is changed.\nInitial setting is 100.\n\ndefshell command\n\nSynonym to the shell .screenrc command. See there.\n" }, { "name": "defsilence [ on | off ]", "content": "Same as the silence command except that the default setting for new windows is changed. Ini‐\ntial setting is `off'.\n\ndefslowpaste msec\n\nSame as the slowpaste command except that the default setting for new windows is changed.\nInitial setting is 0 milliseconds, meaning `off'.\n" }, { "name": "defutf8 [ on | off ]", "content": "Same as the utf8 command except that the default setting for new windows is changed. Initial\nsetting is `on' if screen was started with -U, otherwise `off'.\n" }, { "name": "defwrap [ on | off ]", "content": "Same as the wrap command except that the default setting for new windows is changed. Ini‐\ntially line-wrap is on and can be toggled with the wrap command (C-a r) or by means of \"C-a :\nwrap on|off\".\n" }, { "name": "defwritelock [ on | off | auto ]", "content": "Same as the writelock command except that the default setting for new windows is changed.\nInitially writelocks will off.\n\ndetach [-h]\n\nDetach the screen session (disconnect it from the terminal and put it into the background).\nThis returns you to the shell where you invoked screen. A detached screen can be resumed by\ninvoking screen with the -r option (see also section COMMAND-LINE OPTIONS). The -h option\ntells screen to immediately close the connection to the terminal (hangup).\n" }, { "name": "dinfo", "content": "Show what screen thinks about your terminal. Useful if you want to know why features like\ncolor or the alternate charset don't work.\n" }, { "name": "displays", "content": "Shows a tabular listing of all currently connected user front-ends (displays). This is most\nuseful for multiuser sessions. The following keys can be used in displays list:\n\n──────────────────────────────────────────────────────────\nk, C-p, or up Move up one line.\n──────────────────────────────────────────────────────────\nj, C-n, or down Move down one line.\n──────────────────────────────────────────────────────────\nC-a or home Move to the first line.\n──────────────────────────────────────────────────────────\nC-e or end Move to the last line.\n──────────────────────────────────────────────────────────\nC-u or C-d Move one half page up or down.\n──────────────────────────────────────────────────────────\nC-b or C-f Move one full page up or down.\n──────────────────────────────────────────────────────────\nmouseclick Move to the selected line. Avail‐\nable when mousetrack is set to\non.\n──────────────────────────────────────────────────────────\nspace Refresh the list\n──────────────────────────────────────────────────────────\nd Detach that display\n──────────────────────────────────────────────────────────\nD Power detach that display\n──────────────────────────────────────────────────────────\nC-g, enter, or escape Exit the list\n──────────────────────────────────────────────────────────\n\nThe following is an example of what displays could look like:\nxterm 80x42 jnweiger@/dev/ttyp4 0(m11) &rWx\nfacit 80x24 mlschroe@/dev/ttyhf nb 11(tcsh) rwx\nxterm 80x42 jnhollma@/dev/ttyp5 0(m11) &R.x\n(A) (B) (C) (D) (E) (F)(G) (H)(I)\n\nThe legend is as follows:\n\n(A) The terminal type known by screen for this display.\n\n(B) Displays geometry as width x height.\n\n(C) Username who is logged in at the display.\n\n(D) Device name of the display or the attached device\n\n(E) Display is in blocking or nonblocking mode. The available modes are \"nb\", \"NB\",\n\"Z<\", \"Z>\", and \"BL\".\n\n(F) Number of the window\n\n(G) Name/title of window\n\n(H) Whether the window is shared\n\n(I) Window permissions. Made up of three characters.\n┌─────────────────────────────────────────────────────────┐\n│ Window permissions indicators │\n├──────────────────┬──────────────────┬───────────────────┤\n│ 1st character │ 2nd character │ 3rd character │\n├─────┬────────────┼─────┬────────────┼─────┬─────────────┤\n│ - │no read │ - │no write │ - │no execute │\n├─────┼────────────┼─────┼────────────┼─────┼─────────────┤\n│ r │read │ w │write │ x │execute │\n├─────┼────────────┼─────┼────────────┼─────┼─────────────┤\n│ │ │ W │own wlock │ │ │\n├─────┴────────────┴─────┴────────────┴─────┴─────────────┤\n│ Indicators of permissions suppressed by a foreign wlock │\n├─────┬────────────┬─────┬────────────┬─────┬─────────────┤\n│ R │read only │ . │no write │ │ │\n└─────┴────────────┴─────┴────────────┴─────┴─────────────┘\n\ndisplays needs a region size of at least 10 characters wide and 5 characters high in\norder to display.\n\ndigraph [preset[unicode-value]]\n\nThis command prompts the user for a digraph sequence. The next two characters typed are\nlooked up in a builtin table and the resulting character is inserted in the input stream. For\nexample, if the user enters 'a\"', an a-umlaut will be inserted. If the first character en‐\ntered is a 0 (zero), screen will treat the following characters (up to three) as an octal\nnumber instead. The optional argument preset is treated as user input, thus one can create\nan umlaut key. For example the command \"bindkey ^K digraph '\"'\" enables the user to generate\nan a-umlaut by typing CTRL-K a. When a non-zero unicode-value is specified, a new digraph is\ncreated with the specified preset. The digraph is unset if a zero value is provided for the\nunicode-value.\n" }, { "name": "dumptermcap", "content": "Write the termcap entry for the virtual terminal optimized for the currently active window to\nthe file .termcap in the user's $HOME/.screen directory (or wherever screen stores its sock‐\nets. See the FILES section below). This termcap entry is identical to the value of the envi‐\nronment variable $TERMCAP that is set up by screen for each window. For terminfo based sys‐\ntems you will need to run a converter like captoinfo and then compile the entry with tic.\n" }, { "name": "dynamictitle [ on | off ]", "content": "Change behaviour for windows regarding if screen should change window title when seeing\nproper escape sequence. See also \"TITLES (naming windows)\" section.\n\necho [-n] message\n\nThe echo command may be used to annoy screen users with a 'message of the day'. Typically in‐\nstalled in a global /etc/screenrc. The option -n may be used to suppress the line feed. See\nalso sleep. Echo is also useful for online checking of environment variables.\n\nencoding enc [enc]\n\nTell screen how to interpret the input/output. The first argument sets the encoding of the\ncurrent window. Each window can emulate a different encoding. The optional second parameter\noverwrites the encoding of the connected terminal. It should never be needed as screen uses\nthe locale setting to detect the encoding. There is also a way to select a terminal encoding\ndepending on the terminal type by using the KJ termcap entry.\n\nSupported encodings are eucJP, SJIS, eucKR, eucCN, Big5, GBK, KOI8-R, KOI8-U, CP1251, UTF-8,\nISO8859-2, ISO8859-3, ISO8859-4, ISO8859-5, ISO8859-6, ISO8859-7, ISO8859-8, ISO8859-9,\nISO8859-10, ISO8859-15, jis.\n\nSee also defencoding, which changes the default setting of a new window.\n\nescape xy\n\nSet the command character to x and the character generating a literal command character (by\ntriggering the meta command) to y (similar to the -e option). Each argument is either a sin‐\ngle character, a two-character sequence of the form ^x (meaning C-x), a backslash followed by\nan octal number (specifying the ASCII code of the character), or a backslash followed by a\nsecond character, such as \\^ or \\\\. The default is ^Aa.\n\neval command1[command2 ...]\n\nParses and executes each argument as separate command.\n\nexec [[fdpat]newcommand [args ...]]\n\nRun a unix subprocess (specified by an executable path newcommand and its optional arguments)\nin the current window. The flow of data between newcommands stdin/stdout/stderr, the process\noriginally started in the window (let us call it \"application-process\") and screen itself\n(window) is controlled by the file descriptor pattern fdpat. This pattern is basically a\nthree character sequence representing stdin, stdout and stderr of newcommand. A dot (.) con‐\nnects the file descriptor to screen. An exclamation mark (!) causes the file descriptor to\nbe connected to the application-process. A colon (:) combines both. User input will go to\nnewcommand unless newcommand receives the application-process' output (fdpats first character\nis `!' or `:') or a pipe symbol (|) is added (as a fourth character) to the end of fdpat.\n\nInvoking `exec' without arguments shows name and arguments of the currently running sub‐\nprocess in this window. Only one subprocess a time can be running in each window.\n\nWhen a subprocess is running the `kill' command will affect it instead of the windows\nprocess.\n\nRefer to the postscript file `doc/fdpat.ps' for a confusing illustration of all 21 possible\ncombinations. Each drawing shows the digits 2,1,0 representing the three file descriptors of\nnewcommand. The box marked `W' is the usual pty that has the application-process on its slave\nside. The box marked `P' is the secondary pty that now has screen at its master side.\n\nAbbreviations: Whitespace between the word `exec' and fdpat and the command can be omitted.\nTrailing dots and a fdpat consisting only of dots can be omitted. A simple `|' is synonymous\nfor the pattern `!..|'; the word exec can be omitted here and can always be replaced by `!'.\n\nExamples:\n\nexec ... /bin/sh\n\nexec /bin/sh\n\n!/bin/sh\n\nCreates another shell in the same window, while the original shell is still\nrunning. Output of both shells is displayed and user input is sent to the new\n/bin/sh.\n\nexec !.. stty 19200\n\nexec ! stty 19200\n\n!!stty 19200\n\nSet the speed of the window's tty. If your stty command operates on stdout,\nthen add another `!'.\n\nexec !..| less\n\n|less\n\nThis adds a pager to the window output. The special character `|' is needed to\ngive the user control over the pager although it gets its input from the win‐\ndow's process. This works, because less listens on stderr (a behavior that\nscreen would not expect without the `|') when its stdin is not a tty. Less\nversions newer than 177 fail miserably here; good old pg still works.\n\n!:sed -n s/.*Error.*/\\007/p\n\nSends window output to both, the user and the sed command. The sed inserts an\nadditional bell character (oct. 007) to the window output seen by screen. This\nwill cause \"Bell in window x\" messages, whenever the string \"Error\" appears in\nthe window.\n" }, { "name": "fit", "content": "Change the window size to the size of the current region. This command is needed because\nscreen doesn't adapt the window size automatically if the window is displayed more than once.\n" }, { "name": "flow [ on | off | auto]", "content": "Sets the flow-control mode for this window. Without parameters it cycles the current win‐\ndow's flow-control setting from \"automatic\" to \"on\" to \"off\". See the discussion on FLOW-\nCONTROL later on in this document for full details and note, that this is subject to change\nin future releases. Default is set by `defflow'.\n" }, { "name": "focus [ next | prev | up | down | left | right | top | bottom ]", "content": "Move the input focus to the next region. This is done in a cyclic way so that the top left\nregion is selected after the bottom right one. If no option is given it defaults to `next'.\nThe next region to be selected is determined by how the regions are layered. Normally, the\nnext region in the same layer would be selected. However, if that next region contains one\nor more layers, the first region in the highest layer is selected first. If you are at the\nlast region of the current layer, `next' will move the focus to the next region in the lower\nlayer (if there is a lower layer). `Prev' cycles in the opposite order. See split for more\ninformation about layers.\n\nThe rest of the options (`up', `down', `left', `right', `top', and `bottom') are more indif‐\nferent to layers. The option `up' will move the focus upward to the region that is touching\nthe upper left corner of the current region. `Down' will move downward to the region that is\ntouching the lower left corner of the current region. The option `left' will move the focus\nleftward to the region that is touching the upper left corner of the current region, while\n`right' will move rightward to the region that is touching the upper right corner of the cur‐\nrent region. Moving left from a left most region or moving right from a right most region\nwill result in no action.\n\nThe option `top' will move the focus to the very first region in the upper list corner of the\nscreen, and `bottom' will move to the region in the bottom right corner of the screen. Moving\nup from a top most region or moving down from a bottom most region will result in no action.\n\nUseful bindings are (h, j, k, and l as in vi)\nbind h focus left\nbind j focus down\nbind k focus up\nbind l focus right\nbind t focus top\nbind b focus bottom\nNote that k is traditionally bound to the kill command.\n\nfocusminsize [ ( width|max| ) ( height|max| ) ]\n\nThis forces any currently selected region to be automatically resized at least a certain\nwidth and height. All other surrounding regions will be resized in order to accommodate.\nThis constraint follows every time the focus command is used. The resize command can be used\nto increase either dimension of a region, but never below what is set with focusminsize. The\nunderscore `' is a synonym for max. Setting a width and height of `0 0' (zero zero) will\nundo any constraints and allow for manual resizing. Without any parameters, the minimum\nwidth and height is shown.\n" }, { "name": "gr [ on | off ]", "content": "Turn GR charset switching on/off. Whenever screen sees an input character with the 8th bit\nset, it will use the charset stored in the GR slot and print the character with the 8th bit\nstripped. The default (see also defgr) is not to process GR switching because otherwise the\nISO88591 charset would not work.\n\ngroup [grouptitle]\n\nChange or show the group the current window belongs to. Windows can be moved around between\ndifferent groups by specifying the name of the destination group. Without specifying a group,\nthe title of the current group is displayed.\n\nhardcopy [-h] [file]\n\nWrites out the currently displayed image to the file file, or, if no filename is specified,\nto hardcopy.n in the default directory, where n is the number of the current window. This\neither appends or overwrites the file if it exists. See below. If the option -h is speci‐\nfied, dump also the contents of the scrollback buffer.\n" }, { "name": "hardcopy_append [ on | off ]", "content": "If set to \"on\", screen will append to the \"hardcopy.n\" files created by the command C-a h,\notherwise these files are overwritten each time. Default is `off'.\n\nhardcopydir directory\n\nDefines a directory where hardcopy files will be placed. If unset, hardcopys are dumped in\nscreen's current working directory.\n" }, { "name": "hardstatus [ on | off ]", "content": "" }, { "name": "hardstatus [ always ] firstline | lastline | message | ignore [ string ]", "content": "" }, { "name": "hardstatus string [ string ]", "content": "This command configures the use and emulation of the terminal's hardstatus line. The first\nform toggles whether screen will use the hardware status line to display messages. If the\nflag is set to `off', these messages are overlaid in reverse video mode at the display line.\nThe default setting is `on'.\n\nThe second form tells screen what to do if the terminal doesn't have a hardstatus line (i.e.\nthe termcap/terminfo capabilities \"hs\", \"ts\", \"fs\" and \"ds\" are not set). When first‐\nline/lastline is used, screen will reserve the first/last line of the display for the hard‐\nstatus. message uses screen's message mechanism and ignore tells screen never to display the\nhardstatus. If you prepend the word always to the type (e.g., alwayslastline), screen will\nuse the type even if the terminal supports a hardstatus.\n\nThe third form specifies the contents of the hardstatus line. '%h' is used as default\nstring, i.e., the stored hardstatus of the current window (settable via ESC]0;^G or\nESCESC\\) is displayed. You can customize this to any string you like including the\nescapes from the STRING ESCAPES chapter. If you leave out the argument string, the current\nstring is displayed.\n\nYou can mix the second and third form by providing the string as additional argument.\n\nheight [-w|-d] [lines [cols]]\n\nSet the display height to a specified number of lines. When no argument is given it toggles\nbetween 24 and 42 lines display. You can also specify a width if you want to change both val‐\nues. The -w option tells screen to leave the display size unchanged and just set the window\nsize, -d vice versa.\n\nhelp[class]\n\nNot really a online help, but displays a help screen showing you all the key bindings. The\nfirst pages list all the internal commands followed by their current bindings. Subsequent\npages will display the custom commands, one command per key. Press space when you're done\nreading each page, or return to exit early. All other characters are ignored. If the -c op‐\ntion is given, display all bound commands for the specified command class. See also DEFAULT\nKEY BINDINGS section.\n" }, { "name": "history", "content": "Usually users work with a shell that allows easy access to previous commands. For example\ncsh has the command !! to repeat the last command executed. Screen allows you to have a\nprimitive way of re-calling the command that started ...: You just type the first letter of\nthat command, then hit `C-a {' and screen tries to find a previous line that matches with the\n`prompt character' to the left of the cursor. This line is pasted into this window's input\nqueue. Thus you have a crude command history (made up by the visible window and its scroll‐\nback buffer).\n\nhstatus status\n\nChange the window's hardstatus line to the string status.\n\nidle [timeout[cmd-args]]\n\nSets a command that is run after the specified number of seconds inactivity is reached. This\ncommand will normally be the blanker command to create a screen blanker, but it can be any\nscreen command. If no command is specified, only the timeout is set. A timeout of zero (or\nthe special timeout off) disables the timer. If no arguments are given, the current settings\nare displayed.\n" }, { "name": "ignorecase [ on | off ]", "content": "Tell screen to ignore the case of characters in searches. Default is `off'. Without any op‐\ntions, the state of ignorecase is toggled.\n" }, { "name": "info", "content": "Uses the message line to display some information about the current window: the cursor posi‐\ntion in the form (column,row) starting with (1,1), the terminal width and height plus the\nsize of the scrollback buffer in lines, like in (80,24)+50, the current state of window\nXON/XOFF flow control is shown like this (See also section FLOW CONTROL):\n┌──────────┬──────────────────────────────────────────────────────────┐\n│ +flow │ automatic flow control, currently on. │\n├──────────┼──────────────────────────────────────────────────────────┤\n│ -flow │ automatic flow control, currently off. │\n├──────────┼──────────────────────────────────────────────────────────┤\n│ +(+)flow │ flow control enabled. Agrees with automatic control. │\n├──────────┼──────────────────────────────────────────────────────────┤\n│ -(+)flow │ flow control disabled. Disagrees with automatic control. │\n├──────────┼──────────────────────────────────────────────────────────┤\n│ +(-)flow │ flow control enabled. Disagrees with automatic control. │\n├──────────┼──────────────────────────────────────────────────────────┤\n│ -(-)flow │ flow control disabled. Agrees with automatic control. │\n└──────────┴──────────────────────────────────────────────────────────┘\n\nThe current line wrap setting (`+wrap' indicates enabled, `-wrap' not) is also shown. The\nflags `ins', `org', `app', `log', `mon' or `nored' are displayed when the window is in insert\nmode, origin mode, application-keypad mode, has output logging, activity monitoring or par‐\ntial redraw enabled.\n\nThe currently active character set (G0, G1, G2, or G3) and in square brackets the terminal\ncharacter sets that are currently designated as G0 through G3 is shown. If the window is in\nUTF-8 mode, the string UTF-8 is shown instead.\n\nAdditional modes depending on the type of the window are displayed at the end of the status\nline (See also chapter WINDOW TYPES).\n\nIf the state machine of the terminal emulator is in a non-default state, the info line is\nstarted with a string identifying the current state.\n\nFor system information use the time command.\n\ninsreg [key]\n\nNo longer exists, use paste instead.\n" }, { "name": "kill", "content": "Kill current window.\n\nIf there is an `exec' command running then it is killed. Otherwise the process (shell) run‐\nning in the window receives a HANGUP condition, the window structure is removed and screen\n(your display) switches to another window. When the last window is destroyed, screen exits.\nAfter a kill screen switches to the previously displayed window.\n\nNote: Emacs users should keep this command in mind, when killing a line. It is recommended\nnot to use C-a as the screen escape key or to rebind kill to C-a K.\n" }, { "name": "lastmsg", "content": "Redisplay the last contents of the message/status line. Useful if you're typing when a mes‐\nsage appears, because the message goes away when you press a key (unless your terminal has a\nhardware status line). Refer to the commands msgwait and msgminwait for fine tuning.\n\nlayout new [title]\n\nCreate a new layout. The screen will change to one whole region and be switched to the blank\nwindow. From here, you build the regions and the windows they show as you desire. The new\nlayout will be numbered with the smallest available integer, starting with zero. You can op‐\ntionally give a title to your new layout. Otherwise, it will have a default title of layout.\nYou can always change the title later by using the command layout title.\n\nlayout remove [n|title]\n\nRemove, or in other words, delete the specified layout. Either the number or the title can be\nspecified. Without either specification, screen will remove the current layout.\n\nRemoving a layout does not affect your set windows or regions.\n" }, { "name": "layout next", "content": "Switch to the next layout available\n" }, { "name": "layout prev", "content": "Switch to the previous layout available\n\nlayout select [n|title]\n\nSelect the desired layout. Either the number or the title can be specified. Without either\nspecification, screen will prompt and ask which screen is desired. To see which layouts are\navailable, use the layout show command.\n" }, { "name": "layout show", "content": "List on the message line the number(s) and title(s) of the available layout(s). The current\nlayout is flagged.\n\nlayout title [title]\n\nChange or display the title of the current layout. A string given will be used to name the\nlayout. Without any options, the current title and number is displayed on the message line.\n\nlayout number [n]\n\nChange or display the number of the current layout. An integer given will be used to number\nthe layout. Without any options, the current number and title is displayed on the message\nline.\n\nlayout attach [title|:last]\n\nChange or display which layout to reattach back to. The default is :last, which tells screen\nto reattach back to the last used layout just before detachment. By supplying a title, You\ncan instruct screen to reattach to a particular layout regardless which one was used at the\ntime of detachment. Without any options, the layout to reattach to will be shown in the mes‐\nsage line.\n\nlayout save [n|title]\n\nRemember the current arrangement of regions. When used, screen will remember the arrangement\nof vertically and horizontally split regions. This arrangement is restored when a screen ses‐\nsion is reattached or switched back from a different layout. If the session ends or the\nscreen process dies, the layout arrangements are lost. The layout dump command should help in\nthis situation. If a number or title is supplied, screen will remember the arrangement of\nthat particular layout. Without any options, screen will remember the current layout.\n\nSaving your regions can be done automatically by using the layout autosave command.\n" }, { "name": "layout autosave [ on | off]", "content": "Change or display the status of automatically saving layouts. The default is on, meaning when\nscreen is detached or changed to a different layout, the arrangement of regions and windows\nwill be remembered at the time of change and restored upon return. If autosave is set to\noff, that arrangement will only be restored to either to the last manual save, using layout\nsave, or to when the layout was first created, to a single region with a single window. With‐\nout either an on or off, the current status is displayed on the message line.\n\nlayout dump [filename]\n\nWrite to a file the order of splits made in the current layout. This is useful to recreate\nthe order of your regions used in your current layout. Only the current layout is recorded.\nWhile the order of the regions are recorded, the sizes of those regions and which windows\ncorrespond to which regions are not. If no filename is specified, the default is layout-dump,\nsaved in the directory that the screen process was started in. If the file already exists,\nlayout dump will append to that file. As an example:\n\nC-a : layout dump /home/user/.screenrc\n\nwill save or append the layout to the user's .screenrc file.\n" }, { "name": "license", "content": "Display the disclaimer page. This is done whenever screen is started without options, which\nshould be often enough. See also the startupmessage command.\n" }, { "name": "lockscreen", "content": "Lock this display. Call a screenlock program. Screen does not accept any command keys until\nthis program terminates. Meanwhile processes in the windows may continue, as the windows are\nin the `detached' state. The screenlock program may be changed through the environment vari‐\nable $LOCKPRG (which must be set in the shell from which screen is started) and is executed\nwith the user's uid and gid.\n\nWarning: When you leave other shells unlocked and you have no password set on screen, the\nlock is void: One could easily re-attach from an unlocked shell. This feature should rather\nbe called `lockterminal'.\n" }, { "name": "log [ on | off ]", "content": "Start/stop writing output of the current window to a file screenlog.n in the window's default\ndirectory, where n is the number of the current window. This filename can be changed with the\n`logfile' command. If no parameter is given, the state of logging is toggled. The session log\nis appended to the previous contents of the file if it already exists. The current contents\nand the contents of the scrollback history are not included in the session log. Default is\n`off'.\n\nlogfile filename\n\nlogfile flush secs\n\nDefines the name the log files will get. The default is screenlog.%n. The second form changes\nthe number of seconds screen will wait before flushing the logfile buffer to the file-system.\nThe default value is 10 seconds.\n" }, { "name": "login [ on | off ]", "content": "Adds or removes the entry in the utmp database file for the current window. This controls if\nthe window is `logged in'. When no parameter is given, the login state of the window is tog‐\ngled. Additionally to that toggle, it is convenient having a `log in' and a `log out' key.\nE.g. `bind I login on' and `bind O login off' will map these keys to be C-a I and C-a O. The\ndefault setting (in config.h.in) should be on for a screen that runs under suid-root. Use\nthe deflogin command to change the default login state for new windows. Both commands are\nonly present when screen has been compiled with utmp support.\n\nlogtstamp [on|off]\n\nlogtstamp after [secs]\n" }, { "name": "logtstamp string", "content": "[string]\n\nThis command controls logfile time-stamp mechanism of screen. If time-stamps are turned on,\nscreen adds a string containing the current time to the logfile after two minutes of inactiv‐\nity. When output continues and more than another two minutes have passed, a second time-\nstamp is added to document the restart of the output. You can change this timeout with the\nsecond form of the command. The third form is used for customizing the time-stamp string (`--\n%n:%t -- time-stamp -- %M/%d/%y %c:%s --\\n' by default).\n" }, { "name": "mapdefault", "content": "Tell screen that the next input character should only be looked up in the default bindkey ta‐\nble. See also bindkey.\n" }, { "name": "mapnotnext", "content": "Like mapdefault, but don't even look in the default bindkey table.\n\nmaptimeout [timeout]\n\nSet the inter-character timer for input sequence detection to a timeout of timeout ms. The\ndefault timeout is 300ms. Maptimeout with no arguments shows the current setting. See also\nbindkey.\n\nmarkkeys string\n\nThis is a method of changing the keymap used for copy/history mode. The string is made up of\noldchar=newchar pairs which are separated by `:'. Example: The string B=^B:F=^F will change\nthe keys `C-b' and `C-f' to the vi style binding (scroll up/down fill page). This happens to\nbe the default binding for `B' and `F'. The command markkeys h=^B:l=^F:$=^E would set the\nmode for an emacs-style binding. If your terminal sends characters, that cause you to abort\ncopy mode, then this command may help by binding these characters to do nothing. The no-op\ncharacter is `@' and is used like this: markkeys @=L=H if you do not want to use the `H' or\n`L' commands any longer. As shown in this example, multiple keys can be assigned to one\nfunction in a single statement.\n\nmaxwin num\n\nSet the maximum window number screen will create. Doesn't affect already existing windows.\nThe number can be increased only when there are no existing windows.\n" }, { "name": "meta", "content": "Insert the command character (C-a) in the current window's input stream.\n" }, { "name": "monitor [ on | off ]", "content": "Toggles activity monitoring of windows. When monitoring is turned on and an affected window\nis switched into the background, you will receive the activity notification message in the\nstatus line at the first sign of output and the window will also be marked with an `@' in the\nwindow-status display. Monitoring is initially off for all windows.\n" }, { "name": "mousetrack [ on | off ]", "content": "This command determines whether screen will watch for mouse clicks. When this command is en‐\nabled, regions that have been split in various ways can be selected by pointing to them with\na mouse and left-clicking them. Without specifying on or off, the current state is displayed.\nThe default state is determined by the defmousetrack command.\n\nmsgminwait sec\n\nDefines the time screen delays a new message when one message is currently displayed. The\ndefault is 1 second.\n\nmsgwait sec\n\nDefines the time a message is displayed if screen is not disturbed by other activity. The de‐\nfault is 5 seconds.\n" }, { "name": "multiuser [ on | off ]", "content": "Switch between singleuser and multiuser mode. Standard screen operation is singleuser. In\nmultiuser mode the commands `acladd', `aclchg', `aclgrp' and `acldel' can be used to enable\n(and disable) other users accessing this screen session.\n" }, { "name": "nethack [ on | off ]", "content": "Changes the kind of error messages used by screen. When you are familiar with the game\nnethack, you may enjoy the nethack-style messages which will often blur the facts a little,\nbut are much funnier to read. Anyway, standard messages often tend to be unclear as well.\nThis option is only available if screen was compiled with the NETHACK flag defined. The de‐\nfault setting is then determined by the presence of the environment variable $NETHACKOPTIONS\nand the file ~/.nethackrc - if either one is present, the default is on.\n" }, { "name": "next", "content": "Switch to the next window. This command can be used repeatedly to cycle through the list of\nwindows.\n" }, { "name": "nonblock [ on | off | numsecs ]", "content": "Tell screen how to deal with user interfaces (displays) that cease to accept output. This can\nhappen if a user presses ^S or a TCP/modem connection gets cut but no hangup is received. If\nnonblock is off (this is the default) screen waits until the display restarts to accept the\noutput. If nonblock is on, screen waits until the timeout is reached (on is treated as 1s).\nIf the display still doesn't receive characters, screen will consider it blocked and stop\nsending characters to it. If at some time it restarts to accept characters, screen will un‐\nblock the display and redisplay the updated window contents.\n\nnumber [[+|-]n]\n\nChange the current window's number. If the given number n is already used by another window,\nboth windows exchange their numbers. If no argument is specified, the current window number\n(and title) is shown. Using `+' or `-' will change the window's number by the relative amount\nspecified.\n\nobuflimit [limit]\n\nIf the output buffer contains more bytes than the specified limit, no more data will be read\nfrom the windows. The default value is 256. If you have a fast display (like xterm), you can\nset it to some higher value. If no argument is specified, the current setting is displayed.\n" }, { "name": "only", "content": "Kill all regions but the current one.\n" }, { "name": "other", "content": "Switch to the window displayed previously. If this window does no longer exist, other has the\nsame effect as next.\n" }, { "name": "partial [ on | off ]", "content": "Defines whether the display should be refreshed (as with redisplay) after switching to the\ncurrent window. This command only affects the current window. To immediately affect all win‐\ndows use the allpartial command. Default is `off', of course. This default is fixed, as\nthere is currently no defpartial command.\n\npassword [cryptedpw]\n\nPresent a crypted password in your .screenrc file and screen will ask for it, whenever some‐\none attempts to resume a detached. This is useful if you have privileged programs running\nunder screen and you want to protect your session from reattach attempts by another user mas‐\nquerading as your uid (i.e. any superuser.) If no crypted password is specified, screen\nprompts twice for typing a password and places its encryption in the paste buffer. Default\nis `none', this disables password checking.\n\npaste [registers [destreg]]\n\nWrite the (concatenated) contents of the specified registers to the stdin queue of the cur‐\nrent window. The register '.' is treated as the paste buffer. If no parameter is given the\nuser is prompted for a single register to paste. The paste buffer can be filled with the\ncopy, history and readbuf commands. Other registers can be filled with the register, readreg\nand paste commands. If paste is called with a second argument, the contents of the specified\nregisters is pasted into the named destination register rather than the window. If '.' is\nused as the second argument, the displays paste buffer is the destination. Note, that paste\nuses a wide variety of resources: Whenever a second argument is specified no current window\nis needed. When the source specification only contains registers (not the paste buffer) then\nthere need not be a current display (terminal attached), as the registers are a global re‐\nsource. The paste buffer exists once for every user.\n" }, { "name": "pastefont [ on | off ]", "content": "Tell screen to include font information in the paste buffer. The default is not to do so.\nThis command is especially useful for multi character fonts like kanji.\n" }, { "name": "pow_break", "content": "Reopen the window's terminal line and send a break condition. See `break'.\n" }, { "name": "pow_detach", "content": "Power detach. Mainly the same as detach, but also sends a HANGUP signal to the parent\nprocess of screen. CAUTION: This will result in a logout, when screen was started from your\nlogin-shell.\n\npowdetachmsg [message]\n\nThe message specified here is output whenever a `Power detach' was performed. It may be used\nas a replacement for a logout message or to reset baud rate, etc. Without parameter, the\ncurrent message is shown.\n" }, { "name": "prev", "content": "Switch to the window with the next lower number. This command can be used repeatedly to cy‐\ncle through the list of windows.\n\nprintcmd [cmd]\n\nIf cmd is not an empty string, screen will not use the terminal capabilities po/pf if it de‐\ntects an ansi print sequence ESC [ 5 i, but pipe the output into cmd. This should normally\nbe a command like lpr or printcmd without a command displays the current setting. The ansi\nsequence ESC [ 4 i ends printing and closes the pipe.\n\nWarning: Be careful with this command! If other user have write access to your terminal, they\nwill be able to fire off print commands.\n\nprocess [key]\n\nStuff the contents of the specified register into screen's input queue. If no argument is\ngiven you are prompted for a register name. The text is parsed as if it had been typed in\nfrom the user's keyboard. This command can be used to bind multiple actions to a single key.\n" }, { "name": "quit", "content": "Kill all windows and terminate screen. Note that on VT100-style terminals the keys C-4 and\nC-\\ are identical. This makes the default bindings dangerous: Be careful not to type C-a C-4\nwhen selecting window no. 4. Use the empty bind command (as in bind '^\\') to remove a key\nbinding.\n\nreadbuf [encoding] [filename]\n\nReads the contents of the specified file into the paste buffer. You can tell screen the en‐\ncoding of the file via the -e option. If no file is specified, the screen-exchange filename\nis used. See also bufferfile command.\n\nreadreg [encoding] [register [filename]]\n\nDoes one of two things, dependent on number of arguments: with zero or one arguments it du‐\nplicates the paste buffer contents into the register specified or entered at the prompt. With\ntwo arguments it reads the contents of the named file into the register, just as readbuf\nreads the screen-exchange file into the paste buffer. You can tell screen the encoding of\nthe file via the -e option. The following example will paste the system's password file into\nthe screen window (using register p, where a copy remains):\n\nC-a : readreg p /etc/passwd\nC-a : paste p\n" }, { "name": "redisplay", "content": "Redisplay the current window. Needed to get a full redisplay when in partial redraw mode.\n\nregister [-eencoding]key-string\n\nSave the specified string to the register key. The encoding of the string can be specified\nvia the -e option. See also the paste command.\n" }, { "name": "remove", "content": "Kill the current region. This is a no-op if there is only one region.\n" }, { "name": "removebuf", "content": "Unlinks the screen-exchange file used by the commands writebuf and readbuf.\n" }, { "name": "rendition [ bell | monitor | silence | so ] attr [ color ]", "content": "Change the way screen renders the titles of windows that have monitor or bell flags set in\ncaption or hardstatus or windowlist. See the STRING ESCAPES chapter for the syntax of the\nmodifiers. The default for monitor is currently =b (bold, active colors), for bell =ub\n(underline, bold and active colors), and =u for silence.\n" }, { "name": "reset", "content": "Reset the virtual terminal to its power-on values. Useful when strange settings (like scroll\nregions or graphics character set) are left over from an application.\n\nresize [-h|-v|-b|-l|-p] [[+|-] n[%] |=|max|min||0]\n\nResize the current region. The space will be removed from or added to the surrounding regions\ndepending on the order of the splits. The available options for resizing are `-h'(horizon‐\ntal), `-v'(vertical), `-b'(both), `-l'(local to layer), and `-p'(perpendicular). Horizontal\nresizes will add or remove width to a region, vertical will add or remove height, and both\nwill add or remove size from both dimensions. Local and perpendicular are similar to horizon‐\ntal and vertical, but they take in account of how a region was split. If a region's last\nsplit was horizontal, a local resize will work like a vertical resize. If a region's last\nsplit was vertical, a local resize will work like a horizontal resize. Perpendicular resizes\nwork in opposite of local resizes. If no option is specified, local is the default.\n\nThe amount of lines to add or remove can be expressed a couple of different ways. By specify‐\ning a number n by itself will resize the region by that absolute amount. You can specify a\nrelative amount by prefixing a plus `+' or minus `-' to the amount, such as adding +n lines\nor removing -n lines. Resizing can also be expressed as an absolute or relative percentage by\npostfixing a percent sign `%'. Using zero `0' is a synonym for `min' and using an underscore\n`' is a synonym for `max'.\n\nSome examples are:\n\nresize +N\nincrease current region by N\n\nresize -N\ndecrease current region by N\n\nresize N\nset current region to N\n\nresize 20%\nset current region to 20% of original size\n\nresize +20%\nincrease current region by 20%\n\nresize -b =\nmake all windows equally\n\nresize max\nmaximize current region\n\nresize min\nminimize current region\n\nWithout any arguments, screen will prompt for how you would like to resize the current re‐\ngion.\n\nSee focusminsize if you want to restrict the minimum size a region can have.\n\nscreen [-opts] [n] [cmd [args]|//group]\n\nEstablish a new window. The flow-control options (-f, -fn and -fa), title (a.k.a.) option\n(-t), login options (-l and -ln) , terminal type option (-T ), the all-capability-flag\n(-a) and scrollback option (-h ) may be specified with each command. The option (-M)\nturns monitoring on for this window. The option (-L) turns output logging on for this win‐\ndow. If an optional number n in the range 0..MAXWIN-1 is given, the window number n is as‐\nsigned to the newly created window (or, if this number is already in-use, the next available\nnumber). If a command is specified after screen, this command (with the given arguments) is\nstarted in the window; otherwise, a shell is created. If //group is supplied, a container-\ntype window is created in which other windows may be created inside it.\n\nThus, if your .screenrc contains the lines\n\n# example for .screenrc:\nscreen 1\nscreen -fn -t foobar -L 2 telnet foobar\n\nscreen creates a shell window (in window #1) and a window with a TELNET connection to the ma‐\nchine foobar (with no flow-control using the title foobar in window #2) and will write a log‐\nfile (screenlog.2) of the telnet session. Note, that unlike previous versions of screen no\nadditional default window is created when screen commands are included in your .screenrc\nfile. When the initialization is completed, screen switches to the last window specified in\nyour .screenrc file or, if none, opens a default window #0.\n\nScreen has built in some functionality of cu and telnet. See also chapter WINDOW TYPES.\n\nscrollback num\n\nSet the size of the scrollback buffer for the current windows to num lines. The default\nscrollback is 100 lines. See also the defscrollback command and use info to view the current\nsetting. To access and use the contents in the scrollback buffer, use the copy command.\n\nselect [WindowID]\n\nSwitch to the window identified by WindowID. This can be a prefix of a window title (al‐\nphanumeric window name) or a window number. The parameter is optional and if omitted, you\nget prompted for an identifier. When a new window is established, the first available number\nis assigned to this window. Thus, the first window can be activated by select 0. The number\nof windows is set by the MAXWIN configuration parameter (which defaults to 100), but it can\nbe changed by using `maxwin' command. There are two special WindowIDs, - selects the inter‐\nnal blank window and . selects the current window. The latter is useful if used with screen's\n-X option.\n\nsessionname [name]\n\nRename the current session. Note, that for screen -list the name shows up with the process-id\nprepended. If the argument name is omitted, the name of this session is displayed. Caution:\nThe $STY environment variables will still reflect the old name in pre-existing shells. This\nmay result in confusion. Use of this command is generally discouraged. Use the -S command-\nline option if you want to name a new session. The default is constructed from the tty and\nhost names.\n\nsetenv [var [string]]\n\nSet the environment variable var to value string. If only var is specified, the user will be\nprompted to enter a value. If no parameters are specified, the user will be prompted for\nboth variable and value. The environment is inherited by all subsequently forked shells.\n" }, { "name": "setsid [ on | off ]", "content": "Normally screen uses different sessions and process groups for the windows. If setsid is\nturned off, this is not done anymore and all windows will be in the same process group as the\nscreen backend process. This also breaks job-control, so be careful. The default is on, of\ncourse. This command is probably useful only in rare circumstances.\n\nshell command\n\nSet the command to be used to create a new shell. This overrides the value of the environ‐\nment variable $SHELL. This is useful if you'd like to run a tty-enhancer which is expecting\nto execute the program specified in $SHELL. If the command begins with a '-' character, the\nshell will be started as a login-shell. Typical shells do only minimal initialization when\nnot started as a login-shell. E.g. Bash will not read your ~/.bashprofile unless it is a\nlogin-shell.\n\nshelltitle title\n\nSet the title for all shells created during startup or by the C-A C-c command. For details\nabout what a title is, see the discussion entitled TITLES (naming windows).\n" }, { "name": "silence [ on | off | sec ]", "content": "Toggles silence monitoring of windows. When silence is turned on and an affected window is\nswitched into the background, you will receive the silence notification message in the status\nline after a specified period of inactivity (silence). The default timeout can be changed\nwith the `silencewait' command or by specifying a number of seconds instead of `on' or `off'.\nSilence is initially off for all windows.\n\nsilencewait sec\n\nDefine the time that all windows monitored for silence should wait before displaying a mes‐\nsage. Default 30 seconds.\n\nsleep num\n\nThis command will pause the execution of a .screenrc file for num seconds. Keyboard activity\nwill end the sleep. It may be used to give users a chance to read the messages output by\necho.\n\nslowpaste msec\n\nDefine the speed at which text is inserted into the current window by the paste (\"C-a ]\")\ncommand. If the slowpaste value is nonzero text is written character by character. screen\nwill make a pause of msec milliseconds after each single character write to allow the appli‐\ncation to process its input. Only use slowpaste if your underlying system exposes flow con‐\ntrol problems while pasting large amounts of text.\n" }, { "name": "sort", "content": "Sort the windows in alphabetical order of the window tiles.\n\nsource file\n\nRead and execute commands from file file. Source commands may be nested to a maximum recur‐\nsion level of ten. If file is not an absolute path and screen is already processing a source\ncommand, the parent directory of the running source command file is used to search for the\nnew command file before screen's current directory.\n\nNote that termcap/terminfo/termcapinfo commands only work at startup and reattach time, so\nthey must be reached via the default screenrc files to have an effect.\n\nsorendition [attr[color]]\n\nThis command is deprecated. See \"rendition so\" instead.\n\nsplit[-v]\n\nSplit the current region into two new ones. All regions on the display are resized to make\nroom for the new region. The blank window is displayed in the new region. The default is to\ncreate a horizontal split, putting the new regions on the top and bottom of each other. Using\n`-v' will create a vertical split, causing the new regions to appear side by side of each\nother. Use the remove or the only command to delete regions. Use focus to toggle between\nregions.\n\nWhen a region is split opposite of how it was previously split (that is, vertical then hori‐\nzontal or horizontal then vertical), a new layer is created. The layer is used to group to‐\ngether the regions that are split the same. Normally, as a user, you should not see nor have\nto worry about layers, but they will affect how some commands (focus and resize) behave.\n\nWith this current implementation of screen, scrolling data will appear much slower in a ver‐\ntically split region than one that is not. This should be taken into consideration if you\nneed to use system commands such as cat or tail -f.\n" }, { "name": "startup_message [ on | off ]", "content": "Select whether you want to see the copyright notice during startup. Default is `on', as you\nprobably noticed.\n" }, { "name": "status [ top | up | down | bottom ] [ left | right ]", "content": "The status window by default is in bottom-left corner. This command can move status messages\nto any corner of the screen. top is the same as up, down is the same as bottom.\n\nstuff [string]\n\nStuff the string string in the input buffer of the current window. This is like the paste\ncommand but with much less overhead. Without a parameter, screen will prompt for a string to\nstuff. You cannot paste large buffers with the stuff command. It is most useful for key\nbindings. See also bindkey.\n\nsu [username [password [password2]]]\n\nSubstitute the user of a display. The command prompts for all parameters that are omitted. If\npasswords are specified as parameters, they have to be specified un-crypted. The first pass‐\nword is matched against the systems passwd database, the second password is matched against\nthe screen password as set with the commands acladd or password. Su may be useful for the\nscreen administrator to test multiuser setups. When the identification fails, the user has\naccess to the commands available for user nobody. These are detach, license, version, help\nand displays.\n" }, { "name": "suspend", "content": "Suspend screen. The windows are in the `detached' state, while screen is suspended. This\nfeature relies on the shell being able to do job control.\n\nterm term\n\nIn each window's environment screen opens, the $TERM variable is set to screen by default.\nBut when no description for screen is installed in the local termcap or terminfo data base,\nyou set $TERM to - say - vt100. This won't do much harm, as screen is VT100/ANSI compatible.\nThe use of the term command is discouraged for non-default purpose. That is, one may want to\nspecify special $TERM settings (e.g. vt100) for the next screen rlogin othermachine command.\nUse the command screen -T vt100 rlogin othermachine rather than setting and resetting the de‐\nfault.\n\ntermcap term terminal-tweaks[window-tweaks]\n\nterminfo term terminal-tweaks[window-tweaks]\n\ntermcapinfo term terminal-tweaks[window-tweaks]\n\nUse this command to modify your terminal's termcap entry without going through all the has‐\nsles involved in creating a custom termcap entry. Plus, you can optionally customize the\ntermcap generated for the windows. You have to place these commands in one of the screenrc\nstartup files, as they are meaningless once the terminal emulator is booted.\n\nIf your system uses the terminfo database rather than termcap, screen will understand the\n`terminfo' command, which has the same effects as the `termcap' command. Two separate com‐\nmands are provided, as there are subtle syntactic differences, e.g. when parameter interpola‐\ntion (using `%') is required. Note that termcap names of the capabilities have to be used\nwith the `terminfo' command.\n\nIn many cases, where the arguments are valid in both terminfo and termcap syntax, you can use\nthe command `termcapinfo', which is just a shorthand for a pair of `termcap' and `terminfo'\ncommands with identical arguments.\n\nThe first argument specifies which terminal(s) should be affected by this definition. You\ncan specify multiple terminal names by separating them with `|'s. Use `*' to match all ter‐\nminals and `vt*' to match all terminals that begin with vt.\n\nEach tweak argument contains one or more termcap defines (separated by `:'s) to be inserted\nat the start of the appropriate termcap entry, enhancing it or overriding existing values.\nThe first tweak modifies your terminal's termcap, and contains definitions that your terminal\nuses to perform certain functions. Specify a null string to leave this unchanged (e.g. '').\nThe second (optional) tweak modifies all the window termcaps, and should contain definitions\nthat screen understands (see the VIRTUAL TERMINAL section).\n\nSome examples:\n\ntermcap xterm* LP:hs@\n\nInforms screen that all terminals that begin with `xterm' have firm auto-margins that allow\nthe last position on the screen to be updated (LP), but they don't really have a status line\n(no 'hs' - append `@' to turn entries off). Note that we assume `LP' for all terminal names\nthat start with vt, but only if you don't specify a termcap command for that terminal.\ntermcap vt* LP\n\ntermcap vt102|vt220 Z0=\\E[?3h:Z1=\\E[?3l\n\nSpecifies the firm-margined `LP' capability for all terminals that begin with `vt', and the\nsecond line will also add the escape-sequences to switch into (Z0) and back out of (Z1)\n132-character-per-line mode if this is a VT102 or VT220. (You must specify Z0 and Z1 in your\ntermcap to use the width-changing commands.)\n\ntermcap vt100 \"\" l0=PF1:l1=PF2:l2=PF3:l3=PF4\n\nThis leaves your vt100 termcap alone and adds the function key labels to each window's term‐\ncap entry.\n\ntermcap h19|z19 am@:im=\\E@:ei=\\EO dc=\\E[P\n\nTakes a h19 or z19 termcap and turns off auto-margins (am@) and enables the insert mode (im)\nand end-insert (ei) capabilities (the `@' in the `im' string is after the `=', so it is part\nof the string). Having the `im' and `ei' definitions put into your terminal's termcap will\ncause screen to automatically advertise the character-insert capability in each window's\ntermcap. Each window will also get the delete-character capability (dc) added to its term‐\ncap, which screen will translate into a line-update for the terminal (we're pretending it\ndoesn't support character deletion).\n\nIf you would like to fully specify each window's termcap entry, you should instead set the\n$SCREENCAP variable prior to running screen. See the discussion on the VIRTUAL TERMINAL in\nthis manual, and the termcap(5) man page for more information on termcap definitions.\n\ntime [string]\n\nUses the message line to display the time of day, the host name, and the load averages over\n1, 5, and 15 minutes (if this is available on your system). For window specific information,\nuse info.\n\nIf a string is specified, it changes the format of the time report like it is described in\nthe STRING ESCAPES chapter. Screen uses a default of \"%c:%s %M %d %H%? %l%?\".\n\ntitle [windowtitle]\n\nSet the name of the current window to windowtitle. If no name is specified, screen prompts\nfor one. This command was known as `aka' in previous releases.\n" }, { "name": "unbindall", "content": "Unbind all the bindings. This can be useful when screen is used solely for its detaching\nabilities, such as when letting a console application run as a daemon. If, for some reason,\nit is necessary to bind commands after this, use 'screen -X'.\n\nunsetenv var\n\nUnset an environment variable.\n" }, { "name": "utf8 [ on | off [ on | off ]]", "content": "Change the encoding used in the current window. If utf8 is enabled, the strings sent to the\nwindow will be UTF-8 encoded and vice versa. Omitting the parameter toggles the setting. If a\nsecond parameter is given, the display's encoding is also changed (this should rather be done\nwith screen's -U option). See also defutf8, which changes the default setting of a new win‐\ndow.\n" }, { "name": "vbell [ on | off ]", "content": "Sets the visual bell setting for this window. Omitting the parameter toggles the setting. If\nvbell is switched on, but your terminal does not support a visual bell, a `vbell-message' is\ndisplayed in the status line when the bell character (^G) is received. Visual bell support\nof a terminal is defined by the termcap variable `vb' (terminfo: 'flash').\n\nPer default, vbell is off, thus the audible bell is used. See also `bellmsg'.\n\nvbellmsg [message]\n\nSets the visual bell message. message is printed to the status line if the window receives a\nbell character (^G), vbell is set to on, but the terminal does not support a visual bell.\nThe default message is Wuff, Wuff!!. Without a parameter, the current message is shown.\n\nvbellwait sec\n\nDefine a delay in seconds after each display of screen's visual bell message. The default is\n1 second.\n" }, { "name": "verbose [ on | off ]", "content": "If verbose is switched on, the command name is echoed, whenever a window is created (or res‐\nurrected from zombie state). Default is off. Without a parameter, the current setting is\nshown.\n" }, { "name": "version", "content": "Print the current version and the compile date in the status line.\n\nwall message\n\nWrite a message to all displays. The message will appear in the terminal's status line.\n\nwidth [-w|-d] [cols [lines]]\n\nToggle the window width between 80 and 132 columns or set it to cols columns if an argument\nis specified. This requires a capable terminal and the termcap entries Z0 and Z1. See the\ntermcap command for more information. You can also specify a new height if you want to change\nboth values. The -w option tells screen to leave the display size unchanged and just set the\nwindow size, -d vice versa.\n" }, { "name": "windowlist [ -b ] [ -m ] [ -g ]", "content": "windowlist string [string]\n\nwindowlist title [title]\n\nDisplay all windows in a table for visual window selection. If screen was in a window group,\nscreen will back out of the group and then display the windows in that group. If the -b op‐\ntion is given, screen will switch to the blank window before presenting the list, so that the\ncurrent window is also selectable. The -m option changes the order of the windows, instead\nof sorting by window numbers screen uses its internal most-recently-used list. The -g option\nwill show the windows inside any groups in that level and downwards.\n\nThe following keys are used to navigate in windowlist:\n\n─────────────────────────────────────────────────────────────────────\nk, C-p, or up Move up one line.\n─────────────────────────────────────────────────────────────────────\nj, C-n, or down Move down one line.\n─────────────────────────────────────────────────────────────────────\nC-g or escape Exit windowlist.\n─────────────────────────────────────────────────────────────────────\nC-a or home Move to the first line.\n─────────────────────────────────────────────────────────────────────\nC-e or end Move to the last line.\n─────────────────────────────────────────────────────────────────────\nC-u or C-d Move one half page up or down.\n─────────────────────────────────────────────────────────────────────\nC-b or C-f Move one full page up or down.\n─────────────────────────────────────────────────────────────────────\n0..9 Using the number keys, move to the selected line.\n─────────────────────────────────────────────────────────────────────\nmouseclick Move to the selected line. Available when mouse‐\ntrack is set to on\n─────────────────────────────────────────────────────────────────────\n/ Search.\n─────────────────────────────────────────────────────────────────────\nn Repeat search in the forward direction.\n─────────────────────────────────────────────────────────────────────\nN Repeat search in the backward direction.\n─────────────────────────────────────────────────────────────────────\nm Toggle MRU.\n─────────────────────────────────────────────────────────────────────\ng Toggle group nesting.\n─────────────────────────────────────────────────────────────────────\na All window view.\n─────────────────────────────────────────────────────────────────────\nC-h or backspace Back out the group.\n─────────────────────────────────────────────────────────────────────\n, Switch numbers with the previous window.\n─────────────────────────────────────────────────────────────────────\n. Switch numbers with the next window.\n─────────────────────────────────────────────────────────────────────\nK Kill that window.\n─────────────────────────────────────────────────────────────────────\nspace or enter Select that window.\n─────────────────────────────────────────────────────────────────────\n\nThe table format can be changed with the string and title option, the title is displayed as\ntable heading, while the lines are made by using the string setting. The default setting is\nNum Name%=Flags for the title and %3n %t%=%f for the lines. See the STRING ESCAPES chapter\nfor more codes (e.g. color settings).\n\nWindowlist needs a region size of at least 10 characters wide and 6 characters high in order\nto display.\n" }, { "name": "windows [ string ]", "content": "Uses the message line to display a list of all the windows. Each window is listed by number\nwith the name of process that has been started in the window (or its title); the current win‐\ndow is marked with a `*'; the previous window is marked with a `-'; all the windows that are\nlogged in are marked with a `$'; a background window that has received a bell is marked with\na `!'; a background window that is being monitored and has had activity occur is marked with\nan `@'; a window which has output logging turned on is marked with `(L)'; windows occupied by\nother users are marked with `&'; windows in the zombie state are marked with `Z'. If this\nlist is too long to fit on the terminal's status line only the portion around the current\nwindow is displayed. The optional string parameter follows the STRING ESCAPES format. If\nstring parameter is passed, the output size is unlimited. The default command without any\nparameter is limited to a size of 1024 bytes.\n" }, { "name": "wrap [ on | off ]", "content": "Sets the line-wrap setting for the current window. When line-wrap is on, the second consecu‐\ntive printable character output at the last column of a line will wrap to the start of the\nfollowing line. As an added feature, backspace (^H) will also wrap through the left margin\nto the previous line. Default is `on'. Without any options, the state of wrap is toggled.\n\nwritebuf [-e encoding] [filename]\n\nWrites the contents of the paste buffer to the specified file, or the public accessible\nscreen-exchange file if no filename is given. This is thought of as a primitive means of com‐\nmunication between screen users on the same host. If an encoding is specified the paste\nbuffer is recoded on the fly to match the encoding. The filename can be set with the buffer‐\nfile command and defaults to /tmp/screen-exchange.\n" }, { "name": "writelock [ on | off | auto]", "content": "In addition to access control lists, not all users may be able to write to the same window at\nonce. Per default, writelock is in `auto' mode and grants exclusive input permission to the\nuser who is the first to switch to the particular window. When he leaves the window, other\nusers may obtain the writelock (automatically). The writelock of the current window is dis‐\nabled by the command writelock off. If the user issues the command writelock on he keeps the\nexclusive write permission while switching to other windows.\n" }, { "name": "xoff", "content": "" }, { "name": "xon", "content": "Insert a CTRL-s / CTRL-q character to the stdin queue of the current window.\n" }, { "name": "zmodem [ off | auto | catch | pass ]", "content": "zmodem sendcmd [string]\n\nzmodem recvcmd [string]\n\nDefine zmodem support for screen. Screen understands two different modes when it detects a\nzmodem request: pass and catch. If the mode is set to pass, screen will relay all data to\nthe attacher until the end of the transmission is reached. In catch mode screen acts as a\nzmodem endpoint and starts the corresponding rz/sz commands. If the mode is set to auto,\nscreen will use catch if the window is a tty (e.g. a serial line), otherwise it will use\npass.\n\nYou can define the templates screen uses in catch mode via the second and the third form.\n\nNote also that this is an experimental feature.\n\nzombie [keys[onerror]]\n\nPer default screen windows are removed from the window list as soon as the windows process\n(e.g. shell) exits. When a string of two keys is specified to the zombie command, `dead' win‐\ndows will remain in the list. The kill command may be used to remove such a window. Pressing\nthe first key in the dead window has the same effect. When pressing the second key, screen\nwill attempt to resurrect the window. The process that was initially running in the window\nwill be launched again. Calling zombie without parameters will clear the zombie setting, thus\nmaking windows disappear when their process exits.\n\nAs the zombie-setting is manipulated globally for all windows, this command should probably\nbe called defzombie, but it isn't.\n\nOptionally you can put the word onerror after the keys. This will cause screen to monitor\nexit status of the process running in the window. If it exits normally ('0'), the window dis‐\nappears. Any other exit value causes the window to become a zombie.\n\nzombietimeout[seconds]\n\nPer default screen windows are removed from the window list as soon as the windows process\n(e.g. shell) exits. If zombie keys are defined (compare with above zombie command), it is\npossible to also set a timeout when screen tries to automatically reconnect a dead screen\nwindow.\n\n" } ] }, "THE MESSAGE LINE": { "content": "Screen displays informational messages and other diagnostics in a message line. While this\nline is distributed to appear at the bottom of the screen, it can be defined to appear at the\ntop of the screen during compilation. If your terminal has a status line defined in its\ntermcap, screen will use this for displaying its messages, otherwise a line of the current\nscreen will be temporarily overwritten and output will be momentarily interrupted. The mes‐\nsage line is automatically removed after a few seconds delay, but it can also be removed\nearly (on terminals without a status line) by beginning to type.\n\nThe message line facility can be used by an application running in the current window by\nmeans of the ANSI Privacy message control sequence. For instance, from within the shell, try\nsomething like:\n\necho '^Hello world from window '$WINDOW'\\\\'\n\nwhere '' is an escape, '^' is a literal up-arrow, and '\\\\' turns into a single back‐\nslash.\n\n", "subsections": [] }, "WINDOW TYPES": { "content": "Screen provides three different window types. New windows are created with screen's screen\ncommand (see also the entry in chapter CUSTOMIZATION). The first parameter to the screen com‐\nmand defines which type of window is created. The different window types are all special\ncases of the normal type. They have been added in order to allow screen to be used effi‐\nciently as a console multiplexer with 100 or more windows.\n\n\n• The normal window contains a shell (default, if no parameter is given) or any other system\ncommand that could be executed from a shell (e.g. slogin, etc...)\n\n\n• If a tty (character special device) name (e.g. /dev/ttya) is specified as the first para‐\nmeter, then the window is directly connected to this device. This window type is similar\nto screen cu -l /dev/ttya. Read and write access is required on the device node, an ex‐\nclusive open is attempted on the node to mark the connection line as busy. An optional\nparameter is allowed consisting of a comma separated list of flags in the notation used by\nstty(1):\n\n\nUsually 300, 1200, 9600 or 19200. This affects transmission as well as receive\nspeed.\n\ncs8 or cs7\nSpecify the transmission of eight (or seven) bits per byte.\n\ncstopb or -cstopb\nSpecify two stop bits per character (one with '-')\n\nparenb or -parenb\nGenerate parity bit in output and expect parity bit in input\n\nparodd or -parodd\nSet odd parity (or even parity with '-')\n\nixon or -ixon\nEnables (or disables) software flow-control (CTRL-S/CTRL-Q) for sending data.\n\nixoff or -ixoff\nEnables (or disables) software flow-control for receiving data.\n\nistrip or -istrip\nClear (or keep) the eight bit in each received byte.\n\nYou may want to specify as many of these options as applicable. Unspecified options cause\nthe terminal driver to make up the parameter values of the connection. These values are\nsystem dependent and may be in defaults or values saved from a previous connection.\n\nFor tty windows, the info command shows some of the modem control lines in the status\nline. These may include `RTS', `CTS', 'DTR', `DSR', `CD' and more. This depends on the\navailable ioctl()'s and system header files as well as the on the physical capabilities of\nthe serial board. Signals that are logical low (inactive) have their name preceded by an\nexclamation mark (!), otherwise the signal is logical high (active). Signals not sup‐\nported by the hardware but available to the ioctl() interface are usually shown low.\n\nWhen the CLOCAL status bit is true, the whole set of modem signals is placed inside curly\nbraces ({ and }). When the CRTSCTS or TIOCSOFTCAR bit is set, the signals `CTS' or `CD'\nare shown in parenthesis, respectively.\n\nFor tty windows, the command break causes the Data transmission line (TxD) to go low for a\nspecified period of time. This is expected to be interpreted as break signal on the other\nside. No data is sent and no modem control line is changed when a break is issued.\n\n\n• If the first parameter is //telnet, the second parameter is expected to be a host name,\nand an optional third parameter may specify a TCP port number (default decimal 23).\nScreen will connect to a server listening on the remote host and use the telnet protocol\nto communicate with that server.\n\nFor telnet windows, the command info shows details about the connection in square brackets ([\nand ]) at the end of the status line.\n\nb BINARY. The connection is in binary mode.\n\ne ECHO. Local echo is disabled.\n\nc SGA. The connection is in `character mode' (default: `line mode').\n\nt TTYPE. The terminal type has been requested by the remote host. Screen sends\nthe name screen unless instructed otherwise (see also the command `term').\n\nw NAWS. The remote site is notified about window size changes.\n\nf LFLOW. The remote host will send flow control information. (Ignored at the mo‐\nment.)\n\nAdditional flags for debugging are x, t and n (XDISPLOC, TSPEED and NEWENV).\n\nFor telnet windows, the command break sends the telnet code IAC BREAK (decimal 243) to\nthe remote host.\n\n\nThis window type is only available if screen was compiled with the ENABLETELNET op‐\ntion defined.\n\n\n", "subsections": [] }, "STRING ESCAPES": { "content": "Screen provides an escape mechanism to insert information like the current time into messages\nor file names. The escape character is '%' with one exception: inside of a window's hardsta‐\ntus '^%' ('^E') is used instead.\n\nHere is the full list of supported escapes:\n\n% the escape character itself\n\nE sets %? to true if the escape character has been pressed.\n\ne encoding\n\nf flags of the window, see windows for meanings of the various flags\n\nF sets %? to true if the window has the focus\n\nh hardstatus of the window\n\nH hostname of the system\n\nn window number\n\nP sets %? to true if the current region is in copy/paste mode\n\nS session name\n\ns window size\n\nt window title\n\nu all other users on this window\n\nw all window numbers and names. With '-' qualifier: up to the current window; with '+'\nqualifier: starting with the window after the current one.\n\nW all window numbers and names except the current one\n\nx the executed command including arguments running in this windows\n\nX the executed command without arguments running in this windows\n\n? the part to the next '%?' is displayed only if a '%' escape inside the part expands to\na non-empty string\n\n: else part of '%?'\n\n= pad the string to the display's width (like TeX's hfill). If a number is specified,\npad to the percentage of the window's width. A '0' qualifier tells screen to treat\nthe number as absolute position. You can specify to pad relative to the last absolute\npad position by adding a '+' qualifier or to pad relative to the right margin by using\n'-'. The padding truncates the string if the specified position lies before the cur‐\nrent position. Add the 'L' qualifier to change this.\n\n< same as '%=' but just do truncation, do not fill with spaces\n\n> mark the current text position for the next truncation. When screen needs to do trun‐\ncation, it tries to do it in a way that the marked position gets moved to the speci‐\nfied percentage of the output area. (The area starts from the last absolute pad posi‐\ntion and ends with the position specified by the truncation operator.) The 'L' quali‐\nfier tells screen to mark the truncated parts with '...'.\n\n{ attribute/color modifier string terminated by the next }\n\n` Substitute with the output of a 'backtick' command. The length qualifier is misused to\nidentify one of the commands.\n\nThe 'c' and 'C' escape may be qualified with a '0' to make screen use zero instead of space\nas fill character. The '0' qualifier also makes the '=' escape use absolute positions. The\n'n' and '=' escapes understand a length qualifier (e.g. '%3n'), 'D' and 'M' can be prefixed\nwith 'L' to generate long names, 'w' and 'W' also show the window flags if 'L' is given.\n\nAn attribute/color modifier is used to change the attributes or the color settings. Its for‐\nmat is [attribute modifier] [color description]. The attribute modifier must be prefixed by a\nchange type indicator if it can be confused with a color description. The following change\ntypes are known:\n\n+ add the specified set to the current attributes\n\n- remove the set from the current attributes\n\n! invert the set in the current attributes\n\n= change the current attributes to the specified set\n\nThe attribute set can either be specified as a hexadecimal number or a combination of the\nfollowing letters:\n\nd dim\nu underline\nb bold\nr reverse\ns /standout\nB blinking\n\nColors are coded either as a hexadecimal number or two letters specifying the desired back‐\nground and foreground color (in that order). The following colors are known:\n\nk black\nr red\ng green\ny yellow\nb blue\nm magenta\nc cyan\nw white\nd default color\n. leave color unchanged\n\nThe capitalized versions of the letter specify bright colors. You can also use the pseudo-\ncolor 'i' to set just the brightness and leave the color unchanged.\nA one digit/letter color description is treated as foreground or background color dependent\non the current attributes: if reverse mode is set, the background color is changed instead of\nthe foreground color. If you don't like this, prefix the color with a .. If you want the\nsame behavior for two-letter color descriptions, also prefix them with a ..\nAs a special case, %{-} restores the attributes and colors that were set before the last\nchange was made (i.e., pops one level of the color-change stack).\n\nExamples:\n\nG set color to bright green\n\n+b r use bold red\n\n= yd clear all attributes, write in default color on yellow background.\n\n%-Lw%{= BW}%50>%n%f* %t%{-}%+Lw%<\nThe available windows centered at the current window and truncated to the available\nwidth. The current window is displayed white on blue. This can be used with hardsta‐\ntus alwayslastline.\n\n%?%F%{.R.}%?%3n %t%? [%h]%?\nThe window number and title and the window's hardstatus, if one is set. Also use a\nred background if this is the active focus. Useful for caption string.\n", "subsections": [] }, "FLOW-CONTROL": { "content": "Each window has a flow-control setting that determines how screen deals with the XON and XOFF\ncharacters (and perhaps the interrupt character). When flow-control is turned off, screen\nignores the XON and XOFF characters, which allows the user to send them to the current pro‐\ngram by simply typing them (useful for the emacs editor, for instance). The trade-off is\nthat it will take longer for output from a normal program to pause in response to an XOFF.\nWith flow-control turned on, XON and XOFF characters are used to immediately pause the output\nof the current window. You can still send these characters to the current program, but you\nmust use the appropriate two-character screen commands (typically C-a q (xon) and C-a s\n(xoff)). The xon/xoff commands are also useful for typing C-s and C-q past a terminal that\nintercepts these characters.\n\nEach window has an initial flow-control value set with either the -f option or the defflow\n.screenrc command. Per default the windows are set to automatic flow-switching. It can then\nbe toggled between the three states 'fixed on', 'fixed off' and 'automatic' interactively\nwith the flow command bound to \"C-a f\".\n\nThe automatic flow-switching mode deals with flow control using the TIOCPKT mode (like rlogin\ndoes). If the tty driver does not support TIOCPKT, screen tries to find out the right mode\nbased on the current setting of the application keypad - when it is enabled, flow-control is\nturned off and visa versa. Of course, you can still manipulate flow-control manually when\nneeded.\n\nIf you're running with flow-control enabled and find that pressing the interrupt key (usually\nC-c) does not interrupt the display until another 6-8 lines have scrolled by, try running\nscreen with the interrupt option (add the interrupt flag to the flow command in your\n.screenrc, or use the -i command-line option). This causes the output that screen has accu‐\nmulated from the interrupted program to be flushed. One disadvantage is that the virtual\nterminal's memory contains the non-flushed version of the output, which in rare cases can\ncause minor inaccuracies in the output. For example, if you switch screens and return, or\nupdate the screen with C-a l you would see the version of the output you would have gotten\nwithout interrupt being on. Also, you might need to turn off flow-control (or use auto-flow\nmode to turn it off automatically) when running a program that expects you to type the inter‐\nrupt character as input, as it is possible to interrupt the output of the virtual terminal to\nyour physical terminal when flow-control is enabled. If this happens, a simple refresh of\nthe screen with C-a l will restore it. Give each mode a try, and use whichever mode you find\nmore comfortable.\n\n\n\nTITLES (naming windows)\nYou can customize each window's name in the window display (viewed with the windows command\n(C-a w)) by setting it with one of the title commands. Normally the name displayed is the\nactual command name of the program created in the window. However, it is sometimes useful to\ndistinguish various programs of the same name or to change the name on-the-fly to reflect the\ncurrent state of the window.\n\nThe default name for all shell windows can be set with the shelltitle command in the\n.screenrc file, while all other windows are created with a screen command and thus can have\ntheir name set with the -t option. Interactively, there is the title-string escape-sequence\n(kname\\) and the title command (C-a A). The former can be output from an applica‐\ntion to control the window's name under software control, and the latter will prompt for a\nname when typed. You can also bind pre-defined names to keys with the title command to set\nthings quickly without prompting. Changing title by this escape sequence can be controlled by\ndefdynamictitle and dynamictitle commands.\n\nFinally, screen has a shell-specific heuristic that is enabled by setting the window's name\nto search|name and arranging to have a null title escape-sequence output as a part of your\nprompt. The search portion specifies an end-of-prompt search string, while the name portion\nspecifies the default shell name for the window. If the name ends in a `:' screen will add\nwhat it believes to be the current command running in the window to the end of the window's\nshell name (e.g. name:cmd). Otherwise the current command name supersedes the shell name\nwhile it is running.\n\nHere's how it works: you must modify your shell prompt to output a null title-escape-se‐\nquence (k\\) as a part of your prompt. The last part of your prompt must be the\nsame as the string you specified for the search portion of the title. Once this is set up,\nscreen will use the title-escape-sequence to clear the previous command name and get ready\nfor the next command. Then, when a newline is received from the shell, a search is made for\nthe end of the prompt. If found, it will grab the first word after the matched string and\nuse it as the command name. If the command name begins with either '!', '%', or '^' screen\nwill use the first word on the following line (if found) in preference to the just-found\nname. This helps csh users get better command names when using job control or history recall\ncommands.\n\nHere's some .screenrc examples:\n\nscreen -t top 2 nice top\n\nAdding this line to your .screenrc would start a nice-d version of the top command in window\n2 named top rather than nice.\n\nshelltitle '> |csh'\nscreen 1\n\nThese commands would start a shell with the given shelltitle. The title specified is an\nauto-title that would expect the prompt and the typed command to look something like the fol‐\nlowing:\n\n/usr/joe/src/dir> trn\n\n(it looks after the '> ' for the command name). The window status would show the name trn\nwhile the command was running, and revert to csh upon completion.\n\nbind R screen -t '% |root:' su\n\nHaving this command in your .screenrc would bind the key sequence C-a R to the su command and\ngive it an auto-title name of root:. For this auto-title to work, the screen could look\nsomething like this:\n\n% !em\nemacs file.c\n\nHere the user typed the csh history command !em which ran the previously entered emacs com‐\nmand. The window status would show root:emacs during the execution of the command, and re‐\nvert to simply root: at its completion.\n\nbind o title\nbind E title \"\"\nbind u title (unknown)\n\nThe first binding doesn't have any arguments, so it would prompt you for a title when you\ntype C-a o. The second binding would clear an auto-title's current setting (C-a E). The\nthird binding would set the current window's title to (unknown) (C-a u).\n\nOne thing to keep in mind when adding a null title-escape-sequence to your prompt is that\nsome shells (like the csh) count all the non-control characters as part of the prompt's\nlength. If these invisible characters aren't a multiple of 8 then backspacing over a tab\nwill result in an incorrect display. One way to get around this is to use a prompt like\nthis:\n\nset prompt='^[[0000m^[k^[\\% '\n\nThe escape-sequence [0000m not only normalizes the character attributes, but all the ze‐\nros round the length of the invisible characters up to 8. Bash users will probably want to\necho the escape sequence in the PROMPTCOMMAND:\n\nPROMPTCOMMAND='printf \"\\033k\\033\\134\"'\n\n(I used \\134 to output a `\\' because of a bug in bash v1.04).\n\n\n", "subsections": [] }, "THE VIRTUAL TERMINAL": { "content": "Each window in a screen session emulates a VT100 terminal, with some extra functions added.\nThe VT100 emulator is hard-coded, no other terminal types can be emulated.\nUsually screen tries to emulate as much of the VT100/ANSI standard as possible. But if your\nterminal lacks certain capabilities, the emulation may not be complete. In these cases screen\nhas to tell the applications that some of the features are missing. This is no problem on ma‐\nchines using termcap, because screen can use the $TERMCAP variable to customize the standard\nscreen termcap.\n\nBut if you do a rlogin on another machine or your machine supports only terminfo this method\nfails. Because of this, screen offers a way to deal with these cases. Here is how it works:\n\nWhen screen tries to figure out a terminal name for itself, it first looks for an entry named\nscreen., where is the contents of your $TERM variable. If no such entry exists,\nscreen tries screen (or screen-w if the terminal is wide (132 cols or more)). If even this\nentry cannot be found, vt100 is used as a substitute.\n\nThe idea is that if you have a terminal which doesn't support an important feature (e.g.\ndelete char or clear to EOS) you can build a new termcap/terminfo entry for screen (named\nscreen.) in which this capability has been disabled. If this entry is installed on\nyour machines you are able to do a rlogin and still keep the correct termcap/terminfo entry.\nThe terminal name is put in the $TERM variable of all new windows. Screen also sets the\n$TERMCAP variable reflecting the capabilities of the virtual terminal emulated. Notice that,\nhowever, on machines using the terminfo database this variable has no effect. Furthermore,\nthe variable $WINDOW is set to the window number of each window.\n\nThe actual set of capabilities supported by the virtual terminal depends on the capabilities\nsupported by the physical terminal. If, for instance, the physical terminal does not support\nunderscore mode, screen does not put the `us' and `ue' capabilities into the window's $TERM‐\nCAP variable, accordingly. However, a minimum number of capabilities must be supported by a\nterminal in order to run screen; namely scrolling, clear screen, and direct cursor addressing\n(in addition, screen does not run on hardcopy terminals or on terminals that over-strike).\n\nAlso, you can customize the $TERMCAP value used by screen by using the termcap .screenrc com‐\nmand, or by defining the variable $SCREENCAP prior to startup. When the latter is defined,\nits value will be copied verbatim into each window's $TERMCAP variable. This can either be\nthe full terminal definition, or a filename where the terminal screen (and/or screen-w) is\ndefined.\n\nNote that screen honors the terminfo .screenrc command if the system uses the terminfo data‐\nbase rather than termcap.\n\nWhen the boolean `G0' capability is present in the termcap entry for the terminal on which\nscreen has been called, the terminal emulation of screen supports multiple character sets.\nThis allows an application to make use of, for instance, the VT100 graphics character set or\nnational character sets. The following control functions from ISO 2022 are supported: lock\nshift G0 (SI), lock shift G1 (SO), lock shift G2, lock shift G3, single shift G2, and single\nshift G3. When a virtual terminal is created or reset, the ASCII character set is designated\nas G0 through G3. When the `G0' capability is present, screen evaluates the capabilities\n`S0', `E0', and `C0' if present. `S0' is the sequence the terminal uses to enable and start\nthe graphics character set rather than SI. `E0' is the corresponding replacement for SO.\n`C0' gives a character by character translation string that is used during semi-graphics\nmode. This string is built like the `acsc' terminfo capability.\n\nWhen the `po' and `pf' capabilities are present in the terminal's termcap entry, applications\nrunning in a screen window can send output to the printer port of the terminal. This allows\na user to have an application in one window sending output to a printer connected to the ter‐\nminal, while all other windows are still active (the printer port is enabled and disabled\nagain for each chunk of output). As a side-effect, programs running in different windows can\nsend output to the printer simultaneously. Data sent to the printer is not displayed in the\nwindow. The info command displays a line starting `PRIN' while the printer is active.\n\nScreen maintains a hardstatus line for every window. If a window gets selected, the display's\nhardstatus will be updated to match the window's hardstatus line. If the display has no hard‐\nstatus the line will be displayed as a standard screen message. The hardstatus line can be\nchanged with the ANSI Application Program Command (APC): ESCESC\\. As a convenience\nfor xterm users the sequence ESC]0..2;^G is also accepted.\n\nSome capabilities are only put into the $TERMCAP variable of the virtual terminal if they can\nbe efficiently implemented by the physical terminal. For instance, `dl' (delete line) is\nonly put into the $TERMCAP variable if the terminal supports either delete line itself or\nscrolling regions. Note that this may provoke confusion, when the session is reattached on a\ndifferent terminal, as the value of $TERMCAP cannot be modified by parent processes.\n\nThe \"alternate screen\" capability is not enabled by default. Set the altscreen .screenrc\ncommand to enable it.\n\nThe following is a list of control sequences recognized by screen. (V) and (A) indicate\nVT100-specific and ANSI- or ISO-specific functions, respectively.\n\nESC E Next Line\n\nESC D Index\n\nESC M Reverse Index\n\nESC H Horizontal Tab Set\n\nESC Z Send VT100 Identification String\n\nESC 7 (V) Save Cursor and Attributes\n\nESC 8 (V) Restore Cursor and Attributes\n\nESC [s (A) Save Cursor and Attributes\n\nESC [u (A) Restore Cursor and Attributes\n\nESC c Reset to Initial State\n\nESC g Visual Bell\n\nESC Pn p Cursor Visibility (97801)\n\nPn = 6 Invisible\n\nPn = 7 Visible\n\nESC = (V) Application Keypad Mode\n\nESC > (V) Numeric Keypad Mode\n\nESC # 8 (V) Fill Screen with E's\n\nESC \\ (A) String Terminator\n\nESC ^ (A) Privacy Message String (Message Line)\n\nESC ! Global Message String (Message Line)\n\nESC k A.k.a. Definition String\n\nESC P (A) Device Control String. Outputs a string directly to the host ter‐\nminal without interpretation.\n\nESC (A) Application Program Command (Hardstatus)\n\nESC ] 0 ; string ^G (A) Operating System Command (Hardstatus, xterm title hack)\n\nESC ] 83 ; cmd ^G (A) Execute screen command. This only works if multi-user support is\ncompiled into screen. The pseudo-user :window: is used to check\nthe access control list. Use addacl :window: -rwx #? to create a\nuser with no rights and allow only the needed commands.\n\nControl-N (A) Lock Shift G1 (SO)\n\nControl-O (A) Lock Shift G0 (SI)\n\nESC n (A) Lock Shift G2\n\nESC o (A) Lock Shift G3\n\nESC N (A) Single Shift G2\n\nESC O (A) Single Shift G3\n\nESC ( Pcs (A) Designate character set as G0\n\nESC ) Pcs (A) Designate character set as G1\n\nESC * Pcs (A) Designate character set as G2\n\nESC + Pcs (A) Designate character set as G3\n\nESC [ Pn ; Pn H Direct Cursor Addressing\n\nESC [ Pn ; Pn f same as above\n\nESC [ Pn J Erase in Display\n\nPn = None or 0 From Cursor to End of Screen\n\nPn = 1 From Beginning of Screen to Cursor\n\nPn = 2 Entire Screen\n\nESC [ Pn K Erase in Line\n\nPn = None or 0 From Cursor to End of Line\n\nPn = 1 From Beginning of Line to Cursor\n\nPn = 2 Entire Line\n\nESC [ Pn X Erase character\n\nESC [ Pn A Cursor Up\n\nESC [ Pn B Cursor Down\n\nESC [ Pn C Cursor Right\n\nESC [ Pn D Cursor Left\n\nESC [ Pn E Cursor next line\n\nESC [ Pn F Cursor previous line\n\nESC [ Pn G Cursor horizontal position\n\nESC [ Pn ` same as above\n\nESC [ Pn d Cursor vertical position\n\nESC [ Ps ;...; Ps m Select Graphic Rendition\n\nPs = None or 0 Default Rendition\n\nPs = 1 Bold\n\nPs = 2 (A) Faint\n\nPs = 3 (A) Standout Mode (ANSI: Italicized)\n\nPs = 4 Underlined\n\nPs = 5 Blinking\n\nPs = 7 Negative Image\n\nPs = 22 (A) Normal Intensity\n\nPs = 23 (A) Standout Mode off (ANSI: Italicized\noff)\n\nPs = 24 (A) Not Underlined\n\nPs = 25 (A) Not Blinking\n\nPs = 27 (A) Positive Image\n\nPs = 30 (A) Foreground Black\n\nPs = 31 (A) Foreground Red\n\nPs = 32 (A) Foreground Green\n\nPs = 33 (A) Foreground Yellow\n\nPs = 34 (A) Foreground Blue\n\nPs = 35 (A) Foreground Magenta\n\nPs = 36 (A) Foreground Cyan\n\nPs = 37 (A) Foreground White\n\nPs = 39 (A) Foreground Default\n\nPs = 40 (A) Background Black\n\nPs = ...\n\nPs = 49 (A) Background Default\n\nESC [ Pn g Tab Clear\n\nPn = None or 0 Clear Tab at Current Position\n\nPn = 3 Clear All Tabs\n\nESC [ Pn ; Pn r (V) Set Scrolling Region\n\nESC [ Pn I (A) Horizontal Tab\n\nESC [ Pn Z (A) Backward Tab\n\nESC [ Pn L (A) Insert Line\n\nESC [ Pn M (A) Delete Line\n\nESC [ Pn @ (A) Insert Character\n\nESC [ Pn P (A) Delete Character\n\nESC [ Pn S Scroll Scrolling Region Up\n\nESC [ Pn T Scroll Scrolling Region Down\n\nESC [ Pn ^ same as above\n\nESC [ Ps ;...; Ps h Set Mode\n\nESC [ Ps ;...; Ps l Reset Mode\n\nPs = 4 (A) Insert Mode\n\nPs = 20 (A) Automatic Linefeed Mode\n\nPs = 34 Normal Cursor Visibility\n\nPs = ?1 (V) Application Cursor Keys\n\nPs = ?3 (V) Change Terminal Width to 132 columns\n\nPs = ?5 (V) Reverse Video\n\nPs = ?6 (V) Origin Mode\n\nPs = ?7 (V) Wrap Mode\n\nPs = ?9 X10 mouse tracking\n\nPs = ?25 (V) Visible Cursor\n\nPs = ?47 Alternate Screen (old xterm code)\n\nPs = ?1000 (V) VT200 mouse tracking\n\nPs = ?1047 Alternate Screen (new xterm code)\n\nPs = ?1049 Alternate Screen (new xterm code)\n\nESC [ 5 i (A) Start relay to printer (ANSI Media Copy)\n\nESC [ 4 i (A) Stop relay to printer (ANSI Media Copy)\n\nESC [ 8 ; Ph ; Pw t Resize the window to `Ph' lines and `Pw' columns (SunView special)\n\nESC [ c Send VT100 Identification String\n\nESC [ x Send Terminal Parameter Report\n\nESC [ > c Send VT220 Secondary Device Attributes String\n\nESC [ 6 n Send Cursor Position Report\n\n\n", "subsections": [] }, "INPUT TRANSLATION": { "content": "In order to do a full VT100 emulation screen has to detect that a sequence of characters in\nthe input stream was generated by a keypress on the user's keyboard and insert the VT100\nstyle escape sequence. Screen has a very flexible way of doing this by making it possible to\nmap arbitrary commands on arbitrary sequences of characters. For standard VT100 emulation the\ncommand will always insert a string in the input buffer of the window (see also command stuff\nin the command table). Because the sequences generated by a keypress can change after a\nreattach from a different terminal type, it is possible to bind commands to the termcap name\nof the keys. Screen will insert the correct binding after each reattach. See the bindkey\ncommand for further details on the syntax and examples.\n\nHere is the table of the default key bindings. The fourth is what command is executed if the\nkeyboard is switched into application mode.\n\n┌─────────────────┬──────────────┬──────────┬──────────┐\n│ Key name │ Termcap name │ Command │ App mode │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Cursor up │ ku │ \\033[A │ \\033OA │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Cursor down │ kd │ \\033[B │ \\033OB │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Cursor right │ kr │ \\033[C │ \\033OC │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Cursor left │ kl │ \\033[D │ \\033OD │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Function key 0 │ k0 │ \\033[10~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Function key 1 │ k1 │ \\033OP │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Function key 2 │ k2 │ \\033OQ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Function key 3 │ k3 │ \\033OR │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Function key 4 │ k4 │ \\033OS │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Function key 5 │ k5 │ \\033[15~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Function key 6 │ k6 │ \\033[17~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Function key 7 │ k7 │ \\033[18~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Function key 8 │ k8 │ \\033[19~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Function key 9 │ k9 │ \\033[20~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Function key 10 │ k; │ \\033[21~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Function key 11 │ F1 │ \\033[23~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Function key 12 │ F2 │ \\033[24~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Home │ kh │ \\033[1~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ End │ kH │ \\033[4~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Insert │ kI │ \\033[2~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Delete │ kD │ \\033[3~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Page up │ kP │ \\033[5~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Page down │ kN │ \\033[6~ │ │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad 0 │ f0 │ 0 │ \\033Op │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad 1 │ f1 │ 1 │ \\033Oq │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad 2 │ f2 │ 2 │ \\033Or │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad 3 │ f3 │ 3 │ \\033Os │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad 4 │ f4 │ 4 │ \\033Ot │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad 5 │ f5 │ 5 │ \\033Ou │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad 6 │ f6 │ 6 │ \\033Ov │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad 7 │ f7 │ 7 │ \\033Ow │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad 8 │ f8 │ 8 │ \\033Ox │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad 9 │ f9 │ 9 │ \\033Oy │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad + │ f+ │ + │ \\033Ok │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad - │ f- │ - │ \\033Om │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad * │ f* │ * │ \\033Oj │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad / │ f/ │ / │ \\033Oo │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad = │ fq │ = │ \\033OX │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad . │ f. │ . │ \\033On │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad , │ f, │ , │ \\033Ol │\n├─────────────────┼──────────────┼──────────┼──────────┤\n│ Keypad enter │ fe │ \\015 │ \\033OM │\n└─────────────────┴──────────────┴──────────┴──────────┘\n\n", "subsections": [] }, "SPECIAL TERMINAL CAPABILITIES": { "content": "The following table describes all terminal capabilities that are recognized by screen and are\nnot in the termcap(5) manual. You can place these capabilities in your termcap entries (in\n`/etc/termcap') or use them with the commands `termcap', `terminfo' and `termcapinfo' in your\nscreenrc files. It is often not possible to place these capabilities in the terminfo data‐\nbase.\n", "subsections": [ { "name": "LP _(bool)", "content": "obsolete because screen uses the standard 'xn' instead.\n" }, { "name": "Z0 _(str)", "content": "" }, { "name": "Z1 _(str)", "content": "" }, { "name": "WS _(str)", "content": "SunView(tm) example: '\\E[8;%d;%dt'.\n" }, { "name": "NF _(bool)", "content": "Same as 'flow off'. The opposite of this capability is 'nx'.\n" }, { "name": "G0 _(bool)", "content": "" }, { "name": "S0 _(str)", "content": "" }, { "name": "E0 _(str)", "content": "" }, { "name": "C0 _(str)", "content": "more details.\n" }, { "name": "CS _(str)", "content": "" }, { "name": "CE _(str)", "content": "" }, { "name": "AN _(bool)", "content": "" }, { "name": "OL _(num)", "content": "" }, { "name": "KJ _(str)", "content": "ings.\n" }, { "name": "AF _(str)", "content": "almost always be set to '\\E[3%dm' ('\\E[3%p1%dm' on terminfo machines).\n" }, { "name": "AB _(str)", "content": "" }, { "name": "AX _(bool)", "content": "" }, { "name": "XC _(str)", "content": "More details follow in the next section.\n" }, { "name": "XT _(bool)", "content": "" }, { "name": "C8 _(bool)", "content": "" }, { "name": "TF _(bool)", "content": "" } ] }, "CHARACTER TRANSLATION": { "content": "Screen has a powerful mechanism to translate characters to arbitrary strings depending on the\ncurrent font and terminal type. Use this feature if you want to work with a common standard\ncharacter set (say ISO8851-latin1) even on terminals that scatter the more unusual characters\nover several national language font pages.\n\nSyntax:\nXC={,,}\n :=