(U+662F): Add `<-denotational@usage' for BUCS+662F and A2-DJT-04512;
[chise/xemacs-chise.git] / src / s / README
1 This directory contains C header files containing
2 operating-system-specific definitions.  Each file describes a
3 particular operating system.  The emacs configuration script edits
4 ../config.h to include the appropriate one of these files, and then
5 each emacs source file includes config.h.
6
7 template.h is a generic template for system descriptions; it describes
8 the parameters a system file can specify.
9
10 General XEmacs Changes
11 ---------------------------
12 The following is a list of those changes made globally across all
13 files.  They are not marked individually in each header file.  All
14 other changes should be preceded by a comment /* XEmacs change */.
15
16
17 1. Removed all #defines of [read|write|open|close].  This is now
18    handled automatically by checking the INTERRUPTIBLE_IO etc. flags.
19
20 2. Removed all instances of #undef SIGIO and replaced them with
21    #define BROKEN_SIGIO.  Jamie says:
22
23    /* use BROKEN_SIGIO instead of this kludge -- jwz */
24
25 3. All instances of HAVE_GETWD, HAVE_DUP2, HAVE_UNISTD_H, NEED_UNISTD_H,
26    HAVE_GETTIMEOFDAY and NEED_REALPATH removed.  We detect these
27    automatically with configure.
28
29 4. All instances of HAVE_X11 replaced with HAVE_X_WINDOWS.  We don't
30    support X10 or earlier so the HAVE_X11 define was purged.
31
32 5. Most of the signal crap (e.g. redefining sigsetmask, defining
33    POSIX_SIGNALS) has been removed.  There are four possible
34    signal paradigms that all systems fall into, and we auto-detect
35    them in configure and handle them in syssignal.h.
36
37 6. Removed references to INTERRUPT_INPUT.  XEmacs does not use
38    this bizarre way of reading input.
39
40 7. Removed references to BROKEN_FIONREAD.  FIONREAD is used only
41    in INTERRUPT_INPUT and in the select() emulator, neither of
42    which are supported in XEmacs.
43
44 8. Removed references to NOMULTIPLEJOBS.  This is unused in XEmacs
45    and in FSF Emacs.
46
47 9. Removed references to HAVE_WAIT_HEADER and WAIT_USE_INT.
48    They are unnecessary with the cleaned up syswait.h in XEmacs.
49    (We autodetect sys/wait.h).  Instead, #define or #undef
50    HAVE_UNION_WAIT.
51
52 10. Removed BSTRING.  Not used anywhere. (If the header file
53     says there are bugs in bcopy() or the like, however, a
54     #define BROKEN_BCOPY is added for reference.)
55
56 11. Removed #defines of bcopy, bzero, bcmp, index, rindex.
57     XEmacs makes consistent use of the ANSI-equivalent
58     functions memcpy, memset, memcmp, strchr, strrchr.
59
60 12. '#define subprocesses' removed.  Use '#define NO_SUBPROCESSES'
61     if they don't exist.
62
63 13. References to HAVE_VFORK removed.  configure detects this.
64
65 14. Removed references to SYSV_SYSTEM_DIR, NONSYSTEM_DIR_LIBRARY,
66     HAVE_SOCKETS, HAVE_SYSVIPC.  configure detects these.
67
68 15. Removed defines of HAVE_TERMIOS, HAVE_TERMIO, and
69     HAVE_TCATTR (when HAVE_TERMIOS was also defined).
70     configure detects these and systty.h automatically defines
71     HAVE_TCATTR when HAVE_TERMIOS is defined.
72
73 16. Removed SETPGRP_RELEASES_CTTY.  Not necessary any more, with
74     fixed definitions of EMACS_SEPARATE_PROCESS_GROUP et al.
75
76 17. Removed defines of NLIST_STRUCT.  configure detects this.
77
78 18. Removed defines of _setjmp and _longjmp.  configure detects this.
79
80 19. Removed all '#define static' business.  Defines NO_REMAP instead.
81
82 20. Removed defines of HAVE_MACH_MACH_H.  configure detects this.