|
231
|
1 -*- mode:outline -*-
|
|
134
|
2
|
|
|
3 * Introduction
|
|
|
4 ==============
|
|
|
5
|
|
|
6 You are running an experimental version of XEmacs. Please do not
|
|
|
7 report problems with Beta XEmacs to comp.emacs.xemacs. Report them to
|
|
|
8 xemacs-beta@xemacs.org.
|
|
|
9
|
|
|
10 ** XEmacs Beta Mailing List
|
|
|
11 ===========================
|
|
|
12
|
|
|
13 *** Subscribing
|
|
|
14 ---------------
|
|
|
15
|
|
|
16 If you are not subscribed to the XEmacs beta list you should be. Send
|
|
|
17 an email message with a subject of `subscribe' (without the quotes) to
|
|
|
18 xemacs-beta-request@xemacs.org and follow the directions. You do not
|
|
|
19 have to fill out the survey if you don't want to.
|
|
|
20
|
|
|
21 *** Unsubscribing
|
|
|
22 -----------------
|
|
|
23
|
|
|
24 To unsubscribe from the list send an email message with a subject of
|
|
|
25 `unsubscribe' (without the quotes) to xemacs-beta-request@xemacs.org.
|
|
|
26
|
|
|
27 *** Administrivia
|
|
|
28 -----------------
|
|
|
29
|
|
|
30 The XEmacs beta list is managed by the SmartList mailing list package,
|
|
|
31 and the usual SmartList commands work. Do not send mailing list
|
|
|
32 requests to the main address (xemacs-beta@xemacs.org), always send
|
|
|
33 them to xemacs-beta-request@xemacs.org. If you have problems with the
|
|
203
|
34 list itself, they should be brought to the attention of the XEmacs
|
|
|
35 Mailing List manager Steve Baur <steve@xemacs.org>.
|
|
134
|
36
|
|
|
37
|
|
|
38 ** Beta Release Schedule
|
|
|
39 ========================
|
|
|
40
|
|
243
|
41 The URL ftp://ftp.xemacs.org/pub/xemacs/beta/README always contains
|
|
|
42 the best estimate of when the next beta XEmacs will be released. For
|
|
|
43 weekend betas the release time is generally in the vicinity of 2PM to
|
|
|
44 5PM US Pacific Time (Universal Time minus 8 hours). For weekday
|
|
|
45 betas, the release time is generally in the vicinity of 8PM to
|
|
|
46 Midnight US Pacific Time on the listed day.
|
|
134
|
47
|
|
|
48 Betas are nominally a week apart, scheduled on every Saturday.
|
|
|
49 Midweek releases are made when a serious enough problem warrants it.
|
|
|
50
|
|
|
51
|
|
|
52 ** Reporting Problems
|
|
|
53 =====================
|
|
|
54
|
|
|
55 The best way to get problems fixed in XEmacs is to submit good problem
|
|
203
|
56 reports. Since this is beta software, problems are certain to exist.
|
|
134
|
57 Please read through all of part II of the XEmacs FAQ for an overview
|
|
|
58 of problem reporting. Other items which are most important are:
|
|
|
59
|
|
|
60 1. Do not submit C stack backtraces without line numbers. Since it
|
|
|
61 is possible to compile optimized with debug information with GCC
|
|
|
62 it is never a good idea to compile XEmacs without the -g flag.
|
|
|
63 XEmacs runs on a variety of platforms, and often it is not
|
|
|
64 possible to recreate problems which afflict a specific platform.
|
|
|
65 The line numbers in the C stack backtrace help isolate where the
|
|
|
66 problem is actually occurring.
|
|
|
67
|
|
|
68 2. Attempt to recreate the problem starting with an invocation of
|
|
203
|
69 XEmacs with `xemacs -q -no-site-file'. Quite often, problems are
|
|
134
|
70 due to package interdependencies, and the like. An actual bug in
|
|
|
71 XEmacs should be reproducible in a default configuration without
|
|
|
72 loading any special packages (or the one or two specific packages
|
|
|
73 that cause the bug to appear).
|
|
|
74
|
|
|
75 3. A picture can be worth a thousand words. When reporting an
|
|
|
76 unusual display, it is generally best to capture the problem in a
|
|
|
77 screen dump and include that with the problem report. The easiest
|
|
|
78 way to get a screen dump is to use the xv program and its grab
|
|
|
79 function. Save the image as a GIF to keep bandwidth requirements
|
|
|
80 down without loss of information. MIME is the preferred method
|
|
|
81 for making the image attachments.
|
|
|
82
|
|
|
83 * Compiling Beta XEmacs
|
|
|
84 =======================
|
|
|
85
|
|
|
86 ** Building an XEmacs from patches
|
|
|
87 ==================================
|
|
|
88
|
|
|
89 All beta releases of XEmacs are included with patches from the
|
|
|
90 previous version in an attempt to keep bandwidth requirements down.
|
|
|
91 Patches should be applied with the GNU patch program in something like
|
|
227
|
92 the following. Let's say you're upgrading XEmacs 20.15-beta10 to
|
|
|
93 XEmacs 20.15-beta11 and you have a full unmodified XEmacs 20.15-beta10
|
|
134
|
94 source tree to work with. Cd to the top level directory and issue the
|
|
|
95 shell command:
|
|
|
96
|
|
227
|
97 $ gunzip -c /tmp/xemacs-20.15-b10-20.15-b11.patch.gz | patch -p1
|
|
134
|
98
|
|
203
|
99 After patching, check to see that no patches were missed by doing
|
|
134
|
100 $ find . -name \*.rej -print
|
|
|
101
|
|
|
102 Any rejections should be treated as serious problems to be resolved
|
|
203
|
103 before building XEmacs.
|
|
134
|
104
|
|
179
|
105 After seeing that there were no rejections, issue the commands
|
|
134
|
106
|
|
179
|
107 $ ./config.status --recheck
|
|
|
108 $ make beta
|
|
134
|
109
|
|
203
|
110 and go play minesweep for a while on an older XEmacs while the binary
|
|
134
|
111 is rebuilt.
|
|
|
112
|
|
203
|
113 ** Building XEmacs from a full distribution
|
|
134
|
114 ==============================================
|
|
|
115
|
|
|
116 Locate a convenient place where you have at least 100MB of free space
|
|
|
117 and issue the command
|
|
|
118
|
|
227
|
119 $ gunzip -c /tmp/xemacs-20.15-b11.tar.gz | tar xvf -
|
|
134
|
120
|
|
227
|
121 (or simply `tar zxvf /tmp/xemacs-20.15-b11.tar.gz' if you use GNU tar).
|
|
134
|
122
|
|
|
123 cd to the top level directory and issue an appropriate configure
|
|
203
|
124 command. One maintainer uses the following at the time of this
|
|
134
|
125 writing:
|
|
|
126
|
|
203
|
127 ./configure \
|
|
134
|
128 --cflags="-m486 -g -O4 -fno-strength-reduce -malign-loops=2 \
|
|
203
|
129 -malign-jumps=2 -malign-functions=2" \
|
|
|
130 --with-sound=no --with=offix \
|
|
|
131 --error-checking=all --debug=yes \
|
|
|
132 --with-scrollbars=athena3d --with-dialogs=athena3d \
|
|
|
133 --with-mule --with-canna --with-wnn
|
|
134
|
134
|
|
203
|
135 Part of the configure output is a summary that looks something like:
|
|
|
136
|
|
227
|
137 uname -a: Linux altair.xemacs.org 2.0.32 #2 Sun Nov 16 18:52:14 PST 1997 i586
|
|
|
138
|
|
|
139 ./configure '--cflags=-Wall -Wno-switch -O6' '--error-checking=none' '--debug=no' '--with-mule=yes' '--with-dialogs=athena3d' '--with-scrollbars=athena3d' '--use-union-type=no' '--with-xim=xlib' '--with-xfs' '--mail-locking=file'
|
|
|
140
|
|
134
|
141
|
|
227
|
142 Configured for `i586-pc-linux'.
|
|
|
143
|
|
|
144 Where should the build process find the source code? /usr/src/xemacs-20.15
|
|
134
|
145 What installation prefix should install use? /usr/local
|
|
227
|
146 Where should XEmacs look for packages? ~/.xemacs:/usr/local/lib/xemacs/packages
|
|
134
|
147 What operating system and machine description files should XEmacs use?
|
|
|
148 `s/linux.h' and `m/intel386.h'
|
|
227
|
149 What compiler should XEmacs be built with? gcc -Wall -Wno-switch -O6
|
|
134
|
150 Should XEmacs use the GNU version of malloc? yes
|
|
|
151 Should XEmacs use the relocating allocator for buffers? yes
|
|
|
152 What window system should XEmacs use? x11
|
|
|
153 Where do we find X Windows header files? /usr/X11R6/include
|
|
|
154 Where do we find X Windows libraries? /usr/X11R6/lib
|
|
|
155 Compiling in support for XAUTH.
|
|
203
|
156 Compiling in support for XPM images.
|
|
|
157 Compiling in support for X-Face message headers.
|
|
227
|
158 Compiling in support for ImageMagick image conversion.
|
|
|
159 Using -ljbig -ljpeg -lmpeg -lttf -lpng -lz -ltiff -ljpeg -lz for graphics libraries.
|
|
|
160 Compiling in native sound support.
|
|
134
|
161 Compiling in support for Berkeley DB.
|
|
227
|
162 Compiling in support for DBM.
|
|
|
163 Compiling in support for ncurses.
|
|
134
|
164 Compiling in Mule (multi-lingual) support.
|
|
227
|
165 Compiling in XIM (X11R5+ I18N input method) support.
|
|
|
166 Using raw Xlib to provide XIM support.
|
|
|
167 Using XFontSet to provide bilingual menubar.
|
|
|
168 Compiling in support for Canna on Mule.
|
|
203
|
169 Compiling in support for the WNN input method on Mule.
|
|
|
170 Using WNN version 6.
|
|
134
|
171 Compiling in support for OffiX.
|
|
227
|
172 Using Lucid menubars.
|
|
|
173 Using Athena-3d scrollbars.
|
|
|
174 Using Athena-3d dialog boxes.
|
|
|
175 movemail will use "dot-locking" for locking mail spool files.
|
|
|
176 The `Info-default-directory-list' will be initialized from:
|
|
|
177 INFOPATH="/usr/local/info:/usr/info:/usr/local/lib/texmf/doc/info:/usr/lib/texmf/doc/info"
|
|
134
|
178
|
|
197
|
179 Then type `make; make finder' and you should have a working XEmacs.
|
|
134
|
180
|
|
|
181 After you have verified that you have a functional editor, fire up
|
|
|
182 your favorite mail program and send a build report to
|
|
|
183 xemacs-beta@xemacs.org. The build report should include
|
|
|
184
|
|
|
185 1. Your hardware configuration (OS version, etc.)
|
|
|
186
|
|
|
187 2. Version numbers of software in use (X11 version, system library
|
|
|
188 versions if appropriate, graphics library versions if appropriate).
|
|
|
189 If you're on a system like Linux, include all the version numbers
|
|
|
190 you can because chances are it makes a difference.
|
|
|
191
|
|
|
192 3. The options given to configure
|
|
|
193
|
|
|
194 4. The configuration report illustrated above
|
|
|
195
|
|
197
|
196 For convenience all of the above items are placed in a file called
|
|
203
|
197 `Installation' in the top level build directory.
|
|
197
|
198
|
|
134
|
199 5. Any other unusual items you feel should be brought to the attention
|
|
|
200 of the developers.
|
|
136
|
201
|
|
|
202 ** Creating patches for submission
|
|
|
203 ==================================
|
|
|
204
|
|
223
|
205 When making patches please use the `-u' option, or if your diff
|
|
|
206 doesn't support it, `-c'. Using ordinary (context-free) diffs are
|
|
203
|
207 notoriously prone to error, since line numbers tend to change when
|
|
|
208 others make changes to the same source file.
|
|
136
|
209
|
|
|
210 $ diff -u old-file.c new-file.c
|
|
|
211
|
|
|
212 -or-
|
|
|
213
|
|
|
214 $ diff -c old-file.c new-file.c
|
|
|
215
|
|
203
|
216 Also, it is helpful if you create the patch in the top level of the
|
|
|
217 XEmacs source directory:
|
|
136
|
218
|
|
203
|
219 $ cp -p lwlib/xlwmenu.c lwlib/xlwmenu.c.orig
|
|
|
220 hack, hack, hack....
|
|
|
221 $ diff -u lwlib/xlwmenu.c.orig lwlib/xlwmenu.c
|
|
136
|
222
|
|
203
|
223 It is preferrable for patches to be accompanied by an update (raw
|
|
223
|
224 entry preferred) to the appropriate ChangeLog file. Patches to
|
|
|
225 ChangeLog files have an extremely high rate of failure.
|
|
136
|
226
|
|
|
227 Also note that if you cut & paste from an xterm to an XEmacs mail buffer
|
|
203
|
228 you will probably lose due to tab expansion. The best thing to do is
|
|
|
229 to use an XEmacs shell buffer to run the diff commands, or ...
|
|
136
|
230 M-x cd to the appropriate directory, and issue the command `C-u M-!' from
|
|
|
231 within XEmacs.
|
|
195
|
232
|
|
227
|
233 * XEmacs 20.5 packages
|
|
195
|
234
|
|
227
|
235 XEmacs 20.5 has added the concept of installable packages searched prior
|
|
195
|
236 to dump time when building.
|
|
|
237
|
|
|
238 Packages are searched by default under /usr/local/lib/xemacs/packages/.
|
|
|
239 The summary message in configure will tell you where XEmacs is looking
|
|
|
240 for them. The packages hierarchy differs from site-lisp in that you
|
|
203
|
241 do not have to install XEmacs to use it. Indeed, the package path is
|
|
195
|
242 searched prior to dump time so that installed packages have the same
|
|
203
|
243 status as lisp distributed in the xemacs core tarball.
|
|
195
|
244
|
|
|
245 The structure of each directory in the package search path should look
|
|
|
246 like the base installed directory (ie. have etc/, info/, and lisp/,).
|
|
|
247 Lisp is searched recursively. It and all subdirectories are added to
|
|
|
248 the `load-path'. Each etc directory is added to `data-directory-list',
|
|
|
249 and each info directory is added to `Info-default-directory-list'.
|
|
|
250
|
|
|
251 A `find . -type d -print' in my top-level package directory reveals:
|
|
|
252 ./etc
|
|
|
253 ./etc/auctex
|
|
|
254 ./etc/auctex/style
|
|
|
255 ./etc/gnus
|
|
|
256 ./etc/skk
|
|
|
257 ./etc/gnusrefcard
|
|
|
258 ./etc/smilies
|
|
|
259 ./etc/message
|
|
|
260 ./info
|
|
|
261 ./lisp
|
|
|
262 ./lisp/gnus
|
|
|
263 ./lisp/auctex
|
|
|
264 ./lisp/auctex/man
|
|
|
265 ./lisp/footnote
|
|
|
266 ./lisp/skk
|
|
|
267
|
|
|
268
|
|
|
269 AUCTeX and Gnus have package tarballs in
|
|
243
|
270 ftp://ftp.xemacs.org/pub/xemacs/beta/xemacs-20.5/packages/
|
|
195
|
271 that you can simply untar in a package directory to install.
|
|
|
272
|
|
|
273 Karl Hegbloom has a set of packages in
|
|
203
|
274 [sorry - reference has been lost]
|
|
195
|
275 that work the same way.
|
|
|
276
|
|
203
|
277 ** Packages directory on the FTP Site
|
|
|
278 =====================================
|
|
|
279
|
|
|
280 The packages directory
|
|
209
|
281 ftp://ftp.xemacs.org/pub/xemacs/beta/xemacs-20.4/packages/
|
|
203
|
282
|
|
|
283 is divided into subdirectory by the major type of package.
|
|
|
284
|
|
|
285 drwxr-xr-x 2 beta-f beta-f 1024 Oct 10 00:43 binary-packages
|
|
|
286 drwxr-xr-x 2 beta-f beta-f 512 Oct 10 00:44 package-sources
|
|
|
287 drwxr-xr-x 2 beta-f beta-f 512 Oct 10 00:44 utils
|
|
|
288
|
|
|
289 ** Support Utilities (utils)
|
|
|
290 ============================
|
|
|
291
|
|
|
292 The utils directory contains tools to deal with current Lisp sources that
|
|
|
293 have not had yet gotten XEmacs package integration. The script `xpackage.sh'
|
|
|
294 is used with Quassia Gnus. Edit the appropriate variables at the top of
|
|
|
295 the script to reflect the local configuration and run it in the top level
|
|
|
296 directory of a Quassia Gnus source tree to install an update to Quassia Gnus.
|
|
|
297
|
|
|
298 ** Binary package installation (binary-packages)
|
|
|
299 ================================================
|
|
|
300
|
|
229
|
301 Prerequisite: XEmacs 20.5-b1.
|
|
203
|
302
|
|
|
303 Binary packages are complete entities that can be untarred at the top
|
|
|
304 level of an XEmacs package hierarchy and work at runtime. To install files
|
|
|
305 in this directory, run the command `M-x package-admin-add-binary-package'
|
|
|
306 and fill in appropriate values to the prompts.
|
|
|
307
|
|
229
|
308 ** Manual procedures for package management
|
|
|
309 ===========================================
|
|
|
310
|
|
|
311 Prerequisite: XEmacs 20.5
|
|
|
312
|
|
|
313 When adding and deleting files from a lisp directory the
|
|
|
314 auto-autoloads.el (global symbols) and custom-load.el (Customization
|
|
|
315 groups) must be kept in synch. Assuming one is manipulating a
|
|
|
316 directory called `lisp-utils', the command to rebuild the
|
|
|
317 auto-autoloads.el file is:
|
|
|
318
|
|
|
319 xemacs-20.5 -vanilla -batch -l autoload -f batch-update-directory lisp-utils
|
|
|
320
|
|
|
321 The command to rebuild the custom-load.el file is:
|
|
|
322
|
|
|
323 xemacs-20.5 -vanilla -batch -l cus-dep \
|
|
|
324 -f Custom-make-dependencies lisp-utils
|
|
|
325
|
|
|
326 To bytecompile both of these files the command is:
|
|
|
327
|
|
|
328 xemacs-20.5 -vanilla -batch -f batch-byte-compile \
|
|
|
329 lisp-utils/auto-autoloads.el lisp-utils/custom-laod.el
|
|
253
|
330
|
|
|
331 ** Building XEmacs and XEmacs packages from scratch
|
|
|
332 ===================================================
|
|
|
333
|
|
|
334 To build everything completely from scratch (not a high priority as a
|
|
|
335 design goal), the following procedure should work. (I don't recommend
|
|
|
336 building this way).
|
|
|
337
|
|
|
338 *** Phase 1 -- Get a minimal XEmacs binary with mule to build the package
|
|
|
339 lisp with.
|
|
|
340
|
|
|
341 **** Grab a mule-base tarball and install it into a newly created package
|
|
|
342 directory.
|
|
|
343
|
|
|
344 **** Configure XEmacs with mule and a package-path including the
|
|
|
345 directory created above.
|
|
|
346
|
|
|
347 **** Do a `make dist' to build an XEmacs binary.
|
|
|
348
|
|
|
349 *** Phase 2 -- Build and install the package lisp.
|
|
|
350
|
|
|
351 **** Modify XEmacs.rules for local paths and the XEmacs binary created in
|
|
|
352 Phase 1.
|
|
|
353
|
|
|
354 **** Do a make from the top level package lisp source directory.[1]
|
|
|
355
|
|
|
356 ***** There are two build glitches at this time. You must `make
|
|
|
357 auto-autoloads.el' manually in comm/tm before starting if you have
|
|
|
358 done a `make distclean'. This should be unnecessary after a fresh
|
|
|
359 cvs checkout.
|
|
|
360
|
|
|
361 ***** You must go back and rebuild the strokes package after the main
|
|
|
362 build is complete.
|
|
|
363
|
|
|
364 **** Do `make bindist's on all the packages you wish to install and
|
|
|
365 remove the byproduct .tar.gz's.
|
|
|
366
|
|
|
367 *** Phase 3 -- Redump XEmacs with the packages that require dump time
|
|
|
368 support (like egg-its, VM, etc.) and install it.
|
|
|
369
|
|
|
370 **** Reconfigure without Mule if you don't wish a Mule-ish XEmacs, and
|
|
|
371 rebuild XEmacs.
|
|
|
372
|
|
|
373 - or -
|
|
|
374
|
|
|
375 **** rm lib-src/DOC src/xemacs; make
|
|
|
376
|
|
|
377 **** Install or run in-place.
|
|
|
378
|
|
|
379 Note that this is in essence what `make all-elc' has always done.
|
