| blob | 41831a0a2682a131fb9658e03d66031b22128434 |
1 Installation of screen 4.3.1
4 0.) This instruction is quite lengthy
5 -------------------------------------
6 ... and there are still important items near the end. Start here:
7 Unpack. Screen comes as a compressed tar archive. You need gzip to
8 uncompress. And... well, you probably already managed that step,
9 when you are reading this.
11 For general documentation on the coding and usage standards this
12 distributions follows, see the GNU standards document on
13 https://www.gnu.org/prep/standards/, especially the `Makefile
14 Conventions', `Configuration', and `User Interfaces' sections.
16 0.) autogen.sh
17 --------------
18 First, run ./autogen.sh. This will create configure file that you can use.
19 This should be already done, so you can skip this step.
21 1.) configure & config.status
22 -----------------------------
23 Run ./configure. This should create a reasonable Makefile and a config.h file
24 suited for your machine. Rename config.status to reflect the architecture
25 (hostname) where it was built. To reconfigure quickly for that architecture
26 just run that config.status file.
27 If this process fails, try to find out what configure did do and what it
28 should have checked.
29 And then please report a bug (https://savannah.gnu.org/bugs/?group=screen
30 or mail screen-devel@gnu.org).
31 Actually the initial Makefile that comes with the distribution just runs
32 configure -- thus you can start by typing 'make' right after unpacking.
33 You will be prompted to run 'make' again, which will really make screen.
35 2.) Makefile & config.h
36 -----------------------
37 Look through the Makefile & user configuration section in config.h and check
38 pathnames. Change them to suit your installation requirements. Usually
39 sysadmins discuss the location of SOCKDIR, whether it should be in /tmp or
40 not. At least it must be on a filesystem that supports sockets/fifos.
41 SOCKDIR must not point into an AFS (Andrew File System) mounted directory.
42 If you are uncertain about your NFS implementation, use a UFS directory for
43 SOCKDIR. Personally, I favour a users home directory and recommend the the
44 /tmp/ area.
45 The path for ETCSCREENRC may also need to be adapted.
47 3.) how to actually compile
48 ---------------------------
49 Run 'make'. Screen should compile without too many warnings :)
50 The creation of term.h, comm.h, tty.c or osdef.h may fail on some machines
51 for some odd reason. (E.g. the sed under SCO-unix is known to be
52 case-insensitive and breaks term.h.) If so, please mail a short description
53 of the problem to screen-devel@gnu.org and use the files ending in .dist
54 as a replacement (or in case of osdef.h retry with an empty file).
55 You can then try 'make install' (if you dare).
57 4.) where to install
58 --------------------
59 You may well run screen from your private binary directory and with a
60 private socket directory like $HOME/.screen. But to have a full featured
61 screen and (from a users point of view) more secure pty's you should
62 consult a system administrator and discuss installing screen setuid-root
63 in some globally accessible directory like /usr/local/bin.
65 Consider this, when deciding whether you install screen setuid-root:
66 - On some machines root privileges are required to open pty's.
67 - Pty's should be owned by the user, so that she can do chmod to prevent
68 intruder attacks. The PTYs used by screen will remain world read-writable
69 if screen is not installed setuid-root.
70 - Some commands only work properly when the pty is owned by the user.
71 These include mesg and biff.
72 - The ^At feature may need to lseek and read the kernel file to retrieve
73 the load average.
74 - On most machines utmp slots can only be created/manipulated with root
75 privileges. Users will appear to be logged on the primary terminal
76 instead of the screen windows, if screen is not installed setuid-root.
77 - Multi-user screen sessions are only allowed when screen has a root-s-bit.
78 - If screen sockets of multiple users are kept in one directory (e.g.
79 /tmp/screens), this directory must be world writable when screen is not
80 installed setuid-root. Any user can remove or abuse any socket then.
83 5.) doc/screen.1 & doc/screen.texinfo
84 -------------------------------------
85 The man page doc/screen.1 should go to /usr/local/man/man1, or some similar
86 directory. It should format nicely with nroff -man. If it does not, then
87 try removing extra dots with: sed -e 's/^\.\././' < screen.1 | nroff -man
88 The info page doc/screen.texinfo contains basically the same information as
89 the man-page, we may have missed one or another thing in one of the files.
90 If so, mail me.
92 6.) etc/screenrc & etc/etcscreenrc
93 ----------------------------------
94 The files screenrc and etc/etcscreenrc are instructive samples that
95 demonstrate what can/should be done from your private .screenrc and from
96 $ETCSCREENRC -- do not just copy them. Read them. Look through the
97 etcscreenrc file for system wide defaults that you like to set. e.g.
98 autodetach off, startup_message off, vbell on, ...
99 Since version 3.2.15 the screenrc file syntax changed slightly. All rc files
100 from previous versions should be run through the 'newsyntax' script that comes
101 with this package.
102 If and only if you want to install screen as a console multiplexer, look
103 at the *.sample files and what 'make cscreen' suggests.
105 7.) terminfo/screeninfo.src & terminfo/screencap
106 ------------------------------------------------
107 Every now and then we update the termcap/terminfo entries for screen.
108 E.g. keycodes were added in 3.6.0 -- thus you check that your termcap/terminfo
109 database is up to date. See the README in the terminfo subdirectory.
111 8.) have fun
112 ------------
113 To get an idea what the basic screen commands are, read the file README.
114 Request snail mail address for liquid and solid donations. :-)