C-x 5 1
[emacs.git] / src / s / template.h
blob070e5ed259f14a975f5cd247dcdc43b69e6a32ea
1 /* Template for system description header files.
2 This file describes the parameters that system description files
3 should define or not.
4 Copyright (C) 1985, 1986, 1992, 1999 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
25 * Define symbols to identify the version of Unix this is.
26 * Define all the symbols that apply correctly.
29 /* #define UNIPLUS */
30 /* #define USG5 */
31 /* #define USG */
32 /* #define HPUX */
33 /* #define UMAX */
34 /* #define BSD4_1 */
35 /* #define BSD4_2 */
36 /* #define BSD4_3 */
37 /* #define BSD_SYSTEM */
38 /* #define VMS */
40 /* SYSTEM_TYPE should indicate the kind of system you are using.
41 It sets the Lisp variable system-type. */
43 #define SYSTEM_TYPE "berkeley-unix"
45 /* NOMULTIPLEJOBS should be defined if your system's shell
46 does not have "job control" (the ability to stop a program,
47 run some other program, then continue the first one). */
49 /* #define NOMULTIPLEJOBS */
51 /* Emacs can read input using SIGIO and buffering characters itself,
52 or using CBREAK mode and making C-g cause SIGINT.
53 The choice is controlled by the variable interrupt_input.
55 Define INTERRUPT_INPUT to make interrupt_input = 1 the default (use SIGIO)
57 Emacs uses the presence or absence of the SIGIO and BROKEN_SIGIO macros
58 to indicate whether or not signal-driven I/O is possible. It uses
59 INTERRUPT_INPUT to decide whether to use it by default.
61 SIGIO can be used only on systems that implement it (4.2 and 4.3).
62 CBREAK mode has two disadvantages
63 1) At least in 4.2, it is impossible to handle the Meta key properly.
64 I hear that in system V this problem does not exist.
65 2) Control-G causes output to be discarded.
66 I do not know whether this can be fixed in system V.
68 Another method of doing input is planned but not implemented.
69 It would have Emacs fork off a separate process
70 to read the input and send it to the true Emacs process
71 through a pipe. */
73 #define INTERRUPT_INPUT
75 /* Letter to use in finding device name of first pty,
76 if system supports pty's. 'a' means it is /dev/ptya0 */
78 #define FIRST_PTY_LETTER 'a'
81 * Define HAVE_TERMIOS if the system provides POSIX-style
82 * functions and macros for terminal control.
84 * Define HAVE_TERMIO if the system provides sysV-style ioctls
85 * for terminal control.
87 * Do not define both. HAVE_TERMIOS is preferred, if it is
88 * supported on your system.
91 #define HAVE_TERMIOS
92 /* #define HAVE_TERMIO */
95 * Define HAVE_PTYS if the system supports pty devices.
98 #define HAVE_PTYS
101 * Define NONSYSTEM_DIR_LIBRARY to make Emacs emulate
102 * The 4.2 opendir, etc., library functions.
105 #define NONSYSTEM_DIR_LIBRARY
107 /* Define this symbol if your system has the functions bcopy, etc. */
109 #define BSTRING
111 /* subprocesses should be defined if you want to
112 have code for asynchronous subprocesses
113 (as used in M-x compile and M-x shell).
114 This is generally OS dependent, and not supported
115 under most USG systems. */
117 #define subprocesses
119 /* If your system uses COFF (Common Object File Format) then define the
120 preprocessor symbol "COFF". */
122 /* #define COFF */
124 /* define MAIL_USE_FLOCK if the mailer uses flock
125 to interlock access to /usr/spool/mail/$USER.
126 The alternative is that a lock file named
127 /usr/spool/mail/$USER.lock. */
129 #define MAIL_USE_FLOCK
131 /* Define CLASH_DETECTION if you want lock files to be written
132 so that Emacs can tell instantly when you try to modify
133 a file that someone else has modified in his Emacs. */
135 #define CLASH_DETECTION
137 /* Define this if your operating system declares signal handlers to
138 have a type other than the usual. `The usual' is `void' for ANSI C
139 systems (i.e. when the __STDC__ macro is defined), and `int' for
140 pre-ANSI systems. If you're using GCC on an older system, __STDC__
141 will be defined, but the system's include files will still say that
142 signal returns int or whatever; in situations like that, define
143 this to be what the system's include files want. */
144 /* #define SIGTYPE int */
146 /* If the character used to separate elements of the executable path
147 is not ':', #define this to be the appropriate character constant. */
148 /* #define SEPCHAR ':' */
150 /* ============================================================ */
152 /* Here, add any special hacks needed
153 to make Emacs work on this system. For example,
154 you might define certain system call names that don't
155 exist on your system, or that do different things on
156 your system and must be used only through an encapsulation
157 (Which you should place, by convention, in sysdep.c). */
159 /* Some compilers tend to put everything declared static
160 into the initialized data area, which becomes pure after dumping Emacs.
161 On these systems, you must #define static as nothing to foil this.
162 Note that emacs carefully avoids static vars inside functions. */
164 /* #define static */
166 /* If the system's imake configuration file defines `NeedWidePrototypes'
167 as `NO', we must define NARROWPROTO manually. Such a define is
168 generated in the Makefile generated by `xmkmf'. If we don't
169 define NARROWPROTO, we will see the wrong function prototypes
170 for X functions taking float or double parameters. */
172 /* #define NARROWPROTO 1 */
174 /* ============================================================ */
176 /* After adding support for a new system, modify the large case
177 statement in the `configure' script to recognize reasonable
178 configuration names, and add a description of the system to
179 `etc/MACHINES'.
181 If you've just fixed a problem in an existing configuration file,
182 you should also check `etc/MACHINES' to make sure its descriptions
183 of known problems in that configuration should be updated. */