Doc fixes.
[emacs.git] / src / config.in
blobd462b75425b6b8d8ea6d8a0025f5676ed28357b2
1 /* GNU Emacs site configuration template file.  -*- C -*-
2    Copyright (C) 1988, 1993, 1994, 1999, 2000 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs 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 2, or (at your option)
9 any later version.
11 GNU Emacs 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 GNU Emacs; see the file COPYING.  If not, write to the
18 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA.  */
22 /* No code in Emacs #includes config.h twice, but some of the code
23    intended to work with other packages as well (like gmalloc.c) 
24    think they can include it as many times as they like.  */
25 #ifndef EMACS_CONFIG_H
26 #define EMACS_CONFIG_H
28 /* These are all defined in the top-level Makefile by configure.
29    They're here only for reference.  */
31 /* Define GNU_MALLOC if you want to use the GNU memory allocator. */
32 #undef GNU_MALLOC
34 /* Define if you are using the GNU C Library. */
35 #undef DOUG_LEA_MALLOC
37 /* Define REL_ALLOC if you want to use the relocating allocator for
38    buffer space. */
39 #undef REL_ALLOC
40   
41 /* Define HAVE_X_WINDOWS if you want to use the X window system.  */
42 #undef HAVE_X_WINDOWS
44 /* Define HAVE_X11 if you want to use version 11 of X windows.
45    Otherwise, Emacs expects to use version 10.  */
46 #undef HAVE_X11
48 /* Define if using an X toolkit.  */
49 #undef USE_X_TOOLKIT
51 /* Define this if you're using XFree386.  */
52 #undef HAVE_XFREE386
54 /* Define this if you have Motif 2.1 or newer.  */
55 #undef HAVE_MOTIF_2_1
57 /* Define HAVE_MENUS if you have mouse menus.
58    (This is automatic if you use X, but the option to specify it remains.)
59    It is also defined with other window systems that support xmenu.c.  */
60 #undef HAVE_MENUS
62 /* Define if we have the X11R6 or newer version of Xt.  */
63 #undef HAVE_X11XTR6
65 /* Define if we have the X11R6 or newer version of Xlib.  */
66 #undef HAVE_X11R6
68 /* Define if we have the X11R5 or newer version of Xlib.  */
69 #undef HAVE_X11R5
71 /* Define if we have the XPM libary.  */
72 #undef HAVE_XPM
74 /* Define if we have the PNG library.  */
75 #undef HAVE_PNG
77 /* Define if we have the JPEG library.  */
78 #undef HAVE_JPEG
80 /* Define if we have the TIFF library.  */
81 #undef HAVE_TIFF
83 /* Define if we have the GIF library.  */
84 #undef HAVE_GIF
86 /* Define if libXaw3d is available.  */
87 #undef HAVE_XAW3D
89 /* Define if we should use toolkit scroll bars.  */
90 #undef USE_TOOLKIT_SCROLL_BARS
92 /* Define if we should use XIM, if it is available.  */
93 #undef USE_XIM
95 /* Define if netdb.h declares h_errno.  */
96 #undef HAVE_H_ERRNO
98 /* If we're using any sort of window system, define some consequences.  */
99 #ifdef HAVE_X_WINDOWS
100 #define HAVE_WINDOW_SYSTEM
101 #define MULTI_KBOARD
102 #define HAVE_MOUSE
103 #endif
105 /* Define USER_FULL_NAME to return a string
106    that is the user's full name.
107    It can assume that the variable `pw'
108    points to the password file entry for this user.
110    At some sites, the pw_gecos field contains
111    the user's full name.  If neither this nor any other
112    field contains the right thing, use pw_name,
113    giving the user's login name, since that is better than nothing.  */
114 #define USER_FULL_NAME pw->pw_gecos
116 /* Define AMPERSAND_FULL_NAME if you use the convention
117    that & in the full name stands for the login id.  */
118 /* Turned on June 1996 supposing nobody will mind it.  */
119 #define AMPERSAND_FULL_NAME
121 /* Things set by --with options in the configure script.  */
123 /* Define to support POP mail retrieval.  */
124 #undef MAIL_USE_POP
126 /* Define to support Kerberos-authenticated POP mail retrieval.  */
127 #undef KERBEROS
128 /* Define to use Kerberos 5 instead of Kerberos 4 */
129 #undef KERBEROS5
130 /* Define to support GSS-API in addition to (or instead of) Kerberos */
131 #undef GSSAPI
133 /* Define to support using a Hesiod database to find the POP server.  */
134 #undef HESIOD
136 /* Header for Voxware or PCM sound card driver.  */
137 #undef HAVE_MACHINE_SOUNDCARD_H
138 #undef HAVE_SYS_SOUNDCARD_H
139 #undef HAVE_SOUNDCARD_H
141 /* Define HAVE_SOUND if we have sound support.  We know it works
142    and compiles only on the specified platforms.   For others,
143    it probably doesn't make sense to try.  */
145 #if defined __FreeBSD__ || defined __NetBSD__ || defined __linux__
146 #ifdef HAVE_MACHINE_SOUNDCARD_H
147 #define HAVE_SOUND 1
148 #endif
149 #ifdef HAVE_SYS_SOUNDCARD_H
150 #define HAVE_SOUND 1
151 #endif
152 #ifdef HAVE_SOUNDCARD_H
153 #define HAVE_SOUND 1
154 #endif
155 #endif /* __FreeBSD__ || __NetBSD__ || __linux__  */
157 /* Some things figured out by the configure script, grouped as they are in
158    configure.in.  */
159 #ifndef _ALL_SOURCE  /* suppress warning if this is pre-defined */
160 #undef _ALL_SOURCE
161 #endif
163 #undef HAVE_SYS_SELECT_H
164 #undef HAVE_SYS_TIMEB_H
165 #undef HAVE_SYS_TIME_H
166 #undef HAVE_UNISTD_H
167 #undef HAVE_UTIME_H
168 #undef HAVE_LINUX_VERSION_H
169 #undef HAVE_SYS_SYSTEMINFO_H
170 #undef HAVE_TERMIOS_H
171 #undef HAVE_LIMITS_H
172 #undef HAVE_STRING_H
173 #undef HAVE_STDLIB_H
174 #undef HAVE_TERMCAP_H
175 #undef HAVE_TERM_H
176 #undef HAVE_STDIO_EXT_H
177 #undef STDC_HEADERS
178 #undef TIME_WITH_SYS_TIME
179 #undef HAVE_VFORK_H
180 #undef HAVE_FCNTL_H
181 #undef HAVE_SETITIMER
182 #undef HAVE_UALARM
183 #undef HAVE_SYS_WAIT_H
184 #undef HAVE_STRINGS_H
186 #undef HAVE_LIBDNET
187 #undef HAVE_LIBPTHREADS
188 #undef HAVE_LIBRESOLV
189 #undef HAVE_LIBXMU
190 #undef HAVE_LIBNCURSES
191 #undef HAVE_LIBINTL
192 #undef HAVE_LIBXP
194 /* movemail Kerberos support */
195 /* libraries */
196 #undef HAVE_LIBKRB
197 #undef HAVE_LIBKRB4
198 #undef HAVE_LIBDES
199 #undef HAVE_LIBDES425
200 #undef HAVE_LIBKRB5
201 #undef HAVE_LIBCRYPTO
202 #undef HAVE_LIBCOM_ERR
203 /* header files */
204 #undef HAVE_KRB5_H
205 #undef HAVE_DES_H
206 #undef HAVE_KRB_H
207 #undef HAVE_KERBEROSIV_DES_H
208 #undef HAVE_KERBEROSIV_KRB_H
209 #undef HAVE_KERBEROS_DES_H
210 #undef HAVE_KERBEROS_KRB_H
211 #undef HAVE_COM_ERR_H
213 /* GSS-API libraries and headers */
214 #undef HAVE_LIBGSSAPI_KRB5
215 #undef HAVE_LIBGSSAPI
216 #undef HAVE_GSSAPI_H
218 /* Mail-file locking */
219 #undef HAVE_LIBMAIL
220 #undef HAVE_MAILLOCK_H
221 #undef HAVE_TOUCHLOCK
223 #undef HAVE_ALLOCA_H
225 #undef HAVE_DEV_PTMX
227 #undef HAVE_GETTIMEOFDAY
228 /* If we don't have gettimeofday,
229    the test for GETTIMEOFDAY_ONE_ARGUMENT may succeed,
230    but we should ignore it.  */
231 #ifdef HAVE_GETTIMEOFDAY
232 #undef GETTIMEOFDAY_ONE_ARGUMENT
233 #endif
234 #undef HAVE_GETHOSTNAME
235 #undef HAVE_GETDOMAINNAME
236 #undef HAVE_DUP2
237 #undef HAVE_RENAME
238 #undef HAVE_CLOSEDIR
240 #undef TM_IN_SYS_TIME
241 #undef HAVE_TM_ZONE
242 #undef HAVE_TZNAME
243 #undef HAVE_TM_GMTOFF
245 #undef const
247 #undef HAVE_LONG_FILE_NAMES
249 #undef CRAY_STACKSEG_END
251 #undef UNEXEC_SRC
253 #undef HAVE_LIBXBSD
254 #undef HAVE_XRMSETDATABASE
255 #undef HAVE_XSCREENRESOURCESTRING
256 #undef HAVE_XSCREENNUMBEROFSCREEN
257 #undef HAVE_XSETWMPROTOCOLS
258 #undef HAVE_XKBGETKEYBOARD
260 #undef HAVE_MKDIR
261 #undef HAVE_RMDIR
262 #undef HAVE_SYSINFO
263 #undef HAVE_RANDOM
264 #undef HAVE_LRAND48
265 #undef HAVE_BCOPY
266 #undef HAVE_BCMP
267 #undef HAVE_LOGB
268 #undef HAVE_FREXP
269 #undef HAVE_FMOD
270 #undef HAVE_RINT
271 #undef HAVE_CBRT
272 #undef HAVE_FTIME
273 #undef HAVE_RES_INIT /* For -lresolv on Suns.  */
274 #undef HAVE_SETSID
275 #undef HAVE_FPATHCONF
276 #undef HAVE_SELECT
277 #undef HAVE_MKTIME
278 #undef BROKEN_MKTIME            /* have mktime but it's broken */
279 #undef HAVE_EUIDACCESS
280 #undef HAVE_GETPAGESIZE
281 #undef HAVE_TZSET
282 #undef HAVE_SETLOCALE
283 #undef HAVE_UTIMES
284 #undef HAVE_SETRLIMIT
285 #undef HAVE_SETPGID
286 #undef HAVE_GETCWD
287 #undef HAVE_GETWD
288 #undef HAVE_SHUTDOWN
289 #undef HAVE_STRFTIME
290 #undef HAVE_GETADDRINFO
291 #undef HAVE___FPENDING
292 #undef HAVE_FSEEKO
293 #undef HAVE_GETLOADAVG
294 #undef NLIST_STRUCT
295 #undef NLIST_NAME_UNION
296 #undef HAVE_MBLEN
297 #undef HAVE_MBRLEN
298 #undef HAVE_STRSIGNAL
299 #undef HAVE_GRANTPT
300 #undef HAVE_GETPT
301 #undef HAVE_SPEED_T             /* speed_t typedef in termios.h */
302 #undef HAVE_STRUCT_TIMEZONE
303 #undef HAVE_INDEX
304 #undef HAVE_RINDEX
305 #undef HAVE_MMAP
306 #undef HAVE_GAI_STRERROR
307 #undef HAVE_MKSTEMP
309 #undef LOCALTIME_CACHE
310 #undef HAVE_INET_SOCKETS
312 #undef HAVE_AIX_SMT_EXP
314 #undef vfork
315 #undef size_t
317 /* Define if you have the ANSI `strerror' function.
318    Otherwise you must have the variable `char *sys_errlist[]'.  */
319 #undef HAVE_STRERROR
321 /* Define if `sys_siglist' is declared by <signal.h>.  */
322 #undef SYS_SIGLIST_DECLARED
324 /* Define if `struct utimbuf' is declared by <utime.h>.  */
325 #undef HAVE_STRUCT_UTIMBUF
327 /* Define if `struct timeval' is declared by <sys/time.h>.  */
328 #undef HAVE_TIMEVAL
330 /* If using GNU, then support inline function declarations. */
331 /* Don't try to switch on inline handling as detected by AC_C_INLINE
332    generally, because even if non-gcc compilers accept `inline', they
333    may reject `extern inline'.  */
334 #ifdef __GNUC__
335 #define INLINE __inline__
336 #else
337 #define INLINE
338 #endif
340 /* Define this if you don't have struct exception in math.h.  */
341 #undef NO_MATHERR
343 /* Define as `void' if your compiler accepts `void *'; otherwise
344    define as `char'.  */
345 #undef POINTER_TYPE
346 #define PTR POINTER_TYPE *      /* For strftime.c.  */
348 /* Number of bits in a file offset, on hosts where this is settable.  */
349 #undef _FILE_OFFSET_BITS
350 /* Define to make ftello visible on some hosts (e.g. HP-UX 10.20).  */
351 #undef _LARGEFILE_SOURCE
352 /* Define for large files, on AIX-style hosts.  */
353 #undef _LARGE_FILES
355 #undef EMACS_CONFIGURATION
357 #undef EMACS_CONFIG_OPTIONS
359 /* The configuration script defines opsysfile to be the name of the
360    s/SYSTEM.h file that describes the system type you are using.  The file
361    is chosen based on the configuration name you give.
363    See the file ../etc/MACHINES for a list of systems and the
364    configuration names to use for them.
366    See s/template.h for documentation on writing s/SYSTEM.h files.  */
367 #undef config_opsysfile 
368 #include config_opsysfile
370 /* The configuration script defines machfile to be the name of the
371    m/MACHINE.h file that describes the machine you are using.  The file is
372    chosen based on the configuration name you give.
374    See the file ../etc/MACHINES for a list of machines and the
375    configuration names to use for them.
377    See m/template.h for documentation on writing m/MACHINE.h files.  */
378 #undef config_machfile
379 #include config_machfile
381 /* Load in the conversion definitions if this system
382    needs them and the source file being compiled has not
383    said to inhibit this.  There should be no need for you
384    to alter these lines.  */
386 #ifdef SHORTNAMES
387 #ifndef NO_SHORTNAMES
388 #include "../shortnames/remap.h"
389 #endif /* not NO_SHORTNAMES */
390 #endif /* SHORTNAMES */
392 /* If no remapping takes place, static variables cannot be dumped as
393    pure, so don't worry about the `static' keyword. */
394 #ifdef NO_REMAP
395 #undef static
396 #endif
398 /* Define `subprocesses' should be defined if you want to
399    have code for asynchronous subprocesses
400    (as used in M-x compile and M-x shell).
401    These do not work for some USG systems yet;
402    for the ones where they work, the s/SYSTEM.h file defines this flag.  */
404 #ifndef VMS
405 #ifndef USG
406 /* #define subprocesses */
407 #endif
408 #endif
410 /* Define LD_SWITCH_SITE to contain any special flags your loader may need.  */
411 #undef LD_SWITCH_SITE
413 /* Define C_SWITCH_SITE to contain any special flags your compiler needs.  */
414 #undef C_SWITCH_SITE
416 /* Define LD_SWITCH_X_SITE to contain any special flags your loader
417    may need to deal with X Windows.  For instance, if you've defined
418    HAVE_X_WINDOWS above and your X libraries aren't in a place that
419    your loader can find on its own, you might want to add "-L/..." or
420    something similar.  */
421 #undef LD_SWITCH_X_SITE
423 /* Define LD_SWITCH_X_SITE_AUX with an -R option
424    in case it's needed (for Solaris, for example).  */
425 #undef LD_SWITCH_X_SITE_AUX
427 /* Define C_SWITCH_X_SITE to contain any special flags your compiler
428    may need to deal with X Windows.  For instance, if you've defined
429    HAVE_X_WINDOWS above and your X include files aren't in a place
430    that your compiler can find on its own, you might want to add
431    "-I/..." or something similar.  */
432 #undef C_SWITCH_X_SITE
434 /* Define STACK_DIRECTION here, but not if m/foo.h did.  */
435 #ifndef STACK_DIRECTION
436 #undef STACK_DIRECTION
437 #endif
439 /* Define the return type of signal handlers if the s-xxx file
440    did not already do so.  */
441 #define RETSIGTYPE void
443 /* SIGTYPE is the macro we actually use.  */
444 #ifndef SIGTYPE
445 #define SIGTYPE RETSIGTYPE
446 #endif
448 #ifdef emacs /* Don't do this for lib-src.  */
449 /* Tell regex.c to use a type compatible with Emacs.  */
450 #define RE_TRANSLATE_TYPE Lisp_Object
451 #define RE_TRANSLATE(TBL, C) CHAR_TABLE_TRANSLATE (TBL, C)
452 #define RE_TRANSLATE_P(TBL) (XFASTINT (TBL) != 0)
453 #endif
455 /* Avoid link-time collision with system mktime if we will use our own.  */
456 #if ! HAVE_MKTIME || BROKEN_MKTIME
457 #define mktime emacs_mktime
458 #endif
460 /* The rest of the code currently tests the CPP symbol BSTRING.
461    Override any claims made by the system-description files.
462    Note that on some SCO version it is possible to have bcopy and not bcmp.  */
463 #undef BSTRING
464 #if defined (HAVE_BCOPY) && defined (HAVE_BCMP)
465 #define BSTRING
466 #endif
468 /* Define to empty if the keyword `volatile' does not work.  Warning:
469    valid code using `volatile' can become incorrect without.  Disable
470    with care. */
471 #undef volatile
473 /* Some of the files of Emacs which are intended for use with other
474    programs assume that if you have a config.h file, you must declare
475    the type of getenv.
477    This declaration shouldn't appear when alloca.s or Makefile.in
478    includes config.h.  */
479 #ifndef NOT_C_CODE
480 extern char *getenv ();
481 #endif
483 #endif /* EMACS_CONFIG_H */
485 /* These default definitions are good for almost all machines.
486    The exceptions override them in m/MACHINE.h.  */
488 #ifndef BITS_PER_CHAR
489 #define BITS_PER_CHAR 8
490 #endif
492 #ifndef BITS_PER_SHORT
493 #define BITS_PER_SHORT 16
494 #endif
496 /* Note that lisp.h uses this in a preprocessor conditional, so it
497    would not work to use sizeof.  That being so, we do all of them
498    without sizeof, for uniformity's sake.  */
499 #ifndef BITS_PER_INT
500 #define BITS_PER_INT 32
501 #endif
503 #ifndef BITS_PER_LONG
504 #ifdef _LP64
505 #define BITS_PER_LONG 64
506 #else
507 #define BITS_PER_LONG 32
508 #endif
509 #endif
511 /* Define if the compiler supports function prototypes.  It may do so
512    but not define __STDC__ (e.g. DEC C by default) or may define it as
513    zero.  */
514 #undef PROTOTYPES
515 /* For mktime.c:  */
516 #ifndef __P
517 # if defined PROTOTYPES
518 #  define __P(args) args
519 # else
520 #  define __P(args) ()
521 # endif  /* GCC.  */
522 #endif /* __P */
525 /* Don't include "string.h" or <stdlib.h> in non-C code.  */
526 #ifndef NOT_C_CODE
527 #ifdef HAVE_STRING_H
528 #include "string.h"
529 #endif
530 #ifdef HAVE_STDLIB_H
531 #include <stdlib.h>
532 #endif
533 #endif
535 /* Define HAVE_X_I18N if we have usable i18n support.  */
537 #ifdef HAVE_X11R6
538 #define HAVE_X_I18N
539 #elif defined HAVE_X11R5 && !defined X11R5_INHIBIT_I18N
540 #define HAVE_X_I18N
541 #endif
543 /* Define HAVE_X11R6_XIM if we have usable X11R6-style XIM support.  */
545 #if defined HAVE_X11R6 && !defined INHIBIT_X11R6_XIM
546 #define HAVE_X11R6_XIM
547 #endif
549 /* Should we enable expensive run-time checking of data types?  */
550 #undef ENABLE_CHECKING
552 #if defined __GNUC__ && (__GNUC__ > 2 \
553                          || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5))
554 #define NO_RETURN       __attribute__ ((__noreturn__))
555 #else
556 #define NO_RETURN       /* nothing */
557 #endif