Bring back --with-sys-screenrc configure flag.
[screen-lua.git] / src / README
blob217573ef84a336bc5d87d40af00626fc94aa2e98
2   [If you just got the screen package, it pays to read the file INSTALL]
3   [This intro only describes the most common features to get you started]
4   [A full description of all features is contained in the source package]
8 Short introduction to screen (Version 3.6.0)                   lvirden 8-8-93
10 Send bugreports, fixes, enhancements, t-shirts, money, beer & pizza to 
11                           screen@uni-erlangen.de
13 Screen provides you with an ANSI/vt100 terminal emulator, which can multiplex
14 up to 10 pseudo-terminals. On startup, it executes $SHELL in window 0.
15 Then it reads $HOME/.screenrc to learn configuration, keybindings, and
16 possibly open more windows.
18   C-a ?         (help)          Show all keybindings.
20   C-a c         (screen)        Create new windows.
22   C-a SPACE     (next)          Advance to next window (with wraparound).
24   C-a C-a       (other)         Toggle between the current and previously
25                                 displayed windows.
27   C-a 0         (select n)      Switch to window n=0 ... 9.
28    ...
29   C-a 9         
31   C-a w         (windows)       Show a list of window names in the status line.
33   C-a a         (meta)          Send a literal C-a/C-s/C-q to the
34   C-a s         (xoff)          process in the window.
35   C-a q         (xon)           For instance, emacs uses C-a and C-s.
37   C-a l         (redisplay)     Redraw this window.
39   C-a W         (width)         Toggle between 80 & 132 columns mode. 
41   C-a L         (login)         Try to toggle the window's utmp-slot.
43   C-a z         (suspend)       Suspend the whole screen session.
45   C-a x         (lockscreen)    Execute /usr/bin/lock, $LOCKCMD or a 
46                                 built-in terminal lock.
48   C-a H         (log)           Log stdout of window n to screenlog.n.
50   C-a C-[       (copy)          Start copy mode.  Move cursor with h,j,k,l.
51                                 Set 2 marks with SPACE or y.  Abort with ESC.
52                                 (C-[ is ESC.)  Preceeding second mark with
53                                 an a appends the text to the copy buffer.
55   C-a C-]       (paste)         Output copy buffer to current window's stdin.
57   C-a <         (readbuf)       Read the copy buffer from /tmp/screen-exchange.
58   C-a >         (writebuf)      Write the copy buffer to /tmp/screen-exchange.
60   C-a d         (detach)        Detach screen. All processes continue and may
61                                 spool output to their pty's, but screen
62                                 disconnects from your terminal.  
64   C-a D D       (pow_detach)    Power detach.  Disconnect like C-a d but also
65                                 kill the parent shell.
67   C-a K         (kill)          Kill a window and send SIGHUP to its process
68                                 group.  Per default this would be C-a C-k,
69                                 but it is redefined in the demo .screenrc
70                                 (think of killing a whole line in emacs).
72   C-a :         (colon)         Online configuration change.
74 See the man page or TeXinfo manual for many more keybindings and commands.
76 screen -r [pid.tty.host|tty.host]
77   Reattach to a specific detached session. The terminal emulator
78   reconfigures according to your $TERMCAP or $TERM settings.
79   When you have multiple screens detached, you must supply the session
80   name.
82 screen -R reattaches to a detached session or (if none) creates a new
83   session.
85 screen -d [pid.tty.host|tty.host]
86   Detach a screen session remotely. Has the same effect as typing 'C-a d'
87   on the controlling terminal. 'screen -D' will power-detach.
89 screen -list
90 screen -ls
91 screen -wipe
92   Show all available sessions and their status.  Use -wipe to remove
93   DEAD sessions.
95   If sockets are missing, you may send a SIGCHLD to its 'SCREEN'
96   process and the process will re-establish the socket (think of 
97   someone cleaning /tmp thoroughly).
99 screen -h 200
100   Starts a new screen session and sets the number of lines in the scrollback
101   buffer to 200. The default is 100 lines.