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