6ca5ebd6b2b095817fd21e3ebb518983e4826806
[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, 2009, 2010, 2011 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 USG5 */
29 /* #define USG */
30 /* #define HPUX */
31 /* #define BSD4_2 */
32 /* #define BSD4_3 */
33 /* #define BSD_SYSTEM */
34
35 /* SYSTEM_TYPE should indicate the kind of system you are using.
36 It sets the Lisp variable system-type. */
37
38 #define SYSTEM_TYPE "berkeley-unix"
39
40 /* NOMULTIPLEJOBS should be defined if your system's shell
41 does not have "job control" (the ability to stop a program,
42 run some other program, then continue the first one). */
43
44 /* #define NOMULTIPLEJOBS */
45
46 /* Emacs can read input using SIGIO and buffering characters itself,
47 or using CBREAK mode and making C-g cause SIGINT.
48 The choice is controlled by the variable interrupt_input.
49
50 Define INTERRUPT_INPUT to make interrupt_input = 1 the default (use SIGIO)
51
52 Emacs uses the presence or absence of the SIGIO and BROKEN_SIGIO macros
53 to indicate whether or not signal-driven I/O is possible. It uses
54 INTERRUPT_INPUT to decide whether to use it by default.
55
56 SIGIO can be used only on systems that implement it (4.2 and 4.3).
57 CBREAK mode has two disadvantages
58 1) At least in 4.2, it is impossible to handle the Meta key properly.
59 I hear that in system V this problem does not exist.
60 2) Control-G causes output to be discarded.
61 I do not know whether this can be fixed in system V.
62
63 Another method of doing input is planned but not implemented.
64 It would have Emacs fork off a separate process
65 to read the input and send it to the true Emacs process
66 through a pipe. */
67
68 #define INTERRUPT_INPUT
69
70 /* Letter to use in finding device name of first pty,
71 if system supports pty's. 'a' means it is /dev/ptya0 */
72
73 #define FIRST_PTY_LETTER 'a'
74
75 /*
76 * Define HAVE_TERMIOS if the system provides POSIX-style
77 * functions and macros for terminal control.
78 *
79 * Define HAVE_TERMIO if the system provides sysV-style ioctls
80 * for terminal control.
81 *
82 * Do not define both. HAVE_TERMIOS is preferred, if it is
83 * supported on your system.
84 */
85
86 #define HAVE_TERMIOS
87 /* #define HAVE_TERMIO */
88
89 /*
90 * Define HAVE_PTYS if the system supports pty devices.
91 */
92
93 #define HAVE_PTYS
94
95 /* Define this symbol if your system has the functions bcopy, etc. */
96
97 #define BSTRING
98
99 /* subprocesses should be undefined if you do NOT want to
100 have code for asynchronous subprocesses
101 (as used in M-x compile and M-x shell).
102 Currently only MSDOS does not support this. */
103
104 /* #undef subprocesses */
105
106 /* If your system uses COFF (Common Object File Format) then define the
107 preprocessor symbol "COFF". */
108
109 /* #define COFF */
110
111 /* define MAIL_USE_FLOCK if the mailer uses flock
112 to interlock access to /usr/spool/mail/$USER.
113 The alternative is that a lock file named
114 /usr/spool/mail/$USER.lock. */
115
116 #define MAIL_USE_FLOCK
117
118 /* Define CLASH_DETECTION if you want lock files to be written
119 so that Emacs can tell instantly when you try to modify
120 a file that someone else has modified in his Emacs. */
121
122 #define CLASH_DETECTION
123
124 /* Define this if your operating system declares signal handlers to
125 have a type other than the usual. `The usual' is `void' for ANSI C
126 systems (i.e. when the __STDC__ macro is defined), and `int' for
127 pre-ANSI systems. If you're using GCC on an older system, __STDC__
128 will be defined, but the system's include files will still say that
129 signal returns int or whatever; in situations like that, define
130 this to be what the system's include files want. */
131 /* #define SIGTYPE int */
132
133 /* If the character used to separate elements of the executable path
134 is not ':', #define this to be the appropriate character constant. */
135 /* #define SEPCHAR ':' */
136
137 /* Define this if the system can use mmap for buffer text allocation. */
138 /* #define USE_MMAP_FOR_BUFFERS 1 */
139
140 /* ============================================================ */
141
142 /* Here, add any special hacks needed
143 to make Emacs work on this system. For example,
144 you might define certain system call names that don't
145 exist on your system, or that do different things on
146 your system and must be used only through an encapsulation
147 (Which you should place, by convention, in sysdep.c). */
148
149 /* If the system's imake configuration file defines `NeedWidePrototypes'
150 as `NO', we must define NARROWPROTO manually. Such a define is
151 generated in the Makefile generated by `xmkmf'. If we don't
152 define NARROWPROTO, we will see the wrong function prototypes
153 for X functions taking float or double parameters. */
154
155 /* #define NARROWPROTO 1 */
156
157 /* ============================================================ */
158
159 /* After adding support for a new system, modify the large case
160 statement in the `configure' script to recognize reasonable
161 configuration names, and add a description of the system to
162 `etc/MACHINES'.
163
164 If you've just fixed a problem in an existing configuration file,
165 you should also check `etc/MACHINES' to make sure its descriptions
166 of known problems in that configuration should be updated. */
167
168 /* arch-tag: 4b426b11-cb2e-4c0e-a488-e663f76a0515
169 (do not change this comment) */