annotate etc/InstallGuide @ 853:2b6fa2618f76

[xemacs-hg @ 2002-05-28 08:44:22 by ben] merge my stderr-proc ws make-docfile.c: Fix places where we forget to check for EOF. code-init.el: Don't use CRLF conversion by default on process output. CMD.EXE and friends work both ways but Cygwin programs don't like the CRs. code-process.el, multicast.el, process.el: Removed. Improvements to call-process-internal: -- allows a buffer to be specified for input and stderr output -- use it on all systems -- implement C-g as documented -- clean up and comment call-process-region uses new call-process facilities; no temp file. remove duplicate funs in process.el. comment exactly how coding systems work and fix various problems. open-multicast-group now does similar coding-system frobbing to open-network-stream. dumped-lisp.el, faces.el, msw-faces.el: Fix some hidden errors due to code not being defined at the right time. xemacs.mak: Add -DSTRICT. ================================================================ ALLOW SEPARATION OF STDOUT AND STDERR IN PROCESSES ================================================================ Standard output and standard error can be processed separately in a process. Each can have its own buffer, its own mark in that buffer, and its filter function. You can specify a separate buffer for stderr in `start-process' to get things started, or use the new primitives: set-process-stderr-buffer process-stderr-buffer process-stderr-mark set-process-stderr-filter process-stderr-filter Also, process-send-region takes a 4th optional arg, a buffer. Currently always uses a pipe() under Unix to read the error output. (#### Would a PTY be better?) sysdep.h, sysproc.h, unexfreebsd.c, unexsunos4.c, nt.c, emacs.c, callproc.c, symsinit.h, sysdep.c, Makefile.in.in, process-unix.c: Delete callproc.c. Move child_setup() to process-unix.c. wait_for_termination() now only needed on a few really old systems. console-msw.h, event-Xt.c, event-msw.c, event-stream.c, event-tty.c, event-unixoid.c, events.h, process-nt.c, process-unix.c, process.c, process.h, procimpl.h: Rewrite the process methods to handle a separate channel for error input. Create Lstreams for reading in the error channel. Many process methods need change. In general the changes are fairly clear as they involve duplicating what's used for reading the normal stdout and changing for stderr -- although tedious, as such changes are required throughout the entire process code. Rewrote the code that reads process output to do two loops, one for stdout and one for stderr. gpmevent.c, tooltalk.c: set_process_filter takes an argument for stderr. ================================================================ NEW ERROR-TRAPPING MECHANISM ================================================================ Totally rewrite error trapping code to be unified and support more features. Basic function is call_trapping_problems(), which lets you specify, by means of flags, what sorts of problems you want trapped. these can include -- quit -- errors -- throws past the function -- creation of "display objects" (e.g. buffers) -- deletion of already-existing "display objects" (e.g. buffers) -- modification of already-existing buffers -- entering the debugger -- gc -- errors->warnings (ala suspended errors) etc. All other error funs rewritten in terms of this one. Various older mechanisms removed or rewritten. window.c, insdel.c, console.c, buffer.c, device.c, frame.c: When creating a display object, added call to note_object_created(), for use with trapping_problems mechanism. When deleting, call check_allowed_operation() and note_object deleted(). The trapping-problems code records the objects created since the call-trapping-problems began. Those objects can be deleted, but none others (i.e. previously existing ones). bytecode.c, cmdloop.c: internal_catch takes another arg. eval.c: Add long comments describing the "five lists" used to maintain state (backtrace, gcpro, specbind, etc.) in the Lisp engine. backtrace.h, eval.c: Implement trapping-problems mechanism, eliminate old mechanisms or redo in terms of new one. frame.c, gutter.c: Flush out the concept of "critical display section", defined by the in_display() var. Use an internal_bind() to get it reset, rather than just doing it at end, because there may be a non-local exit. event-msw.c, event-stream.c, console-msw.h, device.c, dialog-msw.c, frame.c, frame.h, intl.c, toolbar.c, menubar-msw.c, redisplay.c, alloc.c, menubar-x.c: Make use of new trapping-errors stuff and rewrite code based on old mechanisms. glyphs-widget.c, redisplay.h: Protect calling Lisp in redisplay. insdel.c: Protect hooks against deleting existing buffers. frame-msw.c: Use EQ, not EQUAL in hash tables whose keys are just numbers. Otherwise we run into stickiness in redisplay because internal_equal() can QUIT. ================================================================ SIGNAL, C-G CHANGES ================================================================ Here we change the way that C-g interacts with event reading. The idea is that a C-g occurring while we're reading a user event should be read as C-g, but elsewhere should be a QUIT. The former code did all sorts of bizarreness -- requiring that no QUIT occurs anywhere in event-reading code (impossible to enforce given the stuff called or Lisp code invoked), and having some weird system involving enqueue/dequeue of a C-g and interaction with Vquit_flag -- and it didn't work. Now, we simply enclose all code where we want C-g read as an event with {begin/end}_dont_check_for_quit(). This completely turns off the mechanism that checks (and may remove or alter) C-g in the read-ahead queues, so we just get the C-g normal. Signal.c documents this very carefully. cmdloop.c: Correct use of dont_check_for_quit to new scheme, remove old out-of-date comments. event-stream.c: Fix C-g handling to actually work. device-x.c: Disable quit checking when err out. signal.c: Cleanup. Add large descriptive comment. process-unix.c, process-nt.c, sysdep.c: Use QUIT instead of REALLY_QUIT. It's not necessary to use REALLY_QUIT and just confuses the issue. lisp.h: Comment quit handlers. ================================================================ CONS CHANGES ================================================================ free_cons() now takes a Lisp_Object not the result of XCONS(). car and cdr have been renamed so that they don't get used directly; go through XCAR(), XCDR() instead. alloc.c, dired.c, editfns.c, emodules.c, fns.c, glyphs-msw.c, glyphs-x.c, glyphs.c, keymap.c, minibuf.c, search.c, eval.c, lread.c, lisp.h: Correct free_cons calling convention: now takes Lisp_Object, not Lisp_Cons chartab.c: Eliminate direct use of ->car, ->cdr, should be black box. callint.c: Rewrote using EXTERNAL_LIST_LOOP to avoid use of Lisp_Cons. ================================================================ USE INTERNAL-BIND-* ================================================================ eval.c: Cleanups of these funs. alloc.c, fileio.c, undo.c, specifier.c, text.c, profile.c, lread.c, redisplay.c, menubar-x.c, macros.c: Rewrote to use internal_bind_int() and internal_bind_lisp_object() in place of whatever varied and cumbersome mechanisms were formerly there. ================================================================ SPECBIND SANITY ================================================================ backtrace.h: - Improved comments backtrace.h, bytecode.c, eval.c: Add new mechanism check_specbind_stack_sanity() for sanity checking code each time the catchlist or specbind stack change. Removed older prototype of same mechanism. ================================================================ MISC ================================================================ lisp.h, insdel.c, window.c, device.c, console.c, buffer.c: Fleshed out authorship. device-msw.c: Correct bad Unicode-ization. print.c: Be more careful when not initialized or in fatal error handling. search.c: Eliminate running_asynch_code, an FSF holdover. alloc.c: Added comments about gc-cons-threshold. dialog-x.c: Use begin_gc_forbidden() around code to build up a widget value tree, like in menubar-x.c. gui.c: Use Qunbound not Qnil as the default for gethash. lisp-disunion.h, lisp-union.h: Added warnings on use of VOID_TO_LISP(). lisp.h: Use ERROR_CHECK_STRUCTURES to turn on ERROR_CHECK_TRAPPING_PROBLEMS and ERROR_CHECK_TYPECHECK lisp.h: Add assert_with_message. lisp.h: Add macros for gcproing entire arrays. (You could do this before but it required manual twiddling the gcpro structure.) lisp.h: Add prototypes for new functions defined elsewhere.
author ben
date Tue, 28 May 2002 08:45:36 +0000
parents 9ad43877534d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
179
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
1 Introduction
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
2
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
3 Thank you for downloading XEmacs. We of the XEmacs development team
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
4 believe user satisfaction is our number one priority, and we hope that
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
5 you will be pleased with the power of our editor. Please follow all
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
6 of the instructions in order to enjoy a quick and easy installation.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
7
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
8
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
9 Getting Started
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
10
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
11 In this guide, information which you will need to supply will be enclosed in
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
12 angle brackets, <like this>. Commands which you will have to enter will be
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
13 indented,
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
14
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
15 like this.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
16
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
17 You will need to provide a loading directory, in which to load the
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
18 material from tape (/tmp/xemacs is recommended), and a permanent
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
19 installation directory (/usr/local/xemacs is recommended).
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
20
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
21
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
22 Loading From Tape
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
23
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
24 First create and change directory to the loading directory:
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
25
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
26 mkdir <working directory>
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
27 cd <working directory>
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
28
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
29 Now you are ready to load the software from tape.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
30
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
31 The specific device name needed to load the tape varies with hardware vendors,
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
32 and may be found in Appendix A, "Vendors and Device Names".
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
33
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
34 Load the software from tape:
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
35
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
36 tar xvf /dev/<device name>
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
37
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
38 You have now loaded all of the software from tape, and are ready to compile and
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
39 install the XEmacs Text Editor.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
40
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
41
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
42 Compiling and Installing the XEmacs Editor
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
43
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
44 Compiling and installing the libraries is handled by a user-friendly shell
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
45 script. You will need to provide some information to the script, such as your
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
46 organization name and registration number. To run the script, type
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
47
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
48 /bin/sh xemacs/xemacs.install -d <installation directory>
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
49
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
50 Follow the script's directions, and provide the information which it prompts
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
51 for.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
52
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
53 When the script prompts you for the directory in which the distribution files
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
54 are located, you will find that you are unable to provide it with any directory
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
55 which the script will deem satisfactory. That is because it is necessary to
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
56 order the following additional parts which are necessary to continue with the
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
57 installation:
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
58
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
59 Part Number Qty Name Price
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
60
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
61 GM-96-3026 1 Goat, male 1000.00
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
62 CB-13-2395 1 Candle, black 50.00
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
63 CG-63-6376 1 Chalk dust container 10.00
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
64 IB-89-3335 5 Incense sticks 5.00
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
65 DE-44-8846 1 Dagger, ebon, curved 500.00
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
66 AS-87-2319 1 Altar, silver 10000.00
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
67
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
68 Wait until the additional parts arrive; you will be ready to continue the
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
69 installation the next Friday the 13th at midnight.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
70
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
71
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
72 Ritual for Successfully Completing Installation
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
73
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
74 Stand in front of the computer. Pour out the chalk dust in an inscribed
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
75 pentagram around you; be sure that it is without breaks. Set an incense stick
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
76 at each of the five corners, the altar in front of the computer, and the candle
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
77 in front of the altar.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
78
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
79 Light each of the incense sticks and the candles, chanting in a low voice:
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
80
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
81 Daemons and spirits of the netherworld
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
82 Forces of all that is chaotic and mysterious
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
83 Essence of Netscape and MicroSoft
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
84
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
85 I am coming here to appease you
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
86 I offer you this goat
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
87 That my software may work
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
88
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
89 I bind you here
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
90 Do not make my system crash
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
91 Let the software install as advertised
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
92
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
93 Place the goat on the altar, and slaughter it with the dagger.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
94
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
95 May this goat feed you
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
96 Sate your lust for blood
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
97 Into it may your mischief fly
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
98 Not my computer
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
99 Make the software work
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
100 For this is the only way
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
101
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
102 Then spit into the computer's ventilation slots. This will complete different
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
103 circuits inside the computer, causing its motherboard and cards to function in
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
104 ways that the engineers never intended, thereby making your system compatible
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
105 with our libraries.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
106
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
107 Reboot your computer. The installation is now complete.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
108
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
109 [This has undergone a minor rewrite for XEmacs. It originally
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
110 appeared on rec.humor.funny courtesy of jonathan seth hayward
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
111 <jhayward@students.uiuc.edu>, and is included by permission of the
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
112 author].