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