annotate src/s/template.h @ 112328:ba9f26694b92

Merge from mainline.
author Paul Eggert <eggert@cs.ucla.edu>
date Fri, 14 Jan 2011 13:12:57 -0800
parents 417b1e4d63cd
children ef719132ddfa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
1 /* Template for system description header files.
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
2 This file describes the parameters that system description files
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
3 should define or not.
108379
203aa49071bf Move MAIL_USE_FLOCK, MAIL_USE_LOCKF, BLESSMAIL_TARGET from cpp to configure.
Glenn Morris <rgm@gnu.org>
parents: 108018
diff changeset
4
203aa49071bf Move MAIL_USE_FLOCK, MAIL_USE_LOCKF, BLESSMAIL_TARGET from cpp to configure.
Glenn Morris <rgm@gnu.org>
parents: 108018
diff changeset
5 Copyright (C) 1985, 1986, 1992, 1999, 2001, 2002, 2003, 2004, 2005,
112218
376148b31b5e Add 2011 to FSF/AIST copyright years.
Glenn Morris <rgm@gnu.org>
parents: 106815
diff changeset
6 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
7
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
8 This file is part of GNU Emacs.
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
9
94715
1f134b61867c Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 79756
diff changeset
10 GNU Emacs is free software: you can redistribute it and/or modify
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11 it under the terms of the GNU General Public License as published by
94715
1f134b61867c Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 79756
diff changeset
12 the Free Software Foundation, either version 3 of the License, or
1f134b61867c Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 79756
diff changeset
13 (at your option) any later version.
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15 GNU Emacs is distributed in the hope that it will be useful,
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
18 GNU General Public License for more details.
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
19
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
20 You should have received a copy of the GNU General Public License
94715
1f134b61867c Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 79756
diff changeset
21 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
22
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
23
108511
f8e62c2bf3e9 Reformat some comments in src/s/*.h.
Glenn Morris <rgm@gnu.org>
parents: 108379
diff changeset
24 /* Define symbols to identify the version of Unix this is.
f8e62c2bf3e9 Reformat some comments in src/s/*.h.
Glenn Morris <rgm@gnu.org>
parents: 108379
diff changeset
25 Define all the symbols that apply correctly. */
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
26
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
27 /* #define USG5 */
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
28 /* #define USG */
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
29 /* #define HPUX */
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
30 /* #define BSD4_2 */
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
31 /* #define BSD4_3 */
16221
d8360498f935 Comment change.
Karl Heuer <kwzh@gnu.org>
parents: 14186
diff changeset
32 /* #define BSD_SYSTEM */
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
33
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
34 /* SYSTEM_TYPE should indicate the kind of system you are using.
108511
f8e62c2bf3e9 Reformat some comments in src/s/*.h.
Glenn Morris <rgm@gnu.org>
parents: 108379
diff changeset
35 It sets the Lisp variable system-type. */
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
36
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
37 #define SYSTEM_TYPE "berkeley-unix"
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
38
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
39 /* Emacs can read input using SIGIO and buffering characters itself,
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
40 or using CBREAK mode and making C-g cause SIGINT.
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
41 The choice is controlled by the variable interrupt_input.
2734
a0f174dc6ac5 * s/template.h: Explain the relative significance of the SIGIO and
Jim Blandy <jimb@redhat.com>
parents: 2642
diff changeset
42
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
43 Define INTERRUPT_INPUT to make interrupt_input = 1 the default (use SIGIO)
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
44
26090
63fd40a97a75 s/usg5-4.h:
Paul Eggert <eggert@twinsun.com>
parents: 25032
diff changeset
45 Emacs uses the presence or absence of the SIGIO and BROKEN_SIGIO macros
63fd40a97a75 s/usg5-4.h:
Paul Eggert <eggert@twinsun.com>
parents: 25032
diff changeset
46 to indicate whether or not signal-driven I/O is possible. It uses
2734
a0f174dc6ac5 * s/template.h: Explain the relative significance of the SIGIO and
Jim Blandy <jimb@redhat.com>
parents: 2642
diff changeset
47 INTERRUPT_INPUT to decide whether to use it by default.
a0f174dc6ac5 * s/template.h: Explain the relative significance of the SIGIO and
Jim Blandy <jimb@redhat.com>
parents: 2642
diff changeset
48
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
49 SIGIO can be used only on systems that implement it (4.2 and 4.3).
3591
507f64624555 Apply typo patches from Paul Eggert.
Jim Blandy <jimb@redhat.com>
parents: 3053
diff changeset
50 CBREAK mode has two disadvantages
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
51 1) At least in 4.2, it is impossible to handle the Meta key properly.
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
52 I hear that in system V this problem does not exist.
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
53 2) Control-G causes output to be discarded.
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
54 I do not know whether this can be fixed in system V.
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
55
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
56 Another method of doing input is planned but not implemented.
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
57 It would have Emacs fork off a separate process
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
58 to read the input and send it to the true Emacs process
108511
f8e62c2bf3e9 Reformat some comments in src/s/*.h.
Glenn Morris <rgm@gnu.org>
parents: 108379
diff changeset
59 through a pipe. */
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
60 #define INTERRUPT_INPUT
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
61
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
62 /* Letter to use in finding device name of first pty,
108511
f8e62c2bf3e9 Reformat some comments in src/s/*.h.
Glenn Morris <rgm@gnu.org>
parents: 108379
diff changeset
63 if system supports pty's. 'a' means it is /dev/ptya0. */
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
64 #define FIRST_PTY_LETTER 'a'
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
65
108511
f8e62c2bf3e9 Reformat some comments in src/s/*.h.
Glenn Morris <rgm@gnu.org>
parents: 108379
diff changeset
66 /* Define HAVE_PTYS if the system supports pty devices. */
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
67 #define HAVE_PTYS
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
68
96923
d89afa2b4c2f * config.in: Regenerate.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 96729
diff changeset
69 /* subprocesses should be undefined if you do NOT want to
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
70 have code for asynchronous subprocesses
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
71 (as used in M-x compile and M-x shell).
108511
f8e62c2bf3e9 Reformat some comments in src/s/*.h.
Glenn Morris <rgm@gnu.org>
parents: 108379
diff changeset
72 Currently only MSDOS does not support this. */
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
73
96923
d89afa2b4c2f * config.in: Regenerate.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 96729
diff changeset
74 /* #undef subprocesses */
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
75
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
76 /* Define CLASH_DETECTION if you want lock files to be written
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
77 so that Emacs can tell instantly when you try to modify
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
78 a file that someone else has modified in his Emacs. */
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
79 #define CLASH_DETECTION
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
80
514
626908d37dea *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 456
diff changeset
81 /* Define this if your operating system declares signal handlers to
626908d37dea *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 456
diff changeset
82 have a type other than the usual. `The usual' is `void' for ANSI C
626908d37dea *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 456
diff changeset
83 systems (i.e. when the __STDC__ macro is defined), and `int' for
626908d37dea *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 456
diff changeset
84 pre-ANSI systems. If you're using GCC on an older system, __STDC__
626908d37dea *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 456
diff changeset
85 will be defined, but the system's include files will still say that
626908d37dea *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 456
diff changeset
86 signal returns int or whatever; in situations like that, define
626908d37dea *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 456
diff changeset
87 this to be what the system's include files want. */
626908d37dea *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 456
diff changeset
88 /* #define SIGTYPE int */
626908d37dea *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 456
diff changeset
89
2642
05d85e55a081 * emacs.c (SEPCHAR): Instead of defining this to be ',' on VMS and
Jim Blandy <jimb@redhat.com>
parents: 2114
diff changeset
90 /* If the character used to separate elements of the executable path
05d85e55a081 * emacs.c (SEPCHAR): Instead of defining this to be ',' on VMS and
Jim Blandy <jimb@redhat.com>
parents: 2114
diff changeset
91 is not ':', #define this to be the appropriate character constant. */
05d85e55a081 * emacs.c (SEPCHAR): Instead of defining this to be ',' on VMS and
Jim Blandy <jimb@redhat.com>
parents: 2114
diff changeset
92 /* #define SEPCHAR ':' */
05d85e55a081 * emacs.c (SEPCHAR): Instead of defining this to be ',' on VMS and
Jim Blandy <jimb@redhat.com>
parents: 2114
diff changeset
93
3053
7d0d877f8733 Some makes can't handle form feed characters in their makefiles.
Jim Blandy <jimb@redhat.com>
parents: 2917
diff changeset
94 /* ============================================================ */
7d0d877f8733 Some makes can't handle form feed characters in their makefiles.
Jim Blandy <jimb@redhat.com>
parents: 2917
diff changeset
95
108511
f8e62c2bf3e9 Reformat some comments in src/s/*.h.
Glenn Morris <rgm@gnu.org>
parents: 108379
diff changeset
96 /* Here, add any special hacks needed to make Emacs work on this
f8e62c2bf3e9 Reformat some comments in src/s/*.h.
Glenn Morris <rgm@gnu.org>
parents: 108379
diff changeset
97 system. For example, you might define certain system call names
f8e62c2bf3e9 Reformat some comments in src/s/*.h.
Glenn Morris <rgm@gnu.org>
parents: 108379
diff changeset
98 that don't exist on your system, or that do different things on
f8e62c2bf3e9 Reformat some comments in src/s/*.h.
Glenn Morris <rgm@gnu.org>
parents: 108379
diff changeset
99 your system and must be used only through an encapsulation (which
f8e62c2bf3e9 Reformat some comments in src/s/*.h.
Glenn Morris <rgm@gnu.org>
parents: 108379
diff changeset
100 you should place, by convention, in sysdep.c). */
3053
7d0d877f8733 Some makes can't handle form feed characters in their makefiles.
Jim Blandy <jimb@redhat.com>
parents: 2917
diff changeset
101
25032
ae314c884db0 (NARROWPROTO): New.
Gerd Moellmann <gerd@gnu.org>
parents: 16221
diff changeset
102 /* If the system's imake configuration file defines `NeedWidePrototypes'
ae314c884db0 (NARROWPROTO): New.
Gerd Moellmann <gerd@gnu.org>
parents: 16221
diff changeset
103 as `NO', we must define NARROWPROTO manually. Such a define is
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 31600
diff changeset
104 generated in the Makefile generated by `xmkmf'. If we don't
25032
ae314c884db0 (NARROWPROTO): New.
Gerd Moellmann <gerd@gnu.org>
parents: 16221
diff changeset
105 define NARROWPROTO, we will see the wrong function prototypes
ae314c884db0 (NARROWPROTO): New.
Gerd Moellmann <gerd@gnu.org>
parents: 16221
diff changeset
106 for X functions taking float or double parameters. */
ae314c884db0 (NARROWPROTO): New.
Gerd Moellmann <gerd@gnu.org>
parents: 16221
diff changeset
107
ae314c884db0 (NARROWPROTO): New.
Gerd Moellmann <gerd@gnu.org>
parents: 16221
diff changeset
108 /* #define NARROWPROTO 1 */
ae314c884db0 (NARROWPROTO): New.
Gerd Moellmann <gerd@gnu.org>
parents: 16221
diff changeset
109
3053
7d0d877f8733 Some makes can't handle form feed characters in their makefiles.
Jim Blandy <jimb@redhat.com>
parents: 2917
diff changeset
110 /* ============================================================ */
2114
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 620
diff changeset
111
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 620
diff changeset
112 /* After adding support for a new system, modify the large case
108639
cfaca963d899 * src/[ms]/template.h: Comments.
Glenn Morris <rgm@gnu.org>
parents: 108511
diff changeset
113 statement in configure.in to recognize reasonable
2114
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 620
diff changeset
114 configuration names, and add a description of the system to
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 620
diff changeset
115 `etc/MACHINES'.
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 620
diff changeset
116
108639
cfaca963d899 * src/[ms]/template.h: Comments.
Glenn Morris <rgm@gnu.org>
parents: 108511
diff changeset
117 Check for any tests of $opsys in configure.in, and add an entry
cfaca963d899 * src/[ms]/template.h: Comments.
Glenn Morris <rgm@gnu.org>
parents: 108511
diff changeset
118 for the new system if needed.
cfaca963d899 * src/[ms]/template.h: Comments.
Glenn Morris <rgm@gnu.org>
parents: 108511
diff changeset
119
2114
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 620
diff changeset
120 If you've just fixed a problem in an existing configuration file,
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 620
diff changeset
121 you should also check `etc/MACHINES' to make sure its descriptions
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 620
diff changeset
122 of known problems in that configuration should be updated. */
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
123
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
124 /* arch-tag: 4b426b11-cb2e-4c0e-a488-e663f76a0515
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
125 (do not change this comment) */