Wrap script related code with compiler directive.
[screen-lua.git] / src / acconfig.h
blobec641ce73b7372040ff3c13ef945173cdb3a13c7
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)
9 * any later version.
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 ****************************************************************
22 * $Id$ FAU
29 /**********************************************************************
31 * User Configuration Section
35 * Maximum of simultaneously allowed windows per screen session.
37 #ifndef MAXWIN
38 # define MAXWIN 40
39 #endif
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).
54 #undef SOCKDIR
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.
76 #define CHECKLOGIN 1
77 #undef NOSYSLOG
80 /*
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).
91 #undef PTYMODE
92 #undef PTYGROUP
93 #undef PTYROFS
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
100 * exclusive locking.
102 #undef LOCKPTY
105 * If you'd rather see the status line on the first line of your
106 * terminal rather than the last, define TOPSTAT.
108 #undef TOPSTAT
111 * define DETACH can detach a session. An absolute 'must'.
113 #define DETACH
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
132 * sets.
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
143 * define SCRIPT to add scripting support to screen.
145 #undef SIMPLESCREEN
146 #ifndef SIMPLESCREEN
147 # define LOCK
148 # define PASSWORD
149 # define COPY_PASTE
150 # define REMOTE_DETACH
151 # define POW_DETACH
152 # define AUTO_NUKE
153 # define PSEUDOS
154 # define MULTI
155 # define MULTIUSER
156 # define MAPKEYS
157 # define COLOR
158 # define FONT
159 # define DW_CHARS
160 # define ENCODINGS
161 # define UTF8
162 # define COLORS16
163 # define ZMODEM
164 # define BLANKER_PRG
165 # define SCRIPT
166 #endif /* SIMPLESCREEN */
168 #undef BUILTIN_TELNET
169 #undef RXVT_OSC
170 #undef COLORS256
174 * If you have a braille display you should define HAVE_BRAILLE.
175 * The code inside #ifdef HAVE_BRAILLE was contributed by Hadi Bargi
176 * Rangin (bargi@dots.physics.orst.edu).
177 * WARNING: this is more or less unsupported code, it may be full of
178 * bugs leading to security holes, enable at your own risk!
180 #undef HAVE_BRAILLE
184 * As error messages are mostly meaningless to the user, we
185 * try to throw out phrases that are somewhat more familiar
186 * to ...well, at least familiar to us NetHack players.
188 #ifndef NONETHACK
189 # define NETHACK
190 #endif /* NONETHACK */
193 * If screen is installed with permissions to update /etc/utmp (such
194 * as if it is installed set-uid root), define UTMPOK.
196 #define UTMPOK
198 /* Set LOGINDEFAULT to one (1)
199 * if you want entries added to /etc/utmp by default, else set it to
200 * zero (0).
201 * LOGINDEFAULT will be one (1) whenever LOGOUTOK is undefined!
203 #define LOGINDEFAULT 1
205 /* Set LOGOUTOK to one (1)
206 * if you want the user to be able to log her/his windows out.
207 * (Meaning: They are there, but not visible in /etc/utmp).
208 * Disabling this feature only makes sense if you have a secure /etc/utmp
209 * database.
210 * Negative examples: suns usually have a world writable utmp file,
211 * xterm will run perfectly without s-bit.
213 * If LOGOUTOK is undefined and UTMPOK is defined, all windows are
214 * initially and permanently logged in.
216 * Set CAREFULUTMP to one (1) if you want that users have at least one
217 * window per screen session logged in.
219 #define LOGOUTOK 1
220 #undef CAREFULUTMP
224 * If UTMPOK is defined and your system (incorrectly) counts logins by
225 * counting non-null entries in /etc/utmp (instead of counting non-null
226 * entries with no hostname that are not on a pseudo tty), define USRLIMIT
227 * to have screen put an upper-limit on the number of entries to write
228 * into /etc/utmp. This helps to keep you from exceeding a limited-user
229 * license.
231 #undef USRLIMIT
234 * both must be defined if you want to favor tcsendbreak over
235 * other calls to generate a break condition on serial lines.
236 * (Do not bother, if you are not using plain tty windows.)
238 #define POSIX_HAS_A_GOOD_TCSENDBREAK
239 #define SUNOS4_AND_WE_TRUST_TCSENDBREAK
242 * to lower the interrupt load on the host machine, you may want to
243 * adjust the VMIN and VTIME settings used for plain tty windows.
244 * See the termio(4) manual page (Non-Canonical Mode Input Processing)
245 * for details.
246 * if undefined, VMIN=1, VTIME=0 is used as a default - this gives you
247 * best user responsiveness, but highest interrupt frequency.
248 * (Do not bother, if you are not using plain tty windows.)
250 #define TTYVMIN 100
251 #define TTYVTIME 2
254 * looks like the above values are ignored by setting FNDELAY.
255 * This is default for all pty/ttys, you may disable it for
256 * ttys here. After playing with it for a while, one may find out
257 * that this feature may cause screen to lock up.
259 #ifdef bsdi
260 # define TTY_DISABLE_FNBLOCK /* select barfs without it ... */
261 #endif
265 * Some terminals, e.g. Wyse 120, use a bitfield to select attributes.
266 * This doesn't work with the standard so/ul/m? terminal entries,
267 * because they will cancel each other out.
268 * On TERMINFO machines, "sa" (sgr) may work. If you want screen
269 * to switch attributes only with sgr, define USE_SGR.
270 * This is *not* recomended, do this only if you must.
272 #undef USE_SGR
276 * Define USE_LOCALE if you want screen to use the locale names
277 * for the name of the month and day of the week.
279 #define USE_LOCALE
282 * Define USE_PAM if your system supports PAM (Pluggable Authentication
283 * Modules) and you want screen to use it instead of calling crypt().
284 * (You may also need to add -lpam to LIBS in the Makefile.)
286 #undef USE_PAM
289 * Define CHECK_SCREEN_W if you want screen to set TERM to screen-w
290 * if the terminal width is greater than 131 columns. No longer needed
291 * on modern systems which use $COLUMNS or the tty settings instead.
293 #undef CHECK_SCREEN_W
295 /**********************************************************************
297 * End of User Configuration Section
299 * Rest of this file is modified by 'configure'
300 * Change at your own risk!
305 * Some defines to identify special unix variants
307 #ifndef SVR4
308 #undef SVR4
309 #endif
311 /* #ifndef __osf__ */
312 #ifndef MIPS
313 #undef MIPS
314 #endif
315 /* #endif */
317 #ifndef OSX
318 #undef OSX
319 #endif
321 #ifndef ISC
322 #undef ISC
323 #endif
325 #ifndef sysV68
326 #undef sysV68
327 #endif
329 #ifndef _POSIX_SOURCE
330 #undef _POSIX_SOURCE
331 #endif
334 * Define POSIX if your system supports IEEE Std 1003.1-1988 (POSIX).
336 #undef POSIX
339 * Define BSDJOBS if you have BSD-style job control (both process
340 * groups and a tty that deals correctly with them).
342 #undef BSDJOBS
345 * Define TERMIO if you have struct termio instead of struct sgttyb.
346 * This is usually the case for SVID systems, where BSD uses sgttyb.
347 * POSIX systems should define this anyway, even though they use
348 * struct termios.
350 #undef TERMIO
353 * Define CYTERMIO if you have cyrillic termio modes.
355 #undef CYTERMIO
358 * Define TERMINFO if your machine emulates the termcap routines
359 * with the terminfo database.
360 * Thus the .screenrc file is parsed for
361 * the command 'terminfo' and not 'termcap'.
363 #undef TERMINFO
366 * If your library does not define ospeed, define this.
368 #undef NEED_OSPEED
371 * Define SYSV if your machine is SYSV complient (Sys V, HPUX, A/UX)
373 #ifndef SYSV
374 #undef SYSV
375 #endif
378 * Define SIGVOID if your signal handlers return void. On older
379 * systems, signal returns int, but on newer ones, it returns void.
381 #undef SIGVOID
384 * Define USESIGSET if you have sigset for BSD 4.1 reliable signals.
386 #undef USESIGSET
389 * Define SYSVSIGS if signal handlers must be reinstalled after
390 * they have been called.
392 #undef SYSVSIGS
395 * Define BSDWAIT if your system defines a 'union wait' in <sys/wait.h>
397 * Only allow BSDWAIT i.e. wait3 on nonposix systems, since
398 * posix implies wait(3) and waitpid(3). vdlinden@fwi.uva.nl
401 #ifndef POSIX
402 #undef BSDWAIT
403 #endif
406 * On RISCOS we prefer wait2() over wait3(). rouilj@sni-usa.com
408 #ifdef BSDWAIT
409 #undef USE_WAIT2
410 #endif
413 * If your system has getutent(), pututline(), etc. to write to the
414 * utmp file, define GETUTENT.
416 #undef GETUTENT
419 * Define UTHOST if the utmp file has a host field.
421 #undef UTHOST
424 * Define if you have the utempter utmp helper program
426 #undef HAVE_UTEMPTER
429 * If ttyslot() breaks getlogin() by returning indexes to utmp entries
430 * of type DEAD_PROCESS, then our getlogin() replacement should be
431 * selected by defining BUGGYGETLOGIN.
433 #undef BUGGYGETLOGIN
436 * If your system has the calls setreuid() and setregid(),
437 * define HAVE_SETREUID. Otherwise screen will use a forked process to
438 * safely create output files without retaining any special privileges.
440 #undef HAVE_SETRESUID
441 #undef HAVE_SETREUID
444 * If your system supports BSD4.4's seteuid() and setegid(), define
445 * HAVE_SETEUID.
447 #undef HAVE_SETEUID
450 * If you want the "time" command to display the current load average
451 * define LOADAV. Maybe you must install screen with the needed
452 * privileges to read /dev/kmem.
453 * Note that NLIST_ stuff is only checked, when getloadavg() is not available.
455 #undef LOADAV
457 #undef LOADAV_NUM
458 #undef LOADAV_TYPE
459 #undef LOADAV_SCALE
460 #undef LOADAV_GETLOADAVG
461 #undef LOADAV_UNIX
462 #undef LOADAV_AVENRUN
463 #undef LOADAV_USE_NLIST64
465 #undef NLIST_DECLARED
466 #undef NLIST_STRUCT
467 #undef NLIST_NAME_UNION
470 * If your system has the new format /etc/ttys (like 4.3 BSD) and the
471 * getttyent(3) library functions, define GETTTYENT.
473 #undef GETTTYENT
476 * Define USEBCOPY if the bcopy/memcpy from your system's C library
477 * supports the overlapping of source and destination blocks. When
478 * undefined, screen uses its own (probably slower) version of bcopy().
480 * SYSV machines may have a working memcpy() -- Oh, this is
481 * quite unlikely. Tell me if you see one.
482 * "But then, memmove() should work, if at all available" he thought...
483 * Boing, never say "works everywhere" unless you checked SCO UNIX.
484 * Their memove fails the test in the configure script. Sigh. (Juergen)
486 #undef USEBCOPY
487 #undef USEMEMCPY
488 #undef USEMEMMOVE
491 * If your system has vsprintf() and requires the use of the macros in
492 * "varargs.h" to use functions with variable arguments,
493 * define USEVARARGS.
495 #undef USEVARARGS
498 * If the select return value doesn't treat a descriptor that is
499 * usable for reading and writing as two hits, define SELECT_BROKEN.
501 #undef SELECT_BROKEN
504 * Define this if your system supports named pipes.
506 #undef NAMEDPIPE
509 * Define this if your system exits select() immediatly if a pipe is
510 * opened read-only and no writer has opened it.
512 #undef BROKEN_PIPE
515 * Define this if the unix-domain socket implementation doesn't
516 * create a socket in the filesystem.
518 #undef SOCK_NOT_IN_FS
521 * If your system has setenv() and unsetenv() define USESETENV
523 #undef USESETENV
526 * If setenv() takes 3 arguments sefine HAVE_SETENV_3
528 #undef HAVE_SETENV_3
531 * If setenv() takes 2 arguments sefine HAVE_SETENV_2
533 #undef HAVE_SETENV_2
536 * If your system does not come with a setenv()/putenv()/getenv()
537 * functions, you may bring in our own code by defining NEEDPUTENV.
539 #undef NEEDPUTENV
542 * If the passwords are stored in a shadow file and you want the
543 * builtin lock to work properly, define SHADOWPW.
545 #undef SHADOWPW
548 * define HAVE_NL_LANGINFO if your system has the nl_langinfo() call
549 * and <langinfo.h> defines CODESET.
551 #undef HAVE_NL_LANGINFO
554 * Newer versions of Solaris include fdwalk, which can greatly improve
555 * the startup time of screen; otherwise screen spends a lot of time
556 * closing file descriptors.
558 #undef HAVE_FDWALK
561 * define HAVE_DEV_PTC if you have a /dev/ptc character special
562 * device.
564 #undef HAVE_DEV_PTC
567 * define HAVE_SVR4_PTYS if you have a /dev/ptmx character special
568 * device and support the ptsname(), grantpt(), unlockpt() functions.
570 #undef HAVE_SVR4_PTYS
573 * define PTYRANGE0 and or PTYRANGE1 if you want to adapt screen
574 * to unusual environments. E.g. For SunOs the defaults are "qpr" and
575 * "0123456789abcdef". For SunOs 4.1.2
576 * #define PTYRANGE0 "pqrstuvwxyzPQRST"
577 * is recommended by Dan Jacobson.
579 #undef PTYRANGE0
580 #undef PTYRANGE1