1 /* Copyright (c) 1993-2000
2 * Juergen Weigert (jnweiger@immd4.informatik.uni-erlangen.de)
3 * Michael Schroeder (mlschroe@immd4.informatik.uni-erlangen.de)
4 * Copyright (c) 1987 Oliver Laumann
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3, or (at your option)
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program (see the file COPYING); if not, see
18 * http://www.gnu.org/licenses/, or contact Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
21 ****************************************************************
29 /**********************************************************************
31 * User Configuration Section
35 * Maximum of simultaneously allowed windows per screen session.
42 * Define SOCKDIR to be the directory to contain the named sockets
43 * screen creates. This should be in a common subdirectory, such as
44 * /usr/local or /tmp. It makes things a little more secure if you
45 * choose a directory which is not writable by everyone or where the
46 * "sticky" bit is on, but this isn't required.
47 * If SOCKDIR is not defined screen will put the named sockets in
48 * the user's home directory. Notice that this can cause you problems
49 * if some user's HOME directories are AFS- or NFS-mounted. Especially
50 * AFS is unlikely to support named sockets.
52 * Screen will name the subdirectories "S-$USER" (e.g /tmp/S-davison).
57 * Define this if the SOCKDIR is not shared between hosts.
59 #define SOCKDIR_IS_LOCAL_TO_HOST
62 * Screen can look for the environment variable $SYSSCREENRC and -if it
63 * exists- load the file specified in that variable as global screenrc.
64 * If you want to enable this feature, define ALLOW_SYSSCREENRC to one (1).
65 * Otherwise ETCSCREENRC is always loaded.
67 #define ALLOW_SYSSCREENRC 1
70 * Define CHECKLOGIN to force Screen users to enter their Unix password
71 * in addition to the screen password.
73 * Define NOSYSLOG if yo do not have logging facilities. Currently
74 * syslog() will be used to trace ``su'' commands only.
81 * define PTYMODE if you do not like the default of 0622, which allows
82 * public write to your pty.
83 * define PTYGROUP to some numerical group-id if you do not want the
84 * tty to be in "your" group.
85 * Note, screen is unable to change mode or group of the pty if it
86 * is not installed with sufficient privilege. (e.g. set-uid-root)
87 * define PTYROFS if the /dev/pty devices are mounted on a read-only
88 * filesystem so screen should not even attempt to set mode or group
89 * even if running as root (e.g. on TiVo).
96 * If screen is NOT installed set-uid root, screen can provide tty
97 * security by exclusively locking the ptys. While this keeps other
98 * users from opening your ptys, it also keeps your own subprocesses
99 * from being able to open /dev/tty. Define LOCKPTY to add this
105 * If you'd rather see the status line on the first line of your
106 * terminal rather than the last, define TOPSTAT.
111 * define DETACH can detach a session. An absolute 'must'.
116 * here come the erlangen extensions to screen:
117 * define LOCK if you want to use a lock program for a screenlock.
118 * define PASSWORD for secure reattach of your screen.
119 * define COPY_PASTE to use the famous hacker's treasure zoo.
120 * define POW_DETACH to have a detach_and_logout key (requires DETACH).
121 * define REMOTE_DETACH (-d option) to move screen between terminals.
122 * define AUTO_NUKE to enable Tim MacKenzies clear screen nuking
123 * define PSEUDOS to allow window input/output filtering
124 * define MULTI to allow multiple attaches.
125 * define MULTIUSER to allow other users attach to your session
126 * (if they are in the acl, of course)
127 * define MAPKEYS to include input keyboard translation.
128 * define FONT to support ISO2022/alternet charset support
129 * define COLOR to include ansi color support. This may expose
130 * a bug in x11r6-color-xterm.
131 * define DW_CHARS to include support for double-width character
133 * define ENCODINGS to include support for encodings like euc or big5.
134 * Needs FONT to work.
135 * define UTF8 if you want support for UTF-8 encoding.
136 * Needs FONT and ENCODINGS to work.
137 * define COLORS16 if you want 16 colors.
138 * Needs COLOR to work.
139 * define BUILTIN_TELNET to add telnet support to screen.
140 * Syntax: screen //telnet host [port]
141 * define RXVT_OSC if you want support for rxvts special
142 * change fgcolor/bgcolor/bgpicture sequences
149 # define REMOTE_DETACH
164 #endif /* SIMPLESCREEN */
166 #undef BUILTIN_TELNET
172 * If you have a braille display you should define HAVE_BRAILLE.
173 * The code inside #ifdef HAVE_BRAILLE was contributed by Hadi Bargi
174 * Rangin (bargi@dots.physics.orst.edu).
175 * WARNING: this is more or less unsupported code, it may be full of
176 * bugs leading to security holes, enable at your own risk!
182 * As error messages are mostly meaningless to the user, we
183 * try to throw out phrases that are somewhat more familiar
184 * to ...well, at least familiar to us NetHack players.
188 #endif /* NONETHACK */
191 * If screen is installed with permissions to update /etc/utmp (such
192 * as if it is installed set-uid root), define UTMPOK.
196 /* Set LOGINDEFAULT to one (1)
197 * if you want entries added to /etc/utmp by default, else set it to
199 * LOGINDEFAULT will be one (1) whenever LOGOUTOK is undefined!
201 #define LOGINDEFAULT 1
203 /* Set LOGOUTOK to one (1)
204 * if you want the user to be able to log her/his windows out.
205 * (Meaning: They are there, but not visible in /etc/utmp).
206 * Disabling this feature only makes sense if you have a secure /etc/utmp
208 * Negative examples: suns usually have a world writable utmp file,
209 * xterm will run perfectly without s-bit.
211 * If LOGOUTOK is undefined and UTMPOK is defined, all windows are
212 * initially and permanently logged in.
214 * Set CAREFULUTMP to one (1) if you want that users have at least one
215 * window per screen session logged in.
222 * If UTMPOK is defined and your system (incorrectly) counts logins by
223 * counting non-null entries in /etc/utmp (instead of counting non-null
224 * entries with no hostname that are not on a pseudo tty), define USRLIMIT
225 * to have screen put an upper-limit on the number of entries to write
226 * into /etc/utmp. This helps to keep you from exceeding a limited-user
232 * both must be defined if you want to favor tcsendbreak over
233 * other calls to generate a break condition on serial lines.
234 * (Do not bother, if you are not using plain tty windows.)
236 #define POSIX_HAS_A_GOOD_TCSENDBREAK
237 #define SUNOS4_AND_WE_TRUST_TCSENDBREAK
240 * to lower the interrupt load on the host machine, you may want to
241 * adjust the VMIN and VTIME settings used for plain tty windows.
242 * See the termio(4) manual page (Non-Canonical Mode Input Processing)
244 * if undefined, VMIN=1, VTIME=0 is used as a default - this gives you
245 * best user responsiveness, but highest interrupt frequency.
246 * (Do not bother, if you are not using plain tty windows.)
252 * looks like the above values are ignored by setting FNDELAY.
253 * This is default for all pty/ttys, you may disable it for
254 * ttys here. After playing with it for a while, one may find out
255 * that this feature may cause screen to lock up.
258 # define TTY_DISABLE_FNBLOCK /* select barfs without it ... */
263 * Some terminals, e.g. Wyse 120, use a bitfield to select attributes.
264 * This doesn't work with the standard so/ul/m? terminal entries,
265 * because they will cancel each other out.
266 * On TERMINFO machines, "sa" (sgr) may work. If you want screen
267 * to switch attributes only with sgr, define USE_SGR.
268 * This is *not* recomended, do this only if you must.
274 * Define USE_LOCALE if you want screen to use the locale names
275 * for the name of the month and day of the week.
280 * Define USE_PAM if your system supports PAM (Pluggable Authentication
281 * Modules) and you want screen to use it instead of calling crypt().
282 * (You may also need to add -lpam to LIBS in the Makefile.)
287 * Define CHECK_SCREEN_W if you want screen to set TERM to screen-w
288 * if the terminal width is greater than 131 columns. No longer needed
289 * on modern systems which use $COLUMNS or the tty settings instead.
291 #undef CHECK_SCREEN_W
293 /**********************************************************************
295 * End of User Configuration Section
297 * Rest of this file is modified by 'configure'
298 * Change at your own risk!
303 * Some defines to identify special unix variants
309 /* #ifndef __osf__ */
327 #ifndef _POSIX_SOURCE
332 * Define POSIX if your system supports IEEE Std 1003.1-1988 (POSIX).
337 * Define BSDJOBS if you have BSD-style job control (both process
338 * groups and a tty that deals correctly with them).
343 * Define TERMIO if you have struct termio instead of struct sgttyb.
344 * This is usually the case for SVID systems, where BSD uses sgttyb.
345 * POSIX systems should define this anyway, even though they use
351 * Define CYTERMIO if you have cyrillic termio modes.
356 * Define TERMINFO if your machine emulates the termcap routines
357 * with the terminfo database.
358 * Thus the .screenrc file is parsed for
359 * the command 'terminfo' and not 'termcap'.
364 * If your library does not define ospeed, define this.
369 * Define SYSV if your machine is SYSV complient (Sys V, HPUX, A/UX)
376 * Define SIGVOID if your signal handlers return void. On older
377 * systems, signal returns int, but on newer ones, it returns void.
382 * Define USESIGSET if you have sigset for BSD 4.1 reliable signals.
387 * Define SYSVSIGS if signal handlers must be reinstalled after
388 * they have been called.
393 * Define BSDWAIT if your system defines a 'union wait' in <sys/wait.h>
395 * Only allow BSDWAIT i.e. wait3 on nonposix systems, since
396 * posix implies wait(3) and waitpid(3). vdlinden@fwi.uva.nl
404 * On RISCOS we prefer wait2() over wait3(). rouilj@sni-usa.com
411 * If your system has getutent(), pututline(), etc. to write to the
412 * utmp file, define GETUTENT.
417 * Define UTHOST if the utmp file has a host field.
422 * Define if you have the utempter utmp helper program
427 * If ttyslot() breaks getlogin() by returning indexes to utmp entries
428 * of type DEAD_PROCESS, then our getlogin() replacement should be
429 * selected by defining BUGGYGETLOGIN.
434 * If your system has the calls setreuid() and setregid(),
435 * define HAVE_SETREUID. Otherwise screen will use a forked process to
436 * safely create output files without retaining any special privileges.
438 #undef HAVE_SETRESUID
442 * If your system supports BSD4.4's seteuid() and setegid(), define
448 * execvpe is now defined in some systems.
453 * If you want the "time" command to display the current load average
454 * define LOADAV. Maybe you must install screen with the needed
455 * privileges to read /dev/kmem.
456 * Note that NLIST_ stuff is only checked, when getloadavg() is not available.
463 #undef LOADAV_GETLOADAVG
465 #undef LOADAV_AVENRUN
466 #undef LOADAV_USE_NLIST64
468 #undef NLIST_DECLARED
470 #undef NLIST_NAME_UNION
473 * If your system has the new format /etc/ttys (like 4.3 BSD) and the
474 * getttyent(3) library functions, define GETTTYENT.
479 * Define USEBCOPY if the bcopy/memcpy from your system's C library
480 * supports the overlapping of source and destination blocks. When
481 * undefined, screen uses its own (probably slower) version of bcopy().
483 * SYSV machines may have a working memcpy() -- Oh, this is
484 * quite unlikely. Tell me if you see one.
485 * "But then, memmove() should work, if at all available" he thought...
486 * Boing, never say "works everywhere" unless you checked SCO UNIX.
487 * Their memove fails the test in the configure script. Sigh. (Juergen)
494 * If your system has vsprintf() and requires the use of the macros in
495 * "varargs.h" to use functions with variable arguments,
501 * If the select return value doesn't treat a descriptor that is
502 * usable for reading and writing as two hits, define SELECT_BROKEN.
507 * Define this if your system supports named pipes.
512 * Define this if your system exits select() immediatly if a pipe is
513 * opened read-only and no writer has opened it.
518 * Define this if the unix-domain socket implementation doesn't
519 * create a socket in the filesystem.
521 #undef SOCK_NOT_IN_FS
524 * If your system has setenv() and unsetenv() define USESETENV
529 * If setenv() takes 3 arguments define HAVE_SETENV_3
534 * If setenv() takes 2 arguments define HAVE_SETENV_2
539 * If your system does not come with a setenv()/putenv()/getenv()
540 * functions, you may bring in our own code by defining NEEDPUTENV.
545 * If the passwords are stored in a shadow file and you want the
546 * builtin lock to work properly, define SHADOWPW.
551 * define HAVE_NL_LANGINFO if your system has the nl_langinfo() call
552 * and <langinfo.h> defines CODESET.
554 #undef HAVE_NL_LANGINFO
557 * Newer versions of Solaris include fdwalk, which can greatly improve
558 * the startup time of screen; otherwise screen spends a lot of time
559 * closing file descriptors.
564 * define HAVE_DEV_PTC if you have a /dev/ptc character special
570 * define HAVE_SVR4_PTYS if you have a /dev/ptmx character special
571 * device and support the ptsname(), grantpt(), unlockpt() functions.
573 #undef HAVE_SVR4_PTYS
576 * define PTYRANGE0 and or PTYRANGE1 if you want to adapt screen
577 * to unusual environments. E.g. For SunOs the defaults are "qpr" and
578 * "0123456789abcdef". For SunOs 4.1.2
579 * #define PTYRANGE0 "pqrstuvwxyzPQRST"
580 * is recommended by Dan Jacobson.