Mercurial > hg > xemacs-beta
annotate man/xemacs-faq.texi @ 5445:6506fcb40fcf
Merged with trunk.
author | Mats Lidell <matsl@xemacs.org> |
---|---|
date | Fri, 31 Dec 2010 00:27:29 +0100 |
parents | b7232de2a937 |
children | 3889ef128488 |
rev | line source |
---|---|
442 | 1 \input texinfo.tex @c -*- mode: texinfo; coding: iso-2022-8 -*- |
428 | 2 @c %**start of header |
3 @setfilename ../info/xemacs-faq.info | |
4 @settitle Frequently asked questions about XEmacs | |
5 @setchapternewpage off | |
6 @c %**end of header | |
7 @finalout | |
8 @titlepage | |
9 @title XEmacs FAQ | |
3404 | 10 @subtitle Frequently asked questions about XEmacs @* Last Modified: $Date: 2006/05/16 15:36:16 $ |
428 | 11 @sp 1 |
2417 | 12 @author Ben Wing <ben@@xemacs.org> |
1869 | 13 @author Tony Rossini <rossini@@u.washington.edu> |
428 | 14 @author Chuck Thompson <cthomp@@xemacs.org> |
15 @author Steve Baur <steve@@xemacs.org> | |
16 @author Andreas Kaempf <andreas@@sccon.com> | |
17 @author Christian Nyb@o{} <chr@@mediascience.no> | |
434 | 18 @author Sandra Wambold <wambold@@xemacs.org> |
428 | 19 @page |
20 @end titlepage | |
21 | |
22 @ifinfo | |
23 @dircategory XEmacs Editor | |
24 @direntry | |
440 | 25 * FAQ: (xemacs-faq). XEmacs FAQ. |
428 | 26 @end direntry |
27 @end ifinfo | |
28 | |
2417 | 29 @ignore |
30 ***************************************** | |
31 ***** To update the menus and nodes ***** | |
32 ***************************************** | |
33 | |
34 First, the first argument to @node (the name itself) needs to be correct. | |
35 Use a macro if necessary to update the @node names from the | |
36 @unnumberedsubsec commands. Also note that the command we're about to | |
37 run will not correctly fix up the part of the menu to the right of a ::. | |
38 It will leave existing text in place but not change anything. If you | |
39 make a lot of changes and want to update this semi-automatically, use | |
40 M-x occur to pick out all @unnumberedsubsec lines then do some editing | |
41 magic to coerce them into the right format and cut and paste as necessary: | |
42 | |
43 1. M-x occur @unnumberedsubsec | |
44 2. <select a rectangle including all text before the Q#.#.#> | |
45 3. C-x r t *<space> | |
46 4. go to the top and use the following macro to get the indentation right. | |
47 | |
48 (setq last-kbd-macro (read-kbd-macro | |
49 "C-s : RET : <right> M-x indent- to- column RET 14 RET <home> <down>")) | |
50 | |
51 5. Cut and paste the menus into the detailmenu at the top and | |
52 individual menus at the top of the appropriate chapters. (#### I | |
53 wonder, does texinfo-master-menu generate the detailmenu from the | |
54 individual menus or vice-versa or neither?) | |
55 | |
56 Then, | |
57 | |
2559 | 58 6. C-u C-c C-u m (C-u M-x texinfo-master-menu) will update the menus |
2417 | 59 and nodes. However, it appears that even though it tries to |
60 preserve the existing menu structure as much as possible, it | |
61 doesn't do a perfect job. It messes up in at least two ways: The | |
62 indentation in the part of the main menu above the detailmenu will | |
63 be screwed up, and the #.0 titles will be removed from both the | |
64 detailmenu and the individual chapter menus. In addition, | |
65 sometimes random things get screwed up in individual parts of the | |
66 menus. Therefore: | |
67 | |
2559 | 68 1. Use the Lisp line below to get the spacing correct for the Q#.#.# |
69 menu entries. | |
70 | |
71 (set (make-local-variable 'texinfo-column-for-description) 14) | |
72 | |
73 2. Copy the whole detailmenu beforehand. | |
74 3. Run C-u C-c C-u m to fix up the nodes. | |
75 4. Run `fix-main-menu' and `fix-omitted-menu-lines'. | |
76 5. Check the new detailmenu carefully to see if anything is screwed up | |
2417 | 77 compared to the old detailmenu you copied. |
2559 | 78 6. If so, paste back the appropriate sections and fix up the corresponding |
2417 | 79 part of the chapter-specific menu. |
80 | |
81 (defun fix-main-menu () | |
82 (interactive) | |
83 (save-restriction | |
84 (let (p q) | |
2559 | 85 (goto-char (point-min)) |
86 (re-search-forward "^@menu") | |
2417 | 87 (setq p (match-beginning 0)) |
88 (re-search-forward "^$") | |
89 (setq q (match-end 0)) | |
90 (narrow-to-region p q) | |
91 (goto-char p) | |
92 (while (search-forward ":: " nil t) | |
93 (indent-to-column 26))))) | |
94 | |
95 (defun fix-omitted-menu-lines () | |
96 (interactive) | |
97 (save-excursion | |
2559 | 98 (loop for x from 1 to 10 do |
2417 | 99 (goto-char (point-min)) |
100 (re-search-forward (format "@unnumberedsec \\(%d.0: .*\\)" x)) | |
101 (let ((line (match-string 1))) | |
2559 | 102 (re-search-backward "^@menu") |
2417 | 103 (forward-line 1) |
2559 | 104 (unless (looking-at "[0-9]+.0:") |
2417 | 105 (insert line) |
106 (insert "\n")) | |
107 (goto-char (point-min)) | |
2559 | 108 (re-search-forward "^@menu") |
2417 | 109 (search-forward (format "Q%d.0.1:" x)) |
110 (forward-line -1) | |
2559 | 111 (unless (looking-at "[0-9]+.0:") |
112 (insert "\n") | |
113 (insert line)))))) | |
2417 | 114 |
115 ***************************************** | |
116 ***** Other work ***** | |
117 ***************************************** | |
118 | |
119 When you've rearranged and renumbered a bunch of nodes, you can get | |
120 the numbers agreeing again. The macro below assumes that the | |
121 unnumberedsubsec number is correct, and fixes up the node to agree. | |
122 Only the first part of the node is fixed and the other parts may still | |
123 be wrong; but they will be fixed as part of | |
124 @code{texinfo-master-menu}. | |
125 | |
126 (setq last-kbd-macro (read-kbd-macro | |
127 "<f1> unnumberedsubsec SPC RET C-s : RET <left> C-x C-x <f3> <home> <up> <C-right> <right> C-s , RET <left> C-x C-x <f4> <home> 2*<down>")) | |
128 @end ignore | |
129 | |
130 | |
428 | 131 @node Top, Introduction, (dir), (dir) |
132 @top XEmacs FAQ | |
133 | |
134 This is the guide to the XEmacs Frequently Asked Questions list---a | |
135 compendium of questions and answers pertaining to one of the finest | |
442 | 136 programs ever written. XEmacs is much more than just a Text Editor. |
137 | |
138 This FAQ is freely redistributable. This FAQ is distributed in the hope | |
139 that it will be useful, but WITHOUT ANY WARRANTY; without even the | |
140 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
428 | 141 |
142 If you have a Web browser, the official hypertext version is at | |
143 @iftex | |
144 @* | |
145 @end iftex | |
1143 | 146 @uref{http://www.xemacs.org/FAQ/xemacs-faq.html} |
428 | 147 |
148 @ifset CANONICAL | |
149 @html | |
150 This document is available in several different formats: | |
151 @itemize @bullet | |
152 @item | |
153 @uref{xemacs-faq.txt, As a single ASCII file}, produced by | |
154 @code{makeinfo --no-headers} | |
155 @item | |
156 @uref{xemacs-faq.dvi, As a .dvi file}, as used with | |
157 @uref{http://www.tug.org, TeX.} | |
158 @item | |
159 As a PostScript file @uref{xemacs-faq-a4.ps, in A4 format}, | |
160 as well as in @uref{xemacs-faq-letter.ps, letter format} | |
161 @item | |
162 In html format, @uref{xemacs-faq_1.html, split by chapter}, or in | |
163 @uref{xemacs-faq.html, one monolithic} document. | |
164 @item | |
165 The canonical version of the FAQ is the texinfo document | |
166 @uref{xemacs-faq.texi, man/xemacs-faq.texi}. | |
167 @item | |
168 If you do not have makeinfo installed, you may @uref{xemacs-faq.info, | |
169 download the faq} in info format, and install it in @file{<XEmacs | |
170 library directory>/info/}. For example in | |
462 | 171 @file{/usr/local/lib/xemacs-21.4/info/}. |
428 | 172 |
173 @end itemize | |
174 | |
175 @end html | |
176 | |
177 @end ifset | |
178 | |
179 @c end ifset points to CANONICAL | |
180 | |
181 @menu | |
2417 | 182 * Introduction:: Introduction, Policy, Credits. |
183 * Installation:: Installation and Troubleshooting. | |
2459 | 184 * Editing:: Editing Functions. |
185 * Display:: Display Functions. | |
2417 | 186 * External Subsystems:: Interfacing with the OS and External Devices. |
187 * Internet:: Connecting to the Internet. | |
188 * Advanced:: Advanced Customization Using XEmacs Lisp. | |
2459 | 189 * Other Packages:: Other External Packages. |
2417 | 190 * Current Events:: What the Future Holds. |
5028
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
191 * Legacy Versions:: New Information about Old XEmacsen. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
192 * Bleeding Edge:: Working with XEmacs Source Code Repositories. |
428 | 193 |
194 @detailmenu | |
195 --- The Detailed Node Listing --- | |
196 | |
2417 | 197 1 Introduction, Policy, Credits |
198 | |
2537 | 199 1.0: What is XEmacs? |
2417 | 200 * Q1.0.1:: What is XEmacs? |
201 * Q1.0.2:: What is the current version of XEmacs? | |
2537 | 202 * Q1.0.3:: How do you pronounce XEmacs? |
203 * Q1.0.4:: What does XEmacs look like? | |
204 * Q1.0.5:: Who wrote XEmacs? | |
205 * Q1.0.6:: Who wrote the FAQ? | |
206 | |
207 1.1: Getting XEmacs | |
208 * Q1.1.1:: Where can I find XEmacs? | |
209 * Q1.1.2:: Are binaries available? | |
210 * Q1.1.3:: How do I get the bleeding-edge sources? | |
211 * Q1.1.4:: Where can I obtain a printed copy of the XEmacs User's Manual? | |
212 | |
213 1.2: Versions for Different Operating Systems | |
214 * Q1.2.1:: Do I need X11 to run XEmacs? | |
215 * Q1.2.2:: What versions of Unix does XEmacs run on? | |
216 * Q1.2.3:: Is there a port of XEmacs to Microsoft Windows? | |
217 * Q1.2.4:: Can I build XEmacs on MS Windows with X support? Do I need to? | |
218 * Q1.2.5:: What are Cygwin and MinGW, and do I need them to run XEmacs? | |
219 * Q1.2.6:: What are the differences between the various MS Windows emacsen? | |
220 * Q1.2.7:: How does the port cope with differences in the Windows user interface? | |
221 * Q1.2.8:: Is there a port of XEmacs to the Macintosh? | |
222 * Q1.2.9:: Is there a port of XEmacs to MS-DOS? | |
223 * Q1.2.10:: Is there a port of XEmacs to OS/2? | |
224 * Q1.2.11:: Is there a port of XEmacs to NextStep? | |
225 * Q1.2.12:: Is there a port of XEmacs to VMS? | |
226 | |
227 1.3: Getting Started | |
228 * Q1.3.1:: What is an @file{init.el} or @file{.emacs} and is there a sample one? | |
229 * Q1.3.2:: Where do I put my @file{init.el} file? | |
230 * Q1.3.3:: Can I use the same @file{init.el} with the other Emacs? | |
231 * Q1.3.4:: Any good XEmacs tutorials around? | |
232 * Q1.3.5:: May I see an example of a useful XEmacs Lisp function? | |
233 * Q1.3.6:: And how do I bind it to a key? | |
234 * Q1.3.7:: What's the difference between a macro and a function? | |
235 * Q1.3.8:: What is @code{Custom}? | |
236 | |
237 1.4: Getting Help | |
238 * Q1.4.1:: Where can I get help? | |
239 * Q1.4.2:: Which mailing lists are there? | |
2559 | 240 * Q1.4.3:: Where are the mailing lists archived? |
241 * Q1.4.4:: How can I get two instances of info? | |
242 * Q1.4.5:: How do I add new Info directories? | |
2537 | 243 |
244 1.5: Contributing to XEmacs | |
245 * Q1.5.1:: How do I submit changes to the FAQ? | |
246 * Q1.5.2:: How do I become a beta tester? | |
247 * Q1.5.3:: How do I contribute to XEmacs itself? | |
2559 | 248 * Q1.5.4:: How do I get started developing XEmacs? |
249 * Q1.5.5:: What's the basic layout of the code? | |
2537 | 250 |
251 1.6: Politics (XEmacs vs. GNU Emacs) | |
252 * Q1.6.1:: What is GNU Emacs? | |
253 * Q1.6.2:: How does XEmacs differ from GNU Emacs? | |
254 * Q1.6.3:: How much does XEmacs differ? | |
255 * Q1.6.4:: Is XEmacs "GNU"? | |
256 * Q1.6.5:: What is the correct way to refer to XEmacs and GNU Emacs? | |
257 * Q1.6.6:: Why haven't XEmacs and GNU Emacs merged? | |
258 | |
259 1.7: External Packages | |
2559 | 260 * Q1.7.1:: What is the package system? |
261 * Q1.7.2:: Which external packages are there? | |
262 * Q1.7.3:: Do I need to have the packages to run XEmacs? | |
263 * Q1.7.4:: Is there a way to find which package has particular functionality? | |
2537 | 264 |
265 1.8: Internationalization | |
266 * Q1.8.1:: What is the status of internationalization support aka MULE (including Asian language support)? | |
267 * Q1.8.2:: How can I help with internationalization? | |
268 * Q1.8.3:: How do I type non-ASCII characters? | |
269 * Q1.8.4:: Can XEmacs messages come out in a different language? | |
270 * Q1.8.5:: Please explain the various input methods in MULE/XEmacs | |
271 * Q1.8.6:: How do I portably code for MULE/XEmacs? | |
272 * Q1.8.7:: How about Cyrillic modes? | |
273 * Q1.8.8:: Does XEmacs support Unicode? | |
274 * Q1.8.9:: How does XEmacs display Unicode? | |
2417 | 275 |
276 2 Installation and Troubleshooting | |
277 | |
2559 | 278 2.0: Installation (General) |
279 * Q2.0.1:: How do I build and install XEmacs? | |
280 * Q2.0.2:: Where do I find external libraries? | |
281 * Q2.0.3:: How do I specify the paths that XEmacs uses for finding files? | |
282 * Q2.0.4:: Running XEmacs without installing | |
283 * Q2.0.5:: XEmacs is too big | |
284 | |
285 2.1: Package Installation | |
286 * Q2.1.1:: How do I install the packages? | |
287 * Q2.1.2:: Can I install the packages individually? | |
288 * Q2.1.3:: Can I install the packages automatically? | |
289 * Q2.1.4:: Can I upgrade or remove packages? | |
290 * Q2.1.5:: Which packages to install? | |
291 * Q2.1.6:: Can you describe the package location process in more detail? | |
292 * Q2.1.7:: EFS fails with "500 AUTH not understood" | |
293 | |
294 2.2: Unix/Mac OS X Installation (Also Relevant to Cygwin, MinGW) | |
295 * Q2.2.1:: Libraries in non-standard locations | |
296 * Q2.2.2:: Why can't I strip XEmacs? | |
3404 | 297 * Q2.2.3:: X11/bitmaps/gray (or other X11-related file) not found. |
2559 | 298 |
299 2.3: Windows Installation (Windows, Cygwin, MinGW) | |
300 * Q2.3.1:: What exactly are all the different ways to build XEmacs under Windows? | |
301 * Q2.3.2:: What compiler/libraries do I need to compile XEmacs? | |
302 * Q2.3.3:: How do I compile the native port? | |
303 * Q2.3.4:: What do I need for Cygwin? | |
304 * Q2.3.5:: How do I compile under Cygwin? | |
305 * Q2.3.6:: How do I compile using MinGW (aka @samp{the -mno-cygwin flag to gcc})? | |
306 * Q2.3.7:: How do I compile with X support? | |
307 * Q2.3.8:: Cygwin XEmacs won't start -- cygXpm-noX4.dll was not found (NEW) | |
308 | |
309 2.4: General Troubleshooting | |
310 * Q2.4.1:: How do I deal with bugs or with problems building, installing, or running? | |
311 * Q2.4.2:: Help! XEmacs just crashed on me! | |
312 * Q2.4.3:: XEmacs crashes and I compiled it myself. | |
313 * Q2.4.4:: How to debug an XEmacs problem with a debugger | |
314 * Q2.4.5:: I get a cryptic error message when trying to do something. | |
315 * Q2.4.6:: XEmacs hangs when I try to do something. | |
316 * Q2.4.7:: I get an error message when XEmacs is running in batch mode. | |
317 * Q2.4.8:: The keyboard or mouse is not working properly, or I have some other event-related problem. | |
318 * Q2.4.9:: @kbd{C-g} doesn't work for me. Is it broken? | |
319 * Q2.4.10:: How do I debug process-related problems? | |
320 * Q2.4.11:: XEmacs is outputting lots of X errors. | |
321 * Q2.4.12:: After upgrading, XEmacs won't do `foo' any more! | |
322 | |
323 2.5: Startup-Related Problems | |
324 * Q2.5.1:: XEmacs cannot connect to my X Terminal! | |
325 * Q2.5.2:: Startup problems related to paths or package locations. | |
4658
fd2495d78aac
Add FAQ on network slows (lookup order of DNS and /etc/hosts).
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4625
diff
changeset
|
326 * Q2.5.3:: XEmacs won't start without network, or starts slowly. |
2559 | 327 * Q2.5.4:: Startup warnings about deducing proper fonts? |
328 * Q2.5.5:: Warnings from incorrect key modifiers. | |
329 * Q2.5.6:: XEmacs 21.1 on Windows used to spawn an ugly console window on every startup. Has that been fixed? | |
2417 | 330 |
2459 | 331 3 Editing Functions |
2417 | 332 |
333 3.0: The Keyboard | |
2459 | 334 * Q3.0.1:: How can I customize the keyboard? |
335 * Q3.0.2:: How can I bind complex functions (or macros) to keys? | |
336 * Q3.0.3:: How do I bind C-. and C-; to scroll one line up and down? | |
337 * Q3.0.4:: Globally binding @kbd{Delete}? | |
338 * Q3.0.5:: How to map @kbd{Help} key alone on Sun type4 keyboard? | |
339 * Q3.0.6:: How can you type in special characters in XEmacs? | |
340 * Q3.0.7:: Can I turn on @dfn{sticky} modifier keys? | |
341 * Q3.0.8:: How do I map the arrow keys? | |
342 * Q3.0.9:: HP Alt key as Meta. | |
343 * Q3.0.10:: Why does edt emulation not work? | |
344 * Q3.0.11:: How can I emulate VI and use it as my default mode? | |
4625
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
345 * Q3.0.12:: Mac Alt/Option key as Meta. |
2417 | 346 |
347 3.1: The Mouse | |
348 * Q3.1.1:: How can I turn off Mouse pasting? | |
349 * Q3.1.2:: How do I set control/meta/etc modifiers on mouse buttons? | |
350 * Q3.1.3:: Clicking the left button does not do anything in buffer list. | |
351 * Q3.1.4:: How can I get a list of buffers when I hit mouse button 3? | |
2459 | 352 * Q3.1.5:: How can I set XEmacs up so that it pastes where the text cursor is? |
353 | |
354 3.2: Buffers, Text Editing | |
355 * Q3.2.1:: Can I have the end of the buffer delimited in some way? | |
356 * Q3.2.2:: How do I insert today's date into a buffer? | |
357 * Q3.2.3:: How do I get a single minibuffer frame? | |
358 * Q3.2.4:: How can I enable auto-indent and/or Filladapt? | |
359 * Q3.2.5:: How can I get XEmacs to come up in text/auto-fill mode by default? | |
360 | |
361 3.3: Text Selections | |
362 * Q3.3.1:: How do I select a rectangular region? | |
363 * Q3.3.2:: How can I turn off or change highlighted selections? | |
364 * Q3.3.3:: How do I cause typing on an active region to remove it? | |
365 * Q3.3.4:: Can I turn off the highlight during isearch? | |
366 * Q3.3.5:: Why is killing so slow? | |
367 * Q3.3.6:: Why does @kbd{M-w} take so long? | |
368 | |
369 3.4: Editing Source Code | |
370 * Q3.4.1:: I do not like cc-mode. How do I use the old c-mode? | |
371 * Q3.4.2:: How do you make XEmacs indent CL if-clauses correctly? | |
372 | |
373 4 Display Functions | |
374 | |
375 4.0: Textual Fonts and Colors | |
376 * Q4.0.1:: How do I specify a font? | |
377 * Q4.0.2:: How do I set the text, menu and modeline fonts? | |
378 * Q4.0.3:: How can I set color options from @file{init.el}? | |
379 * Q4.0.4:: How can I set the colors when highlighting a region? | |
380 * Q4.0.5:: How can I limit color map usage? | |
381 * Q4.0.6:: My tty supports color, but XEmacs doesn't use them. | |
382 * Q4.0.7:: Can I have pixmap backgrounds in XEmacs? | |
383 * Q4.0.8:: How do I display non-ASCII characters? | |
384 * Q4.0.9:: Font selections in don't get saved after @code{Save Options}. | |
385 | |
386 4.1: Syntax Highlighting (Font Lock) | |
387 * Q4.1.1:: How can I do source code highlighting using font-lock? | |
388 * Q4.1.2:: How do I get @samp{More} Syntax Highlighting on by default? | |
389 | |
390 4.2: The Modeline | |
391 * Q4.2.1:: How can I make the modeline go away? | |
392 * Q4.2.2:: How do you have XEmacs display the line number in the modeline? | |
393 * Q4.2.3:: How do I get XEmacs to put the time of day on the modeline? | |
394 * Q4.2.4:: How can I change the modeline color based on the mode used? | |
395 | |
396 4.3: The Cursor | |
397 * Q4.3.1:: Is there a way to make the bar cursor thicker? | |
398 * Q4.3.2:: Is there a way to get back the block cursor? | |
399 * Q4.3.3:: Can I make the cursor blink? | |
400 | |
401 4.4: The Menubar | |
402 * Q4.4.1:: How do I get rid of the menubar? | |
403 * Q4.4.2:: How can I customize the menubar? | |
404 * Q4.4.3:: How do I enable use of the keyboard (@kbd{Alt}) to access menu items? | |
405 * Q4.4.4:: How do I control how many buffers are listed in the menu @code{Buffers List}? | |
406 * Q4.4.5:: Resources like @code{Emacs*menubar*font} are not working? | |
407 | |
408 4.5: The Toolbar | |
409 * Q4.5.1:: How do I get rid of the toolbar? | |
410 * Q4.5.2:: How can I customize the toolbar? | |
411 * Q4.5.3:: How can I bind a key to a function to toggle the toolbar? | |
412 * Q4.5.4:: @samp{Can't instantiate image error...} in toolbar | |
413 | |
414 4.6: Scrollbars and Scrolling | |
415 * Q4.6.1:: How can I disable the scrollbar? | |
416 * Q4.6.2:: How can I change the scrollbar width? | |
417 * Q4.6.3:: How can I use resources to change scrollbar colors? | |
418 * Q4.6.4:: Moving the scrollbar can move the point; can I disable this? | |
419 * Q4.6.5:: Scrolling one line at a time. | |
420 * Q4.6.6:: How can I turn off automatic horizontal scrolling in specific modes? | |
421 * Q4.6.7:: I find auto-show-mode disconcerting. How do I turn it off? | |
422 | |
423 4.7: The Gutter Tabs, The Progress Bar, Widgets | |
424 * Q4.7.1:: How can I disable the gutter tabs? | |
425 * Q4.7.2:: How can I disable the progress bar? | |
426 * Q4.7.3:: There are bugs in the gutter or widgets. | |
427 * Q4.7.4:: How can I customize the gutter or gutter tabs? | |
428 | |
429 5 Interfacing with the Operating System and External Devices | |
430 | |
431 5.0: X Window System and Resources | |
432 * Q5.0.1:: Where is a list of X resources? | |
433 * Q5.0.2:: How can I detect a color display? | |
434 * Q5.0.3:: How can I get the icon to just say @samp{XEmacs}? | |
435 * Q5.0.4:: How can I have the window title area display the full path? | |
436 * Q5.0.5:: @samp{xemacs -name junk} doesn't work? | |
437 * Q5.0.6:: @samp{-iconic} doesn't work. | |
4505
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
438 * Q5.0.7:: How can I use antialiased fonts under X11? |
2459 | 439 |
440 5.1: Microsoft Windows | |
441 * Q5.1.1:: Does XEmacs rename all the @samp{win32-*} symbols to @samp{w32-*}? | |
442 * Q5.1.2:: How do I get Windows Explorer to associate a file type with XEmacs? | |
443 | |
444 5.2: Printing | |
445 * Q5.2.1:: What do I need to change to make printing work? | |
446 * Q5.2.2:: How can I print WYSIWYG a font-locked buffer? | |
447 * Q5.2.3:: Getting @kbd{M-x lpr} to work with postscript printer. | |
448 * Q5.2.4:: Can you print under MS Windows? | |
449 | |
450 5.3: Sound | |
451 * Q5.3.1:: How do I turn off the sound? | |
452 * Q5.3.2:: How do I get funky sounds instead of a boring beep? | |
453 * Q5.3.3:: What are NAS and ESD (EsounD)? | |
454 * Q5.3.4:: Sunsite sounds don't play. | |
455 | |
456 5.4: Running an Interior Shell, Invoking Subprocesses | |
457 * Q5.4.1:: What is an interior shell? | |
458 * Q5.4.2:: How do I start up a second shell buffer? | |
459 * Q5.4.3:: Telnet from shell filters too much | |
460 * Q5.4.4:: Strange things are happening in Shell Mode. | |
461 * Q5.4.5:: XEmacs complains "No such file or directory, diff" | |
2995 | 462 * Q5.4.6:: Cygwin error "fork_copy: linked dll/bss pass 0 failed" |
2459 | 463 |
464 5.5: Multiple Device Support | |
465 * Q5.5.1:: How do I open a frame on another screen of my multi-headed display? | |
466 * Q5.5.2:: Can I really connect to a running XEmacs after calling up over a modem? How? | |
467 * Q5.5.3:: How do I disable gnuserv from opening a new frame? | |
468 * Q5.5.4:: How do I start gnuserv so that each subsequent XEmacs is a client? | |
469 * Q5.5.5:: Is there a way to start a new XEmacs if there's no gnuserv running, and otherwise use gnuclient? | |
470 | |
471 6 Connecting to the Internet | |
472 | |
473 6.0: General Mail and News | |
474 * Q6.0.1:: What are the various packages for reading mail? | |
475 * Q6.0.2:: How can I send mail? | |
476 * Q6.0.3:: How do I get my outgoing mail archived? | |
477 * Q6.0.4:: How can I read and/or compose MIME messages? | |
478 * Q6.0.5:: How do I customize the From line? | |
479 * Q6.0.6:: How do I get my MUA to filter mail for me? | |
480 * Q6.0.7:: Remote mail reading with an MUA. | |
481 * Q6.0.8:: An MUA gets an error incorporating new mail. | |
482 * Q6.0.9:: Why isn't @file{movemail} working? | |
483 * Q6.0.10:: How do I make my MUA display graphical smilies? | |
484 * Q6.0.11:: How can I get those oh-so-neat X-Face lines? | |
485 | |
486 6.1: Reading Mail with VM | |
487 * Q6.1.1:: How do I set up VM to retrieve mail from a remote site using POP? | |
488 * Q6.1.2:: How can I get VM to automatically check for new mail? | |
489 * Q6.1.3:: I have various addresses at which I receive mail. How can I tell VM to ignore them when doing a "reply-all"? | |
490 * Q6.1.4:: Is there a mailing list or FAQ for VM? | |
491 * Q6.1.5:: How do I make VM stay in a single frame? | |
492 * Q6.1.6:: Customization of VM not covered in the manual, or here. | |
493 | |
494 6.2: Reading Netnews and Mail with Gnus | |
495 * Q6.2.1:: GNUS, (ding) Gnus, Gnus 5, September Gnus, Red Gnus, Quassia Gnus, argh! | |
496 * Q6.2.2:: How do I make Gnus stay within a single frame? | |
497 | |
498 6.3: FTP Access | |
499 * Q6.3.1:: Can I edit files on other hosts? | |
500 * Q6.3.2:: What is EFS? | |
501 | |
502 6.4: Web Browsing with W3 | |
503 * Q6.4.1:: What is W3? | |
504 * Q6.4.2:: How do I run W3 from behind a firewall? | |
505 * Q6.4.3:: Is it true that W3 supports style sheets and tables? | |
506 | |
507 7 Advanced Customization Using XEmacs Lisp | |
508 | |
2537 | 509 7.0: Emacs Lisp and @file{init.el} |
510 * Q7.0.1:: What version of Emacs am I running? | |
511 * Q7.0.2:: How can I evaluate Emacs-Lisp expressions? | |
512 * Q7.0.3:: @code{(setq tab-width 6)} behaves oddly. | |
513 * Q7.0.4:: How can I add directories to the @code{load-path}? | |
514 * Q7.0.5:: How to check if a lisp function is defined? | |
515 * Q7.0.6:: Can I force the output of @code{(face-list)} to a buffer? | |
516 | |
517 7.1: Emacs Lisp Programming Techniques | |
518 * Q7.1.1:: What is the difference in key sequences between XEmacs and GNU Emacs? | |
519 * Q7.1.2:: Can I generate "fake" keyboard events? | |
520 * Q7.1.3:: Could you explain @code{read-kbd-macro} in more detail? | |
521 * Q7.1.4:: What is the performance hit of @code{let}? | |
522 * Q7.1.5:: What is the recommended use of @code{setq}? | |
523 * Q7.1.6:: What is the typical misuse of @code{setq}? | |
524 * Q7.1.7:: I like the @code{do} form of cl, does it slow things down? | |
525 * Q7.1.8:: I like recursion, does it slow things down? | |
526 * Q7.1.9:: How do I put a glyph as annotation in a buffer? | |
527 * Q7.1.10:: @code{map-extents} won't traverse all of my extents! | |
528 * Q7.1.11:: My elisp program is horribly slow. Is there an easy way to find out where it spends time? | |
529 | |
530 7.2: Mathematics | |
2559 | 531 * Q7.2.1:: What are bignums, ratios, and bigfloats in Lisp? |
532 * Q7.2.2:: XEmacs segfaults when I use very big numbers! | |
533 * Q7.2.3:: Bignums are really slow! | |
534 * Q7.2.4:: Equal bignums don't compare as equal! What gives? | |
2459 | 535 |
536 8 Other External Packages | |
537 | |
538 8.0: TeX | |
539 * Q8.0.1:: Is there something better than LaTeX mode? | |
540 * Q8.0.2:: What is AUCTeX? Where do you get it? | |
541 * Q8.0.3:: Problems installing AUCTeX. | |
542 * Q8.0.4:: How do I turn off current chapter from AUCTeX modeline? | |
543 | |
544 8.1: Other Unbundled Packages | |
545 * Q8.1.1:: Is there a reason for an Emacs package not to be included in XEmacs? | |
546 * Q8.1.2:: Are there any Emacs Lisp Spreadsheets? | |
547 * Q8.1.3:: Is there a MatLab mode? | |
548 | |
549 8.2: Environments Built Around XEmacs | |
550 * Q8.2.1:: What are SPARCworks, EOS, and WorkShop? | |
551 * Q8.2.2:: How do I start the Sun Workshop support in XEmacs 21? | |
552 * Q8.2.3:: What is/was Energize? | |
553 * Q8.2.4:: What is Infodock? | |
554 | |
555 9 What the Future Holds | |
556 | |
557 9.0: Changes | |
558 * Q9.0.1:: What new features will be in XEmacs soon? | |
559 * Q9.0.2:: What's new in XEmacs 21.4? | |
560 * Q9.0.3:: What's new in XEmacs 21.1? | |
561 * Q9.0.4:: What's new in XEmacs 20.4? | |
562 * Q9.0.5:: What's new in XEmacs 20.3? | |
563 * Q9.0.6:: What's new in XEmacs 20.2? | |
564 | |
565 10 New information about old XEmacsen | |
566 | |
567 10.0: XEmacs 21.1 | |
568 * Q10.0.1:: Gnus 5.10 won't display smileys in XEmacs 21.1. | |
2559 | 569 * Q10.0.2:: XEmacs won't start on Windows in XEmacs 21.1. |
570 | |
5028
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
571 11 Working with XEmacs source code repositories |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
572 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
573 11.0: The XEmacs repositories |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
574 * Q11.0.1:: Where is the most recent XEmacs development code? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
575 * Q11.0.2:: Where is the most recent XEmacs stable code? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
576 * Q11.0.3:: Where is the most recent XEmacs package code? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
577 * Q11.0.4:: Why isn't @var{package} available? and what to do about it. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
578 * Q11.0.5:: How do I get commit access? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
579 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
580 11.1: Working with CVS |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
581 * Q11.1.1:: How do I keep cool using CVS? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
582 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
583 11.2: Working with Mercurial |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
584 * Q11.2.1:: What is Mercurial? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
585 * Q11.2.2:: Where do I get Mercurial? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
586 * Q11.2.3:: Do I really have to waste space on history? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
587 * Q11.2.4:: @code{hg diff} gives bizarre output. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
588 * Q11.2.5:: How do I recover from a bad commit? (I already pushed.) |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
589 * Q11.2.6:: How do I recover from a bad commit? (I haven't pushed yet.) |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
590 * Q11.2.7:: Testing patches with Mercurial Queues. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
591 |
428 | 592 @end detailmenu |
593 @end menu | |
594 | |
595 @node Introduction, Installation, Top, Top | |
596 @unnumbered 1 Introduction, Policy, Credits | |
597 | |
598 Learning XEmacs is a lifelong activity. Even people who have used Emacs | |
599 for years keep discovering new features. Therefore this document cannot | |
600 be complete. Instead it is aimed at the person who is either | |
601 considering XEmacs for their own use, or has just obtained it and is | |
602 wondering what to do next. It is also useful as a reference to | |
603 available resources. | |
604 | |
2417 | 605 The previous maintainer of the FAQ was |
606 @email{rossini@@biostat.washington.edu, Anthony Rossini}, who started | |
607 it, after getting tired of hearing JWZ complain about repeatedly | |
608 having to answer questions. @email{ben@@xemacs.org, Ben Wing} then | |
609 took over and did a massive update reorganizing the whole thing. At | |
610 this point Anthony took back over, but then had to give it up again. | |
611 Some of the other contributors to this FAQ are listed later in this | |
612 document. | |
428 | 613 |
614 The previous version was converted to hypertext format, and edited by | |
615 @email{steve@@xemacs.org, Steven L. Baur}. It was converted back to | |
434 | 616 texinfo by @email{hniksic@@xemacs.org, Hrvoje Niksic}. The FAQ was then |
617 maintained by @email{andreas@@sccon.com, Andreas Kaempf}, who passed it | |
2417 | 618 on to ChristianNyb@o{}, and then to @email{wambold@@xemacs.org,Sandra Wambold}. |
619 | |
620 The current version of the FAQ has been heavily redone by | |
621 @email{ben@@xemacs.org, Ben Wing}. | |
428 | 622 |
623 If you notice any errors or items which should be added or amended to | |
2417 | 624 this FAQ please send email to @email{xemacs-beta@@xemacs.org}. |
625 Include @samp{XEmacs FAQ} on the Subject: line. | |
428 | 626 |
627 @menu | |
2537 | 628 1.0: What is XEmacs? |
2417 | 629 * Q1.0.1:: What is XEmacs? |
630 * Q1.0.2:: What is the current version of XEmacs? | |
2537 | 631 * Q1.0.3:: How do you pronounce XEmacs? |
632 * Q1.0.4:: What does XEmacs look like? | |
633 * Q1.0.5:: Who wrote XEmacs? | |
634 * Q1.0.6:: Who wrote the FAQ? | |
635 | |
636 1.1: Getting XEmacs | |
637 * Q1.1.1:: Where can I find XEmacs? | |
638 * Q1.1.2:: Are binaries available? | |
639 * Q1.1.3:: How do I get the bleeding-edge sources? | |
640 * Q1.1.4:: Where can I obtain a printed copy of the XEmacs User's Manual? | |
641 | |
642 1.2: Versions for Different Operating Systems | |
643 * Q1.2.1:: Do I need X11 to run XEmacs? | |
644 * Q1.2.2:: What versions of Unix does XEmacs run on? | |
645 * Q1.2.3:: Is there a port of XEmacs to Microsoft Windows? | |
646 * Q1.2.4:: Can I build XEmacs on MS Windows with X support? Do I need to? | |
647 * Q1.2.5:: What are Cygwin and MinGW, and do I need them to run XEmacs? | |
648 * Q1.2.6:: What are the differences between the various MS Windows emacsen? | |
649 * Q1.2.7:: How does the port cope with differences in the Windows user interface? | |
650 * Q1.2.8:: Is there a port of XEmacs to the Macintosh? | |
651 * Q1.2.9:: Is there a port of XEmacs to MS-DOS? | |
652 * Q1.2.10:: Is there a port of XEmacs to OS/2? | |
653 * Q1.2.11:: Is there a port of XEmacs to NextStep? | |
654 * Q1.2.12:: Is there a port of XEmacs to VMS? | |
655 | |
656 1.3: Getting Started | |
657 * Q1.3.1:: What is an @file{init.el} or @file{.emacs} and is there a sample one? | |
658 * Q1.3.2:: Where do I put my @file{init.el} file? | |
659 * Q1.3.3:: Can I use the same @file{init.el} with the other Emacs? | |
660 * Q1.3.4:: Any good XEmacs tutorials around? | |
661 * Q1.3.5:: May I see an example of a useful XEmacs Lisp function? | |
662 * Q1.3.6:: And how do I bind it to a key? | |
663 * Q1.3.7:: What's the difference between a macro and a function? | |
664 * Q1.3.8:: What is @code{Custom}? | |
665 | |
666 1.4: Getting Help | |
667 * Q1.4.1:: Where can I get help? | |
668 * Q1.4.2:: Which mailing lists are there? | |
2559 | 669 * Q1.4.3:: Where are the mailing lists archived? |
670 * Q1.4.4:: How can I get two instances of info? | |
671 * Q1.4.5:: How do I add new Info directories? | |
2537 | 672 |
673 1.5: Contributing to XEmacs | |
674 * Q1.5.1:: How do I submit changes to the FAQ? | |
675 * Q1.5.2:: How do I become a beta tester? | |
676 * Q1.5.3:: How do I contribute to XEmacs itself? | |
2559 | 677 * Q1.5.4:: How do I get started developing XEmacs? |
678 * Q1.5.5:: What's the basic layout of the code? | |
2537 | 679 |
680 1.6: Politics (XEmacs vs. GNU Emacs) | |
681 * Q1.6.1:: What is GNU Emacs? | |
682 * Q1.6.2:: How does XEmacs differ from GNU Emacs? | |
683 * Q1.6.3:: How much does XEmacs differ? | |
684 * Q1.6.4:: Is XEmacs "GNU"? | |
685 * Q1.6.5:: What is the correct way to refer to XEmacs and GNU Emacs? | |
686 * Q1.6.6:: Why haven't XEmacs and GNU Emacs merged? | |
687 | |
688 1.7: External Packages | |
2559 | 689 * Q1.7.1:: What is the package system? |
690 * Q1.7.2:: Which external packages are there? | |
691 * Q1.7.3:: Do I need to have the packages to run XEmacs? | |
692 * Q1.7.4:: Is there a way to find which package has particular functionality? | |
2537 | 693 |
694 1.8: Internationalization | |
695 * Q1.8.1:: What is the status of internationalization support aka MULE (including Asian language support)? | |
696 * Q1.8.2:: How can I help with internationalization? | |
697 * Q1.8.3:: How do I type non-ASCII characters? | |
698 * Q1.8.4:: Can XEmacs messages come out in a different language? | |
699 * Q1.8.5:: Please explain the various input methods in MULE/XEmacs | |
700 * Q1.8.6:: How do I portably code for MULE/XEmacs? | |
701 * Q1.8.7:: How about Cyrillic modes? | |
702 * Q1.8.8:: Does XEmacs support Unicode? | |
703 * Q1.8.9:: How does XEmacs display Unicode? | |
428 | 704 @end menu |
705 | |
2537 | 706 @unnumberedsec 1.0: What is XEmacs? |
2417 | 707 |
428 | 708 @node Q1.0.1, Q1.0.2, Introduction, Introduction |
709 @unnumberedsubsec Q1.0.1: What is XEmacs? | |
710 | |
479 | 711 XEmacs is a powerful, highly customizable open source text editor and |
2417 | 712 application development system, with full GUI support. It is |
713 protected under the GNU Public License and related to other versions | |
714 of Emacs, in particular GNU Emacs. Its emphasis is on modern | |
715 graphical user interface support and an open software development | |
716 model, similar to Linux. XEmacs has an active development community | |
717 numbering in the hundreds (and thousands of active beta testers on top | |
718 of this), and runs on all versions of MS Windows, on Mac OS X, on | |
719 Linux, and on nearly every other version of Unix in existence. | |
720 Support for XEmacs has been supplied by Sun Microsystems, University | |
721 of Illinois, Lucid, ETL/Electrotechnical Laboratory, Amdahl | |
722 Corporation, BeOpen, and others, as well as the unpaid time of a great | |
723 number of individual developers. | |
428 | 724 |
725 @node Q1.0.2, Q1.0.3, Q1.0.1, Introduction | |
726 @unnumberedsubsec Q1.0.2: What is the current version of XEmacs? | |
727 | |
2417 | 728 XEmacs versions 21.4.* are releases made from the current stable |
729 sources. XEmacs versions 21.5.* (which will be released as 22.0) are | |
730 releases made from the development sources. Check at | |
731 @uref{http://www.xemacs.org} for the current minor version. XEmacs | |
732 versions 21.1.* were the previous stable releases, now retired. | |
733 | |
734 XEmacs 20.4, released in February 1998, was the last release of v20. | |
735 | |
736 XEmacs 19.16, released in November, 1997. was the last release of v19, | |
737 and was also the last version without international language support. | |
428 | 738 |
739 @node Q1.0.3, Q1.0.4, Q1.0.2, Introduction | |
2537 | 740 @unnumberedsubsec Q1.0.3: How do you pronounce XEmacs? |
741 | |
4505
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
742 The most common pronounciation is @samp{Eks eemax}, @samp{Eks'im&ks} in |
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
743 Kirshenbaum IPA. (See |
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
744 @uref{http://www.kirshenbaum.net/IPA/ascii-ipa.pdf} if you know the IPA |
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
745 already and want to know how to map from Kirshenbaum to it.) |
428 | 746 |
747 @node Q1.0.4, Q1.0.5, Q1.0.3, Introduction | |
2537 | 748 @unnumberedsubsec Q1.0.4: What does XEmacs look like? |
749 | |
750 Screen snapshots are available at | |
751 @uref{http://www.xemacs.org/About/Screenshots/index.html} | |
752 as part of the XEmacs website. | |
753 | |
754 @node Q1.0.5, Q1.0.6, Q1.0.4, Introduction | |
755 @unnumberedsubsec Q1.0.5: Who wrote XEmacs? | |
756 | |
757 XEmacs is the result of the time and effort of many people, and the | |
758 active developers have changed over time. There are two major | |
759 components of the XEmacs effort -- writing the code itself and providing | |
760 all the support work (testing the code, releasing beta and final | |
761 versions, handling patches, reading bug reports, maintaining the web | |
762 site, managing the mailing lists, etc. etc.). Neither component would | |
763 work without the other. | |
764 | |
765 @subheading CODING | |
766 | |
767 The primary code contributor over the years has been Ben Wing (active | |
768 since late 1992). Between 1991 and 1995, large amounts of coding was | |
769 contributed by Jamie Zawinski and Chuck Thompson. Many other people | |
770 have authored major subsystems or otherwise contributed large amounts of | |
771 code, including Andy Piper, Hrvoje Niksic, Jerry James, Jonathan Harris, | |
772 Kyle Jones, Martin Buchholz, Michael Sperber, Olivier Galibert, Richard | |
773 Mlynarik, Stig, William Perry and plenty of others. | |
774 | |
775 Primary XEmacs-specific subsystems and their authors: | |
776 | |
777 @table @asis | |
778 @item Objects | |
779 @itemize @minus | |
780 @item | |
781 Conversion from 26-bit to 28-bit pointers and integers, lrecords, lcrecords: Richard Mlynarik, 1994 | |
782 @item | |
783 Conversion to 32-bit pointers and 31-bit integers: Kyle Jones, Martin Buchholz | |
784 @item | |
785 Portable dumper, object descriptions: Olivier Galibert | |
786 @item | |
787 KKCC (new garbage collector), ephemerons, weak boxes: Michael Sperber and students | |
788 @item | |
789 Random object work (object equal and hash methods, weak lists, lcrecord lists, bit vectors, dynarr, blocktype, opaque, string resizing): Ben Wing | |
790 @item | |
791 Profiling: Ben Wing | |
792 @item | |
793 Some byte-compilation and hash-table improvements: Martin Buchholz | |
794 @item | |
795 Bignum: Jerry James | |
796 @end itemize | |
797 | |
798 @item Internationalization/Mule | |
799 @itemize @minus | |
800 @item | |
801 mostly Ben Wing; many ideas for future work, Stephen Turnbull | |
802 @end itemize | |
803 | |
804 @item I/O | |
805 @itemize @minus | |
806 @item | |
807 Basic event/event-stream implementation: Jamie Zawinski | |
808 @item | |
809 Most event work since 1994: Ben Wing | |
810 @item | |
811 Asynchronous stuff (async timeouts, signals, quit-checking): Ben Wing | |
812 @item | |
813 Process method abstraction, Windows process work: Kirill Katsnelson | |
814 @item | |
815 Misc-user events, async timeouts, most quit-checking and signal code, most other work since 1994: Ben Wing | |
816 @item | |
817 Lstreams: Ben Wing | |
818 @end itemize | |
819 | |
820 @item Display | |
821 @itemize @minus | |
822 @item | |
823 Redisplay mechanism: implementation, Chuck Thompson; additional work, lots of people | |
824 @item | |
825 Glyphs: mostly Ben Wing | |
826 @item | |
827 Specifiers: Ben Wing | |
828 @item | |
829 Extents: initial implementation, someone at Lucid; rewrite, 1994, Ben Wing | |
830 @item | |
831 Widgets: Andy Piper | |
832 @item | |
833 JPEG/PNG/TIFF image converters: Ben Wing, William Perry, Jareth Hein, others (see comment in @file{glyphs-eimage.c}) | |
834 @item | |
835 Menus: Jamie Zawinski, someone at Lucid (Lucid menus) | |
836 @item | |
837 Scrollbars: Chuck Thompson, ??? (Lucid scrollbar) | |
838 @item | |
839 Multi-device/device-independence work (console/device/etc methods): Ben Wing, prototype by chuck thompson | |
840 @item | |
841 Faces: first implementation, Jamie Zawinski; second, chuck; third, Ben Wing | |
842 @item | |
843 Fonts/colors: first implementation, Jamie Zawinski; further work, Ben Wing | |
844 @item | |
845 Toolbars: implementation, chuck, much interface work, Ben Wing | |
846 @item | |
847 Gutters, tabs: andy piper | |
848 @end itemize | |
849 | |
850 @item Device subsystems | |
851 @itemize @minus | |
852 @item | |
4311 | 853 X Windows: Jamie Zawinski, Ben Wing, others |
2537 | 854 @item |
855 GTK: William Perry, Malcolm Purvis | |
856 @item | |
857 MS Windows: initial implementation, Jonathan Harris; some more work, Andy Piper, Ben Wing | |
858 @item | |
859 TTY: Chuck Thompson, Ben Wing | |
860 @item | |
861 Cygwin: Andy Piper | |
862 @end itemize | |
863 | |
864 @item Misc | |
865 @itemize @minus | |
866 @item | |
867 Configure: initial porting from fsf, Chuck Thompson; conversion to autoconf 2, much rewriting, Martin Buchholz | |
868 @item | |
869 Most initialization-related code: Ben Wing | |
870 @item | |
871 Internals manual, much of Lisp manual: Ben Wing | |
872 @item | |
873 FSF synching: initial sync with FSF 19, Richard Mlynarik, further work, Ben Wing | |
874 @end itemize | |
875 @end table | |
876 | |
877 @subheading SUPPORT | |
878 | |
879 Currently, support duties are handled by many different people. | |
880 | |
881 Release managers have been | |
882 | |
883 @itemize @minus | |
884 @item | |
885 Stephen Turnbull (April 2001 - January 2003, March 2004 - present, 21.2.47 - 21.4.12, 21.5.2 - 21.5.7, 21.5.17 - present) | |
886 @item | |
887 Vin Shelton (May 2003 - present, 21.4.13 - present) | |
888 @item | |
889 Steve Youngs (July 2002 - September 2003, 21.5.8 - 21.5.16) | |
890 @item | |
891 Martin Buchholz (December 1998, November 1999 - May 2001, 21.2.7 - 21.2.8, 21.2.21 - 21.2.46, 21.5.0 - 21.5.1) | |
892 @item | |
893 Steve Baur (early 1997 - December 1998, February 1999 - November 1999, 19.15 - 21.2.5, 21.2.9 - 21.2.20) | |
894 @item | |
895 Andy Piper (December 1998, 21.2.6) | |
896 @item | |
897 Chuck Thompson (June 1994 - September 1996, 19.11 - 19.14) | |
898 @item | |
899 Jamie Zawinski (April 1991 - June 1994, 19.0 - 19.10) | |
900 @end itemize | |
901 | |
902 The recent overlapping dates are intentional, since two or three trees | |
903 are maintained simultaneously at any point. | |
904 | |
905 Other major support work: | |
906 | |
907 @itemize @minus | |
908 @item | |
909 Adrian Aichner wrote and maintains the web site. | |
910 @item | |
911 Stephen Turnbull has produced many of the beta and semi-stable releases | |
912 and has attempted to be the "face" of XEmacs on the newsgroups and | |
913 mailing lists. | |
914 @item | |
915 Steve Youngs currently produces the beta releases (???). | |
916 @item | |
4311 | 917 Steve Youngs, Ville Skyttä, and now Norbert Koch have taken turns |
2537 | 918 maintaining the packages. |
919 @item | |
920 Vin Shelton maintains the stable releases. | |
921 @item | |
922 Testing - #### Norbert, Adrian, ??? | |
923 @end itemize | |
924 | |
925 Portraits and email of some of the major developers: | |
926 | |
927 @itemize @bullet | |
928 @item @email{andy@@xemacs.org, Andy Piper} | |
929 @html | |
930 <br><img src="piper.png" alt="Portrait of Andy Piper"><br> | |
931 @end html | |
932 | |
933 @item @email{ben@@xemacs.org, Ben Wing} | |
934 @html | |
935 <br><img src="ben.png" alt="Portrait of Ben Wing"><br> | |
936 @end html | |
937 | |
938 @item @email{cthomp@@xemacs.org, Chuck Thompson} | |
939 @html | |
940 <br><img src="cthomp.png" alt="Portrait of Chuck Thompson"><br> | |
941 @end html | |
942 | |
943 @item @email{hniksic@@xemacs.org, Hrvoje Niksic} | |
944 | |
945 @html | |
946 <br><img src="hniksic.png" alt="Portrait of Hrvoje Niksic"><br> | |
947 @end html | |
948 | |
949 @item @email{jwz@@jwz.org, Jamie Zawinski} | |
950 @html | |
951 <br><img src="jwz.png" alt="Portrait of Jamie Zawinski"><br> | |
952 @end html | |
953 | |
954 @item @email{martin@@xemacs.org, Martin Buchholz} | |
955 @html | |
956 <br><img src="martin.png" alt="Portrait of Martin Buchholz"><br> | |
957 @end html | |
958 | |
959 @item @email{mly@@adoc.xerox.com, Richard Mlynarik} | |
960 @html | |
961 <br><img src="mly.png" alt="Portrait of Richard Mlynarik"><br> | |
962 @end html | |
963 | |
964 @item @email{stephen@@xemacs.org, Stephen Turnbull} | |
965 | |
966 @item @email{steve@@xemacs.org, Steve Baur} | |
967 @html | |
968 <br><img src="slb.png" alt="Portrait of Steve Baur"><br> | |
969 @end html | |
970 @end itemize | |
971 | |
972 Many other people have contributed to XEmacs; this is partially | |
973 enumerated in the @samp{About XEmacs} option in the Help menu. | |
974 | |
975 @node Q1.0.6, Q1.1.1, Q1.0.5, Introduction | |
976 @unnumberedsubsec Q1.0.6: Who wrote the FAQ? | |
977 | |
978 The current version of this FAQ was created by @email{ben@@xemacs.org, | |
979 Ben Wing}. | |
980 | |
981 Previous contributors to the FAQ include | |
982 | |
983 @itemize @bullet | |
984 @item @email{steve@@xemacs.org, SL Baur} | |
985 | |
986 @item @email{hniksic@@xemacs.org, Hrvoje Niksic} | |
987 | |
988 @item @email{binge@@aloft.att.com, Curtis.N.Bingham} | |
989 | |
990 @item @email{bruncott@@dormeur.inria.fr, Georges Brun-Cottan} | |
991 | |
992 @item @email{rjc@@cogsci.ed.ac.uk, Richard Caley} | |
993 | |
994 @item @email{cognot@@ensg.u-nancy.fr, Richard Cognot} | |
995 | |
996 @item @email{daku@@nortel.ca, Mark Daku} | |
997 | |
998 @item @email{wgd@@martigny.ai.mit.edu, William G. Dubuque} | |
999 | |
1000 @item @email{eeide@@cs.utah.edu, Eric Eide} | |
1001 | |
1002 @item @email{af@@biomath.jussieu.fr, Alain Fauconnet} | |
1003 | |
1004 @item @email{cflatter@@nrao.edu, Chris Flatters} | |
1005 | |
1006 @item @email{ginsparg@@adra.com, Evelyn Ginsparg} | |
1007 | |
1008 @item @email{hall@@aplcenmp.apl.jhu.edu, Marty Hall} | |
1009 | |
1010 @item @email{dkindred@@cmu.edu, Darrell Kindred} | |
1011 | |
1012 @item @email{dmoore@@ucsd.edu, David Moore} | |
1013 | |
1014 @item @email{arup+@@cmu.edu, Arup Mukherjee} | |
1015 | |
1016 @item @email{nickel@@prz.tu-berlin.de, Juergen Nickelsen} | |
1017 | |
1018 @item @email{powell@@csl.ncsa.uiuc.edu, Kevin R. Powell} | |
1019 | |
1020 @item @email{dworkin@@ccs.neu.edu, Justin Sheehy} | |
1021 | |
1022 @item @email{stig@@hackvan.com, Stig} | |
1023 | |
1024 @item @email{Aki.Vehtari@@hut.fi, Aki Vehtari} | |
1025 @end itemize | |
1026 | |
1027 @unnumberedsec 1.1: Getting XEmacs | |
1028 | |
1029 @node Q1.1.1, Q1.1.2, Q1.0.6, Introduction | |
1030 @unnumberedsubsec Q1.1.1: Where can I find XEmacs? | |
1031 | |
1032 To download XEmacs, visit the XEmacs WWW page at | |
1033 @uref{http://www.xemacs.org/Download/}. The most up-to-date list of | |
1034 distribution sites can always be found there. Try to pick a site that | |
1035 is networkologically close to you. If you know of other mirrors of | |
1036 the XEmacs archives, please send e-mail to | |
1037 @uref{mailto:webmaster@@xemacs.org} and we will list them here as well. | |
1038 | |
1039 The canonical distribution point is ftp.xemacs.org, available either | |
1040 through HTTP (@uref{http://ftp.xemacs.org/}) or anonymous FTP | |
1041 (@uref{ftp://ftp.xemacs.org/pub/xemacs/}). | |
1042 | |
1043 @node Q1.1.2, Q1.1.3, Q1.1.1, Introduction | |
1044 @unnumberedsubsec Q1.1.2: Are binaries available? | |
2417 | 1045 |
1046 MS Windows binaries are available at | |
1047 @uref{http://www.xemacs.org/Download/win32/} for the native versions | |
1048 of 21.4 and 21.1. Cygwin binaries are now available as part of the | |
1049 standard Cygwin installation process. XEmacs also comes pre-built as | |
1050 part of many Linux distributions, such as Red Hat and SuSE. | |
1051 | |
1052 Otherwise, you will need to build XEmacs yourself or get your system | |
1053 administrator to do it. Generally, this is not a difficult process | |
1054 under Unix and Mac OS X, as XEmacs has been tested under all of the | |
1055 common Unix versions and under Mac OS X and comes with an extensive | |
1056 configure script that is able to automatically detect most aspects of | |
1057 the configuration of your particular system. | |
1058 | |
2537 | 1059 @node Q1.1.3, Q1.1.4, Q1.1.2, Introduction |
1060 @unnumberedsubsec Q1.1.3: How do I get the bleeding-edge sources? | |
1061 | |
1062 If you are interested in developing XEmacs, or getting the absolutely most | |
1063 recent, up-to-the-moment, bleeding-edge source code, you can directly | |
1064 access the master CVS source tree (read-only, of course, until you ask for | |
1065 and are granted permission to directly modify portions of the source tree) | |
1066 at cvs.xemacs.org. Directions on how to access the source tree are located | |
1067 at @uref{http://www.xemacs.org/Develop/cvsaccess.html}. | |
1068 | |
1069 Nightly CVS snapshots are available at | |
1070 @uref{http://www.dk.xemacs.org/Download/CVS-snapshots/}. | |
1071 | |
1072 @node Q1.1.4, Q1.2.1, Q1.1.3, Introduction | |
1073 @unnumberedsubsec Q1.1.4: Where can I obtain a printed copy of the XEmacs User's Manual? | |
1074 | |
1075 Pre-printed manuals are not available. If you are familiar with | |
1076 TeX, you can generate your own manual from the XEmacs sources. | |
1077 | |
1078 HTML and Postscript versions of XEmacs manuals are available from the | |
1079 XEmacs web site at | |
1080 @uref{http://www.xemacs.org/Documentation/index.html}. | |
1081 | |
1082 @unnumberedsec 1.2: Versions for Different Operating Systems | |
1083 | |
1084 @node Q1.2.1, Q1.2.2, Q1.1.4, Introduction | |
1085 @unnumberedsubsec Q1.2.1: Do I need X11 to run XEmacs? | |
1086 | |
1087 No. The name @dfn{XEmacs} is unfortunate in the sense that it is | |
1088 @strong{not} an X Window System-only version of Emacs. XEmacs has | |
1089 full color support on a color-capable character terminal. | |
1090 | |
1091 @node Q1.2.2, Q1.2.3, Q1.2.1, Introduction | |
1092 @unnumberedsubsec Q1.2.2: What versions of Unix does XEmacs run on? | |
1093 | |
4759
aa5ed11f473b
Remove support for obsolete systems. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
4658
diff
changeset
|
1094 XEmacs is regularly tested on Linux, Solaris and OpenSolaris, HP/UX, |
aa5ed11f473b
Remove support for obsolete systems. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
4658
diff
changeset
|
1095 FreeBSD, OpenBSD, Cygwin, Mac OS X, and probably others. It should work |
aa5ed11f473b
Remove support for obsolete systems. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
4658
diff
changeset
|
1096 on all versions of Unix created in the last 10 years or so, perhaps with |
aa5ed11f473b
Remove support for obsolete systems. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
4658
diff
changeset
|
1097 a bit of work on more obscure platforms to correct bit-rot. It uses a |
aa5ed11f473b
Remove support for obsolete systems. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
4658
diff
changeset
|
1098 sophisticated configuration system to auto-detect zillions of features |
aa5ed11f473b
Remove support for obsolete systems. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
4658
diff
changeset
|
1099 that are implemented differently in different versions of Unix, so it |
aa5ed11f473b
Remove support for obsolete systems. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
4658
diff
changeset
|
1100 will probably work on your vendor's version, possibly with a bit of |
aa5ed11f473b
Remove support for obsolete systems. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
4658
diff
changeset
|
1101 tweaking, even if we've never heard of it. |
2559 | 1102 |
2537 | 1103 For problems with particular machines and versions of Unix, see the |
1104 @file{PROBLEMS} file. | |
1105 | |
1106 Much effort has gone into making XEmacs work on as many different | |
1107 machines, configurations, and compilers as possible. | |
1108 | |
1109 Much effort has gone into making XEmacs 64-bit clean. | |
1110 | |
1111 Much effort has gone into removing system-specific code, and replacing | |
1112 such code with autodetection at configure time. | |
1113 | |
1114 The XEmacs core should build "out of the box" on most Unix-like systems. | |
1115 | |
1116 XEmacs 21.2 was tested and @samp{make check} succeeded on these Unix | |
1117 configurations as of 2001-02-10: | |
1118 | |
1119 @example | |
1120 alphaev56-dec-osf4.0e (both Compaq C and gcc) | |
1121 i386-unknown-freebsd4.2 | |
1122 i386-unknown-netbsdelf1.5 | |
1123 i586-sco-sysv5uw7.0.1 (both SCO's cc and gcc) | |
1124 i686-pc-linux-gnu | |
1125 hppa2.0-hp-hpux10.20 (both HP's ANSI cc and gcc) | |
1126 mips-sgi-irix6.5 (both MIPSpro cc and gcc) | |
1127 rs6000-ibm-aix4.3.0.0 (both IBM's xlc and gcc) | |
1128 sparc-sun-solaris2.6 (both Sun's Forte C and gcc) | |
1129 sparc-sun-solaris2.7 (both Sun's Forte C and gcc) | |
1130 sparc-sun-sunos4.1.4 (gcc) | |
1131 @end example | |
1132 | |
3018 | 1133 Some systems have a dual mode 32-bit/64-bit compiler. On most of these, |
1134 XEmacs requires the @samp{--pdump} (in XEmacs 21.5, | |
1135 @samp{--enable-pdump}) configure option to build correctly with the | |
1136 64-bit version of the compiler. | |
2537 | 1137 |
1138 @example | |
1139 mips-sgi-irix6.5, CC="gcc -mabi=64" | |
1140 mips-sgi-irix6.5, CC="cc -64" | |
1141 rs6000-ibm-aix4.3.0.0, CC="cc -q64" | |
1142 @end example | |
1143 | |
1144 On most of these systems, XEmacs also builds with a C++ compiler, | |
1145 but not "out of the box". This feature is only for use by the | |
1146 maintainers. | |
1147 | |
1148 XEmacs 21.2 is known @emph{not} to work on any machines with m680x0 | |
1149 processors. Sorry, all you sun3 and Unix PC nostalgia buffs out there. | |
1150 | |
1151 VMS has never been supported by XEmacs. In fact, all the old VMS code | |
1152 inherited from Emacs has been removed. Sorry, all you VMS fans out there. | |
1153 | |
1154 @node Q1.2.3, Q1.2.4, Q1.2.2, Introduction | |
1155 @unnumberedsubsec Q1.2.3: Is there a port of XEmacs to Microsoft Windows? | |
1156 | |
1157 Yes. Beginning with release 21.0, XEmacs has worked under MS Windows | |
1158 and is fully-featured and actively developed. A group of dedicated | |
1159 developers actively maintains and improves the Windows-specific | |
1160 portions of the code. Some of the core developers, in fact, use | |
1161 Windows as their only development environment, and some features, such | |
1162 as printing, actually work better on Windows than native Unix and Mac | |
1163 OS X. The mailing list at @email{xemacs-winnt@@xemacs.org} is dedicated | |
1164 to that effort (please use the -request address to | |
1165 subscribe). (Despite its name, XEmacs actually works on all versions | |
1166 of Windows.) | |
1167 | |
1168 The list name is misleading, as XEmacs supports and has been compiled on | |
1169 Windows 95, Windows 98, Windows NT, Windows 2000, Windows ME, Windows | |
1170 XP, and all newer versions of Windows. The MS Windows-specific code is | |
1171 based on Microsoft Win32 API, and will not work on MS Windows 3.x or on | |
1172 MS-DOS. | |
1173 | |
1174 XEmacs also supports the Cygwin and MinGW development and runtime | |
1175 environments, where it also uses native Windows code for graphical | |
1176 features. In addition, under Cygwin it is possible to compile XEmacs | |
1177 to use an X server (and XFree86 is available as part of the standard | |
1178 Cygwin installation). | |
1179 | |
1180 @node Q1.2.4, Q1.2.5, Q1.2.3, Introduction | |
1181 @unnumberedsubsec Q1.2.4: Can I build XEmacs on MS Windows with X support? Do I need to? | |
1182 | |
1183 Yes, you can, but no you do not need to. In fact, we recommend that you | |
1184 use a native-GUI version unless you have a specific need for an X | |
1185 version. | |
1186 | |
1187 @node Q1.2.5, Q1.2.6, Q1.2.4, Introduction | |
1188 @unnumberedsubsec Q1.2.5: What are Cygwin and MinGW, and do I need them to run XEmacs? | |
1189 | |
1190 To answer the second part of the question: No, you, you don't need | |
1191 Cygwin or MinGW to build or to run XEmacs. But if you have them and | |
1192 want to use them, XEmacs supports these environments. | |
1193 | |
1194 (One important reason to support Cygwin is that it lets the MS Windows | |
1195 developers test out their code in a Unix environment without actually | |
1196 having to have a Unix machine around. For this reason alone, Cygwin | |
1197 support is likely to remain supported for a long time in XEmacs. Same | |
1198 goes for the X support under Cygwin, for the same reasons. MinGW | |
1199 support, on the other hand, depends on volunteers to keep it up to date; | |
1200 but this is generally not hard.) | |
1201 | |
1202 Cygwin is a set of tools providing Unix-like API on top of Win32. | |
1203 It makes it easy to port large Unix programs without significant | |
1204 changes to their source code. It is a development environment as well | |
1205 as a runtime environment. | |
1206 | |
1207 When built with Cygwin, XEmacs supports all display types -- TTY, X & | |
1208 Win32 GUI, and can be built with support for all three simultaneously. | |
1209 If you build with Win32 GUI support then the Cygwin version uses the | |
1210 majority of the Windows-specific code, which is mostly related to | |
1211 display. If you want to build with X support you need X libraries (and | |
2559 | 1212 an X server to display XEmacs on); see @ref{Q2.3.7}. TTY and Win32 GUI |
2537 | 1213 require no additional libraries beyond what comes standard with Cygwin. |
1214 | |
1215 The advantages of the Cygwin version are that it integrates well with | |
1216 the Cygwin environment for existing Cygwin users; uses configure so | |
1217 building with different features is very easy; and actively supports X & | |
1218 TTY. Furthermore, the entire Cygwin environment and compiler are free, | |
1219 whereas Visual C++ costs money. | |
1220 | |
1221 The disadvantage is that it requires the whole Cygwin environment, | |
1222 whereas the native port requires only a suitable MS Windows compiler. | |
1223 Also, it follows the Unix filesystem and process model very closely | |
1224 (some will undoubtedly view this as an advantage). | |
1225 | |
1226 See @uref{http://www.cygwin.com/} for more information on | |
1227 Cygwin. | |
1228 | |
1229 MinGW is a collection of header files and import libraries that allow | |
1230 one to use GCC under the Cygwin environment to compile and produce | |
1231 exactly the same native Win32 programs that you can using Visual C++. | |
1232 Programs compiled with MinGW make use of the standard Microsoft runtime | |
1233 library @file{MSVCRT.DLL}, present on all Windows systems, and look, | |
1234 feel, and act like a standard Visual-C-produced application. (The only | |
1235 difference is the compiler.) This means that, unlike a | |
1236 standardly-compiled Cygwin application, no extra runtime support | |
1237 (e.g. Cygwin's @file{cygwin1.dll}) is required. This, along with the | |
1238 fact that GCC is free (and works in a nice Unix-y way in a nice Unix-y | |
1239 environment, for those die-hard Unix hackers out there), is the main | |
1240 advantage of MinGW. It is also potentially faster than Cygwin because | |
1241 it has less overhead when calling Windows, but you lose the POSIX | |
1242 emulation layer, which makes Unix programs harder to port. (But this is | |
1243 irrelevant for XEmacs since it's already ported to Win32.) | |
1244 | |
1245 See @uref{http://www.mingw.org/} for more information on MinGW. | |
1246 | |
1247 @node Q1.2.6, Q1.2.7, Q1.2.5, Introduction | |
1248 @unnumberedsubsec Q1.2.6: What are the differences between the various MS Windows emacsen? | |
1249 | |
1250 XEmacs, Win-Emacs, DOS Emacs, NT Emacs, this is all very confusing. | |
1251 Could you briefly explain the differences between them? | |
1252 | |
1253 Here is a recount of various Emacs versions running on MS Windows: | |
1254 | |
1255 @itemize @bullet | |
1256 | |
1257 @item | |
1258 XEmacs | |
1259 | |
1260 @itemize @minus | |
1261 | |
1262 @item | |
1263 Beginning with XEmacs 19.12, XEmacs' architecture was redesigned | |
1264 in such a way to allow clean support of multiple window systems. At | |
1265 this time the TTY support was added, making X and TTY the first two | |
1266 "window systems" supported by XEmacs. The 19.12 design is the basis for | |
1267 the current native MS Windows code. | |
1268 | |
1269 @item | |
1270 Some time during 1997, David Hobley (soon joined by Marc Paquette) | |
1271 imported some of the NT-specific portions of GNU Emacs, making XEmacs | |
1272 with X support compile under Windows NT, and creating the "X" port. | |
1273 | |
1274 @item | |
1275 Several months later, Jonathan Harris sent out initial patches to use | |
1276 the Win32 API, thus creating the native port. Since then, various | |
1277 people have contributed, including Kirill M. Katsnelson (contributed | |
1278 support for menubars, subprocesses and network, as well as loads of | |
1279 other code), Andy Piper (ported XEmacs to Cygwin environment, | |
1280 contributed Windows unexec, Windows-specific glyphs and toolbars code, | |
1281 and more), Ben Wing (loads of improvements; primary MS Windows developer | |
1282 since 2000), Jeff Sparkes (contributed scrollbars support) and many | |
1283 others. | |
1284 @end itemize | |
1285 | |
1286 @item | |
1287 NT Emacs | |
1288 | |
1289 @itemize @minus | |
1290 | |
1291 @item | |
1292 NT Emacs was an early version of GNU Emacs 19 modified to compile and | |
1293 run under MS Windows 95 and NT using the native Win32 API. It was | |
1294 written by Geoff Voelker, and has long since been incorporated into | |
1295 the mainline GNU Emacs distribution. | |
1296 @end itemize | |
1297 | |
1298 @item | |
1299 Win-Emacs | |
1300 | |
1301 @itemize @minus | |
1302 | |
1303 @item | |
1304 Win-Emacs was a port of Lucid Emacs 19.6 to MS Windows using X | |
1305 compatibility libraries. Win-Emacs was written by Ben Wing. The MS | |
1306 Windows code never made it back to Lucid Emacs, and its creator (Pearl | |
1307 Software) has long since gone out of business. | |
1308 @end itemize | |
1309 | |
1310 @item | |
1311 GNU Emacs for DOS | |
1312 | |
1313 @itemize @minus | |
1314 | |
1315 @item | |
1316 GNU Emacs features support for MS-DOS and DJGPP (D.J. Delorie's DOS | |
1317 port of GCC). Such an Emacs is heavily underfeatured, because it does | |
1318 not support long file names, lacks proper subprocesses support, and | |
1319 is far too big compared with typical DOS editors. | |
1320 @end itemize | |
1321 | |
1322 @item | |
1323 GNU Emacs compiled with Win32 | |
1324 | |
1325 @itemize @minus | |
1326 | |
1327 @item | |
1328 Starting with GNU Emacs 19.30, it has been possible to compile GNU Emacs | |
1329 under MS Windows using the DJGPP compiler and X libraries. The result | |
1330 is very similar to GNU Emacs compiled under MS DOS, only it works | |
1331 somewhat better because it runs in 32-bit mode, makes use of all the | |
1332 system memory, supports long file names, etc. | |
1333 @end itemize | |
1334 | |
1335 @end itemize | |
1336 | |
1337 @node Q1.2.7, Q1.2.8, Q1.2.6, Introduction | |
1338 @unnumberedsubsec Q1.2.7: How does the port cope with differences in the Windows user interface? | |
1339 | |
1340 The XEmacs (and Emacs in general) user interface is pretty different | |
1341 from what is expected of a typical MS Windows program. How does the MS | |
1342 Windows port cope with it? | |
1343 | |
1344 As a general rule, we follow native MS Windows conventions as much as | |
1345 possible. 21.4 is a fairly complete Windows application, supporting | |
1346 native printing, system file dialog boxes, tool tips, etc. In cases | |
1347 where there's a clear UI conflict, we currently use normal Unix XEmacs | |
1348 behavior by default, but make sure the MS Windows "look and feel" (mark | |
1349 via shift-arrow, self-inserting deletes region, Alt selects menu items, | |
1350 etc.) is easily configurable (respectively: using the variable | |
1351 @code{shifted-motion-keys-select-region} in 21.4 and above [it's in fact | |
1352 the default in these versions], or the @file{pc-select} package; using | |
1353 the @file{pending-del} package; and setting the variable | |
1354 @code{menu-accelerator-enabled} to @code{menu-force} in 21.4 and above). | |
1355 In fact, if you use the sample @file{init.el} file as your init file, | |
1356 you will get all these behaviors automatically turned on. | |
1357 | |
1358 In future versions, some of these features might be turned on by | |
1359 default in the MS Windows environment. | |
1360 | |
1361 @node Q1.2.8, Q1.2.9, Q1.2.7, Introduction | |
1362 @unnumberedsubsec Q1.2.8: Is there a port of XEmacs to the Macintosh? | |
1363 | |
1364 Yes. | |
1365 | |
1366 XEmacs 21.5 (perhaps 21.4 also?) works on MacOS X, although it certainly | |
1367 will not feel very much like a Mac application as it has no Mac-specific | |
1368 code in it. | |
1369 | |
1370 There is also a port of XEmacs 19.14 that works on all recent versions | |
1371 of MacOS, from 8.1 through MacOS X, by @email{pjarvis@@ispchannel.com, | |
1372 Pitts Jarvis} (recently deceased). It runs in an equivalent of TTY | |
1373 mode only (one single Macintosh window, 25 colors), but has a large | |
1374 number of Mac-specific additions. It's available at | |
1375 @uref{http://homepage.mac.com/pjarvis/xemacs.html}. | |
1376 | |
1377 @node Q1.2.9, Q1.2.10, Q1.2.8, Introduction | |
2559 | 1378 @unnumberedsubsec Q1.2.9: Is there a port of XEmacs to MS-DOS? |
1379 | |
1380 No. We have never supported running on MS-DOS or Windows 3.1, and in | |
1381 fact have long since deleted all MS-DOS-related code. We're not | |
1382 particularly interested in patches for these platforms, as they would | |
1383 introduce huge amounts of code clutter due to the woefully | |
1384 underfeatured nature of these systems. (See GNU Emacs for a port to | |
1385 MS-DOS.) | |
2537 | 1386 |
1387 @node Q1.2.10, Q1.2.11, Q1.2.9, Introduction | |
2559 | 1388 @unnumberedsubsec Q1.2.10: Is there a port of XEmacs to OS/2? |
2537 | 1389 |
1390 No, but Alexander Nikolaev <avn_1251@@mail.ru> was at one point | |
1391 working on it. | |
1392 | |
2559 | 1393 @node Q1.2.11, Q1.2.12, Q1.2.10, Introduction |
1394 @unnumberedsubsec Q1.2.11: Is there a port of XEmacs to NextStep? | |
2537 | 1395 |
1396 Carl Edman, apparently no longer at @email{cedman@@princeton.edu}, did | |
1397 the port of GNU Emacs to NeXTstep and expressed interest in doing the | |
1398 XEmacs port, but never went any farther. | |
1399 | |
2559 | 1400 @node Q1.2.12, Q1.3.1, Q1.2.11, Introduction |
1401 @unnumberedsubsec Q1.2.12: Is there a port of XEmacs to VMS? | |
2537 | 1402 |
1403 VMS has never been supported by XEmacs. In fact, all the old VMS code | |
1404 inherited from GNU Emacs has been removed. Sorry, all you VMS fans | |
1405 out there. | |
1406 | |
1407 @unnumberedsec 1.3: Getting Started | |
1408 | |
2559 | 1409 @node Q1.3.1, Q1.3.2, Q1.2.12, Introduction |
2537 | 1410 @unnumberedsubsec Q1.3.1: What is an @file{init.el} or @file{.emacs} and is there a sample one? |
1411 | |
1412 The @file{init.el} or @file{.emacs} file is used to customize XEmacs to | |
1413 your tastes. Starting in 21.4, the preferred location for the init file | |
1414 is @file{~/.xemacs/init.el}; in previous versions, it was | |
1415 @file{~/.emacs}. 21.4 still accepts the old location, but the first | |
1416 time you run it, it will ask to migrate your file to the new location. | |
1417 If you answer yes, the file will be moved, and a "compatibility" | |
1418 @file{.emacs} file will be placed in the old location so that you can | |
1419 still run older versions of XEmacs, and versions of GNU Emacs, which | |
1420 expect the old location. The @file{.emacs} file present is just a stub | |
1421 that loads the real file in @file{~/.xemacs/init.el}. | |
1422 | |
1423 No two init files are alike, nor are they expected to be alike, but | |
1424 that's the point. The XEmacs distribution contains an excellent starter | |
1425 example in the @file{etc/} directory called @file{sample.init.el} | |
1426 (starting in 21.4) or @file{sample.emacs} in older versions. Copy this | |
1427 file from there to @file{~/.xemacs/init.el} (starting in 21.4) or | |
1428 @file{~/.emacs} in older versions, where @samp{~} means your home | |
1429 directory, of course. Then edit it to suit. | |
1430 | |
1431 You may bring the @file{sample.init.el} or @file{sample.emacs} file into | |
1432 an XEmacs buffer from the menubar. (The menu entry for it is always | |
1433 under the @samp{Help} menu, but its location under that has changed in | |
1434 various versions. Recently, look under the @samp{Samples} submenu.) To | |
1435 determine the location of the @file{etc/} directory type the command | |
1436 @kbd{C-h v data-directory @key{RET}}. | |
1437 | |
1438 @node Q1.3.2, Q1.3.3, Q1.3.1, Introduction | |
1439 @unnumberedsubsec Q1.3.2: Where do I put my @file{init.el} file? | |
1440 | |
1441 @file{init.el} is the name of the init file starting with 21.4, and is | |
1442 located in the subdirectory @file{.xemacs/} of your home directory. In | |
1443 prior versions, the init file is called @file{.emacs} and is located in | |
1444 your home directory. | |
1445 | |
1446 Your home directory under Windows is determined by the @samp{HOME} | |
1447 environment variable. If this is not set, it defaults to @samp{C:\}. | |
1448 To set this variable, modify @file{AUTOEXEC.BAT} under Windows 95/98, or | |
1449 select @samp{Control Panel->System->Advanced->Environment Variables...} | |
1450 under Windows NT/2000. | |
1451 | |
1452 @node Q1.3.3, Q1.3.4, Q1.3.2, Introduction | |
1453 @unnumberedsubsec Q1.3.3: Can I use the same @file{init.el} with the other Emacs? | |
1454 | |
1455 Yes. The sample @file{init.el} included in the XEmacs | |
1456 distribution will show you how to handle different versions and flavors | |
1457 of Emacs. | |
1458 | |
1459 @node Q1.3.4, Q1.3.5, Q1.3.3, Introduction | |
1460 @unnumberedsubsec Q1.3.4: Any good XEmacs tutorials around? | |
1461 | |
1462 There's the XEmacs tutorial available from the Help Menu under | |
1463 @samp{Help->Tutorials}, or by typing @kbd{C-h t}. To check whether | |
1464 it's available in a non-english language, type @kbd{C-u C-h t TAB}, type | |
1465 the first letters of your preferred language, then type @key{RET}. | |
1466 | |
1467 @comment There's an Emacs Lisp tutorial at | |
1468 @comment | |
1469 @comment @example | |
1470 @comment @uref{ftp://prep.ai.mit.edu/pub/gnu/emacs-lisp-intro-1.04.tar.gz}. | |
1471 @comment @end example | |
1472 @comment | |
1473 @comment @email{erik@@petaxp.rug.ac.be, Erik Sundermann} has made a tutorial web | |
1474 @comment page at | |
1475 @comment @iftex | |
1476 @comment @* | |
1477 @comment @end iftex | |
1478 @comment @uref{http://petaxp.rug.ac.be/~erik/xemacs/}. | |
1479 | |
1480 @node Q1.3.5, Q1.3.6, Q1.3.4, Introduction | |
1481 @unnumberedsubsec Q1.3.5: May I see an example of a useful XEmacs Lisp function? | |
1482 | |
1483 The following function does a little bit of everything useful. It does | |
1484 something with the prefix argument, it examines the text around the | |
1485 cursor, and it's interactive so it may be bound to a key. It inserts | |
1486 copies of the current word the cursor is sitting on at the cursor. If | |
1487 you give it a prefix argument: @kbd{C-u 3 M-x double-word} then it will | |
1488 insert 3 copies. | |
1489 | |
1490 @lisp | |
1491 (defun double-word (count) | |
1492 "Insert a copy of the current word underneath the cursor" | |
1493 (interactive "*p") | |
1494 (let (here there string) | |
1495 (save-excursion | |
1496 (forward-word -1) | |
1497 (setq here (point)) | |
1498 (forward-word 1) | |
1499 (setq there (point)) | |
1500 (setq string (buffer-substring here there))) | |
1501 (while (>= count 1) | |
1502 (insert string) | |
1503 (decf count)))) | |
1504 @end lisp | |
1505 | |
1506 The best way to see what is going on here is to let XEmacs tell you. | |
1507 Put the code into an XEmacs buffer, and do a @kbd{C-h f} with the cursor | |
1508 sitting just to the right of the function you want explained. Eg. move | |
1509 the cursor to the SPACE between @code{interactive} and @samp{"*p"} and | |
1510 hit @kbd{C-h f} to see what the function @code{interactive} does. Doing | |
1511 this will tell you that the @code{*} requires a writable buffer, and | |
1512 @code{p} converts the prefix argument to a number, and | |
1513 @code{interactive} allows you to execute the command with @kbd{M-x}. | |
1514 | |
1515 @node Q1.3.6, Q1.3.7, Q1.3.5, Introduction | |
1516 @unnumberedsubsec Q1.3.6: And how do I bind it to a key? | |
1517 | |
1518 To bind to a key do: | |
1519 | |
1520 @lisp | |
1521 (global-set-key "\C-cd" 'double-word) | |
1522 @end lisp | |
1523 | |
1524 Or interactively, @kbd{M-x global-set-key} and follow the prompts. | |
1525 | |
1526 @node Q1.3.7, Q1.3.8, Q1.3.6, Introduction | |
1527 @unnumberedsubsec Q1.3.7: What's the difference between a macro and a function? | |
1528 | |
1529 Quoting from the Lisp Reference (a.k.a @dfn{Lispref}) Manual: | |
1530 | |
1531 @dfn{Macros} enable you to define new control constructs and other | |
1532 language features. A macro is defined much like a function, but instead | |
1533 of telling how to compute a value, it tells how to compute another Lisp | |
1534 expression which will in turn compute the value. We call this | |
1535 expression the @dfn{expansion} of the macro. | |
1536 | |
1537 Macros can do this because they operate on the unevaluated expressions | |
1538 for the arguments, not on the argument values as functions do. They can | |
1539 therefore construct an expansion containing these argument expressions | |
1540 or parts of them. | |
1541 | |
1542 Do not confuse the two terms with @dfn{keyboard macros}, which are | |
1543 another matter, entirely. A keyboard macro is a key bound to several | |
1544 other keys. Refer to manual for details. | |
1545 | |
1546 @node Q1.3.8, Q1.4.1, Q1.3.7, Introduction | |
1547 @unnumberedsubsec Q1.3.8: What is @code{Custom}? | |
1548 | |
1549 @code{Custom} is a system for customizing XEmacs options. | |
1550 | |
1551 You can access @code{Advanced (Customize)} from the @code{Options} menu | |
1552 or invoking one of customize commands by typing eg. | |
1553 @kbd{M-x customize}, @kbd{M-x customize-face}, | |
1554 @kbd{M-x customize-variable} or @kbd{M-x customize-apropos}. | |
1555 | |
1556 There is also new @samp{browser} mode for Customize. | |
1557 Try it out with @kbd{M-x customize-browse} | |
1558 | |
1559 @unnumberedsec 1.4: Getting Help | |
1560 | |
1561 @node Q1.4.1, Q1.4.2, Q1.3.8, Introduction | |
1562 @unnumberedsubsec Q1.4.1: Where can I get help? | |
1563 | |
1564 Probably the easiest way, if everything is installed, is to use Info, by | |
1565 pressing @kbd{C-h i}, or looking for an Info item on the | |
1566 Help Menu. @kbd{M-x apropos} can be used to look for particular commands. | |
1567 | |
1568 For items not found in the manual, try reading this FAQ | |
1569 and reading the Usenet group comp.emacs.xemacs. | |
1570 | |
1571 If you choose to post to a newsgroup, @strong{please use | |
1572 comp.emacs.xemacs}. Please do not post XEmacs related questions to | |
1573 gnu.emacs.help. | |
1574 | |
1575 If you cannot post or read Usenet news, there is a corresponding mailing | |
1576 list @email{xemacs-news@@xemacs.org} which is available. It can be | |
1577 subscribed to via the Mailman Web interface or by sending mail to to | |
1578 @email{xemacs-news-request@@xemacs.org} with @samp{subscribe} in the | |
1579 body of the message. See also | |
1580 @uref{http://www.xemacs.org/Lists/#xemacs-news}. To cancel a | |
1581 subscription, you may use the @email{xemacs-news-request@@xemacs.org} | |
1582 address or the Web interface. Send a message with a subject of | |
1583 @samp{unsubscribe} to be removed. | |
1584 | |
1585 @node Q1.4.2, Q1.4.3, Q1.4.1, Introduction | |
1586 @unnumberedsubsec Q1.4.2: Which mailing lists are there? | |
1587 | |
1588 For complete, up-to-date info on the lists and how to subscribe, see | |
1589 @uref{http://www.xemacs.org/Lists/}. | |
1590 | |
1591 @table @samp | |
1592 | |
1593 @item comp.emacs.xemacs | |
1594 is a Usenet newsgroup | |
1595 for XEmacs users to discuss problems and issues that arise | |
1596 for them. It's not generally an appropriate place to ask | |
1597 about apparent bugs (use @samp{xemacs-beta}), or future plans | |
1598 (use @samp{xemacs-design}). | |
1599 | |
1600 @item xemacs-announce | |
1601 is a read-only, low | |
1602 volume list for announcements concerning the XEmacs project | |
1603 and new releases of the XEmacs software. | |
1604 | |
1605 @item xemacs-beta | |
2559 | 1606 is an open list for bug reports about beta versions of XEmacs. This |
1607 includes the bug reports themselves, by both users and developers, as | |
1608 well as queries, follow-ups, and discussions further determining their | |
1609 nature and status. This is the primary channel for this kind of | |
1610 discussion; related code changes will usually not be applied until | |
1611 they have been discussed here. When such discussions touch on | |
1612 significant changes to the code (in particular, structural changes), | |
1613 or on changes to API's or external functionality, they should be moved | |
1614 to @samp{xemacs-design}. Requests and proposals for non-bug-related | |
1615 changes do not belong on @samp{xemacs-beta}, and should be sent to | |
1616 @samp{xemacs-design} instead. | |
2537 | 1617 |
1618 @item xemacs-beta-ja | |
1619 is an open list for bug | |
1620 reports and design discussion related to Mule features, | |
1621 including Japanese handling, in beta versions of XEmacs. | |
1622 Japanese is the preferred language of discussion. For most | |
1623 timely presentation to reviewers, please consider sending | |
1624 appropriate discussion to @samp{xemacs-mule} or | |
1625 @samp{xemacs-design} in English when convenient for | |
1626 the participants in discussion. When possible, bug reports | |
1627 not related to Mule (including Japanese) should be reported on | |
1628 @samp{xemacs-beta} in English. | |
1629 | |
1630 @item xemacs-buildreports | |
1631 is an open list for | |
1632 submission of build-reports on beta versions of XEmacs. For | |
1633 information on what the build-reports should contain, please | |
1634 see the `etc/BETA' file which is included in each beta | |
1635 distribution. | |
1636 | |
1637 @item xemacs-cvs | |
1638 is a read-only list for notices | |
1639 and information on what has been committed to the XEmacs CVS | |
1640 trees, by whom, and for what. | |
1641 | |
1642 @item xemacs-design | |
1643 is an open list for | |
1644 discussing the design of XEmacs. This includes discussion | |
1645 about planned and ongoing changes to functionality and API | |
1646 changes and additions as well as requests for them. This is | |
1647 the primary channel for this kind of discussion; related code | |
1648 changes will usually not be applied until they have been | |
1649 discussed here. This does not include bug reports, which go | |
1650 to @samp{xemacs-beta}. | |
1651 | |
1652 @item xemacs-mule | |
1653 is an open mailing list for | |
1654 discussion of International extensions to XEmacs including | |
1655 Mule, XIM, I18n issues, etc, and is not confined to | |
1656 developmental issues. This list is not restricted to | |
1657 English, postings in all languages are welcome. | |
1658 | |
1659 @item xemacs-news | |
1660 is an open list for discussion | |
1661 and bug reporting for XEmacs. This mailing list is | |
1662 bi-directionally gatewayed with the USENET newsgroup | |
1663 comp.emacs.xemacs. | |
1664 | |
1665 @item xemacs-nt | |
1666 is a developers-only mailing | |
1667 list and is intended for people who wish to work actively on | |
1668 the porting of XEmacs to Microsoft Windows NT and Microsoft | |
1669 Windows '95. | |
1670 | |
1671 @item xemacs-patches | |
1672 is an open, moderated | |
1673 list for submission of patches to the XEmacs distribution | |
1674 and its packages. Anyone may subscribe or submit to | |
1675 xemacs-patches, but all submissions are reviewed by the list | |
1676 moderator before they are distributed to the | |
1677 list. Discussion is not appropriate on xemacs-patches. | |
1678 | |
1679 @item xemacs-users-ja | |
1680 is an open list for | |
1681 discussion and bug reporting for XEmacs. Japanese is the | |
1682 preferred language of discussion. It is not gated to | |
1683 comp.emacs.xemacs or the @samp{xemacs} list. For | |
1684 fastest response, bugs not specifically related to Japanese | |
1685 or Mule features should be reported on | |
1686 @samp{xemacs-beta} (in English). | |
1687 | |
1688 @item xemacs-users-ru | |
1689 is an open list for | |
1690 discussion and bug reporting for XEmacs. Russian is the | |
1691 preferred language of discussion. It is not gated to | |
1692 comp.emacs.xemacs or the @samp{xemacs} list. For | |
1693 fastest response, bugs not specifically related to Russian | |
1694 or Mule features should be reported on | |
1695 @samp{xemacs-beta} (in English). | |
1696 @end table | |
1697 | |
1698 @node Q1.4.3, Q1.4.4, Q1.4.2, Introduction | |
1699 @unnumberedsubsec Q1.4.3: Where are the mailing lists archived? | |
1700 | |
1701 The archives can be found at @uref{http://list-archive.xemacs.org} | |
1702 | |
1703 @node Q1.4.4, Q1.4.5, Q1.4.3, Introduction | |
1704 @unnumberedsubsec Q1.4.4: How can I get two instances of info? | |
1705 | |
1706 Before 21.4, you can't. The @code{info} package does not provide for | |
1707 multiple info buffers. In 21.4, this should be fixed. #### how? | |
1708 | |
1709 @node Q1.4.5, Q1.5.1, Q1.4.4, Introduction | |
1710 @unnumberedsubsec Q1.4.5: How do I add new Info directories? | |
1711 | |
1712 You use something like: | |
1713 | |
1714 @lisp | |
1715 (setq Info-directory-list (cons | |
1716 (expand-file-name "~/info") | |
1717 Info-default-directory-list)) | |
1718 @end lisp | |
1719 | |
1720 @email{davidm@@prism.kla.com, David Masterson} writes: | |
1721 | |
1722 @quotation | |
1723 Emacs Info and XEmacs Info do many things differently. If you're trying to | |
1724 support a number of versions of Emacs, here are some notes to remember: | |
1725 | |
1726 @enumerate | |
1727 @item | |
1728 Emacs Info scans @code{Info-directory-list} from right-to-left while | |
1729 XEmacs Info reads it from left-to-right, so append to the @emph{correct} | |
1730 end of the list. | |
1731 | |
1732 @item | |
1733 Use @code{Info-default-directory-list} to initialize | |
1734 @code{Info-directory-list} @emph{if} it is available at startup, but not | |
1735 all Emacsen define it. | |
1736 | |
1737 @item | |
1738 Emacs Info looks for a standard @file{dir} file in each of the | |
1739 directories scanned from #1 and magically concatenates them together. | |
1740 | |
1741 @item | |
1742 XEmacs Info looks for a @file{localdir} file (which consists of just the | |
1743 menu entries from a @file{dir} file) in each of the directories scanned | |
1744 from #1 (except the first), does a simple concatenation of them, and | |
1745 magically attaches the resulting list to the end of the menu in the | |
1746 @file{dir} file in the first directory. | |
1747 @end enumerate | |
1748 | |
1749 Another alternative is to convert the documentation to HTML with | |
1750 texi2html and read it from a web browser like Lynx or W3. | |
1751 @end quotation | |
1752 | |
1753 @unnumberedsec 1.5: Contributing to XEmacs | |
1754 | |
1755 @node Q1.5.1, Q1.5.2, Q1.4.5, Introduction | |
1756 @unnumberedsubsec Q1.5.1: How do I submit changes to the FAQ? | |
1757 | |
1758 The FAQ is actively maintained and modified regularly. All links should | |
1759 be up to date. Unfortunately, some of the information is out of date -- | |
1760 a situation which the FAQ maintainer is working on. All submissions are | |
1761 welcome, please e-mail submissions to @email{faq@@xemacs.org, XEmacs FAQ | |
1762 maintainers}. | |
1763 | |
1764 Please make sure that @samp{XEmacs FAQ} appears on the Subject: line. | |
1765 If you think you have a better way of answering a question, or think a | |
1766 question should be included, we'd like to hear about it. Questions and | |
1767 answers included into the FAQ will be edited for spelling and grammar | |
1768 and will be attributed. Answers appearing without attribution are | |
1769 either from versions of the FAQ dated before May 1996 or are from | |
1770 previous FAQ maintainers. Answers quoted from Usenet news articles will | |
1771 always be attributed, regardless of the author. | |
1772 | |
1773 @node Q1.5.2, Q1.5.3, Q1.5.1, Introduction | |
1774 @unnumberedsubsec Q1.5.2: How do I become a beta tester? | |
1775 | |
1776 Send an email message to @email{xemacs-beta-request@@xemacs.org} with | |
1777 the line @samp{subscribe} in the body of the message. | |
1778 | |
1779 Be prepared to get your hands dirty, as beta testers are expected to | |
1780 identify problems as best they can. | |
1781 | |
2559 | 1782 @node Q1.5.3, Q1.5.4, Q1.5.2, Introduction |
2537 | 1783 @unnumberedsubsec Q1.5.3: How do I contribute to XEmacs itself? |
1784 | |
1785 It depends on the knowledge and time you possess. If you are able, by | |
1786 all means become a beta tester (@pxref{Q1.5.2}). If you are a | |
1787 programmer, try to build XEmacs and see if you can improve it. | |
1788 | |
1789 Otherwise, you can still help by using XEmacs as your everyday editor | |
1790 (for pre-built binary versions, @pxref{Q1.1.2}) and reporting bugs you | |
1791 find to the mailing list. | |
1792 | |
1793 Another area where we need help is the documentation: We need good | |
1794 documentation for building XEmacs and for using it. This FAQ is a | |
1795 small step in that direction. | |
1796 | |
1797 Ben Wing @email{ben@@xemacs.org} writes: | |
1798 | |
1799 @quotation | |
1800 BTW if you have a wish list of things that you want added, you have to | |
1801 speak up about it! More specifically, you can do the following if you | |
1802 want a feature added (in increasing order of usefulness): | |
1803 | |
1804 @itemize @bullet | |
1805 @item | |
1806 Make a posting about a feature you want added. | |
1807 | |
1808 @item | |
1809 Become a beta tester and make more postings about those same features. | |
1810 | |
1811 @item | |
1812 Convince us that you're going to use the features in some cool and | |
1813 useful way. | |
1814 | |
1815 @item | |
1816 Come up with a clear and well-thought-out API concerning the features. | |
1817 | |
1818 @item | |
1819 Write the code to implement a feature and send us a patch. | |
1820 @end itemize | |
1821 | |
1822 (not that we're necessarily requiring you to write the code, but we can | |
1823 always hope :) | |
1824 @end quotation | |
1825 | |
2559 | 1826 @node Q1.5.4, Q1.5.5, Q1.5.3, Introduction |
1827 @unnumberedsubsec Q1.5.4: How do I get started developing XEmacs? | |
1828 | |
1829 First, get yourself set up under CVS so that you can access the CVS | |
1830 repositories containing the XEmacs sources and the XEmacs packages. | |
1831 | |
1832 Next, set up your layout. This is important, as a good layout will | |
1833 facilitate getting things done efficiently, while a bad layout will could | |
1834 lead to disaster, as you can't figure out which code is the most recent, | |
1835 which can be thrown away, etc. We suggest the following layout: (feel free | |
1836 to make changes) | |
1837 | |
1838 @itemize @bullet | |
1839 @item | |
1840 Everything goes under @file{/src/xemacs} (use a different directory if | |
1841 you want). From now, instead of saying @file{/src/xemacs}, we use | |
1842 @file{<xsrc-top>}, to make it easier in case someone picked a | |
1843 different directory. | |
1844 | |
1845 @item | |
1846 Package source is in @file{<xsrc-top>/package-src}. | |
1847 | |
1848 @item | |
1849 Installed packages go under @file{<xsrc-top>/xemacs-packages}, and | |
1850 @file{<xsrc-top>/mule-packages}. | |
1851 | |
1852 @item | |
1853 A "workspace" is a complete copy of the sources, in which you do work of | |
1854 a particular kind. Workspaces can be differentiated by which branch of | |
1855 the source tree they extend off of -- usually either the stable or | |
1856 experimental, unless other branches have been created (for example, Ben | |
1857 created a branch for his Mule work because (1) the project was long-term | |
1858 and involved an enormous number of changes, (2) people wanted to be able | |
1859 to look at what his work in progress, and (3) he wanted to be able to | |
1860 check things in and in general use source-code control, since it was a | |
1861 long-term project). Workspaces are also differentiated in what their | |
1862 purpose is -- general working workspace, workspace for particular | |
1863 projects, workspace keeping the latest copy of the code in one of the | |
1864 branches without mods, etc. | |
1865 | |
1866 @item | |
1867 Various workspaces are subdirectories under @file{<xsrc-top>}, e.g.: | |
1868 | |
1869 @itemize @bullet | |
1870 @item | |
1871 @file{<xsrc-top>/working} (the workspace you're actively working on, | |
1872 periodically synched up with the latest trunk) | |
1873 | |
1874 @item | |
1875 @file{<xsrc-top>/stable} (for making changes to the stable version of | |
1876 XEmacs, which sits on a branch) | |
1877 | |
1878 @item | |
1879 @file{<xsrc-top>/unsigned-removal} (a workspace for a specific, difficult | |
1880 task that's going to affect lots of source and take a long time, and | |
1881 so best done in its own workspace without the interference of other | |
1882 work you're doing. Also, you can commit just this one large change, | |
1883 separate from all the other changes). | |
1884 | |
1885 @item | |
1886 @file{<xsrc-top>/latest} (a copy of the latest sources on the trunk, | |
1887 i.e. the experimental version of XEmacs, with no patches in it; | |
1888 either update it periodically, by hand, or set up a cron job to do it | |
1889 automatically). Set it up so it can be built, and build it so you | |
1890 have a working XEmacs. (Building it might also go into the cron job.) | |
1891 | |
1892 This workspace serves a number of purposes: | |
1893 @enumerate | |
1894 @item | |
1895 You always have a recent version of XEmacs you can compare | |
1896 against when something you're working on breaks. It's true | |
1897 that you can do this with cvs diff, but when you need to do | |
1898 some serious investigation, this method just fails. | |
1899 @item | |
1900 You (almost) always have a working, up-to-date executable that | |
1901 can be used when your executable is crashing and you need to | |
1902 keep developing it, or when you need an `xemacs' to build | |
1903 packages, etc. | |
1904 @item | |
1905 When creating new workspaces, you can just copy the `latest' | |
1906 workspace using GNU @code{cp -a}. You have all the .elc's built, | |
1907 everything else probably configured, any spare files in place | |
1908 (e.g. some annoying xpm.dll under Windows, etc.). | |
1909 @end enumerate | |
1910 | |
1911 @item | |
1912 @file{<xsrc-top>/latest-stable/} (equivalent to @file{<xsrc-top>/latest/}, but | |
1913 for the Stable branch of XEmacs, rather than the Experimental branch | |
1914 of XEmacs). This may or may not be necessary depending on how much | |
1915 development you do of the stable branch. | |
1916 @end itemize | |
1917 | |
1918 @item | |
1919 @file{<xsrc-top>/xemacsweb} is a workspace for working on the XEmacs | |
1920 web site. | |
1921 | |
1922 @item | |
1923 @file{<xsrc-top>/in-patches} for patches received from email and saved | |
1924 to files. | |
1925 | |
1926 @item | |
1927 @file{<xsrc-top>/out-patches} for locally-generated patches to be sent | |
1928 to @email{xemacs-patches@@xemacs.org}. Less useful now that the | |
1929 patcher util has been developed. | |
1930 | |
1931 @item | |
1932 @file{<xsrc-top>/build}, for build trees when compiling and testing XEmacs with | |
1933 various configuration options turned off and on. The scripts in | |
1934 xemacs-builds/ben (see below) can be used to automate building XEmacs | |
1935 workspaces with many different configuration options and automatically | |
1936 filtering out the normal output so that you see only the abnormal | |
1937 output. | |
1938 | |
1939 @item | |
1940 @file{<xsrc-top>/xemacs-builds}, for the xemacs-builds module, which you need | |
1941 to check out separately in CVS. This contains scripts used for building | |
1942 XEmacs, automating and simplifying using CVS, etc. Under various | |
1943 people's directories are their own build and other scripts. The | |
1944 currently most-maintained scripts are under ben/, where there are easily | |
1945 configurable scripts that can be used to easily build any workspace | |
1946 (esp. if you've more or less followed the layout presented above) | |
1947 unattended, with one or more configuration states (there's a | |
1948 pre-determined list of the most useful, but it's easy to change). The | |
1949 output is filtered and split up in various ways so that you can identify | |
1950 which output came from where, and you can see the output either full or | |
1951 with all "normal" output except occasional status messages filtered so | |
1952 that you only see the abnormal ones. | |
1953 @end itemize | |
1954 | |
1955 @node Q1.5.5, Q1.6.1, Q1.5.4, Introduction | |
1956 @unnumberedsubsec Q1.5.5: What's the basic layout of the code? | |
1957 | |
1958 The file @file{configure} is a shell script to acclimate XEmacs to the | |
1959 oddities of your processor and operating system. It will create a | |
1960 file named @file{Makefile} (a script for the @file{make} program), which helps | |
1961 automate the process of building and installing emacs. See INSTALL | |
1962 for more detailed information. | |
1963 | |
1964 The file @file{configure.in} is the input used by the autoconf program to | |
1965 construct the @file{configure} script. Since XEmacs has configuration | |
1966 requirements that autoconf can't meet, @file{configure.in} uses an unholy | |
1967 marriage of custom-baked configuration code and autoconf macros; it | |
1968 may be wise to avoid rebuilding @file{configure} from @file{configure.in} when | |
1969 possible. | |
1970 | |
1971 The file @file{Makefile.in} is a template used by @file{configure} to create | |
1972 @file{Makefile}. | |
1973 | |
1974 There are several subdirectories: | |
1975 | |
1976 @enumerate | |
1977 @item | |
1978 @file{src} holds the C code for XEmacs (the XEmacs Lisp interpreter and its | |
1979 primitives, the redisplay code, and some basic editing functions). | |
1980 @item | |
1981 @file{lisp} holds the XEmacs Lisp code for XEmacs (most everything else). | |
1982 @item | |
1983 @file{lib-src} holds the source code for some utility programs for use by | |
1984 or with XEmacs, like movemail and etags. | |
1985 @item | |
1986 @file{etc} holds miscellaneous architecture-independent data files | |
1987 XEmacs uses, like the tutorial text. The contents of the @file{lisp}, | |
1988 @file{info} and @file{man} subdirectories are architecture-independent too. | |
1989 @item | |
1990 @file{lwlib} holds the C code for the X toolkit objects used by XEmacs. | |
1991 @item | |
1992 @file{info} holds the Info documentation tree for XEmacs. | |
1993 @item | |
1994 @file{man} holds the source code for the XEmacs online documentation. | |
1995 @item | |
1996 @file{nt} holds files used compiling XEmacs under Microsoft Windows. | |
1997 @end enumerate | |
1998 | |
2537 | 1999 @unnumberedsec 1.6: Politics (XEmacs vs. GNU Emacs) |
2000 | |
2559 | 2001 @node Q1.6.1, Q1.6.2, Q1.5.5, Introduction |
2537 | 2002 @unnumberedsubsec Q1.6.1: What is GNU Emacs? |
2003 | |
2004 GNU Emacs and XEmacs are related open-source text editors. Both | |
2005 derive from GNU Emacs version 18; the split between the two happened | |
2006 in 1991 (for comparison, the oldest versions of GNU Emacs date from | |
2007 1984). For information on GNU Emacs, see | |
2008 @uref{http://www.gnu.org/software/emacs/emacs.html}. | |
2009 | |
2010 @node Q1.6.2, Q1.6.3, Q1.6.1, Introduction | |
2011 @unnumberedsubsec Q1.6.2: How does XEmacs differ from GNU Emacs? | |
428 | 2012 |
2013 For a detailed description of the differences between GNU Emacs and | |
2014 XEmacs and a detailed history of XEmacs, check out the | |
2015 @example | |
430 | 2016 @uref{http://www.xemacs.org/About/XEmacsVsGNUemacs.html, NEWS file} |
428 | 2017 @end example |
2018 | |
2417 | 2019 @table @strong |
2020 @item User-Visible Editing Features | |
2021 XEmacs in general tries hard to conform to exist user-interface | |
2022 standards, and to work "out-of-the-box" without the need for obscure | |
2023 customization changes. GNU Emacs, particularly version 21, has gotten | |
2024 better about this (in many cases by copying the XEmacs behavior!), but | |
2025 still has some weirdnesses. For example, the standard method of | |
2026 selecting text using the Shift key works out-of-the-box in XEmacs. | |
2027 | |
2028 XEmacs has a built-in toolbar. Four toolbars can actually be configured | |
2029 simultaneously: top, bottom, left, and right toolbars. | |
2030 | |
2031 XEmacs has vertical and horizontal scrollbars. Unlike in GNU Emacs 19 | |
2032 (which provides a primitive form of vertical scrollbar), these are true | |
2033 toolkit scrollbars. A look-alike Motif scrollbar is provided for those | |
2034 who don't have Motif. (Even for those who do, the look-alike may be | |
2035 preferable as it is faster.) | |
2036 | |
2037 XEmacs has buffer tabs along the top of the frame (although the | |
2038 position can be changed) that make it very easy to switch buffers. | |
2039 | |
2040 The menubar under XEmacs is better-designed, with more thought put into | |
2041 it. | |
2042 | |
2043 XEmacs can ask questions using popup dialog boxes. Any command executed | |
2044 from a menu will ask yes/no questions with dialog boxes, while commands | |
2045 executed via the keyboard will use the minibuffer. | |
2046 | |
2047 XEmacs under MS Windows provides uses the standard file-dialog box for | |
2048 opening and saving files. Standard menu-accelerator behavior can easily | |
2049 be enabled using the Options menu, and integrates well into the existing | |
2050 keymap. | |
2051 | |
2052 XEmacs has (still experimental) support for widgets of various sorts -- | |
2053 buttons, text boxes, sliders, progress bars, etc. A progress bar is | |
2054 used in font lock to show the progress. | |
2055 | |
2056 Experimental support for drag-and-drop protocols is provided from | |
2057 XEmacs 21. | |
2058 | |
2059 @item General Platform Support | |
2060 If you're running on a machine with audio hardware, you can specify | |
2061 sound files for XEmacs to play instead of the default X beep. See the | |
2062 documentation of the function load-sound-file and the variable | |
2063 sound-alist. XEmacs also supports the network sound protocols NAS and | |
2064 EsounD. | |
2065 | |
2066 XEmacs 21 supports database protocols with LISP bindings, currently | |
2067 including Berkeley DB, LDAP, and PostgreSQL (21.2 only). | |
2068 | |
2069 XEmacs 20 and 21 support the Canna, Wnn, and SJ3 Japanese input method | |
2070 servers directly, as well as through the X Input Method (XIM) | |
2071 protocol. GNU Emacs 20 supports only the XIM protocol. Both Emacsen | |
2072 support the Quail family of input methods (implemented in LISP) for many | |
2073 languages. | |
2074 | |
2075 XEmacs provides support for ToolTalk on systems that have | |
2076 it. | |
2077 | |
2078 @item Packaged LISP Libraries | |
2079 Many more packages are provided standard with XEmacs than with GNU Emacs | |
2080 19 or 20. | |
2081 | |
2082 XEmacs 21 supports an integrated package management system which uses | |
2083 EFS to download, then automatically install prebuilt LISP | |
2084 libraries. This allows XEmacs users much more straightforward access to | |
2085 the "latest and greatest" version of any given library. | |
2086 | |
2087 We are working on a standard method for enabling, disabling and | |
2088 otherwise controlling packages, which should make them very easy to use. | |
2089 | |
2090 @item LISP Programming | |
2091 From XEmacs 20 on, characters are a separate type. Characters can be | |
2092 converted to integers (and many integers can be converted to | |
2093 characters), but characters are not integers. GNU Emacs 19, XEmacs 19, | |
2094 Mule 2.3 (an extensive patch to GNU Emacs 18.55 and 19.x), and GNU Emacs | |
2095 20 (incorporating Mule 3 and later Mule 4) represent them as integers. | |
2096 | |
2097 From XEmacs 20 on, the buffer is treated as an array of characters, and | |
2098 the representation of buffer text is not exposed to LISP. The GNU Emacs | |
2099 20 functions like buffer-as-multibyte are not supported. | |
2100 | |
2101 In XEmacs, events are first-class objects. GNU Emacs 19 represents them | |
2102 as integers, which obscures the differences between a key gesture and | |
2103 the ancient ASCII code used to represent a particular overlapping subset | |
2104 of them. | |
2105 | |
2106 In XEmacs, keymaps are first-class opaque objects. GNU Emacs 19 | |
2107 represents them as complicated combinations of association lists and | |
2108 vectors. If you use the advertised functional interface to manipulation | |
2109 of keymaps, the same code will work in XEmacs, GNU Emacs 18, and GNU | |
2110 Emacs 19; if your code depends on the underlying implementation of | |
2111 keymaps, it will not. | |
2112 | |
2113 XEmacs uses "extents" to represent all non-textual aspects of buffers; | |
2114 GNU Emacs 19 uses two distinct objects, "text properties" and | |
2115 "overlays", which divide up the functionality between them. Extents are | |
2116 a superset of the union of the functionality of the two GNU Emacs data | |
2117 types. The full GNU Emacs 19 interface to text properties and overlays | |
2118 is supported in XEmacs (with extents being the underlying | |
2119 representation). | |
2120 | |
2121 Extents can be made to be copied into strings, and then restored, by | |
2122 kill and yank. Thus, one can specify this behavior on either "extents" | |
2123 or "text properties", whereas in GNU Emacs 19 text properties always | |
2124 have this behavior and overlays never do. | |
2125 | |
2126 @item Window System Programming Interface | |
2127 XEmacs uses the MIT "Xt" toolkit instead of raw Xlib calls, which makes | |
2128 it be a more well-behaved X citizen (and also improves portability). A | |
2129 result of this is that it is possible to include other Xt "Widgets" in | |
2130 the XEmacs window. Also, XEmacs understands the standard Xt command-line | |
2131 arguments. | |
2132 | |
2133 XEmacs supports Motif applications, generic Xt (e.g. Athena) | |
2134 applications, and raw Xlib applications. An XEmacs variant which | |
2135 supports GTK+ is available (integration as an option in the XEmacs | |
2136 mainline is planned for XEmacs 22), although code to take advantage of | |
2137 the support is as yet scarce. | |
2138 | |
2139 An XEmacs frame can be placed within an "external client widget" managed | |
2140 by another application. This allows an application to use an XEmacs | |
2141 frame as its text pane rather than the standard Text widget that is | |
2142 provided with Motif or Athena. | |
2143 | |
2144 @item Community Participation | |
2459 | 2145 Joining the XEmacs development team is simple. Mail to |
2146 @email{xemacs-beta@@xemacs.org, XEmacs Developers}, and you're in! (If | |
2147 you want to be, of course. You're also welcome to just post | |
2148 development-related questions and bug reports.) The GNU Emacs | |
2417 | 2149 development team and internal mailing lists are still by invitation |
2150 only. | |
2151 | |
2152 The "bleeding edge" of mainline XEmacs development is available by | |
2153 anonymous CVS as are some subsidiary branches (check out the xemacs-gtk | |
2154 module for the latest in GUI features!) | |
2155 | |
2156 Development and maintenance of Lisp libraries is separated from the core | |
2157 editor development at a fairly low level. This provides better | |
2158 modularization and a better division of responsibility between external | |
2159 library maintainers and the XEmacs core development team. Even for | |
2160 packages the size of Gnus, XEmacs users normally have access to a | |
2161 pre-built version within a few weeks of a major release, and minor | |
2162 updates often within days. | |
2163 | |
2164 CVS commit authority is broadly dispersed. Recognized maintainers of | |
2165 LISP libraries who are willing to maintain XEmacs packaged versions | |
2166 automatically qualify for CVS accounts for their packages. | |
2167 @end table | |
2168 | |
2537 | 2169 @node Q1.6.3, Q1.6.4, Q1.6.2, Introduction |
2170 @unnumberedsubsec Q1.6.3: How much does XEmacs differ? | |
2417 | 2171 |
2172 RMS has asserted at times that XEmacs is merely a "patch" on top of | |
2537 | 2173 GNU Emacs (@pxref{Q1.6.4}). In fact, probably not more than 5% of the |
2417 | 2174 code, if that, remains unchanged, and nearly 14 years of work has gone |
2175 into XEmacs at this point. (GNU Emacs itself is only than 20 years | |
2176 old, and thus XEmacs has existed as a separate product for over 2/3 of | |
2177 the lifespan of GNU Emacs.) As a point of comparison, XEmacs 21.5 has | |
2178 perhaps 65,000 more lines of C code than GNU Emacs 21.2. | |
2179 | |
2180 However, the XEmacs developers strive to keep their code compatible with | |
2181 GNU Emacs, especially on the Lisp level. Much effort goes into | |
2182 "synching" the XEmacs Elisp code with recent GNU Emacs releases so as to | |
2183 benefit from GNU Emacs development work. (In contrast, almost no code | |
2184 from XEmacs has made it into GNU Emacs, and in fact the GNU Emacs | |
2185 developers are instructed by RMS not to even look at XEmacs source code! | |
2186 This stems from self-imposed licensing restrictions on the part of GNU | |
2187 Emacs -- and almost certainly out of hostility, as well.) | |
2188 | |
2537 | 2189 @node Q1.6.4, Q1.6.5, Q1.6.3, Introduction |
2190 @unnumberedsubsec Q1.6.4: Is XEmacs "GNU"? | |
2417 | 2191 |
2192 RMS insists on the term "GNU XEmacs" and maintains that | |
2193 | |
2194 @quotation | |
2195 XEmacs is GNU software because it's a modified version of a | |
2196 GNU program. And it is GNU software because the FSF is the copyright | |
2197 holder for most of it, and therefore the legal responsibility for | |
2198 protecting its free status falls on us whether we want it or not. This | |
2199 is why the term "GNU XEmacs" is legitimate. | |
2200 @end quotation | |
2201 | |
2202 In fact, FSF is @emph{not} the copyright holder for most of the code, | |
2537 | 2203 as very little unmodified FSF code remains (@pxref{Q1.6.3}). |
2417 | 2204 |
2205 Furthermore, RMS's assertion that XEmacs is "GNU" seems rather bizarre | |
2206 to the XEmacs developers given RMS's hostility and general lack of | |
2207 interest in cooperation. "GNU" software in general is part of the GNU | |
2208 Project, is distributed by it on their FTP site, and receives support | |
2209 (or at least cooperation), as well as implicit endorsement, from it. | |
2210 The GNU Project, however, has never supported XEmacs and never | |
2211 distributed XEmacs, and RMS's hostility is the farthest thing possible | |
2212 from an endorsement. In fact, the GNU Project distributes a number of | |
2213 non-GNU software projects on the FSF web site, but again XEmacs is not | |
2214 one of them. | |
2215 | |
2537 | 2216 @node Q1.6.5, Q1.6.6, Q1.6.4, Introduction |
2217 @unnumberedsubsec Q1.6.5: What is the correct way to refer to XEmacs and GNU Emacs? | |
2417 | 2218 |
2219 Unfortunately even the naming of these two applications has become | |
2220 politicized. Much of this stems from RMS, who has a history of | |
2221 politicizing similar issues. (Compare the controversy over "Lignux" | |
2222 and "GNU/Linux".) We would prefer that the terms "XEmacs" and "GNU | |
2223 Emacs" be used, which are neutral and acceptable to most people. RMS, | |
2224 however, is not willing to accept these terms. He insists that, if | |
2225 his product is called "GNU Emacs", then ours must be called "GNU | |
2537 | 2226 XEmacs". (For our opinion of this term, @xref{Q1.6.4}.) On the other |
2417 | 2227 hand, if our product is to be called "XEmacs", as we prefer, then his |
2228 product must simply be called "Emacs". The intent of this seems | |
2229 clear: RMS wants to make sure the names reflect his view that his | |
2230 version is the "real" Emacs and ours is merely a derivative, | |
2537 | 2231 second-class product (@pxref{Q1.6.3}). |
2417 | 2232 |
2233 The XEmacs developers hope that you will use the neutral terms | |
2234 "XEmacs" and "GNU Emacs" for these two specific products. "Emacs", on | |
2235 the other hand, is a generic term for a class of programmable text | |
2236 editors with a similar look-and-feel, and usually a Lisp-based | |
2237 extension language. These trace themselves back to early editors such | |
2238 as EINE, ZWEI, ZMACS and Multics Emacs. @xref{A History of Emacs,,, | |
2239 internals, XEmacs Internals Manual}. | |
2240 | |
2241 We also call upon RMS, in the spirit of furthering cooperation, to | |
2242 stop politicizing this issue and use the neutral terms "XEmacs" and | |
2243 "GNU Emacs". We have already acceded to RMS' wishes in this respect, | |
2244 and we expect him to do the same. (In the past, the XEmacs developers | |
2245 often used the terms "FSF Emacs" or "FSFmacs" or "RMSmacs" in | |
2246 reference to GNU Emacs; these terms were apparently modeled after RMS' | |
2247 own usage of "Gosmacs" and "Gosling Emacs" in reference to Unipress | |
2248 Emacs, produced by James Gosling. RMS, however, considers such terms | |
2249 to be insulting, so we refrain from using them as much as possible in | |
2250 preference to GNU Emacs.) | |
2251 | |
2537 | 2252 @node Q1.6.6, Q1.7.1, Q1.6.5, Introduction |
2253 @unnumberedsubsec Q1.6.6: Why haven't XEmacs and GNU Emacs merged? | |
2417 | 2254 |
2255 There are currently irreconcilable differences in the views about | |
2256 technical, programming, design, organizational and legal matters | |
2257 between Richard Stallman (RMS), the author and leader of the GNU Emacs | |
2258 project, and the XEmacs development team which provide little hope for | |
2259 a merge to take place in the short-term future. There have been | |
2260 repeated attempts at merging by all of the major XEmacs developers, | |
2261 starting from the early days of Lucid Emacs (in 1991), but they have | |
2262 all failed. RMS has very strong views about how GNU Emacs should be | |
2263 structured and how his project should be run, and during the repeated | |
2264 merge efforts has never demonstrated any realistic interest in | |
2265 sufficiently compromising or ceding control to allow a middle ground | |
2266 to be found. The basic problem seems to be the very different goals | |
2267 of RMS and the XEmacs project. The primary goals of the XEmacs | |
2268 project are technical and organizational -- we want to create the best | |
2269 editor possible, and to make it as easy as possible for people around | |
2270 the world to contribute. The primary goals of RMS, on the other hand, | |
2271 are political, and GNU Emacs, and any potential merge efforts with | |
2272 XEmacs, are strictly subservient to these goals. In fact, in many | |
2273 ways RMS sees GNU Emacs as the "poster child" of his aims, the one | |
2274 program in the GNU project that above all others must set an example | |
2275 to the world. (This has to do with the fact that GNU Emacs was the | |
2276 first program in the GNU project, and the only one that he is still | |
2277 personally involved with on a day-to-day basis.) Given his goals, his | |
2278 position is completely reasonable -- but unfortunately, makes any | |
2279 merge impossible. | |
2280 | |
2281 From the XEmacs perspective, the most intractable issues appear to be | |
2282 legal and organizational, specifically: | |
428 | 2283 |
2284 @itemize @bullet | |
2285 @item | |
2417 | 2286 RMS requires "legal papers" to be signed for all contributions of code |
2287 to GNU Emacs over 10 lines or so, transferring the copyright and all | |
2288 legal rights to the code to the Free Software Foundation. XEmacs does | |
2289 not and has never required this, since it has the practical effect of | |
2290 discouraging individual and in particular corporate contributions -- | |
2291 corporations will almost never sign away their legal rights to code | |
2292 since it makes it impossible to reuse the code in any product that | |
2293 whose license is not compatible with the GNU General Public License. | |
2294 Since RMS has shown no inclination to compromise on this issue, a | |
2295 merge would require that most of the existing XEmacs code would need | |
2296 to be thrown away and rewritten -- something the XEmacs developers are | |
2297 understandably reluctant to do. | |
2298 | |
2299 @item | |
2300 A repeated stumbling block in the merge talks has been the issue of | |
2301 organizational control over the resulting product. RMS has made it | |
2302 clear that he intends to have final say over design issues in a merged | |
2303 Emacs. Unfortunately, RMS and the XEmacs developers have repeatedly | |
2304 clashed over design decisions, and RMS' insistence on getting his way | |
2305 in such disagreements was the very reason for the split in the first | |
2306 place. This same issue has come up again and again in merge talks and | |
2307 we have never been able to come to a satisfactory resolution. To the | |
2308 extent that RMS is willing to compromise at all, it appears to be of a | |
2309 purely political rather than technical nature -- "If we support this | |
2310 feature of yours, we also get to support this other feature of mine." | |
2311 The XEmacs developers cannot see how such a process would lead to | |
2312 anything but a mess of incompatible things hodgepodged together. | |
2313 | |
2314 @item | |
2315 Because of the years of separate development, distinct and | |
2316 incompatible interfaces have developed and merging would be extremely | |
2317 difficult even with the above non-technical issues resolved. The | |
2318 problem has been exacerbated by the issue of legal papers -- because | |
2319 XEmacs code is not "kosher" from RMS' perspective, he discourages | |
2320 developers from even looking at it out of legal concerns. Although it | |
2321 is still possible to read the XEmacs documentation and run the | |
2322 program, the practical effect of this prohibition has been to strongly | |
2323 discourage code-sharing and cooperative development -- although a | |
2324 great deal of GNU Emacs code has been incorporated into XEmacs, | |
2325 practically none has gone the other direction. | |
428 | 2326 @end itemize |
2327 | |
2328 If you have a comment to add regarding the merge, it is a good idea to | |
2417 | 2329 avoid posting to the newsgroups, because of the very heated flamewars |
2330 that often result. Mail your questions to | |
2331 @email{xemacs-beta@@xemacs.org} and @email{emacs-devel@@gnu.org}. | |
2332 | |
2537 | 2333 @unnumberedsec 1.7: External Packages |
2334 | |
2559 | 2335 @node Q1.7.1, Q1.7.2, Q1.6.6, Introduction |
2336 @unnumberedsubsec Q1.7.1: What is the package system? | |
2337 | |
2338 In order to reduce the size and increase the maintainability of | |
2339 XEmacs, the majority of the Elisp packages that came with previous | |
2340 releases have been unbundled. They have been replaced by the package | |
2341 system. Each elisp add-on (or groups of them when they are small) now | |
2342 comes in its own tarball that contains a small search hierarchy. | |
2343 | |
2344 You select just the ones you need. Install them by untarring them into | |
2345 the right place. On startup XEmacs will find them, set up the load | |
2346 path correctly, install autoloads, etc, etc. | |
2347 | |
2348 @xref{Q2.1.1}, for more info on how to download and install the packages. | |
2349 | |
2350 @node Q1.7.2, Q1.7.3, Q1.7.1, Introduction | |
2351 @unnumberedsubsec Q1.7.2: Which external packages are there? | |
2537 | 2352 |
2353 @subheading Normal Packages | |
2354 | |
2355 A very broad collection of elisp packages. | |
2417 | 2356 |
2357 @table @asis | |
2537 | 2358 @item Sun |
2359 Support for Sparcworks. | |
2360 | |
2361 @item ada | |
2362 Ada language support. | |
2363 | |
2364 @item apel | |
2365 A Portable Emacs Library. Used by XEmacs MIME support. | |
2366 | |
2367 @item auctex | |
2368 Basic TeX/LaTeX support. | |
2369 | |
2370 @item bbdb | |
2371 The Big Brother Data Base: a rolodex-like database program. | |
2372 | |
2373 @item build | |
2374 Build XEmacs from within (UNIX, Windows). | |
2375 | |
2376 @item c-support | |
2377 Basic single-file add-ons for editing C code. | |
2378 | |
2379 @item calc | |
2380 Emacs calculator. | |
2381 | |
2382 @item calendar | |
2383 Calendar and diary support. | |
2384 | |
2385 @item cc-mode | |
2386 C, C++, Objective-C, Java, CORBA IDL, Pike and AWK language support. | |
2387 | |
2388 @item clearcase | |
2389 New Clearcase Version Control for XEmacs (UNIX, Windows). | |
2390 | |
2391 @item clearcase | |
2392 Support for the Clearcase version control system. | |
2393 | |
2394 @item cookie | |
2395 "Fortune cookie"-style messages. Includes Spook (suspicious phrases) | |
2396 and Yow (Zippy quotes). | |
2397 | |
2398 @item crisp | |
2399 Crisp/Brief emulation. | |
2400 | |
2401 @item debug | |
2402 GUD, gdb, dbx debugging support. | |
2403 | |
2404 @item dictionary | |
2405 Interface to RFC2229 dictionary servers. | |
2406 | |
2407 @item dired | |
2408 The DIRectory EDitor is for manipulating, and running commands on | |
2409 files in a directory. | |
2410 | |
2411 @item docbookide | |
2412 DocBook editing support. | |
2413 | |
2414 @item ecb | |
2415 Emacs source code browser. | |
2416 | |
2417 @item ecrypto | |
2418 Crypto functionality in Emacs Lisp. | |
2419 | |
2420 @item edebug | |
2421 An Emacs Lisp debugger. | |
2422 | |
2423 @item ediff | |
2424 Interface over GNU patch. | |
2425 | |
2426 @item edit-utils | |
2427 Miscellaneous editor extensions, you probably need this. | |
2428 | |
2429 @item edt | |
2430 DEC EDIT/EDT emulation. | |
2431 | |
2432 @item efs | |
2433 Treat files on remote systems the same as local files. | |
2434 | |
2435 @item eieio | |
2436 Enhanced Implementation of Emacs Interpreted Objects. | |
2437 | |
2438 @item elib | |
2439 Portable Emacs Lisp utilities library. | |
2440 | |
2441 @item emerge | |
2442 Another interface over GNU patch. | |
2443 | |
2444 @item erc | |
2445 ERC is an Emacs InternetRelayChat client. | |
2446 | |
2447 @item escreen | |
2448 Multiple editing sessions withing a single frame (like screen). | |
2449 | |
2450 @item eshell | |
2451 Command shell implemented entirely in Emacs Lisp. | |
2452 | |
2453 @item ess | |
2454 ESS: Emacs Speaks Statistics. | |
2455 | |
2456 @item eterm | |
2457 Terminal emulation. | |
2458 | |
2459 @item eudc | |
2460 Emacs Unified Directory Client (LDAP, PH). | |
2461 | |
2462 @item footnote | |
2463 Footnoting in mail message editing modes. | |
2464 | |
2465 @item forms | |
2466 Forms editing support (obsolete, use Widget instead). | |
2467 | |
2468 @item fortran-modes | |
2469 Fortran support. | |
2470 | |
2471 @item fortran-modes | |
2472 Fortran language support. | |
2473 | |
2474 @item frame-icon | |
2475 Set up mode-specific icons for each frame under XEmacs. | |
2476 | |
2477 @item fsf-compat | |
2478 GNU Emacs compatibility files. | |
2479 | |
2480 @item games | |
2481 Tetris, Sokoban, and Snake. | |
2482 | |
2483 @item general-docs | |
2484 General documentation. Presently, empty. | |
2485 | |
2486 @item gnats | |
2487 XEmacs bug reports. | |
2488 | |
2489 @item gnus | |
2490 The Gnus Newsreader and Mailreader. | |
2491 | |
2492 @item haskell-mode | |
2493 Haskell editing support. | |
2494 | |
2495 @item hm--html-menus | |
2496 HTML editing. | |
2497 | |
2498 @item hyperbole | |
2499 Hyperbole: The Everyday Info Manager. | |
2500 | |
2501 @item ibuffer | |
2502 Advanced replacement for buffer-menu. | |
2503 | |
2504 @item idlwave | |
2505 Editing and Shell mode for the Interactive Data Language. | |
2506 | |
2507 @item igrep | |
2508 Enhanced front-end for Grep. | |
2509 | |
2510 @item ilisp | |
2511 Front-end for interacting with Inferior Lisp (external lisps). | |
2512 | |
2513 @item ispell | |
2514 Spell-checking with GNU ispell. | |
2515 | |
2516 @item jde | |
2517 Integrated Development Environment for Java. | |
2518 | |
2519 @item liece | |
2520 IRC (Internet Relay Chat) client for Emacs. Note, this package is | |
2521 deprecated and will be removed, use riece instead. | |
2522 | |
2523 @item mail-lib | |
2524 Fundamental lisp files for providing email support. | |
2525 | |
2526 @item mailcrypt | |
2527 Support for messaging encryption with PGP. | |
2528 | |
2529 @item mew | |
2530 Messaging in an Emacs World; a MIME-based email program. | |
2531 | |
2532 @item mh-e | |
2533 The XEmacs Interface to the MH Mail System. | |
2534 | |
2535 @item mine | |
2536 Elisp implementation of the game 'Minehunt'. | |
2537 | |
2538 @item misc-games | |
2539 Other amusements and diversions. | |
2540 | |
2541 @item mmm-mode | |
2542 Support for Multiple Major Modes within a single buffer. | |
2543 | |
2544 @item net-utils | |
2545 Miscellaneous Networking Utilities. | |
2546 | |
2547 @item ocaml | |
2548 Objective Caml editing support. | |
2549 | |
2550 @item oo-browser | |
2551 OO-Browser: The Multi-Language Object-Oriented Code Browser. | |
2552 | |
2553 @item ocaml | |
2554 Objective Caml editing support. | |
2555 | |
2556 @item os-utils | |
2557 Miscellaneous single-file O/S utilities, for printing, archiving, | |
2558 compression, remote shells, etc. | |
2559 | |
2560 @item pc | |
2561 PC style interface emulation. | |
2562 | |
2563 @item pcl-cvs | |
2564 CVS frontend. | |
2565 | |
2566 @item pcomplete | |
2567 Provides programmatic completion. | |
2568 | |
2569 @item perl-modes | |
2570 Perl support. | |
2571 | |
2572 @item pgg | |
2573 Emacs interface to various PGP implementations. | |
2574 | |
2575 @item prog-modes | |
2576 Support for various programming languages. | |
2577 | |
2578 @item ps-print | |
2579 Printing functions and utilities. | |
2580 | |
2581 @item psgml | |
2582 Validated HTML/SGML editing. | |
2583 | |
2584 @item psgml-dtds | |
2585 A collection of DTDs for psgml. Note that this package is deprecated | |
2586 and will be removed in the future, most likely Q2/2003. Instead of using | |
2587 this, you should install needed DTDs yourself. | |
2588 | |
2589 @item python-modes | |
2590 Python language support. | |
2591 | |
2592 @item reftex | |
2593 Emacs support for LaTeX cross-references, citations. | |
2594 | |
2595 @item riece | |
2596 IRC (Internet Relay Chat) client for Emacs. | |
2597 | |
2598 @item rmail | |
2599 An obsolete Emacs mailer. If you do not already use it don't start. | |
2600 | |
2601 @item ruby-modes | |
2602 Ruby support. | |
2603 | |
2604 @item sasl | |
2605 Simple Authentication and Security Layer (SASL) library. | |
2606 | |
2607 @item scheme | |
2608 Front-end support for Inferior Scheme. | |
2609 | |
2610 @item semantic | |
2611 Semantic bovinator (Yacc/Lex for XEmacs). Includes Senator. | |
2612 | |
2613 @item sgml | |
2614 SGML/Linuxdoc-SGML editing. | |
2615 | |
2616 @item sh-script | |
2617 Support for editing shell scripts. | |
2618 | |
2619 @item sieve | |
2620 Manage Sieve email filtering scripts. | |
2621 | |
2622 @item slider | |
2623 User interface tool. | |
2624 | |
2625 @item sml-mode | |
2626 SML editing support. | |
2627 | |
2628 @item sounds-au | |
2629 XEmacs Sun sound files. | |
2630 | |
2631 @item sounds-wav | |
2632 XEmacs Microsoft sound files. | |
2633 | |
2634 @item speedbar | |
2635 Provides a separate frame with convenient references. | |
2636 | |
2637 @item strokes | |
2638 Mouse enhancement utility. | |
2639 | |
2640 @item supercite | |
2641 An Emacs citation tool for News & Mail messages. | |
2642 | |
2643 @item texinfo | |
2644 XEmacs TeXinfo support. | |
2645 | |
2646 @item text-modes | |
2647 Miscellaneous support for editing text files. | |
2648 | |
2649 @item textools | |
2650 Miscellaneous TeX support. | |
2651 | |
2652 @item time | |
2653 Display time & date on the modeline. | |
2654 | |
2655 @item tm | |
2656 Emacs MIME support. Not needed for gnus >= 5.8.0. | |
2657 | |
2658 @item tooltalk | |
2659 Support for building with Tooltalk. | |
2660 | |
2661 @item tpu | |
2662 DEC EDIT/TPU support. | |
2663 | |
2664 @item tramp | |
2665 Remote shell-based file editing. This is similar to EFS or Ange-FTP, | |
2666 but works with rsh/ssh and rcp/scp. | |
2667 | |
2668 @item vc | |
2669 Version Control for Free systems. | |
2670 | |
2671 @item vc-cc | |
2672 Version Control for ClearCase (UnFree) systems. | |
2673 | |
2674 @item vhdl | |
2675 Support for VHDL. | |
2676 | |
2677 @item view-process | |
2678 A Unix process browsing tool. | |
2679 | |
2680 @item viper | |
2681 VI emulation support. | |
2682 | |
2683 @item vm | |
2684 An Emacs mailer. | |
2685 | |
2686 @item w3 | |
2687 A Web browser. | |
2688 | |
2689 @item x-symbol | |
2690 Semi WYSIWYG for LaTeX, HTML, etc, using additional fonts. | |
2691 | |
2692 @item xemacs-base | |
2693 Fundamental XEmacs support, you almost certainly need this. | |
2694 | |
2695 @item xemacs-devel | |
2696 XEmacs Lisp developer support. This package contains utilities for | |
2697 supporting Lisp development. It is a single-file package so it may be | |
2698 tailored. | |
2699 | |
2700 @item xlib | |
2701 Emacs interface to X server. | |
2702 | |
2703 @item xslide | |
2704 XSL editing support. | |
2705 | |
2706 @item xslt-process | |
2707 A minor mode for (X)Emacs which allows running an XSLT processor on a | |
2708 buffer. | |
2709 | |
2710 @item xwem | |
2711 X Emacs Window Manager. | |
2712 | |
2713 @item zenirc | |
2714 ZENIRC IRC Client. | |
2417 | 2715 @end table |
2716 | |
2537 | 2717 @subheading Mule Support (mule) |
2718 | |
2719 MULti-lingual Enhancement. Support for world scripts such as | |
2720 Latin, Arabic, Cyrillic, Chinese, Japanese, Greek, Hebrew etc. | |
2721 To use these packages your XEmacs must be compiled with Mule | |
2722 support. | |
2723 | |
2724 @table @asis | |
2725 @item edict | |
2726 MULE: Lisp Interface to EDICT, Kanji Dictionary. | |
2727 | |
2728 @item egg-its | |
2729 MULE: Wnn (4.2 and 6) support. SJ3 support. | |
2730 | |
2731 @item latin-unity | |
2732 MULE: find single ISO 8859 character set to encode a buffer. | |
2733 | |
2734 @item latin-unity | |
2735 Unify character sets in a buffer. When characters belong to disjoint | |
2736 character sets, this attempts to translate the characters so | |
2737 that they belong to one character set. If the buffer coding system is | |
2738 not sufficient, this suggests different coding systems. | |
2739 | |
2740 @item leim | |
2741 MULE: Quail. All non-English and non-Japanese language support. | |
2742 | |
2743 @item locale | |
2744 MULE: Localized menubars and localized splash screens. | |
2745 | |
2746 @item lookup | |
2747 Dictionary support. (This isn't an English dictionary program) | |
2748 | |
2749 @item mule-base | |
2750 MULE: Basic Mule support, required for building with Mule. | |
2751 | |
2752 @item mule-ucs | |
2753 MULE: Extended coding systems (including Unicode) for XEmacs. | |
2754 | |
2755 @item mule-ucs | |
2756 Extended coding systems (including Unicode) for XEmacs. | |
2757 | |
2758 @item skk | |
2759 Another Japanese Language Input Method. Can be used without a | |
2760 separate process running as a dictionary server. | |
2761 @end table | |
2762 | |
2559 | 2763 @node Q1.7.3, Q1.7.4, Q1.7.2, Introduction |
2764 @unnumberedsubsec Q1.7.3: Do I need to have the packages to run XEmacs? | |
2765 | |
2766 Strictly speaking, no. XEmacs will build and install just fine without | |
2767 any packages installed. However, only the most basic editing functions | |
2768 will be available with no packages installed, so installing packages is | |
2769 an essential part of making your installed XEmacs _useful_. | |
2770 | |
2771 @node Q1.7.4, Q1.8.1, Q1.7.3, Introduction | |
2772 @unnumberedsubsec Q1.7.4: Is there a way to find which package has particular functionality? | |
2773 | |
2774 If you want to find out which package contains the functionality you | |
2775 are looking for, use @kbd{M-x package-get-package-provider}, and give it a | |
2776 symbol that is likely to be in that package. | |
2777 | |
2778 For example, if some code you want to use has a @code{(require 'thingatpt)} | |
2779 in it: | |
2780 | |
2781 @example | |
2782 M-x package-get-package-provider RET thingatpt RET | |
2783 @end example | |
2784 | |
2785 which will return something like: @samp{(fsf-compat "1.08").} | |
2786 | |
2537 | 2787 @unnumberedsec 1.8: Internationalization |
2788 | |
2559 | 2789 @node Q1.8.1, Q1.8.2, Q1.7.4, Introduction |
2537 | 2790 @unnumberedsubsec Q1.8.1: What is the status of internationalization support aka MULE (including Asian language support)? |
442 | 2791 |
2792 Both the stable and development versions of XEmacs include | |
1135 | 2793 internationalization support (aka MULE). MULE currently (21.4) works on |
2794 UNIX and Linux systems. It is possible to build with MULE on Windows | |
2795 systems, but if you really need MULE on Windows, it is recommended that | |
2796 you build and use the development (21.5) version, and deal with the | |
2797 instability of the development tree. Binaries compiled without MULE | |
2798 support run faster than MULE capable XEmacsen. | |
428 | 2799 |
2537 | 2800 @node Q1.8.2, Q1.8.3, Q1.8.1, Introduction |
2801 @unnumberedsubsec Q1.8.2: How can I help with internationalization? | |
430 | 2802 |
2803 If you would like to help, you may want to join the | |
2804 @email{xemacs-mule@@xemacs.org} mailing list. Especially needed are | |
2805 people who speak/write languages other than English, who are willing to | |
2806 use XEmacs/MULE regularly, and have some experience with Elisp. | |
428 | 2807 |
1135 | 2808 Translations of the TUTORIAL and man page are welcome, and XEmacs does |
2809 support multilingual menus, but we have few current translations. | |
2810 | |
2537 | 2811 @xref{Q1.5.2, How do I become a Beta Tester?}. |
2812 | |
2813 @node Q1.8.3, Q1.8.4, Q1.8.2, Introduction | |
2814 @unnumberedsubsec Q1.8.3: How do I type non-ASCII characters? | |
2417 | 2815 |
2459 | 2816 @xref{Q3.0.6, How can you type in special characters in XEmacs?}, in |
2417 | 2817 part 3 of this FAQ, for some simple methods that also work in non-MULE |
2818 builds of XEmacs (but only for one-octet coded character sets, and | |
2819 mostly for ISO 8859/1). Many of the methods available for Cyrillic | |
2537 | 2820 (@pxref{Q1.8.7, How about Cyrillic modes?}) work without MULE. MULE |
2821 has more general capabilities. @xref{Q1.8.5, Please explain the | |
2417 | 2822 various input methods in MULE/XEmacs}. |
2823 | |
2459 | 2824 @xref{Q4.0.8, How do I display non-ASCII characters?}, which covers |
2417 | 2825 display of non-ASCII characters. |
2826 | |
2537 | 2827 @node Q1.8.4, Q1.8.5, Q1.8.3, Introduction |
2828 @unnumberedsubsec Q1.8.4: Can XEmacs messages come out in a different language? | |
428 | 2829 |
1135 | 2830 The message-catalog support was written but is badly bit-rotted. XEmacs |
2831 20 and 21 did @emph{not} support it, and early releases of XEmacs 22 | |
2832 will not either. | |
2833 | |
2834 However, menubar localization @emph{does} work. To enable it, add to | |
2835 your @file{Emacs} file entries like this: | |
428 | 2836 |
2837 @example | |
440 | 2838 Emacs*XlwMenu.resourceLabels: True |
2839 Emacs*XlwMenu.file.labelString: Fichier | |
442 | 2840 Emacs*XlwMenu.openInOtherWindow.labelString: In anderem Fenster oeffnen |
428 | 2841 @end example |
2842 | |
2843 The name of the resource is derived from the non-localized entry by | |
2844 removing punctuation and capitalizing as above. | |
2845 | |
2537 | 2846 @node Q1.8.5, Q1.8.6, Q1.8.4, Introduction |
2847 @unnumberedsubsec Q1.8.5: Please explain the various input methods in MULE/XEmacs | |
428 | 2848 |
1135 | 2849 Mule supports a wide variety of input methods. There are three basic |
2850 classes: Lisp implementations, generic platform support, and library | |
2851 interfaces. | |
2852 | |
2853 @emph{Lisp implementations} include Quail, which provides table-driven input | |
2854 methods for almost all the character sets that Mule supports (including | |
2855 all of the ISO 8859 family, the Indic languages, Thai, and so on), and | |
2856 SKK, for Japanese. (SKK also supports an interface to an external | |
2857 "dictionary server" process.) Quail supports both typical "dead-key" | |
2858 methods (eg, in the "latin-1-prefix" method, @kbd{" a} produces ä, LATIN | |
2859 SMALL LETTER A WITH DIAERESIS), and the complex dictionary-based phonetic | |
2860 methods used for Asian ideographic languages like Chinese. | |
2861 | |
2862 Lisp implementations can be less powerful (but they are not perceptibly | |
2863 inefficient), and of course are not portable to non-Emacs applications. | |
2864 The incompatibility can be very annoying. On the other hand, they | |
2865 require no special platform support or external libraries, so if you can | |
2866 display the characters, Mule can input them for you and you can edit, | |
2867 anywhere. | |
2868 | |
2869 @emph{Generic platform support} is currently limited to the X Input | |
2870 Method (XIM) framework, although support for MSIME (for MS Windows) is | |
2871 planned, and IIIMF (Sun's Internet-Intranet Input Method Framework) | |
2872 support is extremely desirable. XIM is enabled at build time by use of | |
2873 the @samp{--with-xim} flag to @code{configure}. For use of XIM, see | |
2874 your platform documentation. However, normally the input method you use | |
2875 is specified via the @samp{LANG} and @samp{XMODIFIERS} environment | |
2876 variables. | |
2877 | |
2878 Of course, input skills are portable across most applications. However, | |
2879 especially in modern GUI systems the habit of using bucky bits has | |
2880 fallen into sad disuse, and many XIM systems are poorly configured for | |
2881 use with Emacs. For example, the kinput2 input manager (a separate | |
2882 process providing an interface between Japanese dictionary servers such | |
2883 as Canna and Wnn, and the application) tends to gobble up keystrokes | |
2884 generating Meta characters. This means that to edit while using an XIM | |
2885 input method, you must toggle the input method off every time you want | |
2886 to use @kbd{M-f}. Your mileage may vary. | |
2887 | |
2888 @emph{Library interfaces} are most common for Japanese, although Wnn | |
2889 supports Chinese (traditional and simplified) and Korean. There are | |
2890 Chinese and Korean input servers available, but we do not know of any | |
2891 patches for XEmacs to use them directly. You can use them via | |
2892 IM-enabled terminals, by manipulating the terminal coding systems. We | |
2893 describe only the Japanese-oriented systems here. The advantage of | |
2894 these systems is that they are very powerful, and on platforms where | |
2895 they are available there is typically a wide range of applications that | |
2896 support them. Thus your input skills are portable across applications. | |
2897 | |
2898 Mule provides built-in interfaces to the following input methods: Wnn4, | |
2899 Wnn6, Canna, and SJ3. These can be configured at build time. There are | |
2900 patches available (no URL, sorry) to support the SKK server, as well. | |
2901 Wnn and SJ3 use the @code{egg} user interface. The interface for Canna | |
2902 is specialized to Canna. | |
428 | 2903 |
2904 Wnn supports Japanese, Chinese and Korean. It is made by OMRON and Kyôto | |
1135 | 2905 University. It is a powerful and complex system. Wnn4 is free and Wnn6 |
2906 is not. Wnn uses grammatical hints and probability of word association, | |
2907 so in principle Wnn can be cleverer than other methods. | |
2908 | |
2909 Canna, made by NEC, supports only Japanese. It is a simple and powerful | |
2910 system. Canna uses only grammar, but its grammar and dictionary are | |
2911 quite sophisticated. So for standard modern Japanese, Canna seems | |
2912 cleverer than Wnn4. In addition, the UNIX version of Canna is free (now | |
2913 there is a Microsoft Windows version). | |
2914 | |
2915 SJ3, by Sony, supports only Japanese. | |
428 | 2916 |
2917 Egg consists of following parts: | |
2918 | |
2919 @enumerate | |
2920 @item | |
2921 Input character Translation System (ITS) layer. | |
2922 It translates ASCII inputs to Kana/PinYin/Hangul characters. | |
2923 | |
2924 @item | |
2925 Kana/PinYin/Hangul to Kanji transfer layer. | |
1135 | 2926 The interface layer to network Kana-Kanji server (Wnn and Sj3). |
428 | 2927 @end enumerate |
2928 | |
1135 | 2929 These input methods are modal. They have a raw (alphabet) mode, a |
2930 phonetic input mode, and Kana-Kanji transfer mode. However there are | |
2931 mode-less input methods for Egg and Canna. @samp{boiled-egg} is a | |
2932 mode-less input method running on Egg. For Canna, @samp{canna.el} has a | |
2933 tiny boiled-egg-like command, @code{(canna-boil)}, and there are some | |
2934 boiled-egg-like utilities. | |
2935 | |
2936 Much of this information was provided by @email{morioka@@jaist.ac.jp, | |
2937 MORIOKA Tomohiko}. | |
428 | 2938 |
2537 | 2939 @node Q1.8.6, Q1.8.7, Q1.8.5, Introduction |
2940 @unnumberedsubsec Q1.8.6: How do I portably code for MULE/XEmacs? | |
428 | 2941 |
1135 | 2942 MULE has evolved rapidly over the last few years, and the original third |
2943 party patch (for GNU Emacs 19), GNU Emacs 20+, and XEmacs 20+ have quite | |
2944 different implementations. The APIs also vary although recent versions | |
2945 of XEmacs have tended to converge to the GNU Emacs standard. | |
2946 | |
2947 MULE implementations are going to continue to evolve. Both GNU Emacs | |
2948 and XEmacs are working hard on Unicode support, which will involve new | |
2949 APIs and probably variations on old ones. For XEmacs 22, the old ISO | |
2950 2022-based system for recognizing encodings will be replaced by a much | |
2951 more flexible system, which should improve accuracy of automatic coding | |
2952 detections, but will also involve new APIs. | |
2953 | |
428 | 2954 @email{morioka@@jaist.ac.jp, MORIOKA Tomohiko} writes: |
2955 | |
2956 @quotation | |
1135 | 2957 The application implementor must write separate code for these mule |
2958 variants. [Please don't hesitate to report these variants to us; they | |
2959 are not, strictly speaking, bugs, but they give third-party developers | |
2960 the same kind of creepy-crawly feeling. We'll do what we can. -- Ed.] | |
428 | 2961 |
2962 MULE and the next version of Emacs are similar but the symbols are very | |
2963 different---requiring separate code as well. | |
2964 | |
2965 Namely we must support 3 kinds of mule variants and 4 or 5 or 6 kinds of | |
2966 emacs variants... (;_;) I'm shocked, so I wrote a wrapper package called | |
1135 | 2967 @code{emu} to provide a common interface. [There is an XEmacs package |
2968 of APEL which provides much more comprehensive coverage. Be careful, | |
2969 however; APEL has problems of its own. -- Ed.] | |
428 | 2970 |
2971 I have the following suggestions about dealing with mule variants: | |
2972 | |
2973 @itemize @bullet | |
2974 @item | |
2975 @code{(featurep 'mule)} @code{t} on all mule variants | |
2976 | |
2977 @item | |
2978 @code{(boundp 'MULE)} is @code{t} on only MULE. Maybe the next version | |
2979 of Emacs will not have this symbol. | |
2980 | |
2981 @item | |
2982 MULE has a variable @code{mule-version}. Perhaps the next version of | |
2983 Emacs will have this variable as well. | |
2984 @end itemize | |
2985 | |
2986 Following is a sample to distinguish mule variants: | |
2987 | |
2988 @lisp | |
2989 (if (featurep 'mule) | |
2990 (cond ((boundp 'MULE) | |
2991 ;; for original Mule | |
2992 ) | |
440 | 2993 ((string-match "XEmacs" emacs-version) |
2994 ;; for XEmacs with Mule | |
2995 ) | |
2996 (t | |
2997 ;; for next version of Emacs | |
2998 )) | |
428 | 2999 ;; for old emacs variants |
3000 ) | |
3001 @end lisp | |
3002 @end quotation | |
3003 | |
2537 | 3004 @node Q1.8.7, Q1.8.8, Q1.8.6, Introduction |
3005 @unnumberedsubsec Q1.8.7: How about Cyrillic modes? | |
428 | 3006 |
3007 @email{ilya@@math.ohio-state.edu, Ilya Zakharevich} writes: | |
3008 | |
3009 @quotation | |
3010 There is a cyrillic mode in the file @file{mysetup.zip} in | |
3011 @iftex | |
3012 @* | |
3013 @end iftex | |
3014 @uref{ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs/}. This is a | |
3015 modification to @email{ava@@math.jhu.ed, Valery Alexeev's} @file{russian.el} | |
3016 which can be obtained from | |
3017 @end quotation | |
3018 | |
871 | 3019 @uref{http://www.math.uga.edu/~valery/russian.el}. |
428 | 3020 |
3021 @email{d.barsky@@ee.surrey.ac.uk, Dima Barsky} writes: | |
3022 | |
3023 @quotation | |
3024 There is another cyrillic mode for both GNU Emacs and XEmacs by | |
3025 @email{manin@@camelot.mssm.edu, Dmitrii | |
3026 (Mitya) Manin} at | |
3027 @iftex | |
3028 | |
3029 @end iftex | |
3030 @uref{http://kulichki-lat.rambler.ru/centrolit/manin/cyr.el}. | |
3031 @c Link above, <URL:http://camelot.mssm.edu/~manin/cyr.el> was dead. | |
3032 @c Changed to russian host instead | |
3033 @end quotation | |
3034 | |
3035 @email{rebecca.ore@@op.net, Rebecca Ore} writes: | |
3036 | |
3037 @quotation | |
3038 The fullest resource I found on Russian language use (in and out of | |
661 | 3039 XEmacs) is @uref{http://www.ibiblio.org/sergei/Software/Software.html} |
428 | 3040 @end quotation |
3041 | |
2537 | 3042 @node Q1.8.8, Q1.8.9, Q1.8.7, Introduction |
3043 @unnumberedsubsec Q1.8.8: Does XEmacs support Unicode? | |
2417 | 3044 |
3045 To get Unicode support, you need a Mule-enabled XEmacs. | |
3046 | |
3047 21.5 has internal support for Unicode and supports it fully, although we | |
3048 don't yet use it as the internal encoding. | |
3049 | |
3050 21.4 supports Unicode partially -- as an external encoding for files, | |
2537 | 3051 processes, and terminals, but without font support. @xref{Q1.8.9, How |
2417 | 3052 does XEmacs display Unicode?}. To get Unicode support in 21.4, |
3053 install Mule-UCS from packages in the usual way, and put | |
745 | 3054 |
1616 | 3055 @example |
745 | 3056 (require 'un-define) |
3057 (set-coding-priority-list '(utf-8)) | |
1616 | 3058 (set-coding-category-system 'utf-8 'utf-8) |
3059 @end example | |
3060 | |
3061 in your init file to enable the UTF-8 coding system. You may wish to | |
3062 view the documentation of @code{set-coding-priority-list} if you find | |
3063 that files that are not UTF-8 are being mis-recognized as UTF-8. | |
745 | 3064 |
2417 | 3065 Install standard national fonts (not Unicode fonts) for all character |
2537 | 3066 sets you use. @xref{Q1.8.9, How does XEmacs display Unicode??}. |
745 | 3067 |
3068 Mule-UCS also supports 16-bit forms of Unicode (UTF-16). It does not | |
3069 support 31-bit forms of Unicode (UTF-32 or UCS-4). | |
3070 | |
2537 | 3071 @node Q1.8.9, , Q1.8.8, Introduction |
3072 @unnumberedsubsec Q1.8.9: How does XEmacs display Unicode? | |
745 | 3073 |
3074 Mule doesn't have a Unicode charset internally, so there's nothing to | |
3075 bind a Unicode registry to. It would not be straightforward to create, | |
3076 either, because Unicode is not ISO 2022-compatible. You'd have to | |
3077 translate it to multiple 96x96 pages. | |
3078 | |
3079 This means that Mule-UCS uses ordinary national fonts for display. This | |
3080 is not really a problem, except for those languages that use the Unified | |
3081 Han characters. The problem here is that Mule-UCS maps from Unicode | |
3082 code points to national character sets in a deterministic way. By | |
3083 default, this means that Japanese fonts are tried first, then Chinese, | |
3084 then Korean. To change the priority ordering, use the command | |
3085 `un-define-change-charset-order'. | |
3086 | |
3087 It also means you can't use Unicode fonts directly, at least not without | |
3088 extreme hackery. You can run -nw with (set-terminal-coding-system | |
3089 'utf-8) if you really want a Unicode font for some reason. | |
3090 | |
3091 Real Unicode support will be introduced in XEmacs 22.0. | |
3092 | |
2459 | 3093 @node Installation, Editing, Introduction, Top |
2417 | 3094 @unnumbered 2 Installation and Troubleshooting |
428 | 3095 |
3096 This is part 2 of the XEmacs Frequently Asked Questions list. This | |
2417 | 3097 section is devoted to Installation, Maintenance and Troubleshooting. |
428 | 3098 |
3099 @menu | |
2559 | 3100 2.0: Installation (General) |
3101 * Q2.0.1:: How do I build and install XEmacs? | |
3102 * Q2.0.2:: Where do I find external libraries? | |
3103 * Q2.0.3:: How do I specify the paths that XEmacs uses for finding files? | |
3104 * Q2.0.4:: Running XEmacs without installing | |
3105 * Q2.0.5:: XEmacs is too big | |
3106 | |
3107 2.1: Package Installation | |
3108 * Q2.1.1:: How do I install the packages? | |
3109 * Q2.1.2:: Can I install the packages individually? | |
3110 * Q2.1.3:: Can I install the packages automatically? | |
3111 * Q2.1.4:: Can I upgrade or remove packages? | |
3112 * Q2.1.5:: Which packages to install? | |
3113 * Q2.1.6:: Can you describe the package location process in more detail? | |
3114 * Q2.1.7:: EFS fails with "500 AUTH not understood" | |
3115 | |
3116 2.2: Unix/Mac OS X Installation (Also Relevant to Cygwin, MinGW) | |
3117 * Q2.2.1:: Libraries in non-standard locations | |
3118 * Q2.2.2:: Why can't I strip XEmacs? | |
3404 | 3119 * Q2.2.3:: X11/bitmaps/gray (or other X11-related file) not found. |
2559 | 3120 |
3121 2.3: Windows Installation (Windows, Cygwin, MinGW) | |
3122 * Q2.3.1:: What exactly are all the different ways to build XEmacs under Windows? | |
3123 * Q2.3.2:: What compiler/libraries do I need to compile XEmacs? | |
3124 * Q2.3.3:: How do I compile the native port? | |
3125 * Q2.3.4:: What do I need for Cygwin? | |
3126 * Q2.3.5:: How do I compile under Cygwin? | |
3127 * Q2.3.6:: How do I compile using MinGW (aka @samp{the -mno-cygwin flag to gcc})? | |
3128 * Q2.3.7:: How do I compile with X support? | |
3129 * Q2.3.8:: Cygwin XEmacs won't start -- cygXpm-noX4.dll was not found (NEW) | |
3130 | |
3131 2.4: General Troubleshooting | |
3132 * Q2.4.1:: How do I deal with bugs or with problems building, installing, or running? | |
3133 * Q2.4.2:: Help! XEmacs just crashed on me! | |
3134 * Q2.4.3:: XEmacs crashes and I compiled it myself. | |
3135 * Q2.4.4:: How to debug an XEmacs problem with a debugger | |
3136 * Q2.4.5:: I get a cryptic error message when trying to do something. | |
3137 * Q2.4.6:: XEmacs hangs when I try to do something. | |
3138 * Q2.4.7:: I get an error message when XEmacs is running in batch mode. | |
3139 * Q2.4.8:: The keyboard or mouse is not working properly, or I have some other event-related problem. | |
3140 * Q2.4.9:: @kbd{C-g} doesn't work for me. Is it broken? | |
3141 * Q2.4.10:: How do I debug process-related problems? | |
3142 * Q2.4.11:: XEmacs is outputting lots of X errors. | |
3143 * Q2.4.12:: After upgrading, XEmacs won't do `foo' any more! | |
3144 | |
3145 2.5: Startup-Related Problems | |
3146 * Q2.5.1:: XEmacs cannot connect to my X Terminal! | |
3147 * Q2.5.2:: Startup problems related to paths or package locations. | |
4658
fd2495d78aac
Add FAQ on network slows (lookup order of DNS and /etc/hosts).
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4625
diff
changeset
|
3148 * Q2.5.3:: XEmacs won't start without network, or starts slowly. |
2559 | 3149 * Q2.5.4:: Startup warnings about deducing proper fonts? |
3150 * Q2.5.5:: Warnings from incorrect key modifiers. | |
3151 * Q2.5.6:: XEmacs 21.1 on Windows used to spawn an ugly console window on every startup. Has that been fixed? | |
428 | 3152 @end menu |
3153 | |
2559 | 3154 @unnumberedsec 2.0: Installation (General) |
2417 | 3155 |
428 | 3156 @node Q2.0.1, Q2.0.2, Installation, Installation |
2559 | 3157 @unnumberedsubsec Q2.0.1: How do I build and install XEmacs? |
3158 | |
3159 See the file @file{etc/NEWS} for information on new features and other | |
3160 user-visible changes since the last version of XEmacs. | |
3161 | |
3162 The file @file{INSTALL} in the top-level directory says how to bring | |
3163 up XEmacs on Unix and Cygwin, once you have loaded the entire subtree | |
3164 of this directory. | |
3165 | |
3166 See the file @file{nt/README} for instructions on building XEmacs for | |
3167 Microsoft Windows. | |
3168 | |
3169 @xref{Q2.1.1}, for the installation of (essential) add on packages. | |
2417 | 3170 |
3171 @node Q2.0.2, Q2.0.3, Q2.0.1, Installation | |
2559 | 3172 @unnumberedsubsec Q2.0.2: Where do I find external libraries? |
2417 | 3173 |
2459 | 3174 All external libraries used by XEmacs can be found on the XEmacs web |
2417 | 3175 site |
3176 @iftex | |
3177 @* | |
3178 @end iftex | |
2459 | 3179 @uref{http://www.xemacs.org/Download/optLibs.html}. |
2417 | 3180 |
3181 The library versions available here are known to work with XEmacs. | |
3182 (Newer versions will probably work as well but we can't guarantee it.) | |
3183 We try to keep the libraries up-to-date but may not always succeed. | |
2459 | 3184 Check the above page for the canonical locations of the external libraries, |
3185 allowing you to download the latest, bleeding-edge versions. | |
2417 | 3186 |
2559 | 3187 @node Q2.0.3, Q2.0.4, Q2.0.2, Installation |
3188 @unnumberedsubsec Q2.0.3: How do I specify the paths that XEmacs uses for finding files? | |
2417 | 3189 |
3190 You can specify what paths to use by using a number of different flags | |
3191 when running configure. See the section MAKE VARIABLES in the top-level | |
3192 file INSTALL in the XEmacs distribution for a listing of those flags. | |
3193 | |
3194 Most of the time, however, the simplest fix is: @strong{do not} specify | |
3195 paths as you might for GNU Emacs. XEmacs can generally determine the | |
3196 necessary paths dynamically at run time. The only path that generally | |
3197 needs to be specified is the root directory to install into. That can | |
3198 be specified by passing the @code{--prefix} flag to configure. For a | |
3199 description of the XEmacs install tree, please consult the @file{NEWS} | |
3200 file. | |
3201 | |
2559 | 3202 @node Q2.0.4, Q2.0.5, Q2.0.3, Installation |
3203 @unnumberedsubsec Q2.0.4: Running XEmacs without installing | |
442 | 3204 |
3205 How can I just try XEmacs without installing it? | |
428 | 3206 |
3207 XEmacs will run in place without requiring installation and copying of | |
3208 the Lisp directories, and without having to specify a special build-time | |
3209 flag. It's the copying of the Lisp directories that requires so much | |
3210 space. XEmacs is largely written in Lisp. | |
3211 | |
3212 A good method is to make a shell alias for xemacs: | |
3213 | |
3214 @example | |
2459 | 3215 alias xemacs=/src/xemacs-21.5/src/xemacs |
428 | 3216 @end example |
3217 | |
3218 (You will obviously use whatever directory you downloaded the source | |
2459 | 3219 tree to instead of @file{/src/xemacs-21.5}). |
428 | 3220 |
3221 This will let you run XEmacs without massive copying. | |
3222 | |
2559 | 3223 @node Q2.0.5, Q2.1.1, Q2.0.4, Installation |
3224 @unnumberedsubsec Q2.0.5: XEmacs is too big | |
428 | 3225 |
442 | 3226 The space required by the installation directories can be |
428 | 3227 reduced dramatically if desired. Gzip all the .el files. Remove all |
442 | 3228 the packages you'll never want to use. Remove the TexInfo manuals. |
428 | 3229 Remove the Info (and use just hardcopy versions of the manual). Remove |
3230 most of the stuff in etc. Remove or gzip all the source code. Gzip or | |
3231 remove the C source code. Configure it so that copies are not made of | |
1138 | 3232 the support lisp. |
428 | 3233 |
3234 These are all Emacs Lisp source code and bytecompiled object code. You | |
3235 may safely gzip everything named *.el here. You may remove any package | |
3236 you don't use. @emph{Nothing bad will happen if you delete a package | |
3237 that you do not use}. You must be sure you do not use it though, so be | |
3238 conservative at first. | |
3239 | |
1648 | 3240 Any package with the possible exceptions of xemacs-base, and EFS are |
3241 candidates for removal. Ask yourself, @emph{Do I ever want to use this | |
3242 package?} If the answer is no, then it is a candidate for removal. | |
428 | 3243 |
3244 First, gzip all the .el files. Then go about package by package and | |
3245 start gzipping the .elc files. Then run XEmacs and do whatever it is | |
1648 | 3246 you normally do. If nothing bad happens, then remove the package. You |
3247 can remove a package via the PUI interface | |
3248 (@code{M-x pui-list-packages}, then press @kbd{d} to mark the packages | |
3249 you wish to delete, and then @kbd{x} to delete them. | |
3250 | |
3251 Another method is to do @code{M-x package-get-delete-package}. | |
428 | 3252 |
2559 | 3253 @unnumberedsec 2.1: Package Installation |
3254 | |
3255 @node Q2.1.1, Q2.1.2, Q2.0.5, Installation | |
3256 @unnumberedsubsec Q2.1.1: How do I install the packages? | |
3257 | |
3258 There are three ways to install the packages. | |
3259 | |
3260 @enumerate | |
3261 @item | |
3262 Manually, all at once, using the 'Sumo Tarball'. | |
3263 @item | |
3264 Manually, using individual package tarballs. | |
3265 @item | |
3266 Automatically, using the package tools from XEmacs. | |
3267 @end enumerate | |
3268 | |
3269 If you don't want to mess with the packages, it is easiest to just | |
3270 grab them manually, all at once. (For the other two ways, | |
3271 @xref{Q2.1.2}, and @xref{Q2.1.3}.) Download the file | |
3272 | |
3273 @file{xemacs-sumo.tar.gz} | |
3274 | |
3275 For an XEmacs compiled with Mule you also need | |
3276 | |
3277 @file{xemacs-mule-sumo.tar.gz} | |
3278 | |
3279 These are in the @file{packages} directory on your XEmacs mirror | |
3280 archive: @uref{ftp://ftp.xemacs.org/pub/xemacs/packages} or its | |
3281 mirrors. N.B. They are called 'Sumo Tarballs' for good reason. They | |
3282 are currently about 19MB and 4.5MB (gzipped) respectively. | |
3283 | |
3284 Install them on Unix and Mac OS X using the shell/Terminal command | |
3285 | |
3286 @code{cd $prefix/lib/xemacs ; gunzip -c <tarballname> | tar xf -} | |
3287 | |
3288 Where @samp{$prefix} is what you gave to the @samp{--prefix} flag to | |
3289 @file{configure}, and defaults to @file{/usr/local}. | |
3290 | |
3291 If you have GNU tar you can use: | |
3292 | |
3293 @code{cd $prefix/lib/xemacs ; tar zxvf <tarballname>} | |
3294 | |
3018 | 3295 If you have the packages somewhere nonstandard and don't want to bother |
3296 with @samp{$prefix} (for example, you're a developer and are compiling | |
3297 the packages yourself, and want your own private copy of everything), | |
3298 you can also directly specify this using @file{configure}. To do this | |
3179 | 3299 with 21.5 and above use the @samp{--with-late-packages} parameter to |
3018 | 3300 specify the directory under which you untarred the above tarballs. |
3301 Under 21.4 and previous you need to use @samp{--package-path}. Using | |
3302 these options looks something like this: | |
2559 | 3303 |
3304 @example | |
3305 configure --package-path="~/.xemacs::/src/xemacs/site-packages:/src/xemacs/xemacs-packages:/src/xemacs/mule-packages" ... | |
3306 @end example | |
3307 | |
3308 Under Windows, you need to place the above @samp{tar.gz} files in the | |
3309 directory specified using the @samp{PACKAGE_PREFIX} value in | |
3310 @file{nt/config.inc} and by default is @file{\Program Files\XEmacs}. | |
3311 (To untar a @samp{tar.gz} file you will need to use a utility such as | |
3312 WinZip, unless you have Cygwin or a similar environment installed, in | |
3313 which case the above Unix shell command should work fine.) If you want | |
3314 the packages somewhere else, just change @samp{PACKAGE_PREFIX}. | |
3315 | |
3316 Note that XEmacs finds the packages automatically anywhere underneath | |
3317 the directory tree where it expects to find the packages. All you | |
3318 need to do is put stuff there; you don't need to run any program to | |
4311 | 3319 tell XEmacs to find the packages, or do anything of that sort. |
2559 | 3320 |
3321 However, XEmacs will only notice newly installed packages when it | |
3322 starts up, so you will have to restart if you are already running | |
3323 XEmacs. | |
3324 | |
3325 For more details, @xref{Startup Paths,,,xemacs, the XEmacs User's | |
3326 Manual}, and @xref{Packages,,,xemacs, the XEmacs User's Manual}. | |
3327 | |
3328 As the Sumo tarballs are not regenerated as often as the individual | |
3329 packages, it is recommended that you use the automatic package tools | |
3330 afterwards to pick up any recent updates. | |
3331 | |
3332 @emph{NOTE}: For detailed information about how the package | |
3333 hierarchies work, @xref{Package Overview,,,lispref, the XEmacs Lisp | |
3334 Reference Manual}. | |
3335 | |
3336 @node Q2.1.2, Q2.1.3, Q2.1.1, Installation | |
3337 @unnumberedsubsec Q2.1.2: Can I install the packages individually? | |
3338 | |
3339 Yes, you can download individual packages from the FTP site (@pxref{Q2.1.1}). Since packages are automatically noticed at startup, you just have to put them in the right place. | |
3340 | |
3341 Note: If you are upgrading packages already installed, it's best to | |
3342 remove the old package first (@pxref{Q2.1.4}). | |
3343 | |
3344 For example if we are installing the @samp{xemacs-base} | |
3345 package (version 1.48): | |
3346 | |
3347 @example | |
3348 mkdir $prefix/lib/xemacs/xemacs-packages RET # if it does not exist yet | |
3349 cd $prefix/lib/xemacs/xemacs-packages RET | |
3350 gunzip -c /path/to/xemacs-base-1.48-pkg.tar.gz | tar xvf - RET | |
3351 @end example | |
3352 | |
3353 Or if you have GNU tar, the last step can be: | |
3354 | |
3355 @example | |
3356 tar zxvf /path/to/xemacs-base-1.48-pkg.tar.gz RET | |
3357 @end example | |
3358 | |
3359 For MULE related packages, it is best to untar into the @samp{mule-packages} | |
3360 hierarchy, i.e. for the @samp{mule-base} package, version 1.37: | |
3361 | |
3362 @example | |
3363 mkdir $prefix/lib/xemacs/mule-packages RET # if it does not exist yet | |
3364 cd $prefix/lib/xemacs/mule-packages RET | |
3365 gunzip -c /path/to/mule-base-1.37-pkg.tar.gz | tar xvf - RET | |
3366 @end example | |
3367 | |
3368 Or if you have GNU tar, the last step can be: | |
3369 | |
3370 @example | |
3371 tar zxvf /path/to/mule-base-1.37-pkg.tar.gz RET | |
3372 @end example | |
3373 | |
3374 @node Q2.1.3, Q2.1.4, Q2.1.2, Installation | |
3375 @unnumberedsubsec Q2.1.3: Can I install the packages automatically? | |
3376 | |
3377 XEmacs comes with some tools to make the periodic updating and | |
3378 installing easier. It will notice if new packages or versions are | |
3379 available and will fetch them from the FTP site. | |
3380 | |
3381 Unfortunately this requires that a few packages are already in place. | |
3382 You will have to install them by hand as above or use a SUMO tarball. | |
3383 This requirement will hopefully go away in the future. The packages | |
3384 you need are: | |
3385 | |
3386 @example | |
3387 efs - To fetch the files from the FTP site or mirrors. | |
3388 xemacs-base - Needed by efs. | |
3389 @end example | |
3390 | |
3391 and optionally: | |
3392 | |
3393 @example | |
3394 mailcrypt - For PGP verification of the package-index file. | |
3395 @end example | |
3396 | |
3397 After installing these by hand, fire up XEmacs and follow these | |
3398 steps. | |
3399 | |
3400 @enumerate | |
3401 @item | |
3402 Choose a download site. | |
3403 @itemize @bullet | |
3404 @item | |
3405 via menu: Tools -> Packages -> Set Download Site | |
3406 @item | |
3407 via keyb: M-x customize-variable RET package-get-remote RET | |
3408 (put in the details of remote host and directory) | |
3409 @end itemize | |
3410 | |
3411 If the package tarballs _AND_ the package-index file are in a | |
3412 local directory, you can: M-x pui-set-local-package-get-directory RET | |
3413 | |
3414 @item | |
3415 Obtain a list of packages and display the list in a buffer named | |
3416 "*Packages*". | |
3417 @itemize @bullet | |
3418 @item | |
3419 menu: Tools -> Packages -> List & Install | |
3420 @item | |
3421 keyb: M-x pui-list-packages RET | |
3422 @end itemize | |
3423 | |
3424 XEmacs will now connect to the remote site and download the | |
3425 latest package-index file. | |
3426 | |
3427 The resulting buffer, "*Packages*" has brief instructions at the | |
3428 end of the buffer. | |
3429 | |
3430 @item | |
3431 Choose the packages you wish to install. | |
3432 @itemize @bullet | |
3433 @item | |
3434 mouse: Click button 2 on the package name. | |
3435 @item | |
3436 keyb: RET on the package name | |
3437 @end itemize | |
3438 | |
3439 @item | |
3440 Make sure you have everything you need. | |
3441 @itemize @bullet | |
3442 @item | |
3443 menu: Packages -> Add Required | |
3444 @item | |
3445 keyb: r | |
3446 @end itemize | |
3447 | |
3448 XEmacs will now search for packages that are required by the | |
3449 ones that you have chosen to install and offer to select | |
3450 those packages also. | |
3451 | |
3452 For novices and gurus alike, this step can save your bacon. | |
3453 It's easy to forget to install a critical package. | |
3454 | |
3455 @item | |
3456 Download and install the packages. | |
3457 @itemize @bullet | |
3458 @item | |
3459 menu: Packages -> Install/Remove Selected | |
3460 @item | |
3461 keyb: x | |
3462 @end itemize | |
3463 @end enumerate | |
3464 | |
3465 @node Q2.1.4, Q2.1.5, Q2.1.3, Installation | |
3466 @unnumberedsubsec Q2.1.4: Can I upgrade or remove packages? | |
3467 | |
3468 As the exact files and their locations contained in a package may | |
3469 change it is recommended to remove a package first before installing a | |
4311 | 3470 new version. In order to facilitate removal each package contains a |
3471 pkginfo/MANIFEST.pkgname file which lists all the files belonging to | |
3472 the package. M-x package-admin-delete-binary-package RET can be used | |
3473 to remove a package using this file. | |
2559 | 3474 |
3475 Note that the interactive package tools included with XEmacs already do | |
3476 this for you. | |
3477 | |
3478 @node Q2.1.5, Q2.1.6, Q2.1.4, Installation | |
3479 @unnumberedsubsec Q2.1.5: Which packages to install? | |
3480 | |
3481 Unless you are an advanced user, just install everything. | |
3482 | |
3483 If you really want to install only what's absolutely needed, a good | |
3484 minimal set of packages for XEmacs-latin1 would be | |
3485 | |
3486 @example | |
3487 xemacs-base, xemacs-devel, c-support, cc-mode, debug, dired, efs, | |
3488 edit-utils, fsf-compat, mail-lib, net-utils, os-utils, prog-modes, | |
3489 text-modes, time, mailcrypt | |
3490 @end example | |
3491 | |
3492 If you are using the XEmacs package tools, don't forget to do: | |
3493 | |
3494 @example | |
3495 Packages -> Add Required | |
3496 @end example | |
3497 | |
3498 To make sure you have everything that the packages you have chosen to | |
3499 install need. | |
3500 | |
3501 @xref{Q1.7.2}, for a description of the various packages. | |
3502 | |
3503 @node Q2.1.6, Q2.1.7, Q2.1.5, Installation | |
3504 @unnumberedsubsec Q2.1.6: Can you describe the package location process in more detail? | |
3505 | |
3506 On startup XEmacs looks for packages in so-called package hierarchies. | |
3507 Normally, there are three system wide hierarchies, like this: | |
3508 | |
3509 @example | |
3510 $prefix/lib/xemacs/xemacs-packages/ | |
3511 Normal packages go here. | |
3512 | |
3513 $prefix/lib/xemacs/mule-packages/ | |
3514 Mule packages go here and are only searched by MULE-enabled XEmacsen. | |
3515 | |
3516 $prefix/lib/xemacs/site-packages/ | |
3517 Local and 3rd party packages go here. | |
3518 @end example | |
3519 | |
3520 This is what you get when you untar the SUMO tarballs under | |
3521 @file{$prefix/lib/xemacs}. | |
3522 | |
3523 @file{$prefix} is specified using the @samp{--prefix} parameter to | |
3524 @file{configure}, and defaults to @file{usr/local}. | |
3525 | |
3526 If the package path is not explicitly specified, XEmacs looks for the | |
3527 package directory @file{xemacs-packages} (and @file{mule-packages} and | |
3528 @file{site-packages}) first under @samp{~/.xemacs}, then for a sister | |
3529 directory @file{lib/xemacs-VERSION} of the directory in which the | |
3530 XEmacs executable is located, then for a sister directory | |
3531 @file{lib/xemacs}. The XEmacs executable (under Unix at least) is | |
3532 installed by default in @file{/usr/local/bin}; this explains why | |
3533 XEmacs in its default installation will find packages that you put | |
3534 under @file{/usr/local/lib/xemacs}. | |
3535 | |
3536 You can specify where exactly XEmacs looks for packages by using the | |
3179 | 3537 @samp{--with-user-packages} (an alias for @samp{--with-early-packages}) |
3538 or @samp{--with-system-packages} (an alias for | |
3539 @samp{--with-late-packages}) or @samp{--with-legacy-packages} | |
3540 (an alias for @samp{--with-last-packages}) | |
3541 parameters to @file{configure} (or the equivalent settings in | |
3542 @file{config.inc}, under Windows), or setting the | |
3543 @samp{EMACSEARLYPACKAGES}, @samp{EMACSLATEPACKAGES}, and | |
3544 @samp{EMACSLASTPACKAGES} environment variables (which have the same | |
3545 format as the configure options). @xref{Q2.1.1}. | |
2559 | 3546 |
3547 See @file{configure.usage} for more info about the format of these | |
3548 @file{configure} parameters. | |
3549 | |
3550 In addition to the system wide packages, each user can have his own | |
3551 packages installed under @file{~/.xemacs/}. If you want to install | |
3552 packages there using the interactive tools, you need to set | |
3553 @code{package-get-install-to-user-init-directory} to @code{t}. | |
3554 | |
3555 The site-packages hierarchy replaces the old @file{site-lisp} | |
3556 directory. XEmacs no longer looks into a @file{site-lisp} directly by | |
3557 default. A good place to put @file{site-start.el} would be in | |
3558 @file{$prefix/lib/xemacs/site-packages/lisp/}. | |
3559 | |
3560 @node Q2.1.7, Q2.2.1, Q2.1.6, Installation | |
3561 @unnumberedsubsec Q2.1.7: EFS fails with "500 AUTH not understood" (NEW) | |
2417 | 3562 |
3563 A typical error: FTP Error: USER request failed; 500 AUTH not understood. | |
3564 | |
4311 | 3565 Thanks to Giacomo Boffi @email{giacomo.boffi@@polimi.it} who recommends |
2417 | 3566 on comp.emacs.xemacs: |
3567 | |
3568 tell your ftp client to not attempt AUTH authentication (or do not | |
3569 use FTP servers that don't understand AUTH) | |
3570 | |
3571 and notes that you need to add an element (often "-u") to | |
3572 `efs-ftp-program-args'. Use M-x customize-variable, and verify the | |
3573 needed flag with `man ftp' or other local documentation. | |
3574 | |
2559 | 3575 @unnumberedsec 2.2: Unix/Mac OS X Installation (Also Relevant to Cygwin, MinGW) |
3576 | |
3577 @node Q2.2.1, Q2.2.2, Q2.1.7, Installation | |
3578 @unnumberedsubsec Q2.2.1: Libraries in non-standard locations | |
428 | 3579 |
2459 | 3580 If your libraries are in a non-standard location, you can specify the location |
3018 | 3581 using the following flags to @file{configure}. Under 21.4 or earlier: |
2459 | 3582 |
3583 @example | |
3584 --site-libraries=WHATEVER | |
3585 --site-includes=WHATEVER | |
3586 @end example | |
3587 | |
3018 | 3588 Under 21.5 or later: |
3589 | |
3590 @example | |
3591 --with-site-libraries=WHATEVER | |
3592 --with-site-includes=WHATEVER | |
3593 @end example | |
3594 | |
2459 | 3595 If you have multiple paths to specify, use the following syntax: |
428 | 3596 |
3597 @example | |
3598 --site-libraries='/path/one /path/two /path/etc' | |
3599 @end example | |
3600 | |
3018 | 3601 If the libraries and headers reside in the directories @samp{lib} and |
3602 @samp{include} of a common root (say @samp{/sw}) then both can be | |
3603 specified with a single option: | |
3604 | |
3605 @example | |
3606 --site-prefixes=WHATEVER | |
3607 @end example | |
3608 | |
3609 or for 21.5: | |
3610 | |
3611 @example | |
3612 --with-site-prefixes=WHATEVER | |
3613 @end example | |
3614 | |
3404 | 3615 @node Q2.2.2, Q2.2.3, Q2.2.1, Installation |
2559 | 3616 @unnumberedsubsec Q2.2.2: Why can't I strip XEmacs? |
428 | 3617 |
3618 @email{cognot@@fronsac.ensg.u-nancy.fr, Richard Cognot} writes: | |
3619 | |
3620 @quotation | |
3621 Because of the way XEmacs (and every other Emacsen, AFAIK) is built. The | |
3622 link gives you a bare-boned emacs (called temacs). temacs is then run, | |
3623 preloading some of the lisp files. The result is then dumped into a new | |
3624 executable, named xemacs, which will contain all of the preloaded lisp | |
3625 functions and data. | |
3626 | |
3627 Now, during the dump itself, the executable (code+data+symbols) is | |
3628 written on disk using a special unexec() function. This function is | |
3629 obviously heavily system dependent. And on some systems, it leads to an | |
3630 executable which, although valid, cannot be stripped without damage. If | |
3631 memory serves, this is especially the case for AIX binaries. On other | |
462 | 3632 architectures it might work OK. |
428 | 3633 |
3634 The Right Way to strip the emacs binary is to strip temacs prior to | |
3635 dumping xemacs. This will always work, although you can do that only if | |
3636 you install from sources (as temacs is @file{not} part of the binary | |
3637 kits). | |
3638 @end quotation | |
3639 | |
3640 @email{nat@@nataa.fr.eu.org, Nat Makarevitch} writes: | |
3641 | |
3642 @quotation | |
3643 Here is the trick: | |
3644 | |
3645 @enumerate | |
3646 @item | |
3647 [ ./configure; make ] | |
3648 | |
3649 @item | |
3650 rm src/xemacs | |
3651 | |
3652 @item | |
3653 strip src/temacs | |
3654 | |
3655 @item | |
3656 make | |
3657 | |
3658 @item | |
3659 cp src/xemacs /usr/local/bin/xemacs | |
3660 | |
3661 @item | |
3662 cp lib-src/DOC-19.16-XEmacs | |
3663 @iftex | |
3664 \ @* | |
3665 @end iftex | |
3666 /usr/local/lib/xemacs-19.16/i586-unknown-linuxaout | |
3667 @end enumerate | |
3668 @end quotation | |
3669 | |
3404 | 3670 @node Q2.2.3, Q2.3.1, Q2.2.2, Installation |
3671 @unnumberedsubsec Q2.2.3: X11/bitmaps/gray (or other X11-related file) not found. | |
3672 | |
3673 The X11R6 distribution was monolithic, but the X11R7 distribution is | |
3674 much more modular. Many OS distributions omit these bitmaps (assuming | |
3675 nobody uses them, evidently). Your OS distribution should have a | |
3676 developer's package containing these files, probably with a name | |
3677 containing the string "bitmap". Known package names (you may need to | |
3678 add an extension such as .deb or .rpm) include x11/xbitmaps (Ubuntu) | |
3679 and xorg-x11-xbitmaps (Fedora Core 5). | |
3680 | |
2559 | 3681 @unnumberedsec 2.3: Windows Installation (Windows, Cygwin, MinGW) |
3682 | |
3404 | 3683 @node Q2.3.1, Q2.3.2, Q2.2.3, Installation |
2559 | 3684 @unnumberedsubsec Q2.3.1: What exactly are all the different ways to build XEmacs under Windows? |
2417 | 3685 |
3686 XEmacs can be built in several ways in the MS Windows environment. | |
3687 | |
3688 The standard way is what we call the "native" port. It uses the Win32 | |
3689 API and has no connection with X whatsoever -- it does not require X | |
3690 libraries to build, nor does it require an X server to run. The native | |
3691 port is the most reliable version and provides the best graphical | |
3692 support. Almost all development is geared towards this version, and | |
3693 there is little reason not to use it. | |
3694 | |
3695 The second way to build is the Cygwin port. It takes advantage of | |
2537 | 3696 Cygnus emulation library under Win32. @xref{Q1.2.5, What are Cygwin |
2417 | 3697 and MinGW, and do I need them to run XEmacs?}, for more information. |
3698 | |
3699 A third way is the MinGW port. It uses the Cygwin environment to | |
2537 | 3700 build but does not require it at runtime. @xref{Q1.2.5, What are |
2417 | 3701 Cygwin and MinGW, and do I need them to run XEmacs?}, for more |
3702 information. | |
3703 | |
3704 Finally, you might also be able to build the non-Cygwin, non-MinGW "X" | |
3705 port. This was actually the first version of XEmacs that ran under MS | |
3706 Windows, and although the code is still in XEmacs, it's essentially | |
3707 orphaned and it's unlikely it will compile without a lot of work. If | |
3708 you want an MS Windows versin of XEmacs that supports X, use the Cygwin | |
3709 version. (The X support there is actively maintained, so that Windows | |
3710 developers can test the X support in XEmacs.) | |
3711 | |
2559 | 3712 @node Q2.3.2, Q2.3.3, Q2.3.1, Installation |
3713 @unnumberedsubsec Q2.3.2: What compiler/libraries do I need to compile XEmacs? | |
2417 | 3714 |
3715 You need Visual C++ 4.2, 5.0, or 6.0 for the native version. (We have | |
3716 some beta testers currently trying to compile with VC.NET, aka version | |
3717 7.0, but we can't yet report complete success.) For the Cygwin and | |
3718 MinGW versions, you need the Cygwin environment, which comes with GCC, | |
2537 | 3719 the compiler used for those versions. @xref{Q1.2.5, What are Cygwin |
2417 | 3720 and MinGW, and do I need them to run XEmacs?}, for more information on |
3721 Cygwin and MinGW. | |
3722 | |
2559 | 3723 @node Q2.3.3, Q2.3.4, Q2.3.2, Installation |
3724 @unnumberedsubsec Q2.3.3: How do I compile the native port? | |
2417 | 3725 |
3726 Please read the file @file{nt/README} in the XEmacs distribution, which | |
3727 contains the full description. | |
3728 | |
2559 | 3729 @node Q2.3.4, Q2.3.5, Q2.3.3, Installation |
3730 @unnumberedsubsec Q2.3.4: What do I need for Cygwin? | |
2417 | 3731 |
3732 You can find the Cygwin tools and compiler at: | |
3733 | |
3734 @uref{http://www.cygwin.com/} | |
3735 | |
3736 Click on the @samp{Install or update now!} link, which will download a | |
3737 file @file{setup.exe}, which you can use to download everything | |
3738 else. (You will need to pick a mirror site; @samp{mirrors.rcn.net} is | |
3739 probably the best.) You should go ahead and install everything -- | |
3740 you'll get various ancillary libraries that XEmacs needs or likes, | |
3741 e.g. XPM, PNG, JPEG, TIFF, etc. You can also get X Windows here, if you | |
3742 want to compile under X. | |
3743 | |
3744 If you want to compile without X, you will need the @file{xpm-nox} | |
3745 library, which must be specifically selected in the Cygwin netinstaller; | |
3746 it is not selected by default. The package has had various names. | |
3747 Currently it is called @file{cygXpm-noX4.dll}. | |
3748 | |
2559 | 3749 @node Q2.3.5, Q2.3.6, Q2.3.4, Installation |
3750 @unnumberedsubsec Q2.3.5: How do I compile under Cygwin? | |
2417 | 3751 |
3752 Similar as on Unix; use the usual `configure' and `make' process. | |
3753 Some problems to watch out for: | |
3754 | |
3755 @itemize @bullet | |
3756 @item | |
3757 make sure HOME is set. This controls where you | |
3758 @file{init.el} file comes from; | |
3759 | |
3760 @item | |
3761 @samp{CYGWIN} needs to be set to @samp{tty} for process support to work; | |
3762 | |
3763 @item | |
3764 picking up some other grep or other UNIX-like tools can kill configure; | |
3765 | |
3766 @item | |
3767 static heap too small, adjust @file{src/sheap-adjust.h} to a more positive | |
3768 number; | |
3769 | |
3770 @item | |
3771 (Unconfirmed) The Cygwin version doesn't understand | |
3772 @file{//machine/path} type paths so you will need to manually mount a | |
3773 directory of this form under a unix style directory for a build to work | |
3774 on the directory; | |
3775 | |
3776 @item | |
3777 If you're building @strong{WITHOUT} X11, don't forget to change symlinks | |
3778 @file{/usr/lib/libXpm.a} and @file{/usr/lib/libXpm.dll.a} to point to | |
3779 the non-X versions of these libraries. By default they point to the X | |
3780 versions. So: | |
3781 | |
3782 @example | |
3783 /usr/lib/libXpm.a -> /usr/lib/libXpm-noX.a | |
3784 /usr/lib/libXpm.dll.a -> /usr/lib/libXpm-noX.dll.a | |
3785 @end example | |
3786 | |
3787 (This advice may now be obsolete because of the availability of the | |
3788 cygXpm-noX4.dll package from Cygwin. Send confirmation to | |
3789 @email{faq@@xemacs.org}.) | |
3790 | |
3791 @item | |
3792 Other problems are listed in the @file{PROBLEMS} file, in the top-level | |
3793 directory of the XEmacs sources. | |
3794 | |
3795 @end itemize | |
3796 | |
3797 | |
2559 | 3798 @node Q2.3.6, Q2.3.7, Q2.3.5, Installation |
3799 @unnumberedsubsec Q2.3.6: How do I compile using MinGW (aka @samp{the -mno-cygwin flag to gcc})? | |
2417 | 3800 |
3801 Similar to the method for Unix. Things to remember: | |
3802 | |
3803 @itemize @bullet | |
3804 @item | |
3805 Specify the target host on the command line for @file{./configure}, e.g. | |
3806 @samp{./configure i586-pc-mingw32}. | |
3807 | |
3808 @item | |
3809 Be sure that your build directory is mounted such that it has the | |
3810 same path either as a cygwin path (@file{/build/xemacs}) or as a Windows | |
3811 path (@file{c:\build\xemacs}). | |
3812 | |
3813 @item | |
3814 Build @samp{gcc -mno-cygwin} versions of the extra libs, i.e. @file{libpng}, | |
3815 @file{compface}, etc. | |
3816 | |
3817 @item | |
3818 Specify the target location of the extra libs on the command line | |
3018 | 3819 to @file{configure}, e.g.for 21.4 or earlier |
3820 @samp{./configure --site-prefixes=/build/libs i586-pc-mingw32} and for | |
3821 21.5 or later | |
3822 @samp{./configure --with-site-prefixes=/build/libs i586-pc-mingw32}. | |
2417 | 3823 @end itemize |
3824 | |
2559 | 3825 @node Q2.3.7, Q2.3.8, Q2.3.6, Installation |
3826 @unnumberedsubsec Q2.3.7: How do I compile with X support? | |
2417 | 3827 |
3828 To compile under Cygwin, all you need to do is install XFree86, which | |
3829 is available as part of the standard Cygwin installation. | |
3830 @uref{http://www.cygwin.com/}. Once installed, @file{configure} | |
3831 should automatically find the X libraries and compile with X support. | |
3832 | |
3833 As noted above, the non-Cygwin X support is basically orphaned, and | |
3834 probably won't work. But if it want to try, it's described in | |
3835 @file{nt/README} in some detail. Basically, you need to get X11 | |
2459 | 3836 libraries from @uref{http://ftp.x.org}, and compile them. If the |
2417 | 3837 precompiled versions are available somewhere, we don't know of it. |
3838 | |
2559 | 3839 @node Q2.3.8, Q2.4.1, Q2.3.7, Installation |
3840 @unnumberedsubsec Q2.3.8: Cygwin XEmacs won't start -- cygXpm-noX4.dll was not found (NEW) | |
1058 | 3841 |
3842 The Cygwin binary distributed with the netinstaller uses an external DLL | |
3843 to handle XPM images (such as toolbar buttons). You may get an error like | |
3844 | |
2559 | 3845 @example |
3846 This application has failed to start because cygXpm-noX4.dll was not found. | |
3847 Re-installing the application may fix this problem. | |
3848 @end example | |
1058 | 3849 |
3850 Andy Piper <andy@@xemacs.org> sez: | |
3851 | |
2559 | 3852 @example |
3853 cygXpm-noX4 is part of the cygwin distribution under libraries or | |
3854 graphics, but is not installed by default. You need to run the | |
3855 cygwin setup again and select this package. | |
3856 @end example | |
1058 | 3857 |
3858 Ie, reinstalling XEmacs won't help because it is not part of the XEmacs | |
3859 distribution. | |
3860 | |
2559 | 3861 @unnumberedsec 2.4: General Troubleshooting |
3862 | |
3863 @node Q2.4.1, Q2.4.2, Q2.3.8, Installation | |
3864 @unnumberedsubsec Q2.4.1: How do I deal with bugs or with problems building, installing, or running? | |
3865 | |
3866 The file @file{PROBLEMS} contains information on many common problems that | |
3867 occur in building, installing and running XEmacs. | |
3868 | |
3869 Reports of bugs in XEmacs should be sent to | |
3870 @email{xemacs-beta@@xemacs.org}. You can also post to the newsgroup | |
3871 comp.emacs.xemacs (or equivalentlt, send to the mailing list | |
3872 @email{xemacs@@xemacs.org}), but it is less likely that the developers | |
3873 will see it in a timely fashion. @xref{Bugs,,, xemacs, the XEmacs | |
3874 User's Manual}, for more information on how to report bugs. | |
3875 @xref{Q1.4.2}, for more information on mailing lists relating to | |
3876 XEmacs. | |
3877 | |
3878 There are three ways to read the Bugs section. | |
3879 | |
3880 @enumerate | |
3881 @item | |
3882 In a printed copy of the XEmacs manual. | |
3883 | |
3884 @item | |
3885 With Info. First, start XEmacs. From the menu, select | |
3886 @samp{Help->Info (Online Docs)->Info Contents} to enter Info, then | |
3887 click on @samp{XEmacs}, then on @samp{Bugs}. Or, use the keyboard: do | |
3888 @kbd{C-h i} to enter Info, then @kbd{m XEmacs RET} to get to the Emacs | |
3889 manual, then @kbd{m Bugs RET} to get to the section on bugs. Or use | |
3890 standalone Info in a like manner. (Standalone Info is part of the | |
3891 Texinfo distribution, not part of the XEmacs distribution.) | |
3892 | |
3893 @item | |
3894 By hand. Do | |
3895 @example | |
3896 cat info/xemacs* | more "+/^File: xemacs.info, Node: Bugs," | |
3897 @end example | |
3898 @end enumerate | |
3899 | |
3900 @node Q2.4.2, Q2.4.3, Q2.4.1, Installation | |
3901 @unnumberedsubsec Q2.4.2: Help! XEmacs just crashed on me! | |
428 | 3902 |
3903 First of all, don't panic. Whenever XEmacs crashes, it tries extremely | |
3904 hard to auto-save all of your files before dying. (The main time that | |
3905 this will not happen is if the machine physically lost power or if you | |
3906 killed the XEmacs process using @code{kill -9}). The next time you try | |
3907 to edit those files, you will be informed that a more recent auto-save | |
3908 file exists. You can use @kbd{M-x recover-file} to retrieve the | |
3909 auto-saved version of the file. | |
3910 | |
462 | 3911 You can use the command @kbd{M-x recover-session} after a crash to pick |
3912 up where you left off. | |
428 | 3913 |
3914 Now, XEmacs is not perfect, and there may occasionally be times, or | |
3915 particular sequences of actions, that cause it to crash. If you can | |
3916 come up with a reproducible way of doing this (or even if you have a | |
3917 pretty good memory of exactly what you were doing at the time), the | |
2417 | 3918 maintainers would be very interested in knowing about it. The best |
3919 way to report a bug is using @kbd{M-x report-emacs-bug} (or by | |
3920 selecting @samp{Send Bug Report...} from the Help menu). If that | |
3921 won't work (e.g. you can't get XEmacs working at all), send ordinary | |
3922 mail to @email{xemacs-beta@@xemacs.org}. @emph{MAKE SURE} to include | |
3923 the output from the crash, especially including the Lisp backtrace, as | |
3924 well as the XEmacs configuration from @kbd{M-x describe-installation} | |
3925 (or equivalently, the file @file{Installation} in the top of the build | |
3926 tree). Note that the developers do @emph{not} usually follow | |
3927 @samp{comp.emacs.xemacs} on a regular basis; thus, this is better for | |
3928 general questions about XEmacs than bug reports. | |
428 | 3929 |
1183 | 3930 If at all possible, include a C stack backtrace of the core dump that |
2417 | 3931 was produced. This shows where exactly things went wrong, and makes |
3932 it much easier to diagnose problems. To do this under Unix and Mac OS | |
3933 X, you need to locate the core file (it's called @file{core}, and is | |
3934 usually sitting in the directory that you started XEmacs from, or your | |
3935 home directory if that other directory was not writable). Then, go to | |
3936 that directory and execute a command like: | |
428 | 3937 |
3938 @example | |
3939 gdb `which xemacs` core | |
3940 @end example | |
3941 | |
3942 and then issue the command @samp{where} to get the stack backtrace. You | |
3943 might have to use @code{dbx} or some similar debugger in place of | |
3944 @code{gdb}. If you don't have any such debugger available, complain to | |
3945 your system administrator. | |
3946 | |
2417 | 3947 It's possible that a core file didn't get produced or the stack trace |
3948 from gdb is garbage, in which case you're out of luck unless you can | |
3949 reproduce the bug. A nonexistent core file can happen in some | |
3950 circumstances on some operating systems, depending on what exactly | |
3951 triggered the crash. It's also possible, however, that your limits | |
3952 are set to turn them off. You may be able to reenable them using a | |
3953 command like @samp{unlimit coredumpsize} or @samp{ulimit -c}. (To find | |
3954 out how your limits are set, use the command @samp{limit}.) However, if | |
3955 you didn't explicitly set your limits this way, go complain to your | |
3956 system administrator and tell him not to disable core files by | |
3957 default. | |
3958 | |
3959 A garbaged stack trace can happen for various reasons. Some versions | |
3960 of gdb are broken on certain operating systems and aren't able to read | |
3961 the core file. It's also possible that the stack got overwritten | |
3962 during the crash. A very simple reason, however, is that your version | |
3963 of XEmacs was compiled without debugging information or had the | |
3964 debugging information stripped. A compilation with optimization can | |
3965 also result in partly or completely garbaged stack trace. In such | |
3966 cases, you will need to recompile XEmacs with debugging information | |
2559 | 3967 and without optimization; @xref{Q2.4.4, How to debug an XEmacs problem |
2417 | 3968 with a debugger}. Note also that core files currently don't work at |
3969 all under Cygwin, and the only way to get a backtrace is to run XEmacs | |
3970 from gdb. | |
3971 | |
3972 If you cannot get a backtrace from the core dump, but can reproduce | |
3973 the problem, try running XEmacs under gdb. The goal is to get clean C | |
3974 and Lisp backtraces and submit a bug report including full | |
3975 configuration information as described above, as this will greatly | |
3976 assist in the process of tracking down the bug. However, even partial | |
3977 information is better than none. The process of getting backtraces | |
2559 | 3978 from gdb is described in detail in @ref{Q2.4.4, How to debug an XEmacs |
2417 | 3979 problem with a debugger}. |
428 | 3980 |
1183 | 3981 If you're under Microsoft Windows, you're out of luck unless you happen |
3982 to have a debugging aid installed on your system, for example Visual | |
3983 C++. In this case, the crash will result in a message giving you the | |
3984 option to enter a debugger (for example, by pressing @samp{Cancel}). Do | |
3985 this and locate the stack-trace window. (If your XEmacs was built | |
3986 without debugging information, the stack trace may not be very useful.) | |
3987 | |
428 | 3988 When making a problem report make sure that: |
3989 | |
3990 @enumerate | |
3991 @item | |
3992 Report @strong{all} of the information output by XEmacs during the | |
3993 crash. | |
3994 | |
3995 @item | |
2417 | 3996 You mention what O/S and Hardware you are running XEmacs on. |
428 | 3997 |
3998 @item | |
3999 What version of XEmacs you are running. | |
4000 | |
4001 @item | |
4002 What build options you are using. | |
4003 | |
4004 @item | |
2417 | 4005 If the problem is related to graphics and you are running Unix or Mac |
4006 OS X, we will also need to know what version of the X Window System | |
4007 you are running, and what window manager you are using. | |
1183 | 4008 |
4009 @item | |
4010 If the problem happened on a TTY, please include the terminal type. | |
2417 | 4011 |
4012 @item | |
4013 Try very hard to get both C and Lisp backtraces, as described above. | |
428 | 4014 @end enumerate |
4015 | |
1135 | 4016 Much of the information above is automatically generated by @kbd{M-x |
4017 report-emacs-bug}. Even more, and often useful, information can be | |
4018 generated by redirecting the output of @code{make} and @code{make check} | |
4019 to a file (@file{beta.err} is the default used by @code{build-report}), | |
4020 and executing @kbd{M-x build-report}. | |
4021 | |
2417 | 4022 |
2559 | 4023 @node Q2.4.3, Q2.4.4, Q2.4.2, Installation |
4024 @unnumberedsubsec Q2.4.3: XEmacs crashes and I compiled it myself. | |
2417 | 4025 |
4026 There have been a variety of reports of crashes due to compilers with | |
4027 buggy optimizers. If you are compiling with optimization, consider | |
2559 | 4028 turning it off (@pxref{Q2.4.4, How to debug an XEmacs problem with a |
2417 | 4029 debugger}) and recompiling. |
4030 | |
4031 Please see the @file{PROBLEMS} file that comes with XEmacs (it's in | |
4032 the top-level source directory) to read what it says about your | |
4033 platform. | |
4034 | |
3018 | 4035 If you compiled XEmacs 21.4 or ealier using @samp{--use-union-type}, or |
4036 21.5 or later using @samp{--enable-union-type} (or in either case used | |
4037 the option @samp{USE_UNION_TYPE} in @file{config.inc} under Windows), | |
4038 try recompiling again without it. The union type has been known to | |
4039 trigger compiler errors in a number of cases. | |
2417 | 4040 |
2559 | 4041 @node Q2.4.4, Q2.4.5, Q2.4.3, Installation |
4042 @unnumberedsubsec Q2.4.4: How to debug an XEmacs problem with a debugger | |
428 | 4043 |
4044 If XEmacs does crash on you, one of the most productive things you can | |
4045 do to help get the bug fixed is to poke around a bit with the debugger. | |
4046 Here are some hints: | |
4047 | |
4048 @itemize @bullet | |
4049 @item | |
4050 First of all, if the crash is at all reproducible, consider very | |
563 | 4051 strongly recompiling your XEmacs with debugging symbols and with no |
4052 optimization (e.g. with GCC use the compiler flags @samp{-g -O0} -- | |
4053 that's an "oh" followed by a zero), and with the configure options | |
3018 | 4054 @samp{--debug=yes} and @samp{--error-checking=all} |
4055 (@samp{--enable-debug=yes} and @samp{--enable-error-checking=all} on | |
4056 XEmacs 21.5 or later). This will make your XEmacs run somewhat slower, | |
4057 but you are a lot more likely to catch the problem earlier (closer to | |
4058 its source). It makes it a lot easier to determine what's going on with | |
4059 a debugger. The way to control the compiler flags is with the | |
4060 configuration option @samp{--cflags} (@samp{--with-cflags} in 21.5). If | |
4061 you have a recent version of 21.5, you should use | |
2417 | 4062 @samp{--without-optimization} in preference to directly setting |
4063 @samp{--cflags}. | |
1258 | 4064 |
4065 @item | |
4066 If it's not a true crash (@emph{i.e.}, XEmacs is hung, or a zombie | |
4067 process), or it's inconvenient to run XEmacs again because XEmacs is | |
4068 already running or is running in batch mode as part of a bunch of | |
4069 scripts, you may be able to attach to the existing process with your | |
2417 | 4070 debugger. Under Unix and Mac OS X, the typical way to do this is to |
4071 first use some variant of the @samp{ps} command to figure out the | |
4072 process ID of XEmacs, for example @samp{ps -auxww | grep xemacs} under | |
4073 a BSD variant, @samp{ps -elf | grep xemacs} under Linux or System V, | |
4074 or @samp{ps -aW | grep xemacs} under Cygwin. Then run | |
4075 | |
4076 @example | |
4077 gdb /path/to/xemacs/xemacs #### | |
4078 @end example | |
4079 | |
4080 Where @code{####} is the process id of your XEmacs. (If you're not | |
4081 sure, try using @samp{which xemacs}.) When gdb attaches, the xemacs | |
4082 will stop and you can type @samp{where} in gdb to get a stack trace as | |
4083 usual. To get things moving again, you can just type @samp{quit} in | |
4084 gdb. It'll tell you the program is running and ask if you want to | |
4085 quit anyways. Say @samp{y} and it'll quit and have your emacs | |
4086 continue from where it was at. | |
4087 | |
4088 If you're running another debugger, a similar method may work, or you | |
4089 may have to run the debugger first and then use the @code{attach} | |
4090 command or something similar. | |
4091 | |
4092 Under Microsoft Windows, use the menu item @samp{Build->Start | |
4093 Debug->Attach to Process...} and select the XEmacs process from the list | |
4094 given. | |
1258 | 4095 |
4096 @item | |
4097 If you're able to run XEmacs under a debugger and reproduce the crash, | |
4098 here are some things you can do: | |
428 | 4099 |
4100 @item | |
4101 If XEmacs is hitting an assertion failure, put a breakpoint on | |
4102 @code{assert_failed()}. | |
4103 | |
4104 @item | |
4105 If XEmacs is hitting some weird Lisp error that's causing it to crash | |
4106 (e.g. during startup), put a breakpoint on @code{signal_1()}---this is | |
2417 | 4107 declared static in @file{eval.c}. |
428 | 4108 |
4109 @item | |
563 | 4110 If XEmacs is outputting lots of X errors, put a breakpoint on |
2417 | 4111 @code{x_error_handler()}; that will tell you which call is causing |
4112 them. Note that the result may not be very useful by default because | |
4113 X Windows normally operates asynchronously: A bunch of commands are | |
4114 buffered up and then sent to the server all at once. This greatly | |
4115 improves performance over a network but means that an error may not be | |
4116 reported until the server receives the commands, which can be long | |
4117 after XEmacs made the erroneous calls. For best results, you need to | |
4118 make the X server synchronous before getting the backtrace. This can | |
4119 be done by starting XEmacs with the @samp{-sync} option or executing | |
4120 the Lisp code @code{(x-debug-mode t)}. | |
563 | 4121 |
4122 @item | |
428 | 4123 Internally, you will probably see lots of variables that hold objects of |
1258 | 4124 type @code{Lisp_Object}. These are references to Lisp objects. |
4125 Printing them out with the debugger probably won't be too | |
4126 useful---you'll likely just see a number. To decode them, do this: | |
428 | 4127 |
4128 @example | |
2417 | 4129 call debug_print (OBJECT) |
428 | 4130 @end example |
4131 | |
4132 where @var{OBJECT} is whatever you want to decode (it can be a variable, | |
1258 | 4133 a function call, etc.). This uses the Lisp printing routines to out a |
4134 readable representation on the TTY from which the xemacs process was | |
4135 invoked. | |
428 | 4136 |
2417 | 4137 Under 21.5 and later, @code{dp} is defined as an easier-to-type equivalent |
4138 of @code{debug_print}. You can also try @code{dpa} if you can't see | |
4139 the output from @code{debug_print} (this will return a string containing | |
4140 the output), or use @code{debug_p3} if @code{debug_print} itself triggers | |
4141 a crash (this is a less comprehensive but super-safe way to print out | |
4142 a Lisp object). | |
4143 | |
428 | 4144 @item |
4145 If you want to get a Lisp backtrace showing the Lisp call | |
4146 stack, do this: | |
4147 | |
4148 @example | |
2417 | 4149 call debug_backtrace () |
428 | 4150 @end example |
4151 | |
2417 | 4152 Under 21.5 and later, @code{db} is defined as an easier-to-type equivalent |
4153 of @code{debug_backtrace}. | |
4154 | |
4155 @item | |
4156 Using @code{debug_print} and @code{debug_backtrace} has two | |
4157 disadvantages - they can only be used with a running (including hung | |
4158 or zombie) xemacs process, and they do not display the internal C | |
4159 structure of a Lisp Object. Even if all you've got is a core dump, | |
4160 all is not lost. | |
428 | 4161 |
4162 If you're using GDB, there are some macros in the file | |
438 | 4163 @file{src/.gdbinit} in the XEmacs source distribution that should make |
4164 it easier for you to decode Lisp objects. This file is automatically | |
4165 read by gdb if gdb is run in the directory where xemacs was built, and | |
4166 contains these useful macros to inspect the state of xemacs: | |
4167 | |
4168 @table @code | |
4169 @item pobj | |
4170 Usage: pobj lisp_object @* | |
4171 Print the internal C representation of a lisp object. | |
4172 | |
4173 @item xtype | |
4174 Usage: xtype lisp_object @* | |
4175 Print the Lisp type of a lisp object. | |
4176 | |
4177 @item lbt | |
4178 Usage: lbt @* | |
4179 Print the current Lisp stack trace. | |
1258 | 4180 Requires a running xemacs process. (It works by calling the db |
4181 routine described above.) | |
438 | 4182 |
4183 @item ldp | |
4184 Usage: ldp lisp_object @* | |
4185 Print a Lisp Object value using the Lisp printer. | |
1258 | 4186 Requires a running xemacs process. (It works by calling the dp |
4187 routine described above.) | |
438 | 4188 |
4189 @item run-temacs | |
4190 Usage: run-temacs @* | |
4191 Run temacs interactively, like xemacs. | |
4192 Use this with debugging tools (like purify) that cannot deal with dumping, | |
4193 or when temacs builds successfully, but xemacs does not. | |
4194 | |
4195 @item dump-temacs | |
4196 Usage: dump-temacs @* | |
4197 Run the dumping part of the build procedure. | |
4198 Use when debugging temacs, not xemacs! | |
4199 Use this when temacs builds successfully, but xemacs does not. | |
4200 | |
4201 @item check-xemacs | |
4202 Usage: check-xemacs @* | |
4203 Run the test suite. Equivalent to 'make check'. | |
4204 | |
4205 @item check-temacs | |
4206 Usage: check-temacs @* | |
4207 Run the test suite on temacs. Equivalent to 'make check-temacs'. | |
4208 Use this with debugging tools (like purify) that cannot deal with dumping, | |
4209 or when temacs builds successfully, but xemacs does not. | |
4210 @end table | |
428 | 4211 |
4212 If you are using Sun's @file{dbx} debugger, there is an equivalent file | |
438 | 4213 @file{src/.dbxrc}, which defines the same commands for dbx. |
428 | 4214 |
4215 @item | |
4216 If you're using a debugger to get a C stack backtrace and you're seeing | |
4217 stack traces with some of the innermost frames mangled, it may be due to | |
4218 dynamic linking. (This happens especially under Linux.) Consider | |
3018 | 4219 reconfiguring with @samp{--dynamic=no} (@samp{--with-dynamic=no} in 21.5 |
4220 or later). Also, sometimes (again under Linux), stack backtraces of | |
4221 core dumps will have the frame where the fatal signal occurred mangled; | |
4222 if you can obtain a stack trace while running the XEmacs process under a | |
4223 debugger, the stack trace should be clean. | |
428 | 4224 |
1183 | 4225 @email{1CMC3466@@ibm.mtsac.edu, Curtiss} suggests upgrading to ld.so |
4226 version 1.8 if dynamic linking and debugging is a problem on Linux. | |
428 | 4227 |
4228 @item | |
4229 If you're using a debugger to get a C stack backtrace and you're | |
4230 getting a completely mangled and bogus stack trace, it's probably due to | |
4231 one of the following: | |
4232 | |
4233 @enumerate a | |
4234 @item | |
4235 Your executable has been stripped. Bad news. Tell your sysadmin not to | |
4236 do this---it doesn't accomplish anything except to save a bit of disk | |
4237 space, and makes debugging much much harder. | |
4238 | |
4239 @item | |
4240 Your stack is getting trashed. Debugging this is hard; you have to do a | |
4241 binary-search type of narrowing down where the crash occurs, until you | |
4242 figure out exactly which line is causing the problem. Of course, this | |
1258 | 4243 only works if the bug is highly reproducible. Also, in many cases if |
4244 you run XEmacs from the debugger, the debugger can protect the stack | |
4245 somewhat. However, if the stack is being smashed, it is typically the | |
4246 case that there is a wild pointer somewhere in the program, often quite | |
4247 far from where the crash occurs. | |
428 | 4248 |
4249 @item | |
4250 If your stack trace has exactly one frame in it, with address 0x0, this | |
4251 could simply mean that XEmacs attempted to execute code at that address, | |
4252 e.g. through jumping to a null function pointer. Unfortunately, under | |
4253 those circumstances, GDB under Linux doesn't know how to get a stack | |
1183 | 4254 trace. (Yes, this is the fourth Linux-related problem I've mentioned. I |
428 | 4255 have no idea why GDB under Linux is so bogus. Complain to the GDB |
1183 | 4256 authors, or to comp.os.linux.development.system.) Again, you'll have to |
428 | 4257 use the narrowing-down process described above. |
4258 | |
4259 @item | |
462 | 4260 You will get a Lisp backtrace output when XEmacs crashes, so you'll have |
4261 something useful. | |
428 | 4262 |
4263 @end enumerate | |
4264 | |
4265 @item | |
4266 If you compile with the newer gcc variants gcc-2.8 or egcs, you will | |
438 | 4267 also need gdb 4.17 or above. Earlier releases of gdb can't handle the |
4268 debug information generated by the newer compilers. | |
428 | 4269 |
4270 @item | |
438 | 4271 In versions of XEmacs before 21.2.27, @file{src/.gdbinit} was named |
4272 @file{src/gdbinit}. This had the disadvantage of not being sourced | |
4273 automatically by gdb, so you had to set that up yourself. | |
428 | 4274 |
1183 | 4275 @item |
4276 If you are running Microsoft Windows, the the file @file{nt/README} for | |
4277 further information about debugging XEmacs. | |
4278 | |
428 | 4279 @end itemize |
4280 | |
2559 | 4281 @node Q2.4.5, Q2.4.6, Q2.4.4, Installation |
4282 @unnumberedsubsec Q2.4.5: I get a cryptic error message when trying to do something. | |
2417 | 4283 |
4284 When I try to use some particular option of some particular package, I | |
4285 get a cryptic error message in the minibuffer. | |
4286 | |
4287 If the message went by too quickly, use @samp{Help->Recent Messages} | |
4288 from the menubar (or type @kbd{C-h l}) to see recent messages. | |
4289 | |
4290 If you can't figure out what's going on, select | |
4291 @samp{Options->Troubleshooting->Debug on Error} from the menubar (or | |
4292 type @kbd{M-:} then @kbd{(setq debug-on-error t)}) then try and make | |
4293 the error happen again. This will put in the debugger (you can get | |
4294 out of this and continue what you were doing before by typing @kbd{c}) | |
4295 and give you a backtrace that may be enlightening. If not, try | |
4296 reading through this FAQ; if that fails, you could try posting to | |
4297 @samp{comp.emacs.xemacs} (making sure to include the backtrace) and | |
4298 someone may be able to help. If you can identify which XEmacs Lisp | |
4299 source file the error is coming from you can get a more detailed stack | |
4300 backtrace by doing the following: | |
428 | 4301 |
4302 @enumerate | |
4303 @item | |
2417 | 4304 Visit the .el file in an XEmacs buffer. |
4305 | |
4306 @item | |
4307 Issue the command @kbd{M-x eval-current-buffer}. | |
4308 | |
4309 @item | |
4310 Reproduce the error. | |
428 | 4311 @end enumerate |
4312 | |
2417 | 4313 For more information on debugging Lisp code, @xref{Debugging,,, |
4314 lispref, XEmacs Lisp Reference Manual}. | |
4315 | |
2559 | 4316 @node Q2.4.6, Q2.4.7, Q2.4.5, Installation |
4317 @unnumberedsubsec Q2.4.6: XEmacs hangs when I try to do something. | |
2417 | 4318 |
4319 XEmacs might just be slow; some operations take a long time. XEmacs | |
4320 may also be waiting on a response from the network, for example when | |
4321 you are trying to send mail. | |
4322 | |
4323 You can usually interrupt XEmacs by typing @kbd{C-g}. If not (for | |
4324 example, Lisp code explicitly disabled this by setting | |
4325 @code{inhibit-quit}), you can use the "critical quit" mechanism by | |
4326 typing @kbd{Control-Shift-G}. This should also pop you into the | |
4327 debugger and give you a backtrace, which can tell you where the | |
2559 | 4328 problem is (@pxref{Q2.4.4, How to debug an XEmacs problem with a |
2417 | 4329 debugger}). (Note that setting @code{debug-on-quit} or selecting |
4330 @samp{Options->Troubleshooting->Debug on Quit} will also cause regular | |
4331 @kbd{C-g} to enter the debugger and give you a backtrace.) | |
4332 | |
4333 If you can't interrupt XEmacs this way, or for some reason XEmacs is | |
4334 not talking to the keyboard, you can try sending the @samp{SIGINT} | |
4335 signal using the @samp{kill} command. | |
4336 | |
4337 If the Lisp backtrace isn't enlightening, or if XEmacs is so hung that | |
4338 you can't interrupt it at all, you could try attaching to the process | |
2559 | 4339 and getting a C stack backtrace. @xref{Q2.4.4, How to debug an XEmacs |
2417 | 4340 problem with a debugger}. |
4341 | |
2559 | 4342 @node Q2.4.7, Q2.4.8, Q2.4.6, Installation |
4343 @unnumberedsubsec Q2.4.7: I get an error message when XEmacs is running in batch mode. | |
2417 | 4344 |
4345 Typically this happens when you are trying to compile some Elisp code. | |
4346 If you are doing this as part of XEmacs or the XEmacs packages, you | |
4347 should automatically get a backtrace, which can help you determine the | |
4348 source of the problem. In other cases, you can get equivalent results | |
4349 by setting the environment variable @samp{XEMACSDEBUG} to @samp{(setq | |
4350 stack-trace-on-error t load-always-display-messages t | |
4351 load-ignore-out-of-date-elc-files t load-show-full-path-in-messages | |
4352 t)} (this needs to be all on one line; to set an environment variable, | |
4353 use @samp{export XEMACSDEBUG='FOO'} under @samp{bash}, @samp{zsh}, | |
4354 etc. or @samp{setenv XEMACSDEBUG 'FOO'} under @samp{csh} and | |
4355 @samp{tcsh}). @samp{XEMACSDEBUG} specifies Lisp code that will be | |
4356 executed at startup time. | |
4357 | |
4358 If the backtrace is not sufficiently useful in helping you diagnose | |
4359 the problem, you should consider using a debugger such as GDB. | |
2559 | 4360 @xref{Q2.4.4, How to debug an XEmacs problem with a debugger}. You |
2417 | 4361 probably want to set a breakpoint on @code{signal_1}. Since such |
4362 errors often occur during compiling, which is often triggered by a | |
4363 complex command run from a make suite, it may be easier to attach to | |
4364 the process once it's running. | |
4365 | |
3018 | 4366 Under Microsoft Windows (and perhaps other operating systems), there is |
4367 another useful trick you can do if you have configured with debugging | |
4368 support (configure option @samp{--debug} (@samp{--with-debug} in 21.5) | |
4369 or setting @samp{DEBUG_XEMACS} in @file{nt/config.inc}). Set the | |
4370 environment variable @samp{XEMACSDEBUG} (as described above) to | |
4371 @samp{(setq debug-on-error t)}. Then, when an error occurs | |
4372 noninteractively, instead of trying to invoke the Lisp debugger (which | |
4373 obviously won't work), XEmacs will break out to a C debugger using | |
2417 | 4374 @code{(force-debugging-signal t)}. @emph{NOTE}: This runs |
4375 @code{abort()}!!! (As well as and after executing INT 3 under MS | |
4376 Windows, which should invoke a debugger if it's active.) This is | |
4377 guaranteed to kill XEmacs! (But in this situation, XEmacs is about to | |
4378 die anyway, and if no debugger is present, this will usefully dump | |
4379 core.) | |
4380 | |
2559 | 4381 @node Q2.4.8, Q2.4.9, Q2.4.7, Installation |
4382 @unnumberedsubsec Q2.4.8: The keyboard or mouse is not working properly, or I have some other event-related problem. | |
2417 | 4383 |
4384 XEmacs has various facilities for debugging event handling. | |
4385 | |
4386 First, try setting the variable @code{debug-emacs-events} to non-zero. | |
4387 This will output various information showing which events are being | |
4388 received and how they are being translated. This may show you, for | |
4389 example, that a key command is getting intercepted using | |
4390 @code{key-translation-map}; this problem can otherwise be very tricky | |
4391 to debug. | |
4392 | |
4393 Under X, you can see exactly which events are being received from the | |
4394 window system by setting @code{x-debug-events} to non-zero. (The value | |
4395 @samp{1} gives you regular output, and @samp{2} gives you verbose | |
4396 output, including all parameters.) | |
4397 | |
4398 A similar facility exists under MS Windows: Set | |
4399 @code{debug-mswindows-events} to non-zero. (The value @samp{1} gives | |
4400 you regular output. The value @samp{2} gives you verbose output, | |
4401 including all parameters. The value @samp{3} gives you | |
4402 super-gorily-detailed output.) | |
4403 | |
2559 | 4404 @node Q2.4.9, Q2.4.10, Q2.4.8, Installation |
4405 @unnumberedsubsec Q2.4.9: @kbd{C-g} doesn't work for me. Is it broken? | |
2417 | 4406 |
4407 @kbd{C-g} does work for most people in most circumstances. If it | |
4408 doesn't, there are two possible explanations: | |
4409 | |
4410 @enumerate | |
4411 @item | |
4412 XEmacs is hung in a way that prevents @kbd{C-g} from working. This | |
4413 can happen when code is wrapped with a binding of @code{inhibit-quit} | |
4414 to @code{t}; you should still be able interrupt XEmacs using "critical | |
4415 quit". On the other hand, XEmacs may be seriously wedged. (If you're | |
4416 lucky, sending @samp{SIGINT} to the XEmacs process will interrupt it.) | |
2559 | 4417 @xref{Q2.4.6, XEmacs hangs when I try to do something.}. |
2417 | 4418 |
4419 @item | |
4420 @kbd{C-g} is indeed broken on your system. To test, try executing | |
4421 @code{(while t)} from the @samp{*scratch*} buffer. If @kbd{C-g} | |
4422 doesn't interrupt, then it's broken. This used to happen with systems | |
4423 where @samp{SIGIO} was broken, but @samp{BROKEN_SIGIO} wasn't defined. | |
4424 However, there may not be very many such systems nowadays. | |
4425 @end enumerate | |
4426 | |
2559 | 4427 @node Q2.4.10, Q2.4.11, Q2.4.9, Installation |
4428 @unnumberedsubsec Q2.4.10: How do I debug process-related problems? | |
2417 | 4429 |
4430 Under MS Windows, you can set the variable | |
4431 @code{debug-mswindows-process-command-lines} to non-@samp{nil} to get | |
4432 information on exactly what is getting passed to a process. This can | |
4433 be useful in determining problems with quoting. (Under Unix, a process | |
4434 receives each argument separately, but under MS Windows a single | |
4435 command line is received, and arguments with spaces or other special | |
4436 characters in them must be quoted. Unfortunately this means that each | |
4437 process, potentially at least, has its own quoting conventions, and | |
4438 the code to process quoting conventions in @file{cmd.exe}, the Visual | |
4439 C++ startup code and the like is baroque and poorly documented. | |
4440 XEmacs uses the variable | |
4441 @code{mswindows-construct-process-command-line-alist} to construct a | |
4442 command line from a list of arguments based on the command to be run, | |
4443 but it is (and cannot be) a perfect solution.) | |
4444 | |
2559 | 4445 @node Q2.4.11, Q2.4.12, Q2.4.10, Installation |
4446 @unnumberedsubsec Q2.4.11: XEmacs is outputting lots of X errors. | |
563 | 4447 |
4448 If this is happening, we would very much like to know what's causing | |
2559 | 4449 them. To find this out, see @ref{Q2.4.4, How to debug an XEmacs |
2417 | 4450 problem with a debugger}. Try to get both a C and Lisp backtrace, and |
4451 send them along with the full error output to | |
4452 @email{xemacs-beta@@xemacs.org}. | |
4453 | |
2559 | 4454 @node Q2.4.12, Q2.5.1, Q2.4.11, Installation |
4455 @unnumberedsubsec Q2.4.12: After upgrading, XEmacs won't do `foo' any more! | |
2417 | 4456 |
4457 You have been used to doing `foo', but now when you invoke it (or | |
4458 click the toolbar button or select the menu item), nothing (or an | |
4459 error) happens. The simplest explanation is that you are missing a | |
4460 package that is essential to you. You can either track it down and | |
4461 install it (there is a list of packages and brief descriptions of | |
4462 their contents in @file{etc/PACKAGES}), or install the `Sumo Tarball' | |
2559 | 4463 (@pxref{Q2.1.2, How do I figure out which packages to install?}). |
2417 | 4464 |
4465 @c #### should xref to XEmacs manual here | |
4466 | |
2559 | 4467 @unnumberedsec 2.5: Startup-Related Problems |
4468 | |
4469 @node Q2.5.1, Q2.5.2, Q2.4.12, Installation | |
4470 @unnumberedsubsec Q2.5.1: XEmacs cannot connect to my X Terminal! | |
2417 | 4471 |
4472 Help! I can not get XEmacs to display on my Envizex X-terminal! | |
4473 | |
4474 Try setting the @code{DISPLAY} variable using the numeric IP address of | |
4475 the host you are running XEmacs from. | |
4476 | |
2559 | 4477 @node Q2.5.2, Q2.5.3, Q2.5.1, Installation |
4478 @unnumberedsubsec Q2.5.2 Startup problems related to paths or package locations. | |
4479 | |
4480 First of all, if XEmacs can't find the packages, check to make sure | |
4481 that you put the packages in the right place, or that you told XEmacs | |
4482 where to look for the packages when you compiled it. @xref{Q2.1.1}. | |
4483 | |
4484 If something is still going wrong, or you get a startup warning about | |
4485 not being able to deduce some paths, you can get detailed information | |
4486 on the path-searching process at startup by setting the environment | |
4487 variable @samp{EMACSDEBUGPATHS} to a non-null value. One thing to | |
4488 look for if you're having package problems is the value of | |
4489 @samp{configure-package-path}. This corresponds to what was compiled | |
4490 into XEmacs using the @samp{--package-prefix} or @samp{--package-path} | |
4491 parameter (@pxref{Q2.1.1}). If this has the value of @samp{nil}, | |
4492 this means that no value was compiled into XEmacs using these parameters. | |
4493 | |
4494 @node Q2.5.3, Q2.5.4, Q2.5.2, Installation | |
4658
fd2495d78aac
Add FAQ on network slows (lookup order of DNS and /etc/hosts).
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4625
diff
changeset
|
4495 @unnumberedsubsec Q2.5.3: XEmacs won't start without network, or starts slowly. |
434 | 4496 |
4497 If XEmacs starts when you're on the network, but fails when you're not | |
4498 on the network, you may be missing a "localhost" entry in your | |
4499 @file{/etc/hosts} file. The file should contain an entry like: | |
4500 | |
4501 @example | |
4502 127.0.0.1 localhost | |
4503 @end example | |
4504 | |
4658
fd2495d78aac
Add FAQ on network slows (lookup order of DNS and /etc/hosts).
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4625
diff
changeset
|
4505 Add that line, and XEmacs will be happy. If your network is unreliable, |
fd2495d78aac
Add FAQ on network slows (lookup order of DNS and /etc/hosts).
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4625
diff
changeset
|
4506 such as a Wifi network, you may experience delays but eventually XEmacs |
fd2495d78aac
Add FAQ on network slows (lookup order of DNS and /etc/hosts).
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4625
diff
changeset
|
4507 starts up. This may be due to having the lookup order give precedence |
fd2495d78aac
Add FAQ on network slows (lookup order of DNS and /etc/hosts).
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4625
diff
changeset
|
4508 to DNS over the hosts file (often lookup order is defined in one of the |
fd2495d78aac
Add FAQ on network slows (lookup order of DNS and /etc/hosts).
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4625
diff
changeset
|
4509 files @file{/etc/host.conf}, @file{/etc/nsswitch.conf}, or |
fd2495d78aac
Add FAQ on network slows (lookup order of DNS and /etc/hosts).
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4625
diff
changeset
|
4510 @file{/etc/resolv.conf}, depending on OS). See your system |
fd2495d78aac
Add FAQ on network slows (lookup order of DNS and /etc/hosts).
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4625
diff
changeset
|
4511 documentation for this configuration. Note that changing the lookup |
fd2495d78aac
Add FAQ on network slows (lookup order of DNS and /etc/hosts).
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4625
diff
changeset
|
4512 order is a workaround; there are good reasons to have DNS come earlier |
fd2495d78aac
Add FAQ on network slows (lookup order of DNS and /etc/hosts).
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4625
diff
changeset
|
4513 by default. Make sure those reasons are less important to you than a |
fd2495d78aac
Add FAQ on network slows (lookup order of DNS and /etc/hosts).
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4625
diff
changeset
|
4514 quick XEmacs startup. |
434 | 4515 |
2559 | 4516 @node Q2.5.4, Q2.5.5, Q2.5.3, Installation |
4517 @unnumberedsubsec Q2.5.4: Startup warnings about deducing proper fonts? | |
2417 | 4518 |
4519 How can I avoid the startup warnings about deducing proper fonts? | |
4520 | |
4521 This is highly dependent on your installation, but try with the | |
4522 following font as your base font for XEmacs and see what it does: | |
4523 | |
4524 @format | |
4525 -adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1 | |
4526 @end format | |
4527 | |
4528 More precisely, do the following in your resource file: | |
4529 | |
4530 @format | |
4531 Emacs.default.attributeFont: \ | |
4532 -adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1 | |
4533 @end format | |
4534 | |
4535 If you just don't want to see the @samp{*Warnings*} buffer at startup | |
4536 time, you can set this: | |
428 | 4537 |
4538 @lisp | |
2417 | 4539 (setq display-warning-minimum-level 'error) |
428 | 4540 @end lisp |
4541 | |
2417 | 4542 The buffer still exists; it just isn't in your face. |
4543 | |
2559 | 4544 @node Q2.5.5, Q2.5.6, Q2.5.4, Installation |
4545 @unnumberedsubsec Q2.5.5: Warnings from incorrect key modifiers. | |
2417 | 4546 |
4547 The following information comes from the @file{PROBLEMS} file that comes | |
4548 with XEmacs. | |
4549 | |
4550 If you're having troubles with HP/UX it is because HP/UX defines the | |
4551 modifiers wrong in X. Here is a shell script to fix the problem; be | |
4552 sure that it is run after VUE configures the X server. | |
428 | 4553 |
4554 @example | |
2417 | 4555 #! /bin/sh |
4556 xmodmap 2> /dev/null - << EOF | |
4557 keysym Alt_L = Meta_L | |
4558 keysym Alt_R = Meta_R | |
4559 EOF | |
4560 | |
4561 xmodmap - << EOF | |
4562 clear mod1 | |
4563 keysym Mode_switch = NoSymbol | |
4564 add mod1 = Meta_L | |
4565 keysym Meta_R = Mode_switch | |
4566 add mod2 = Mode_switch | |
4567 EOF | |
428 | 4568 @end example |
4569 | |
2559 | 4570 @node Q2.5.6, , Q2.5.5, Installation |
4571 @unnumberedsubsec Q2.5.6: XEmacs 21.1 on Windows used to spawn an ugly console window on every startup. Has that been fixed? | |
2417 | 4572 |
4573 Yes. | |
4574 | |
4575 The console was there because @file{temacs} (and in turn, @file{xemacs}) | |
4576 was a console application, and Windows typically creates a new | |
4577 console for a console process unless the creating process requests that | |
4578 one isn't created. This used to be fixed with @file{runemacs}, a small | |
4579 Windows application that existed merely to start @file{xemacs}, stating | |
4580 that it didn't want a console. | |
4581 | |
4582 XEmacs 21.4 fixes this cleanly by the virtue of being a true "GUI" | |
4583 application. The explanation of what that means is included for | |
4584 educational value. | |
4585 | |
4586 When building an application to be run in a Win32 environment, you must | |
4587 state which sub-system it is to run in. Valid subsystems include | |
4588 "console" and "gui". The subsystem you use affects the run time | |
4589 libraries linked into your application, the start up function that is | |
4590 run before control is handed over to your application, the entry point | |
4591 to your program, and how Windows normally invokes your program. (Console | |
4592 programs automatically get a console created for them at startup if | |
4593 their stdin/stdout don't point anywhere useful, which is the case when | |
4594 run from the GUI. This is a stupid design, of course -- instead, the | |
4595 console should get created only when the first I/O actually occurs! | |
4596 GUI programs have an equally stupid design: When called from | |
4597 @file{CMD.EXE}/@file{COMMAND.COM}, their stdin/stdout will be set to | |
4598 point nowhere useful, even though the command shell has its own | |
4599 stdin/stdout. It's as if someone who had learned a bit about stdio but | |
4600 had no actual knowledge of interprocess communication designed the | |
4601 scheme; unfortunately, the whole process-communication aspect of the | |
4602 Win32 API is equally badly designed.) For example, the entry point for a | |
4603 console app is "main" (which is what you'd expect for a C/C++ program), | |
4604 but the entry point for a "gui" app is "WinMain". This confuses and | |
4605 annoys a lot of programmers who've grown up on Unix systems, where the | |
4606 kernel doesn't really care whether your application is a gui program or | |
4607 not. | |
4608 | |
4609 For reasons not altogether clear, and are lost in the mists of time and | |
4610 tradition, XEmacs on Win32 started out as a console application, and | |
4611 therefore a console was automatically created for it. (It may have been | |
4612 made a console application partly because a console is needed in some | |
4613 circumstances, especially under Win95, to interrupt, terminate, or send | |
4614 signals to a child process, and because of the bogosity mentioned above | |
4615 with GUI programs and the standard command shell. Currently, XEmacs | |
4616 just creates and immediately hides a console when necessary, and | |
4617 works around the "no useful stdio" problem by creating its own console | |
4618 window as necessary to display messages in.) | |
4619 | |
2459 | 4620 @node Editing, Display, Installation, Top |
4621 @unnumbered 3 Editing Functions | |
2417 | 4622 |
4623 This is part 3 of the XEmacs Frequently Asked Questions list. This | |
2459 | 4624 section is devoted to the editing-related capabilities of XEmacs (the |
4625 keyboard, mouse, buffers, text selections, etc.) and how to customize | |
4626 them. | |
2417 | 4627 |
4628 @menu | |
4629 3.0: The Keyboard | |
2459 | 4630 * Q3.0.1:: How can I customize the keyboard? |
4631 * Q3.0.2:: How can I bind complex functions (or macros) to keys? | |
4632 * Q3.0.3:: How do I bind C-. and C-; to scroll one line up and down? | |
4633 * Q3.0.4:: Globally binding @kbd{Delete}? | |
4634 * Q3.0.5:: How to map @kbd{Help} key alone on Sun type4 keyboard? | |
4635 * Q3.0.6:: How can you type in special characters in XEmacs? | |
4636 * Q3.0.7:: Can I turn on @dfn{sticky} modifier keys? | |
4637 * Q3.0.8:: How do I map the arrow keys? | |
4638 * Q3.0.9:: HP Alt key as Meta. | |
4639 * Q3.0.10:: Why does edt emulation not work? | |
4640 * Q3.0.11:: How can I emulate VI and use it as my default mode? | |
4625
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4641 * Q3.0.12:: Mac Alt/Option key as Meta. |
2417 | 4642 |
4643 3.1: The Mouse | |
4644 * Q3.1.1:: How can I turn off Mouse pasting? | |
4645 * Q3.1.2:: How do I set control/meta/etc modifiers on mouse buttons? | |
4646 * Q3.1.3:: Clicking the left button does not do anything in buffer list. | |
4647 * Q3.1.4:: How can I get a list of buffers when I hit mouse button 3? | |
2459 | 4648 * Q3.1.5:: How can I set XEmacs up so that it pastes where the text cursor is? |
4649 | |
4650 3.2: Buffers, Text Editing | |
4651 * Q3.2.1:: Can I have the end of the buffer delimited in some way? | |
4652 * Q3.2.2:: How do I insert today's date into a buffer? | |
4653 * Q3.2.3:: How do I get a single minibuffer frame? | |
4654 * Q3.2.4:: How can I enable auto-indent and/or Filladapt? | |
4655 * Q3.2.5:: How can I get XEmacs to come up in text/auto-fill mode by default? | |
4656 | |
4657 3.3: Text Selections | |
4658 * Q3.3.1:: How do I select a rectangular region? | |
4659 * Q3.3.2:: How can I turn off or change highlighted selections? | |
4660 * Q3.3.3:: How do I cause typing on an active region to remove it? | |
4661 * Q3.3.4:: Can I turn off the highlight during isearch? | |
4662 * Q3.3.5:: Why is killing so slow? | |
4663 * Q3.3.6:: Why does @kbd{M-w} take so long? | |
4664 | |
4665 3.4: Editing Source Code | |
4666 * Q3.4.1:: I do not like cc-mode. How do I use the old c-mode? | |
4667 * Q3.4.2:: How do you make XEmacs indent CL if-clauses correctly? | |
2417 | 4668 @end menu |
4669 | |
4670 @unnumberedsec 3.0: The Keyboard | |
4671 | |
2459 | 4672 @node Q3.0.1, Q3.0.2, Editing, Editing |
4673 @unnumberedsubsec Q3.0.1: How can I customize the keyboard? | |
4674 | |
4675 #### Write me. | |
4676 | |
4677 @node Q3.0.2, Q3.0.3, Q3.0.1, Editing | |
4678 @unnumberedsubsec Q3.0.2: How can I bind complex functions (or macros) to keys? | |
428 | 4679 |
4680 As an example, say you want the @kbd{paste} key on a Sun keyboard to | |
4681 insert the current Primary X selection at point. You can accomplish this | |
4682 with: | |
4683 | |
4684 @lisp | |
4685 (define-key global-map [f18] 'x-insert-selection) | |
4686 @end lisp | |
4687 | |
4688 However, this only works if there is a current X selection (the | |
4689 selection will be highlighted). The functionality I like is for the | |
4690 @kbd{paste} key to insert the current X selection if there is one, | |
4691 otherwise insert the contents of the clipboard. To do this you need to | |
4692 pass arguments to @code{x-insert-selection}. This is done by wrapping | |
4693 the call in a 'lambda form: | |
4694 | |
4695 @lisp | |
4696 (global-set-key [f18] | |
4697 (lambda () (interactive) (x-insert-selection t nil))) | |
4698 @end lisp | |
4699 | |
4700 This binds the f18 key to a @dfn{generic} functional object. The | |
4701 interactive spec is required because only interactive functions can be | |
4702 bound to keys. | |
4703 | |
4704 For the FAQ example you could use: | |
4705 | |
4706 @lisp | |
4707 (global-set-key [(control ?.)] | |
4708 (lambda () (interactive) (scroll-up 1))) | |
440 | 4709 (global-set-key [(control ?;)] |
4710 (lambda () (interactive) (scroll-up -1))) | |
428 | 4711 @end lisp |
4712 | |
4713 This is fine if you only need a few functions within the lambda body. | |
2417 | 4714 If you're doing more it's cleaner to define a separate function. |
2459 | 4715 @xref{Q3.0.3, How do I bind C-. and C-; to scroll one line up and |
2417 | 4716 down?}. |
4717 | |
2459 | 4718 @node Q3.0.3, Q3.0.4, Q3.0.2, Editing |
4719 @unnumberedsubsec Q3.0.3: How do I bind C-. and C-; to scroll one line up and down? | |
428 | 4720 |
4721 Add the following (Thanks to @email{mly@@adoc.xerox.com, Richard Mlynarik} and | |
4722 @email{wayne@@zen.cac.stratus.com, Wayne Newberry}) to @file{.emacs}: | |
4723 | |
4724 @lisp | |
4725 (defun scroll-up-one-line () | |
4726 (interactive) | |
4727 (scroll-up 1)) | |
4728 | |
4729 (defun scroll-down-one-line () | |
4730 (interactive) | |
4731 (scroll-down 1)) | |
4732 | |
4733 (global-set-key [(control ?.)] 'scroll-up-one-line) ; C-. | |
440 | 4734 (global-set-key [(control ?;)] 'scroll-down-one-line) ; C-; |
428 | 4735 @end lisp |
4736 | |
4737 The key point is that you can only bind simple functions to keys; you | |
2417 | 4738 can not bind a key to a function that you're also passing arguments |
2459 | 4739 to. (@pxref{Q3.0.2, How can I bind complex functions (or macros) to |
2417 | 4740 keys?} for a better answer). |
4741 | |
2459 | 4742 @node Q3.0.4, Q3.0.5, Q3.0.3, Editing |
4743 @unnumberedsubsec Q3.0.4: Globally binding @kbd{Delete}? | |
428 | 4744 |
4745 I cannot manage to globally bind my @kbd{Delete} key to something other | |
4746 than the default. How does one do this? | |
4747 | |
462 | 4748 Answer: The problem is that many modes explicitly bind @kbd{Delete}. To |
4749 get around this, try the following: | |
4750 | |
428 | 4751 @lisp |
4752 (defun foo () | |
4753 (interactive) | |
4754 (message "You hit DELETE")) | |
4755 | |
462 | 4756 (define-key key-translation-map 'delete 'redirected-delete) |
4757 (global-set-key 'redirected-delete 'foo) | |
428 | 4758 @end lisp |
4759 | |
2459 | 4760 @node Q3.0.5, Q3.0.6, Q3.0.4, Editing |
4761 @unnumberedsubsec Q3.0.5: How to map @kbd{Help} key alone on Sun type4 keyboard? | |
428 | 4762 |
4763 The following works in GNU Emacs 19: | |
4764 | |
4765 @lisp | |
4766 (global-set-key [help] 'help-command);; Help | |
4767 @end lisp | |
4768 | |
462 | 4769 The following works in XEmacs with the addition of shift: |
428 | 4770 |
4771 @lisp | |
4772 (global-set-key [(shift help)] 'help-command);; Help | |
4773 @end lisp | |
4774 | |
4775 But it doesn't work alone. This is in the file @file{PROBLEMS} which | |
4776 should have come with your XEmacs installation: @emph{Emacs ignores the | |
4777 @kbd{help} key when running OLWM}. | |
4778 | |
4779 OLWM grabs the @kbd{help} key, and retransmits it to the appropriate | |
4780 client using | |
4781 @iftex | |
4782 @* | |
4783 @end iftex | |
4784 @code{XSendEvent}. Allowing Emacs to react to synthetic | |
4785 events is a security hole, so this is turned off by default. You can | |
4786 enable it by setting the variable @code{x-allow-sendevents} to t. You | |
4787 can also cause fix this by telling OLWM to not grab the help key, with | |
4788 the null binding @code{OpenWindows.KeyboardCommand.Help:}. | |
4789 | |
2459 | 4790 @node Q3.0.6, Q3.0.7, Q3.0.5, Editing |
4791 @unnumberedsubsec Q3.0.6: How can you type in special characters in XEmacs? | |
428 | 4792 One way is to use the package @code{x-compose}. Then you can use |
4793 sequences like @kbd{Compose " a} to get ä, etc. | |
4794 | |
462 | 4795 Another way is to use the @code{iso-insert} package. Then you can use |
4796 sequences like @kbd{C-x 8 " a} to get ä, etc. | |
428 | 4797 |
4798 @email{glynn@@sensei.co.uk, Glynn Clements} writes: | |
4799 | |
4800 @quotation | |
4801 It depends upon your X server. | |
4802 | |
4803 Generally, the simplest way is to define a key as Multi_key with | |
4804 xmodmap, e.g. | |
4805 @c hey, show some respect, willya -- there's xkeycaps, isn't there? -- | |
4806 @c chr ;) | |
4807 @example | |
440 | 4808 xmodmap -e 'keycode 0xff20 = Multi_key' |
428 | 4809 @end example |
4810 | |
4811 You will need to pick an appropriate keycode. Use xev to find out the | |
4812 keycodes for each key. | |
4813 | |
4814 [NB: On a `Windows' keyboard, recent versions of XFree86 automatically | |
4815 define the right `Windows' key as Multi_key'.] | |
4816 | |
4817 Once you have Multi_key defined, you can use e.g. | |
4818 @example | |
440 | 4819 Multi a ' => á |
4820 Multi e " => ë | |
4821 Multi c , => ç | |
428 | 4822 @end example |
4823 | |
4824 etc. | |
4825 | |
4826 Also, recent versions of XFree86 define various AltGr-<key> | |
4827 combinations as dead keys, i.e. | |
4828 @example | |
440 | 4829 AltGr [ => dead_diaeresis |
4830 AltGr ] => dead_tilde | |
4831 AltGr ; => dead_acute | |
428 | 4832 @end example |
4833 etc. | |
4834 | |
4835 Running @samp{xmodmap -pk} will list all of the defined keysyms. | |
4836 @end quotation | |
4837 | |
1135 | 4838 For the related problem of @emph{displaying} non-ASCII characters in a |
2459 | 4839 non-Mule XEmacs, @xref{Q4.0.8, How do I display non-ASCII characters?}. |
4840 | |
4841 @node Q3.0.7, Q3.0.8, Q3.0.6, Editing | |
4842 @unnumberedsubsec Q3.0.7: Can I turn on @dfn{sticky} modifier keys? | |
428 | 4843 |
4844 Yes, with @code{(setq modifier-keys-are-sticky t)}. This will give the | |
4845 effect of being able to press and release Shift and have the next | |
4846 character typed come out in upper case. This will affect all the other | |
4847 modifier keys like Control and Meta as well. | |
4848 | |
4849 @email{ben@@xemacs.org, Ben Wing} writes: | |
4850 | |
4851 @quotation | |
4852 One thing about the sticky modifiers is that if you move the mouse out | |
4853 of the frame and back in, it cancels all currently ``stuck'' modifiers. | |
4854 @end quotation | |
4855 | |
2459 | 4856 @node Q3.0.8, Q3.0.9, Q3.0.7, Editing |
4857 @unnumberedsubsec Q3.0.8: How do I map the arrow keys? | |
428 | 4858 @c New |
4859 Say you want to map @kbd{C-@key{right}} to forward-word: | |
4860 | |
4861 @email{sds@@usa.net, Sam Steingold} writes: | |
4862 | |
4863 @quotation | |
4864 @lisp | |
4865 ; both XEmacs and Emacs | |
4866 (define-key global-map [(control right)] 'forward-word) | |
4867 @end lisp | |
4868 or | |
4869 @lisp | |
4870 ; Emacs only | |
4871 (define-key global-map [C-right] 'forward-word) | |
4872 @end lisp | |
4873 or | |
4874 @lisp | |
4875 ; ver > 20, both | |
4876 (define-key global-map (kbd "C-<right>") 'forward-word) | |
4877 @end lisp | |
4878 @end quotation | |
4879 | |
2459 | 4880 @node Q3.0.9, Q3.0.10, Q3.0.8, Editing |
4881 @unnumberedsubsec Q3.0.9: HP Alt key as Meta. | |
2417 | 4882 |
4883 How can I make XEmacs recognize the Alt key of my HP workstation as a | |
4884 Meta key? | |
4885 | |
4886 Put the following line into a file and load it with xmodmap(1) before | |
4887 starting XEmacs: | |
428 | 4888 |
4889 @example | |
2417 | 4890 remove Mod1 = Mode_switch |
428 | 4891 @end example |
4892 | |
2459 | 4893 @node Q3.0.10, Q3.0.11, Q3.0.9, Editing |
4894 @unnumberedsubsec Q3.0.10: Why does edt emulation not work? | |
2417 | 4895 |
4896 We don't know, but you can use tpu-edt emulation instead, which works | |
4897 fine and is a little fancier than the standard edt emulation. To do | |
4898 this, add the following line to your @file{init.el}: | |
4899 | |
4900 @lisp | |
4901 (tpu-edt) | |
4902 @end lisp | |
4903 | |
4904 If you don't want it to replace @kbd{C-h} with an edt-style help menu | |
4905 add this as well: | |
428 | 4906 |
4907 @lisp | |
2417 | 4908 (global-set-key [(control h)] 'help-for-help) |
428 | 4909 @end lisp |
4910 | |
4625
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4911 @node Q3.0.11, Q3.0.12, Q3.0.10, Editing |
2459 | 4912 @unnumberedsubsec Q3.0.11: How can I emulate VI and use it as my default mode? |
2417 | 4913 |
4914 Our recommended VI emulator is viper. To make viper-mode the default, | |
4915 add this to your @file{init.el}: | |
428 | 4916 |
4917 @lisp | |
2417 | 4918 (viper-mode) |
428 | 4919 @end lisp |
4920 | |
2417 | 4921 @email{kifer@@CS.SunySB.EDU, Michael Kifer} writes: |
4922 | |
4923 @quotation | |
4924 This should be added as close to the top of @file{init.el} as you can get | |
4925 it, otherwise some minor modes may not get viper-ized. | |
4926 @end quotation | |
4927 | |
4625
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4928 @node Q3.0.12, Q3.1.1, Q3.0.11, Editing |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4929 @unnumberedsubsec Q3.0.12: Mac Alt/Option key as Meta. |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4930 |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4931 Due to the Apple Command key being Meta, I can't use XEmacs on OS X. |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4932 |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4933 Didier Verna suggests: |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4934 |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4935 I use an X version of XEmacs on a Mac every day. You have to tweak the |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4936 keyboard configuration a bit but that's all. |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4937 |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4938 Here's my Xmodmap file on Darwin: |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4939 |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4940 @example |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4941 clear mod1 |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4942 clear mod2 |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4943 keycode 66 = Meta_L |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4944 keycode 63 = Mode_switch |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4945 add mod1 = Meta_L |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4946 @end example |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4947 |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4948 This leaves the command key alone and uses alt/option for Meta. |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4949 |
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4950 |
2417 | 4951 @unnumberedsec 3.1: The Mouse |
4952 | |
4625
4527fc976aa3
Meta on Mac. <87prh51rni.fsf@xemacs.org>
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4509
diff
changeset
|
4953 @node Q3.1.1, Q3.1.2, Q3.0.12, Editing |
2417 | 4954 @unnumberedsubsec Q3.1.1: How can I turn off Mouse pasting? |
428 | 4955 |
4956 I keep hitting the middle mouse button by accident and getting stuff | |
4957 pasted into my buffer so how can I turn this off? | |
4958 | |
4959 Here is an alternative binding, whereby the middle mouse button selects | |
4960 (but does not cut) the expression under the mouse. Clicking middle on a | |
4961 left or right paren will select to the matching one. Note that you can | |
4962 use @code{define-key} or @code{global-set-key}. | |
4963 | |
4964 @lisp | |
4965 (defun mouse-set-point-and-select (event) | |
4966 "Sets the point at the mouse location, then marks following form" | |
4967 (interactive "@@e") | |
4968 (mouse-set-point event) | |
4969 (mark-sexp 1)) | |
4970 (define-key global-map [button2] 'mouse-set-point-and-select) | |
4971 @end lisp | |
4972 | |
2459 | 4973 @node Q3.1.2, Q3.1.3, Q3.1.1, Editing |
2417 | 4974 @unnumberedsubsec Q3.1.2: How do I set control/meta/etc modifiers on mouse buttons? |
428 | 4975 |
4976 Use, for instance, @code{[(meta button1)]}. For example, here is a common | |
4977 setting for Common Lisp programmers who use the bundled @code{ilisp} | |
4978 package, whereby meta-button1 on a function name will find the file where | |
4979 the function name was defined, and put you at that location in the source | |
4980 file. | |
4981 | |
4982 [Inside a function that gets called by the lisp-mode-hook and | |
4983 ilisp-mode-hook] | |
4984 | |
4985 @lisp | |
4986 (local-set-key [(meta button1)] 'edit-definitions-lisp) | |
4987 @end lisp | |
4988 | |
2459 | 4989 @node Q3.1.3, Q3.1.4, Q3.1.2, Editing |
2417 | 4990 @unnumberedsubsec Q3.1.3: Clicking the left button does not do anything in buffer list. |
428 | 4991 |
4992 I do @kbd{C-x C-b} to get a list of buffers and the entries get | |
4993 highlighted when I move the mouse over them but clicking the left mouse | |
4994 does not do anything. | |
4995 | |
4996 Use the middle mouse button. | |
4997 | |
2459 | 4998 @node Q3.1.4, Q3.1.5, Q3.1.3, Editing |
2417 | 4999 @unnumberedsubsec Q3.1.4: How can I get a list of buffers when I hit mouse button 3? |
428 | 5000 |
5001 The following code will replace the default popup on button3: | |
5002 | |
5003 @lisp | |
5004 (global-set-key [button3] 'popup-buffer-menu) | |
5005 @end lisp | |
5006 | |
2459 | 5007 @node Q3.1.5, Q3.2.1, Q3.1.4, Editing |
5008 @unnumberedsubsec Q3.1.5: How can I set XEmacs up so that it pastes where the text cursor is? | |
428 | 5009 |
5010 By default XEmacs pastes X selections where the mouse pointer is. How | |
5011 do I disable this? | |
5012 | |
5013 Examine the function @code{mouse-yank}, by typing @kbd{C-h f mouse-yank | |
5014 @key{RET}}. | |
5015 | |
2417 | 5016 To get XEmacs to paste at the text cursor, add this your @file{init.el}: |
428 | 5017 |
5018 @lisp | |
5019 (setq mouse-yank-at-point t) | |
5020 @end lisp | |
5021 | |
2459 | 5022 You can also change this with Customize. Select from the |
5023 @code{Options} menu @code{Advanced | |
5024 (Customize)->Emacs->Editing->Mouse->Yank At Point...} or type @kbd{M-x | |
5025 customize @key{RET} mouse @key{RET}}. | |
5026 | |
5027 @unnumberedsec 3.2: Buffers, Text Editing | |
5028 | |
5029 @node Q3.2.1, Q3.2.2, Q3.1.5, Editing | |
5030 @unnumberedsubsec Q3.2.1: Can I have the end of the buffer delimited in some way? | |
5031 | |
5032 Say, with: @samp{[END]}? | |
5033 | |
5034 Try this: | |
5035 | |
5036 @lisp | |
5037 (let ((ext (make-extent (point-min) (point-max)))) | |
5038 (set-extent-property ext 'start-closed t) | |
5039 (set-extent-property ext 'end-closed t) | |
5040 (set-extent-property ext 'detachable nil) | |
5041 (set-extent-end-glyph ext (make-glyph [string :data "[END]"]))) | |
5042 @end lisp | |
5043 | |
5044 Since this is XEmacs, you can specify an icon to be shown on | |
5045 window-system devices. To do so, change the @code{make-glyph} call to | |
5046 something like this: | |
5047 | |
5048 @lisp | |
5049 (make-glyph '([xpm :file "~/something.xpm"] | |
5050 [string :data "[END]"])) | |
5051 @end lisp | |
5052 | |
5053 You can inline the @sc{xpm} definition yourself by specifying | |
5054 @code{:data} instead of @code{:file}. Here is such a full-featured | |
5055 version that works on both X and TTY devices: | |
5056 | |
5057 @lisp | |
5058 (let ((ext (make-extent (point-min) (point-max)))) | |
5059 (set-extent-property ext 'start-closed t) | |
5060 (set-extent-property ext 'end-closed t) | |
5061 (set-extent-property ext 'detachable nil) | |
5062 (set-extent-end-glyph ext (make-glyph '([xpm :data "\ | |
5063 /* XPM */ | |
5064 static char* eye = @{ | |
5065 \"20 11 7 2\", | |
5066 \"__ c None\" | |
5067 \"_` c #7f7f7f\", | |
5068 \"_a c #fefefe\", | |
5069 \"_b c #7f0000\", | |
5070 \"_c c #fefe00\", | |
5071 \"_d c #fe0000\", | |
5072 \"_e c #bfbfbf\", | |
5073 \"___________`_`_`___b_b_b_b_________`____\", | |
5074 \"_________`_`_`___b_c_c_c_b_b____________\", | |
5075 \"_____`_`_`_e___b_b_c_c_c___b___b_______`\", | |
5076 \"___`_`_e_a___b_b_d___b___b___b___b______\", | |
5077 \"_`_`_e_a_e___b_b_d_b___b___b___b___b____\", | |
5078 \"_`_`_a_e_a___b_b_d___b___b___b___b___b__\", | |
5079 \"_`_`_e_a_e___b_b_d_b___b___b___b___b_b__\", | |
5080 \"___`_`_e_a___b_b_b_d_c___b___b___d_b____\", | |
5081 \"_____`_`_e_e___b_b_b_d_c___b_b_d_b______\", | |
5082 \"_`_____`_`_`_`___b_b_b_d_d_d_d_b________\", | |
5083 \"___`_____`_`_`_`___b_b_b_b_b_b__________\", | |
5084 @} ;"] | |
5085 [string :data "[END]"])))) | |
5086 @end lisp | |
5087 | |
5088 Note that you might want to make this a function, and put it to a hook. | |
5089 We leave that as an exercise for the reader. | |
5090 | |
5091 @node Q3.2.2, Q3.2.3, Q3.2.1, Editing | |
5092 @unnumberedsubsec Q3.2.2: How do I insert today's date into a buffer? | |
2417 | 5093 |
5094 Like this: | |
428 | 5095 |
5096 @lisp | |
2459 | 5097 (insert (current-time-string)) |
2417 | 5098 @end lisp |
5099 | |
2459 | 5100 @node Q3.2.3, Q3.2.4, Q3.2.2, Editing |
5101 @unnumberedsubsec Q3.2.3: How do I get a single minibuffer frame? | |
5102 | |
5103 @email{acs@@acm.org, Vin Shelton} writes: | |
2417 | 5104 |
5105 @lisp | |
2459 | 5106 (setq initial-frame-plist '(minibuffer nil)) |
5107 (setq default-frame-plist '(minibuffer nil)) | |
5108 (setq default-minibuffer-frame | |
5109 (make-frame | |
5110 '(minibuffer only | |
5111 width 86 | |
5112 height 1 | |
5113 menubar-visible-p nil | |
5114 default-toolbar-visible-p nil | |
5115 name "minibuffer" | |
5116 top -2 | |
5117 left -2 | |
5118 has-modeline-p nil))) | |
5119 (frame-notice-user-settings) | |
2417 | 5120 @end lisp |
5121 | |
2459 | 5122 @strong{Please note:} The single minibuffer frame may not be to everyone's |
5123 taste, and there any number of other XEmacs options settings that may | |
5124 make it difficult or inconvenient to use. | |
5125 | |
5126 @node Q3.2.4, Q3.2.5, Q3.2.3, Editing | |
5127 @unnumberedsubsec Q3.2.4: How can I enable auto-indent and/or Filladapt? | |
5128 | |
5129 Put the following line in your @file{init.el}: | |
428 | 5130 |
5131 @lisp | |
2459 | 5132 (setq indent-line-function 'indent-relative-maybe) |
428 | 5133 @end lisp |
5134 | |
2459 | 5135 If you want to get fancy, try the @code{filladapt} package available |
5136 standard with XEmacs. Put this into your @file{init.el}: | |
428 | 5137 |
5138 @lisp | |
2459 | 5139 (require 'filladapt) |
5140 (setq-default filladapt-mode t) | |
5141 (add-hook 'c-mode-hook 'turn-off-filladapt-mode) | |
428 | 5142 @end lisp |
5143 | |
2459 | 5144 This will enable Filladapt for all modes except C mode, where it doesn't |
5145 work well. To turn Filladapt on only in particular major modes, remove | |
5146 the @code{(setq-default ...)} line and use | |
5147 @code{turn-on-filladapt-mode}, like this: | |
428 | 5148 |
5149 @lisp | |
2459 | 5150 (add-hook 'text-mode-hook 'turn-on-filladapt-mode) |
428 | 5151 @end lisp |
2417 | 5152 |
2459 | 5153 You can customize filling and adaptive filling with Customize. |
5154 Select from the @code{Options} menu | |
5155 @code{Advanced (Customize)->Emacs->Editing->Fill->Fill...} | |
5156 or type @kbd{M-x customize @key{RET} fill @key{RET}}. | |
5157 | |
5158 Note that well-behaving text-lookalike modes will run | |
5159 @code{text-mode-hook} by default (e.g. that's what Message does). For | |
5160 the nasty ones, you'll have to provide the @code{add-hook}s yourself. | |
5161 | |
5162 Please note that the @code{fa-extras} package is no longer useful. | |
5163 | |
5164 @node Q3.2.5, Q3.3.1, Q3.2.4, Editing | |
5165 @unnumberedsubsec Q3.2.5: How can I get XEmacs to come up in text/auto-fill mode by default? | |
5166 | |
5167 Try the following lisp in your @file{init.el}: | |
2417 | 5168 |
5169 @lisp | |
2459 | 5170 (setq default-major-mode 'text-mode) |
2769 | 5171 (add-hook 'text-mode-hook 'turn-on-auto-fill) |
2417 | 5172 @end lisp |
5173 | |
2459 | 5174 @strong{WARNING}: note that changing the value of |
5175 @code{default-major-mode} from @code{fundamental-mode} can break a large | |
5176 amount of built-in code that expects newly created buffers to be in | |
5177 @code{fundamental-mode}. (Changing from @code{fundamental-mode} to | |
5178 @code{text-mode} might not wreak too much havoc, but changing to | |
5179 something more exotic like a lisp-mode would break many Emacs packages). | |
5180 | |
5181 Note that Emacs by default starts up in buffer @code{*scratch*} in | |
5182 @code{initial-major-mode}, which defaults to | |
5183 @code{lisp-interaction-mode}. Thus adding the following form to your | |
5184 Emacs init file will cause the initial @code{*scratch*} buffer to be put | |
5185 into auto-fill'ed @code{text-mode}: | |
2417 | 5186 |
5187 @lisp | |
2459 | 5188 (setq initial-major-mode |
5189 (lambda () | |
5190 (text-mode) | |
5191 (turn-on-auto-fill))) | |
2417 | 5192 @end lisp |
5193 | |
2459 | 5194 Note that after your init file is loaded, if |
5195 @code{inhibit-startup-message} is @code{nil} (the default) and the | |
5196 startup buffer is @code{*scratch*} then the startup message will be | |
5197 inserted into @code{*scratch*}; it will be removed after a timeout by | |
5198 erasing the entire @code{*scratch*} buffer. Keep in mind this default | |
5199 usage of @code{*scratch*} if you desire any prior manipulation of | |
5200 @code{*scratch*} from within your Emacs init file. In particular, | |
5201 anything you insert into @code{*scratch*} from your init file will be | |
5202 later erased. Also, if you change the mode of the @code{*scratch*} | |
5203 buffer, be sure that this will not interfere with possible later | |
5204 insertion of the startup message (e.g. if you put @code{*scratch*} into | |
5205 a nonstandard mode that has automatic font lock rules, then the startup | |
5206 message might get fontified in a strange foreign manner, e.g. as code in | |
5207 some programming language). | |
5208 | |
5209 @unnumberedsec 3.3: Text Selections | |
5210 | |
5211 @node Q3.3.1, Q3.3.2, Q3.2.5, Editing | |
5212 @unnumberedsubsec Q3.3.1: How do I select a rectangular region? | |
2417 | 5213 |
5214 Just select the region normally, then use the rectangle commands (e.g. | |
5215 @code{kill-rectangle} on it. The region does not highlight as a | |
5216 rectangle, but the commands work just fine. | |
5217 | |
5218 To actually sweep out rectangular regions with the mouse you can use | |
5219 @code{mouse-track-do-rectangle} which is assigned to @kbd{M-button1}. | |
5220 Then use rectangle commands. | |
5221 | |
5222 You can also do the following to change default behavior to sweep out | |
5223 rectangular regions: | |
5224 | |
5225 @lisp | |
5226 (setq mouse-track-rectangle-p t) | |
5227 @end lisp | |
5228 | |
2459 | 5229 You can also change this with Customize. |
2417 | 5230 Select from the @code{Options} menu |
5231 @code{Advanced (Customize)->Emacs->Editing->Mouse->Track Rectangle...} or type | |
5232 @kbd{M-x customize @key{RET} mouse @key{RET}}. | |
5233 | |
5234 | |
5235 @example | |
5236 mouse-track-do-rectangle: (event) | |
5237 -- an interactive compiled Lisp function. | |
5238 Like `mouse-track' but selects rectangles instead of regions. | |
5239 @end example | |
5240 | |
2459 | 5241 @node Q3.3.2, Q3.3.3, Q3.3.1, Editing |
5242 @unnumberedsubsec Q3.3.2: How can I turn off or change highlighted selections? | |
428 | 5243 |
5244 The @code{zmacs} mode allows for what some might call gratuitous | |
5245 highlighting for selected regions (either by setting mark or by using | |
5246 the mouse). This is the default behavior. To turn off, add the | |
2417 | 5247 following line to your @file{init.el} file: |
428 | 5248 |
5249 @lisp | |
5250 (setq zmacs-regions nil) | |
5251 @end lisp | |
5252 | |
2417 | 5253 You can also change this with Customize. Select from the |
5254 @code{Options} menu | |
5255 @code{Advanced (Customize)->Emacs->Editing->Basics->Zmacs Regions} | |
5256 or type @kbd{M-x customize @key{RET} editing-basics @key{RET}}. | |
5257 | |
5258 To change the face for selection, look at @code{Options->Advanced (Customize)} | |
5259 on the menubar. | |
5260 | |
2459 | 5261 @node Q3.3.3, Q3.3.4, Q3.3.2, Editing |
5262 @unnumberedsubsec Q3.3.3: How do I cause typing on an active region to remove it? | |
428 | 5263 |
5264 I want to change things so that if I select some text and start typing, | |
5265 the typed text replaces the selected text, similar to Motif. | |
5266 | |
5267 You want to use something called @dfn{pending delete}. Pending delete | |
5268 is what happens when you select a region (with the mouse or keyboard) | |
5269 and you press a key to replace the selected region by the key you typed. | |
5270 Usually backspace kills the selected region. | |
5271 | |
2164 | 5272 To get this behavior, ensure that you have the @file{pc} package |
5273 installed, and add the following lines to your | |
2417 | 5274 @file{init.el}: |
428 | 5275 |
5276 @lisp | |
438 | 5277 (cond |
5278 ((fboundp 'turn-on-pending-delete) | |
5279 (turn-on-pending-delete)) | |
5280 ((fboundp 'pending-delete-on) | |
5281 (pending-delete-on t))) | |
428 | 5282 @end lisp |
5283 | |
1138 | 5284 Note that this will work with both Backspace and Delete. This code is a |
438 | 5285 tad more complicated than it has to be for XEmacs in order to make it |
5286 more portable. | |
428 | 5287 |
2459 | 5288 @node Q3.3.4, Q3.3.5, Q3.3.3, Editing |
5289 @unnumberedsubsec Q3.3.4: Can I turn off the highlight during isearch? | |
428 | 5290 |
5291 I do not like my text highlighted while I am doing isearch as I am not | |
5292 able to see what's underneath. How do I turn it off? | |
5293 | |
2417 | 5294 Put the following in your @file{init.el}: |
428 | 5295 |
5296 @lisp | |
5297 (setq isearch-highlight nil) | |
5298 @end lisp | |
5299 | |
2459 | 5300 You can also change this with Customize. Type |
428 | 5301 @kbd{M-x customize-variable @key{RET} isearch-highlight @key{RET}}. |
5302 | |
5303 Note also that isearch-highlight affects query-replace and ispell. | |
5304 Instead of disabling isearch-highlight you may find that a better | |
5305 solution consists of customizing the @code{isearch} face. | |
5306 | |
2459 | 5307 @node Q3.3.5, Q3.3.6, Q3.3.4, Editing |
5308 @unnumberedsubsec Q3.3.5: Why is killing so slow? | |
892 | 5309 |
5310 This actually is an X Windows question, although you'll notice it with | |
5311 keyboard operations as well as while using the GUI. Basically, there | |
5312 are four ways to communicate interprogram via the X server: | |
5313 | |
5314 @table @strong | |
5315 @item Primary selection | |
5316 a transient selection that gets replaced every time a new selection is made | |
5317 | |
5318 @item Secondary selection | |
5319 for "exchanging" with the primary selection | |
5320 | |
5321 @item Cut buffers | |
5322 a clipboard internal to the X server (deprecated) | |
5323 | |
5324 @item Clipboard selection | |
5325 a selection with a notification protocol that allows a separate app to | |
5326 manage the clipboard | |
5327 @end table | |
5328 | |
5329 The cut buffers are deprecated because managing them is even more | |
5330 inefficient than the clipboard notification protocol. The primary | |
5331 selection works fine for many users and applications, but is not very | |
5332 robust under intensive or sophisticated use. | |
5333 | |
5334 In Motif and MS Windows, a clipboard has become the primary means for | |
5335 managing cut and paste. These means that "modern" applications tend to | |
5336 be oriented toward a true clipboard, rather than the primary selection. | |
5337 (On Windows, there is nothing equivalent to the primary selection.) | |
5338 It's not that XEmacs doesn't support the simple primary selection | |
5339 method, it's that more and more other applications don't. | |
5340 | |
5341 So the slowdown occurs because XEmacs now engages in the clipboard | |
5342 notification protocol on @emph{every} kill. This is especially slow on | |
5343 Motif. | |
5344 | |
5345 With most people running most clients and server on the same host, and | |
5346 many of the rest working over very fast communication, you may expect | |
5347 that the situation is not going to improve. | |
5348 | |
5349 There are a number of workarounds. The most effective is to use a | |
5350 special command to do selection ownership only when you intend to paste | |
5351 to another application. Useful commands are @code{kill-primary-selection} | |
5352 and @code{copy-primary-selection}. These work only on text selected | |
5353 with the mouse (probably; experiment), and are bound by default to the | |
5354 @kbd{Cut} and @kbd{Copy}, respectively, buttons on the toolbar. | |
5355 @code{copy-primary-selection} is also bound to @kbd{C-Insert}. You can | |
5356 yank the clipboard contents with @code{yank-primary-selection}, bound to | |
5357 the @kbd{Paste} toolbar button and @kbd{Sh-Insert}. | |
5358 | |
5359 If you are communicating by cut and paste with applications that use the | |
5360 primary selection, then you can customize | |
5361 @code{interprogram-cut-function} to @code{nil}, restoring the XEmacs | |
5362 version 20 behavior. How can you tell if a program will support this? | |
5363 Motifly-correct programs require the clipboard; you lose. For others, | |
5364 only by trying it. You also need to customize the complementary | |
5365 @code{interprogram-paste-function} to @code{nil}. (Otherwise | |
5366 XEmacs-to-XEmacs pastes will not work correctly.) | |
5367 | |
5368 You may get some relief on Motif by setting | |
5369 @code{x-selection-strict-motif-ownership} to nil, but this means you will | |
5370 only intermittently be able to paste XEmacs kills to Motif applications. | |
5371 | |
5372 Thanks to Jeff Mincy and Glynn Clements for corrections. | |
5373 | |
2459 | 5374 @node Q3.3.6, Q3.4.1, Q3.3.5, Editing |
5375 @unnumberedsubsec Q3.3.6: Why does @kbd{M-w} take so long? | |
2417 | 5376 |
5377 It actually doesn't. It leaves the region visible for a second so that | |
5378 you can see what area is being yanked. If you start working, though, it | |
5379 will immediately complete its operation. In other words, it will only | |
5380 delay for a second if you let it. | |
5381 | |
2459 | 5382 @unnumberedsec 3.4: Editing Source Code |
5383 | |
5384 @node Q3.4.1, Q3.4.2, Q3.3.6, Editing | |
5385 @unnumberedsubsec Q3.4.1: I do not like cc-mode. How do I use the old c-mode? | |
2417 | 5386 |
5387 Well, first off, consider if you really want to do this. cc-mode is | |
5388 much more powerful than the old c-mode. If you're having trouble | |
5389 getting your old offsets to work, try using @code{c-set-offset} instead. | |
5390 You might also consider using the package @code{cc-compat}. | |
5391 | |
5392 But, if you still insist, add the following lines to your @file{init.el}: | |
5393 | |
5394 @lisp | |
5395 (fmakunbound 'c-mode) | |
5396 (makunbound 'c-mode-map) | |
5397 (fmakunbound 'c++-mode) | |
5398 (makunbound 'c++-mode-map) | |
5399 (makunbound 'c-style-alist) | |
5400 (load-library "old-c-mode") | |
5401 (load-library "old-c++-mode") | |
5402 @end lisp | |
5403 | |
5404 This must be done before any other reference is made to either c-mode or | |
5405 c++-mode. | |
5406 | |
2459 | 5407 @node Q3.4.2, , Q3.4.1, Editing |
5408 @unnumberedsubsec Q3.4.2: How do you make XEmacs indent CL if-clauses correctly? | |
2417 | 5409 |
5410 I'd like XEmacs to indent all the clauses of a Common Lisp @code{if} the | |
5411 same amount instead of indenting the 3rd clause differently from the | |
5412 first two. | |
5413 | |
2459 | 5414 The package @code{cl-indent} that comes with XEmacs sets up this kind |
5415 of indentation by default. @code{cl-indent} also knows about many | |
5416 other CL-specific forms. To use @code{cl-indent}, one can do this: | |
2417 | 5417 |
5418 @lisp | |
2459 | 5419 (setq lisp-indent-function 'common-lisp-indent-function) |
2417 | 5420 @end lisp |
5421 | |
5422 One can also customize @file{cl-indent.el} so it mimics the default | |
5423 @code{if} indentation @code{then} indented more than the @code{else}. | |
5424 Here's how: | |
5425 | |
5426 @lisp | |
5427 (put 'if 'common-lisp-indent-function '(nil nil &body)) | |
5428 @end lisp | |
5429 | |
2459 | 5430 @node Display, External Subsystems, Editing, Top |
5431 @unnumbered 4 Display Functions | |
428 | 5432 |
5433 This is part 4 of the XEmacs Frequently Asked Questions list. This | |
2459 | 5434 section is devoted to the display-related capabilities of XEmacs |
5435 (fonts, colors, modeline, menubar, toolbar, scrollbar, etc.) and how | |
5436 to customize them. | |
5437 | |
5438 @menu | |
5439 4.0: Textual Fonts and Colors | |
5440 * Q4.0.1:: How do I specify a font? | |
5441 * Q4.0.2:: How do I set the text, menu and modeline fonts? | |
5442 * Q4.0.3:: How can I set color options from @file{init.el}? | |
5443 * Q4.0.4:: How can I set the colors when highlighting a region? | |
5444 * Q4.0.5:: How can I limit color map usage? | |
5445 * Q4.0.6:: My tty supports color, but XEmacs doesn't use them. | |
5446 * Q4.0.7:: Can I have pixmap backgrounds in XEmacs? | |
5447 * Q4.0.8:: How do I display non-ASCII characters? | |
5448 * Q4.0.9:: Font selections in don't get saved after @code{Save Options}. | |
5449 | |
5450 4.1: Syntax Highlighting (Font Lock) | |
5451 * Q4.1.1:: How can I do source code highlighting using font-lock? | |
5452 * Q4.1.2:: How do I get @samp{More} Syntax Highlighting on by default? | |
5453 | |
5454 4.2: The Modeline | |
5455 * Q4.2.1:: How can I make the modeline go away? | |
5456 * Q4.2.2:: How do you have XEmacs display the line number in the modeline? | |
5457 * Q4.2.3:: How do I get XEmacs to put the time of day on the modeline? | |
5458 * Q4.2.4:: How can I change the modeline color based on the mode used? | |
5459 | |
5460 4.3: The Cursor | |
5461 * Q4.3.1:: Is there a way to make the bar cursor thicker? | |
5462 * Q4.3.2:: Is there a way to get back the block cursor? | |
5463 * Q4.3.3:: Can I make the cursor blink? | |
5464 | |
5465 4.4: The Menubar | |
5466 * Q4.4.1:: How do I get rid of the menubar? | |
5467 * Q4.4.2:: How can I customize the menubar? | |
5468 * Q4.4.3:: How do I enable use of the keyboard (@kbd{Alt}) to access menu items? | |
5469 * Q4.4.4:: How do I control how many buffers are listed in the menu @code{Buffers List}? | |
5470 * Q4.4.5:: Resources like @code{Emacs*menubar*font} are not working? | |
5471 | |
5472 4.5: The Toolbar | |
5473 * Q4.5.1:: How do I get rid of the toolbar? | |
5474 * Q4.5.2:: How can I customize the toolbar? | |
5475 * Q4.5.3:: How can I bind a key to a function to toggle the toolbar? | |
5476 * Q4.5.4:: @samp{Can't instantiate image error...} in toolbar | |
5477 | |
5478 4.6: Scrollbars and Scrolling | |
5479 * Q4.6.1:: How can I disable the scrollbar? | |
5480 * Q4.6.2:: How can I change the scrollbar width? | |
5481 * Q4.6.3:: How can I use resources to change scrollbar colors? | |
5482 * Q4.6.4:: Moving the scrollbar can move the point; can I disable this? | |
5483 * Q4.6.5:: Scrolling one line at a time. | |
5484 * Q4.6.6:: How can I turn off automatic horizontal scrolling in specific modes? | |
5485 * Q4.6.7:: I find auto-show-mode disconcerting. How do I turn it off? | |
5486 | |
5487 4.7: The Gutter Tabs, The Progress Bar, Widgets | |
5488 * Q4.7.1:: How can I disable the gutter tabs? | |
5489 * Q4.7.2:: How can I disable the progress bar? | |
5490 * Q4.7.3:: There are bugs in the gutter or widgets. | |
5491 * Q4.7.4:: How can I customize the gutter or gutter tabs? | |
5492 @end menu | |
5493 | |
5494 @unnumberedsec 4.0: Textual Fonts and Colors | |
5495 | |
5496 @node Q4.0.1, Q4.0.2, Display, Display | |
5497 @unnumberedsubsec Q4.0.1: How do I specify a font? | |
5498 | |
5499 #### Update me. | |
5500 | |
5501 In 21.4 and above, you can use the @samp{Options} menu to change the font. | |
5502 You can also do it in your init file, e.g. like this (for MS Windows): | |
5503 | |
5504 @display | |
5505 (set-face-font 'default "Lucida Console:Regular:10") | |
5506 (set-face-font 'modeline "MS Sans Serif:Regular:10") | |
5507 @end display | |
5508 | |
5509 @node Q4.0.2, Q4.0.3, Q4.0.1, Display | |
5510 @unnumberedsubsec Q4.0.2: How do I set the text, menu and modeline fonts? | |
5511 | |
5512 #### Update me. | |
5513 | |
5514 Note that you should use @samp{Emacs.} and not @samp{Emacs*} when | |
5515 setting face values. | |
5516 | |
5517 In @file{.Xresources}: | |
5518 | |
5519 @example | |
5520 Emacs.default.attributeFont: -*-*-medium-r-*-*-*-120-*-*-m-*-*-* | |
5521 Emacs*menubar*font: fixed | |
5522 Emacs.modeline.attributeFont: fixed | |
5523 @end example | |
5524 | |
5525 This is confusing because @samp{default} and @samp{modeline} are face | |
5526 names, and can be found listed with all faces in the current mode by | |
5527 using @kbd{M-x set-face-font (enter) ?}. They use the face-specific | |
5528 resource @samp{attributeFont}. | |
5529 | |
5530 On the other hand, @samp{menubar} is a normal X thing that uses the | |
5531 resource @samp{font}. With Motif it @emph{may be} necessary to use | |
5532 @samp{fontList} @emph{instead of} @samp{font}. In @emph{non-Motif} | |
5533 configurations with Mule it @emph{is} necessary to use @samp{fontSet} | |
5534 instead of @samp{font}. (Sorry, there just is no simple recipe here.) | |
5535 | |
5536 @node Q4.0.3, Q4.0.4, Q4.0.2, Display | |
5537 @unnumberedsubsec Q4.0.3: How can I set color options from @file{init.el}? | |
5538 | |
5539 How can I set the most commonly used color options from my | |
5540 @file{init.el} instead of from my @file{.Xresources}? | |
5541 | |
5542 Like this: | |
5543 | |
5544 @lisp | |
5545 (set-face-background 'default "bisque") ; frame background | |
5546 (set-face-foreground 'default "black") ; normal text | |
5547 (set-face-background 'zmacs-region "red") ; When selecting w/ | |
5548 ; mouse | |
5549 (set-face-foreground 'zmacs-region "yellow") | |
5550 (set-face-font 'default "*courier-bold-r*120-100-100*") | |
5551 (set-face-background 'highlight "blue") ; Ie when selecting | |
5552 ; buffers | |
5553 (set-face-foreground 'highlight "yellow") | |
5554 (set-face-background 'modeline "blue") ; Line at bottom | |
5555 ; of buffer | |
5556 (set-face-foreground 'modeline "white") | |
5557 (set-face-font 'modeline "*bold-r-normal*140-100-100*") | |
5558 (set-face-background 'isearch "yellow") ; When highlighting | |
5559 ; while searching | |
5560 (set-face-foreground 'isearch "red") | |
5561 (setq x-pointer-foreground-color "black") ; Adds to bg color, | |
5562 ; so keep black | |
5563 (setq x-pointer-background-color "blue") ; This is color | |
5564 ; you really | |
5565 ; want ptr/crsr | |
5566 @end lisp | |
5567 | |
5568 @node Q4.0.4, Q4.0.5, Q4.0.3, Display | |
5569 @unnumberedsubsec Q4.0.4: How can I set the colors when highlighting a region? | |
5570 | |
5571 How can I set the background/foreground colors when highlighting a | |
5572 region? | |
5573 | |
5574 You can change the face @code{zmacs-region} either in your | |
5575 @file{.Xresources}: | |
5576 | |
5577 @example | |
5578 Emacs.zmacs-region.attributeForeground: firebrick | |
5579 Emacs.zmacs-region.attributeBackground: lightseagreen | |
5580 @end example | |
5581 | |
5582 or in your @file{init.el}: | |
5583 | |
5584 @lisp | |
5585 (set-face-background 'zmacs-region "red") | |
5586 (set-face-foreground 'zmacs-region "yellow") | |
5587 @end lisp | |
5588 | |
5589 @node Q4.0.5, Q4.0.6, Q4.0.4, Display | |
5590 @unnumberedsubsec Q4.0.5: How can I limit color map usage? | |
5591 | |
5592 I'm using Netscape (or another color grabber like XEmacs); | |
5593 is there any way to limit the number of available colors in the color map? | |
5594 | |
5595 Answer: No, but you can start Netscape before XEmacs, and it will use | |
5596 the closest available color if the colormap is full. You can also limit | |
5597 the number of colors Netscape uses, using the flags -mono, -ncols <#> or | |
5598 -install (for mono, limiting to <#> colors, or for using a private color | |
5599 map). | |
5600 | |
5601 If you have the money, another solution would be to use a truecolor or | |
5602 direct color video. | |
5603 | |
5604 @node Q4.0.6, Q4.0.7, Q4.0.5, Display | |
5605 @unnumberedsubsec Q4.0.6: My tty supports color, but XEmacs doesn't use them. | |
5606 | |
5607 XEmacs tries to automatically determine whether your tty supports color, | |
5608 but sometimes guesses wrong. In that case, you can make XEmacs Do The | |
5609 Right Thing using this Lisp code: | |
5610 | |
5611 @lisp | |
5612 (if (eq 'tty (device-type)) | |
5613 (set-device-class nil 'color)) | |
5614 @end lisp | |
5615 | |
5616 @node Q4.0.7, Q4.0.8, Q4.0.6, Display | |
5617 @unnumberedsubsec Q4.0.7: Can I have pixmap backgrounds in XEmacs? | |
5618 @c New | |
5619 @email{jvillaci@@wahnsinnig.extreme.indiana.edu, Juan Villacis} writes: | |
5620 | |
5621 @quotation | |
5622 There are several ways to do it. For example, you could specify a | |
5623 default pixmap image to use in your @file{~/.Xresources}, e.g., | |
5624 | |
5625 | |
5626 @example | |
5627 Emacs*EmacsFrame.default.attributeBackgroundPixmap: /path/to/image.xpm | |
5628 @end example | |
5629 | |
5630 | |
5631 and then reload ~/.Xresources and restart XEmacs. Alternatively, | |
5632 since each face can have its own pixmap background, a better way | |
5633 would be to set a face's pixmap within your XEmacs init file, e.g., | |
5634 | |
5635 @lisp | |
5636 (set-face-background-pixmap 'default "/path/to/image.xpm") | |
5637 (set-face-background-pixmap 'bold "/path/to/another_image.xpm") | |
5638 @end lisp | |
5639 | |
5640 and so on. You can also do this interactively via @kbd{M-x edit-faces}. | |
5641 | |
5642 @end quotation | |
5643 | |
5644 @node Q4.0.8, Q4.0.9, Q4.0.7, Display | |
5645 @unnumberedsubsec Q4.0.8: How do I display non-ASCII characters? | |
5646 @c New | |
5647 | |
5648 If you're using a Mule-enabled XEmacs, then display is automatic. If | |
5649 you're not seeing the characters you expect, either (1) you don't have | |
5650 appropriate fonts available or (2) XEmacs did not correctly detect the | |
5651 coding system (@pxref{Recognize Coding, , , xemacs}). In case (1), | |
5652 install fonts as is customary for your platform. In case (2), you | |
5653 need to tell XEmacs explicitly what coding systems you're using. | |
5654 @ref{Specify Coding, , , xemacs}. | |
5655 | |
5656 If your XEmacs is not Mule-enabled, and for some reason getting a | |
5657 Mule-enabled XEmacs seems like the wrong thing to do, all is not lost. | |
5658 You can arrange it by brute force. In @file{event-Xt.c} (suppress the | |
5659 urge to look in this file---play Doom instead, because you'll survive | |
5660 longer), it is written: | |
5661 | |
5662 @quotation | |
5663 In a non-Mule world, a user can still have a multi-lingual editor, by | |
5664 doing @code{(set-face-font "-*-iso8859-2" (current-buffer))} for all | |
5665 their Latin-2 buffers, etc. | |
5666 @end quotation | |
5667 | |
5668 For the related problem of @emph{inputting} non-ASCII characters in a | |
5669 non-Mule XEmacs, @xref{Q3.0.6, How can you type in special characters | |
5670 in XEmacs?}. | |
5671 | |
5672 @node Q4.0.9, Q4.1.1, Q4.0.8, Display | |
5673 @unnumberedsubsec Q4.0.9: Font selections in don't get saved after @code{Save Options}. | |
5674 | |
5675 @email{mannj@@ll.mit.edu, John Mann} writes: | |
5676 | |
5677 @quotation | |
5678 You have to go to @samp{Options->Menubars} and unselect | |
5679 @samp{Frame-Local Font Menu}. If this option is selected, font changes | |
5680 are only applied to the @emph{current} frame and do @emph{not} get saved | |
5681 when you save options. | |
5682 @end quotation | |
5683 | |
5684 Also, set the following in your @file{init.el}: | |
5685 | |
5686 @lisp | |
5687 (setq options-save-faces t) | |
5688 @end lisp | |
5689 | |
5690 @unnumberedsec 4.1: Syntax Highlighting (Font Lock) | |
5691 | |
5692 @node Q4.1.1, Q4.1.2, Q4.0.9, Display | |
5693 @unnumberedsubsec Q4.1.1: How can I do source code highlighting using font-lock? | |
5694 | |
5695 For most modes, font-lock is already set up and just needs to be turned | |
5696 on. This can be done by adding the line: | |
5697 | |
5698 @lisp | |
5699 (require 'font-lock) | |
5700 @end lisp | |
5701 | |
5702 to your @file{init.el}. (You can turn it on for the | |
5703 current buffer and session only by @kbd{M-x font-lock-mode}.) See the | |
5704 file @file{etc/sample.init.el} (@file{etc/sample.emacs} in XEmacs | |
5705 versions prior to 21.4) for more information. | |
5706 | |
5707 @c the old way: | |
5708 @c (add-hook 'emacs-lisp-mode-hook 'turn-on-font-lock) | |
5709 @c (add-hook 'dired-mode-hook 'turn-on-font-lock) | |
5710 | |
5711 See also @code{Syntax Highlighting} from the @code{Options} menu. | |
5712 Remember to save options. | |
5713 | |
5714 @node Q4.1.2, Q4.2.1, Q4.1.1, Display | |
5715 @unnumberedsubsec Q4.1.2: How do I get @samp{More} Syntax Highlighting on by default? | |
5716 | |
5717 Use the following code in your @file{init.el}: | |
5718 | |
5719 @lisp | |
5720 (setq-default font-lock-maximum-decoration t) | |
5721 @end lisp | |
5722 | |
5723 See also @code{Syntax Highlighting} from the @code{Options} menu. | |
5724 Remember to save options. | |
5725 | |
5726 @unnumberedsec 4.2: The Modeline | |
5727 | |
5728 @node Q4.2.1, Q4.2.2, Q4.1.2, Display | |
5729 @unnumberedsubsec Q4.2.1: How can I make the modeline go away? | |
5730 | |
5731 @lisp | |
5732 (set-specifier has-modeline-p nil) | |
5733 @end lisp | |
5734 | |
5735 @node Q4.2.2, Q4.2.3, Q4.2.1, Display | |
5736 @unnumberedsubsec Q4.2.2: How do you have XEmacs display the line number in the modeline? | |
5737 | |
5738 Add the following line to your @file{init.el} file to | |
5739 display the line number: | |
5740 | |
5741 @lisp | |
5742 (line-number-mode 1) | |
5743 @end lisp | |
5744 | |
5745 Use the following to display the column number: | |
5746 | |
5747 @lisp | |
5748 (column-number-mode 1) | |
5749 @end lisp | |
5750 | |
5751 Or select from the @code{Options} menu | |
5752 @iftex | |
5753 @* | |
5754 @end iftex | |
5755 @code{Advanced (Customize)->Emacs->Editing->Basics->Line Number Mode} | |
5756 and/or | |
5757 @iftex | |
5758 @* | |
5759 @end iftex | |
5760 @code{Advanced (Customize)->Emacs->Editing->Basics->Column Number Mode} | |
5761 | |
5762 Or type @kbd{M-x customize @key{RET} editing-basics @key{RET}}. | |
5763 | |
5764 @node Q4.2.3, Q4.2.4, Q4.2.2, Display | |
5765 @unnumberedsubsec Q4.2.3: How do I get XEmacs to put the time of day on the modeline? | |
5766 | |
5767 Add the following line to your @file{init.el} file to | |
5768 display the time: | |
5769 | |
5770 @lisp | |
5771 (display-time) | |
5772 @end lisp | |
5773 | |
5774 See @code{Customize} from the @code{Options} menu for customization. | |
5775 | |
5776 @node Q4.2.4, Q4.3.1, Q4.2.3, Display | |
5777 @unnumberedsubsec Q4.2.4: How can I change the modeline color based on the mode used? | |
5778 | |
5779 You can use something like the following: | |
5780 | |
5781 @lisp | |
5782 (add-hook 'lisp-mode-hook | |
5783 (lambda () | |
5784 (set-face-background 'modeline "red" (current-buffer)))) | |
5785 @end lisp | |
5786 | |
5787 Then, when editing a Lisp file (i.e. when in Lisp mode), the modeline | |
5788 colors change from the default set in your @file{init.el}. | |
5789 The change will only be made in the buffer you just entered (which | |
5790 contains the Lisp file you are editing) and will not affect the modeline | |
5791 colors anywhere else. | |
5792 | |
5793 Notes: | |
5794 | |
5795 @itemize @bullet | |
5796 | |
5797 @item The hook is the mode name plus @code{-hook}. eg. c-mode-hook, | |
5798 c++-mode-hook, emacs-lisp-mode-hook (used for your | |
5799 @file{init.el} or a @file{xx.el} file), | |
5800 lisp-interaction-mode-hook (the @samp{*scratch*} buffer), | |
5801 text-mode-hook, etc. | |
5802 | |
5803 @item | |
5804 Be sure to use @code{add-hook}, not @code{(setq c-mode-hook xxxx)}, | |
5805 otherwise you will erase anything that anybody has already put on the | |
5806 hook. | |
5807 | |
5808 @item | |
5809 You can also do @code{(set-face-font 'modeline @var{font})}, | |
5810 eg. @code{(set-face-font 'modeline "*bold-r-normal*140-100-100*" | |
5811 (current-buffer))} if you wish the modeline font to vary based on the | |
5812 current mode. | |
5813 @end itemize | |
5814 | |
5815 There are additional modeline faces, @code{modeline-buffer-id}, | |
5816 @code{modeline-mousable}, and @code{modeline-mousable-minor-mode}, which | |
5817 you may want to customize. | |
5818 | |
5819 @unnumberedsec 4.3: The Cursor | |
5820 | |
5821 @node Q4.3.1, Q4.3.2, Q4.2.4, Display | |
5822 @unnumberedsubsec Q4.3.1: Is there a way to make the bar cursor thicker? | |
5823 | |
5824 I'd like to have the bar cursor a little thicker, as I tend to "lose" it | |
5825 often. | |
5826 | |
5827 For a 1 pixel bar cursor, use: | |
5828 | |
5829 @lisp | |
5830 (setq bar-cursor t) | |
5831 @end lisp | |
5832 | |
5833 For a 2 pixel bar cursor, use: | |
5834 | |
5835 @lisp | |
5836 (setq bar-cursor 'anything-else) | |
5837 @end lisp | |
5838 | |
5839 You can also change these with Customize. | |
5840 Select from the @code{Options} menu | |
5841 @code{Advanced (Customize)->Emacs->Environment->Display->Bar Cursor...} or type | |
5842 @kbd{M-x customize @key{RET} display @key{RET}}. | |
5843 | |
5844 You can use a color to make it stand out better: | |
5845 | |
5846 @example | |
5847 Emacs*cursorColor: Red | |
5848 @end example | |
5849 | |
5850 @node Q4.3.2, Q4.3.3, Q4.3.1, Display | |
5851 @unnumberedsubsec Q4.3.2: Is there a way to get back the block cursor? | |
5852 | |
5853 @lisp | |
5854 (setq bar-cursor nil) | |
5855 @end lisp | |
5856 | |
5857 You can also change this with Customize. | |
5858 Select from the @code{Options} menu | |
5859 @code{Advanced (Customize)->Emacs->Environment->Display->Bar Cursor...} or type | |
5860 @kbd{M-x customize @key{RET} display @key{RET}}. | |
5861 | |
5862 @node Q4.3.3, Q4.4.1, Q4.3.2, Display | |
5863 @unnumberedsubsec Q4.3.3: Can I make the cursor blink? | |
5864 | |
5865 Yes, like this: | |
5866 | |
5867 @lisp | |
5868 (blink-cursor-mode) | |
5869 @end lisp | |
5870 | |
5871 This function toggles between a steady cursor and a blinking cursor. | |
5872 You may also set this mode from the menu bar by selecting | |
5873 @samp{Options->Display->Blinking Cursor}. Remember to save options. | |
5874 | |
5875 @unnumberedsec 4.4: The Menubar | |
5876 | |
5877 @node Q4.4.1, Q4.4.2, Q4.3.3, Display | |
5878 @unnumberedsubsec Q4.4.1: How do I get rid of the menubar? | |
5879 | |
5880 @lisp | |
5881 (set-specifier menubar-visible-p nil) | |
5882 @end lisp | |
5883 | |
5884 @node Q4.4.2, Q4.4.3, Q4.4.1, Display | |
5885 @unnumberedsubsec Q4.4.2: How can I customize the menubar? | |
5886 | |
5887 For an extensive menubar, add this line to your @file{init.el}: | |
5888 | |
5889 @lisp | |
5890 (load "big-menubar") | |
5891 @end lisp | |
5892 | |
5893 If you'd like to write your own, this file provides as good a set of | |
5894 examples as any to start from. The file is located in edit-utils | |
5895 package. | |
5896 | |
5897 @node Q4.4.3, Q4.4.4, Q4.4.2, Display | |
5898 @unnumberedsubsec Q4.4.3: How do I enable use of the keyboard (@kbd{Alt}) to access menu items? | |
5899 | |
5900 #### Write me. | |
5901 | |
5902 @node Q4.4.4, Q4.4.5, Q4.4.3, Display | |
5903 @unnumberedsubsec Q4.4.4: How do I control how many buffers are listed in the menu @code{Buffers List}? | |
5904 | |
5905 Add the following to your @file{init.el} (suit to fit): | |
5906 | |
5907 @lisp | |
5908 (setq buffers-menu-max-size 20) | |
5909 @end lisp | |
5910 | |
5911 For no limit, use an argument of @samp{nil}. | |
5912 | |
5913 You can also change this with Customize. Select from the | |
5914 @code{Options} menu | |
5915 @code{Advanced (Customize)->Emacs->Environment->Menu->Buffers Menu->Max Size...} | |
5916 or type @kbd{M-x customize @key{RET} buffers-menu @key{RET}}. | |
5917 | |
5918 @node Q4.4.5, Q4.5.1, Q4.4.4, Display | |
5919 @unnumberedsubsec Q4.4.5: Resources like @code{Emacs*menubar*font} are not working? | |
5920 | |
5921 I am trying to use a resource like @code{Emacs*menubar*font} to set the | |
5922 font of the menubar but it's not working. | |
5923 | |
5924 In Motif, the use of @samp{font} resources is obsoleted in order to | |
5925 support internationalization. If you are using the real Motif menubar, | |
5926 this resource is not recognized at all; you have to say: | |
5927 | |
5928 @example | |
5929 Emacs*menubar*fontList: FONT | |
5930 @end example | |
5931 | |
5932 If you are using the Lucid menubar, for backward compatibility with | |
5933 existing user configurations, the @samp{font} resource is recognized. | |
5934 Since this is not supported by Motif itself, the code is a kludge and | |
5935 the @samp{font} resource will be recognized only if the @samp{fontList} | |
5936 resource resource is unset. This means that the resource | |
5937 | |
5938 @example | |
5939 *fontList: FONT | |
5940 @end example | |
5941 | |
5942 will override | |
5943 | |
5944 @example | |
5945 Emacs*menubar*font: FONT | |
5946 @end example | |
5947 | |
5948 even though the latter is more specific. | |
5949 | |
5950 In non-Motif configurations using @samp{--with-mule} and | |
5951 @samp{--with-xfs} it @emph{is} necessary to use the @code{fontSet} | |
5952 resource @emph{instead of} the @code{font} resource. The backward | |
5953 compatibility kludge was never implemented for non-Motif builds. | |
5954 Example: | |
5955 | |
5956 @example | |
5957 *fontSet: FONT | |
5958 @end example | |
5959 | |
5960 @unnumberedsec 4.5: The Toolbar | |
5961 | |
5962 @node Q4.5.1, Q4.5.2, Q4.4.5, Display | |
5963 @unnumberedsubsec Q4.5.1: How do I get rid of the toolbar? | |
5964 | |
5965 #### Write me. | |
5966 | |
5967 @node Q4.5.2, Q4.5.3, Q4.5.1, Display | |
5968 @unnumberedsubsec Q4.5.2: How can I customize the toolbar? | |
5969 | |
5970 #### Write me. | |
5971 | |
5972 @node Q4.5.3, Q4.5.4, Q4.5.2, Display | |
5973 @unnumberedsubsec Q4.5.3: How can I bind a key to a function to toggle the toolbar? | |
5974 | |
5975 Try something like: | |
5976 | |
5977 @lisp | |
5978 (defun my-toggle-toolbar () | |
5979 (interactive) | |
5980 (set-specifier default-toolbar-visible-p | |
5981 (not (specifier-instance default-toolbar-visible-p)))) | |
5982 (global-set-key "\C-xT" 'my-toggle-toolbar) | |
5983 @end lisp | |
5984 | |
5985 @ignore | |
5986 @c Probably not relevant any more | |
5987 There are redisplay bugs in 19.14 that may make the preceding result in | |
5988 a messed-up display, especially for frames with multiple windows. You | |
5989 may need to resize the frame before XEmacs completely realizes the | |
5990 toolbar is really gone. | |
5991 @end ignore | |
5992 | |
5993 Thanks to @email{martin@@xemacs.org, Martin Buchholz} for the correct | |
5994 code. | |
5995 | |
5996 @node Q4.5.4, Q4.6.1, Q4.5.3, Display | |
5997 @unnumberedsubsec Q4.5.4: @samp{Can't instantiate image error...} in toolbar | |
5998 | |
5999 @email{expt@@alanine.ram.org, Dr. Ram Samudrala} writes: | |
6000 | |
6001 I just installed the XEmacs (20.4-2) RPMS that I downloaded from | |
6002 @uref{http://www.xemacs.org/}. Everything works fine, except that when | |
6003 I place my mouse over the toolbar, it beeps and gives me this message: | |
6004 | |
6005 @example | |
6006 Can't instantiate image (probably cached): | |
6007 [xbm :mask-file "/usr/include/X11/bitmaps/leftptrmsk :mask-data | |
6008 (16 16 <strange control characters> ... | |
6009 @end example | |
6010 | |
6011 @email{kyle_jones@@wonderworks.com, Kyle Jones} writes: | |
6012 @quotation | |
6013 This is problem specific to some Chips and Technologies video | |
6014 chips, when running XFree86. Putting | |
6015 | |
6016 @code{Option "sw_cursor"} | |
6017 | |
6018 in @file{XF86Config} gets rid of the problem. | |
6019 @end quotation | |
6020 | |
6021 @unnumberedsec 4.6: Scrollbars and Scrolling | |
6022 | |
6023 @node Q4.6.1, Q4.6.2, Q4.5.4, Display | |
6024 @unnumberedsubsec Q4.6.1: How can I disable the scrollbar? | |
6025 | |
6026 To disable them for all frames, add the following line to | |
6027 your @file{.Xresources}: | |
6028 | |
6029 @example | |
6030 Emacs.scrollBarWidth: 0 | |
6031 @end example | |
6032 | |
6033 Or select @samp{Options->Display->Scrollbars}. | |
6034 Remember to save options. | |
6035 | |
6036 To turn the scrollbar off on a per-frame basis, use the following | |
6037 function: | |
6038 | |
6039 @lisp | |
6040 (set-specifier scrollbar-width 0 (selected-frame)) | |
6041 @end lisp | |
6042 | |
6043 You can actually turn the scrollbars on at any level you want by | |
6044 substituting for (selected-frame) in the above command. For example, to | |
6045 turn the scrollbars off only in a single buffer: | |
6046 | |
6047 @lisp | |
6048 (set-specifier scrollbar-width 0 (current-buffer)) | |
6049 @end lisp | |
6050 | |
6051 @node Q4.6.2, Q4.6.3, Q4.6.1, Display | |
6052 @unnumberedsubsec Q4.6.2: How can I change the scrollbar width? | |
6053 | |
6054 #### Write me. | |
6055 | |
6056 @node Q4.6.3, Q4.6.4, Q4.6.2, Display | |
6057 @unnumberedsubsec Q4.6.3: How can I use resources to change scrollbar colors? | |
6058 | |
6059 Here's a recap of how to use resources to change your scrollbar colors: | |
6060 | |
6061 @example | |
6062 ! Motif scrollbars | |
6063 | |
6064 Emacs*XmScrollBar.Background: skyblue | |
6065 Emacs*XmScrollBar.troughColor: lightgray | |
6066 | |
6067 ! Athena scrollbars | |
6068 | |
6069 Emacs*Scrollbar.Foreground: skyblue | |
6070 Emacs*Scrollbar.Background: lightgray | |
6071 @end example | |
6072 | |
6073 Note the capitalization of @code{Scrollbar} for the Athena widget. | |
6074 | |
6075 @node Q4.6.4, Q4.6.5, Q4.6.3, Display | |
6076 @unnumberedsubsec Q4.6.4: Moving the scrollbar can move the point; can I disable this? | |
6077 | |
6078 When I move the scrollbar in an XEmacs window, it moves the point as | |
6079 well, which should not be the default behavior. Is this a bug or a | |
6080 feature? Can I disable it? | |
6081 | |
6082 The current behavior is a feature, not a bug. Point remains at the same | |
6083 buffer position as long as that position does not scroll off the screen. | |
6084 In that event, point will end up in either the upper-left or lower-left | |
6085 hand corner. | |
6086 | |
6087 This cannot be changed. | |
6088 | |
6089 @node Q4.6.5, Q4.6.6, Q4.6.4, Display | |
6090 @unnumberedsubsec Q4.6.5: Scrolling one line at a time. | |
6091 | |
6092 Can the cursor keys scroll the screen a line at a time, rather than the | |
6093 default half page jump? I tend it to find it disorienting. | |
6094 | |
6095 Use the following: | |
6096 | |
6097 @lisp | |
6098 (setq scroll-step 1) | |
6099 @end lisp | |
6100 | |
6101 You can also change this with Customize. Select from the | |
6102 @code{Options} menu | |
6103 @code{Advanced (Customize)->Emacs->Environment->Windows->Scroll Step...} | |
6104 or type @kbd{M-x customize @key{RET} windows @key{RET}}. | |
6105 | |
6106 @node Q4.6.6, Q4.6.7, Q4.6.5, Display | |
6107 @unnumberedsubsec Q4.6.6: How can I turn off automatic horizontal scrolling in specific modes? | |
6108 | |
6109 Do @code{(setq truncate-lines t)} in the mode-hooks for any modes | |
6110 in which you want lines truncated. | |
6111 | |
6112 More precisely: If @code{truncate-lines} is nil, horizontal scrollbars | |
6113 will never appear. Otherwise, they will appear only if the value of | |
6114 @code{scrollbar-height} for that buffer/window/etc. is non-zero. If you | |
6115 do | |
6116 | |
6117 @lisp | |
6118 (set-specifier scrollbar-height 0) | |
6119 @end lisp | |
6120 | |
6121 then horizontal scrollbars will not appear in truncated buffers unless | |
6122 the package specifically asked for them. | |
6123 | |
6124 @node Q4.6.7, Q4.7.1, Q4.6.6, Display | |
6125 @unnumberedsubsec Q4.6.7: I find auto-show-mode disconcerting. How do I turn it off? | |
6126 | |
6127 @code{auto-show-mode} controls whether or not a horizontal scrollbar | |
6128 magically appears when a line is too long to be displayed. This is | |
6129 enabled by default. To turn it off, put the following in your | |
6130 @file{init.el}: | |
6131 | |
6132 @lisp | |
6133 (setq auto-show-mode nil) | |
6134 (setq-default auto-show-mode nil) | |
6135 @end lisp | |
6136 | |
6137 @unnumberedsec 4.7: The Gutter Tabs, The Progress Bar, Widgets | |
6138 | |
6139 @node Q4.7.1, Q4.7.2, Q4.6.7, Display | |
6140 @unnumberedsubsec Q4.7.1: How can I disable the gutter tabs? | |
6141 | |
6142 #### Write me. | |
6143 | |
6144 @node Q4.7.2, Q4.7.3, Q4.7.1, Display | |
6145 @unnumberedsubsec Q4.7.2: How can I disable the progress bar? | |
6146 | |
6147 #### Write me. | |
6148 | |
6149 @node Q4.7.3, Q4.7.4, Q4.7.2, Display | |
6150 @unnumberedsubsec Q4.7.3: There are bugs in the gutter or widgets. | |
6151 | |
6152 #### Write me. | |
6153 | |
6154 @node Q4.7.4, , Q4.7.3, Display | |
6155 @unnumberedsubsec Q4.7.4: How can I customize the gutter or gutter tabs? | |
6156 | |
6157 #### Write me. | |
6158 | |
6159 @node External Subsystems, Internet, Display, Top | |
6160 @unnumbered 5 Interfacing with the Operating System and External Devices | |
6161 | |
6162 This is part 5 of the XEmacs Frequently Asked Questions list. This | |
2417 | 6163 section is devoted to the various ways that XEmacs interfaces with the |
6164 operating system, with other processes and with external devices such | |
6165 as speakers and the printer. | |
428 | 6166 |
6167 @menu | |
2459 | 6168 5.0: X Window System and Resources |
6169 * Q5.0.1:: Where is a list of X resources? | |
6170 * Q5.0.2:: How can I detect a color display? | |
6171 * Q5.0.3:: How can I get the icon to just say @samp{XEmacs}? | |
6172 * Q5.0.4:: How can I have the window title area display the full path? | |
6173 * Q5.0.5:: @samp{xemacs -name junk} doesn't work? | |
6174 * Q5.0.6:: @samp{-iconic} doesn't work. | |
4505
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
6175 * Q5.0.7:: How can I use antialiased fonts under X11? |
2459 | 6176 |
6177 5.1: Microsoft Windows | |
6178 * Q5.1.1:: Does XEmacs rename all the @samp{win32-*} symbols to @samp{w32-*}? | |
6179 * Q5.1.2:: How do I get Windows Explorer to associate a file type with XEmacs? | |
6180 | |
6181 5.2: Printing | |
6182 * Q5.2.1:: What do I need to change to make printing work? | |
6183 * Q5.2.2:: How can I print WYSIWYG a font-locked buffer? | |
6184 * Q5.2.3:: Getting @kbd{M-x lpr} to work with postscript printer. | |
6185 * Q5.2.4:: Can you print under MS Windows? | |
6186 | |
6187 5.3: Sound | |
6188 * Q5.3.1:: How do I turn off the sound? | |
6189 * Q5.3.2:: How do I get funky sounds instead of a boring beep? | |
6190 * Q5.3.3:: What are NAS and ESD (EsounD)? | |
6191 * Q5.3.4:: Sunsite sounds don't play. | |
6192 | |
6193 5.4: Running an Interior Shell, Invoking Subprocesses | |
6194 * Q5.4.1:: What is an interior shell? | |
6195 * Q5.4.2:: How do I start up a second shell buffer? | |
6196 * Q5.4.3:: Telnet from shell filters too much | |
6197 * Q5.4.4:: Strange things are happening in Shell Mode. | |
6198 * Q5.4.5:: XEmacs complains "No such file or directory, diff" | |
2995 | 6199 * Q5.4.6:: Cygwin error "fork_copy: linked dll/bss pass 0 failed" |
2459 | 6200 |
6201 5.5: Multiple Device Support | |
6202 * Q5.5.1:: How do I open a frame on another screen of my multi-headed display? | |
6203 * Q5.5.2:: Can I really connect to a running XEmacs after calling up over a modem? How? | |
6204 * Q5.5.3:: How do I disable gnuserv from opening a new frame? | |
6205 * Q5.5.4:: How do I start gnuserv so that each subsequent XEmacs is a client? | |
6206 * Q5.5.5:: Is there a way to start a new XEmacs if there's no gnuserv running, and otherwise use gnuclient? | |
428 | 6207 @end menu |
6208 | |
2459 | 6209 @unnumberedsec 5.0: X Window System and Resources |
6210 | |
6211 @node Q5.0.1, Q5.0.2, External Subsystems, External Subsystems | |
6212 @unnumberedsubsec Q5.0.1: Where is a list of X resources? | |
2417 | 6213 |
6214 Search through the @file{NEWS} file for @samp{X Resources}. A fairly | |
6215 comprehensive list is given after it. | |
6216 | |
6217 In addition, an @file{app-defaults} file @file{etc/Emacs.ad} is | |
6218 supplied, listing the defaults. The file @file{etc/sample.Xresources} | |
6219 gives a different set of defaults that you might consider for | |
6220 installation in your @file{~/.Xresources} file. It is nearly the same | |
6221 as @file{etc/Emacs.ad}, but a few entries are altered. Be careful about | |
6222 installing the contents of this file into your @file{.Xresources} (or | |
6223 legacy @file{.Xdefaults}) file if you use GNU Emacs under X11 as well. | |
6224 | |
2459 | 6225 @node Q5.0.2, Q5.0.3, Q5.0.1, External Subsystems |
6226 @unnumberedsubsec Q5.0.2: How can I detect a color display? | |
2417 | 6227 |
6228 You can test the return value of the function @code{(device-class)}, as | |
6229 in: | |
6230 | |
6231 @lisp | |
6232 (when (eq (device-class) 'color) | |
6233 (set-face-foreground 'font-lock-comment-face "Grey") | |
6234 (set-face-foreground 'font-lock-string-face "Red") | |
6235 .... | |
6236 ) | |
6237 @end lisp | |
6238 | |
2459 | 6239 @node Q5.0.3, Q5.0.4, Q5.0.2, External Subsystems |
6240 @unnumberedsubsec Q5.0.3: How can I get the icon to just say @samp{XEmacs}? | |
2417 | 6241 |
6242 I'd like the icon to just say @samp{XEmacs}, and not include the name of | |
6243 the current file in it. | |
6244 | |
6245 Add the following line to your @file{init.el}: | |
6246 | |
6247 @lisp | |
6248 (setq frame-icon-title-format "XEmacs") | |
6249 @end lisp | |
6250 | |
2459 | 6251 @node Q5.0.4, Q5.0.5, Q5.0.3, External Subsystems |
6252 @unnumberedsubsec Q5.0.4: How can I have the window title area display the full path? | |
2417 | 6253 |
6254 I'd like to have the window title area display the full directory/name | |
6255 of the current buffer file and not just the name. | |
6256 | |
6257 Add the following line to your @file{init.el}: | |
6258 | |
6259 @lisp | |
6260 (setq frame-title-format "%S: %f") | |
6261 @end lisp | |
6262 | |
6263 A more sophisticated title might be: | |
6264 | |
6265 @lisp | |
6266 (setq frame-title-format | |
6267 '("%S: " (buffer-file-name "%f" | |
6268 (dired-directory dired-directory "%b")))) | |
6269 @end lisp | |
6270 | |
6271 That is, use the file name, or the dired-directory, or the buffer name. | |
6272 | |
2459 | 6273 @node Q5.0.5, Q5.0.6, Q5.0.4, External Subsystems |
6274 @unnumberedsubsec Q5.0.5: @samp{xemacs -name junk} doesn't work? | |
2417 | 6275 |
6276 When I run @samp{xterm -name junk}, I get an xterm whose class name | |
6277 according to xprop, is @samp{junk}. This is the way it's supposed to | |
6278 work, I think. When I run @samp{xemacs -name junk} the class name is | |
6279 not set to @samp{junk}. It's still @samp{emacs}. What does | |
6280 @samp{xemacs -name} really do? The reason I ask is that my window | |
6281 manager (fvwm) will make a window sticky and I use XEmacs to read my | |
6282 mail. I want that XEmacs window to be sticky, without having to use the | |
6283 window manager's function to set the window sticky. What gives? | |
6284 | |
6285 @samp{xemacs -name} sets the application name for the program (that is, | |
6286 the thing which normally comes from @samp{argv[0]}). Using @samp{-name} | |
6287 is the same as making a copy of the executable with that new name. The | |
6288 @code{WM_CLASS} property on each frame is set to the frame-name, and the | |
6289 application-class. So, if you did @samp{xemacs -name FOO} and then | |
6290 created a frame named @var{BAR}, you'd get an X window with WM_CLASS = | |
6291 @code{( "BAR", "Emacs")}. However, the resource hierarchy for this | |
6292 widget would be: | |
6293 | |
6294 @example | |
6295 Name: FOO .shell .container .BAR | |
6296 Class: Emacs .TopLevelEmacsShell.EmacsManager.EmacsFrame | |
6297 @end example | |
6298 | |
6299 instead of the default | |
6300 | |
6301 @example | |
6302 Name: xemacs.shell .container .emacs | |
6303 Class: Emacs .TopLevelEmacsShell.EmacsManager.EmacsFrame | |
6304 @end example | |
6305 | |
6306 | |
6307 It is arguable that the first element of WM_CLASS should be set to the | |
6308 application-name instead of the frame-name, but I think that's less | |
6309 flexible, since it does not give you the ability to have multiple frames | |
6310 with different WM_CLASS properties. Another possibility would be for | |
6311 the default frame name to come from the application name instead of | |
6312 simply being @samp{emacs}. However, at this point, making that change | |
6313 would be troublesome: it would mean that many users would have to make | |
6314 yet another change to their resource files (since the default frame name | |
6315 would suddenly change from @samp{emacs} to @samp{xemacs}, or whatever | |
6316 the executable happened to be named), so we'd rather avoid it. | |
6317 | |
6318 To make a frame with a particular name use: | |
6319 | |
6320 @lisp | |
6321 (make-frame '((name . "the-name"))) | |
6322 @end lisp | |
6323 | |
4505
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
6324 @node Q5.0.6, Q5.0.7, Q5.0.5, External Subsystems |
2459 | 6325 @unnumberedsubsec Q5.0.6: @samp{-iconic} doesn't work. |
2417 | 6326 |
6327 When I start up XEmacs using @samp{-iconic} it doesn't work right. | |
6328 Using @samp{-unmapped} on the command line, and setting the | |
6329 @code{initiallyUnmapped} X Resource don't seem to help much either... | |
6330 | |
6331 @email{ben@@xemacs.org, Ben Wing} writes: | |
6332 | |
6333 @quotation | |
6334 Ugh, this stuff is such an incredible mess that I've about given up | |
6335 getting it to work. The principal problem is numerous window-manager | |
6336 bugs... | |
6337 @end quotation | |
6338 | |
4505
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
6339 @node Q5.0.7, Q5.1.1, Q5.0.6, External Subsystems |
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
6340 @unnumberedsubsec Q5.0.7: How can I use antialiased fonts under X11? |
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
6341 |
4509
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6342 The X11 version of XEmacs can use antialiased fonts via the Xft, |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6343 fontconfig, and freetype libraries. To configure this you need a recent |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6344 beta version (at least 21.5.24); the more recent, the better. This is |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6345 beta software, the usual caveats apply. Rebuild xemacs using the |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6346 following configure options, plus any others you normally use: |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6347 |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6348 @samp{--enable-mule --with-xft=emacs,menubars} |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6349 |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6350 Xft @emph{may} work without Mule but the developers working on the Xft |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6351 code invariably build with Mule. The tab control also supports Xft, and |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6352 at some date the progress gauge will as well. If they are configured in |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6353 to XEmacs, you may add @samp{tabs} and @samp{gauges} to the value of the |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6354 @samp{--with-xft} option (with a comma separating each value from the |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6355 previous ones). For further details on the XEmacs widgets that support |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6356 XFT, see the output of @code{./configure --help}. If you use a package |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6357 manager from your OS distribution, you may need to install development |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6358 packages for @file{fontconfig} and @file{Xft}, and possibly for their |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6359 prequisites. |
4505
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
6360 |
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
6361 To specify a particular antialiased font, put something like the |
4509
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6362 following lines in your @file{~/.Xdefaults} or @file{~/.Xresources}: |
4505
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
6363 |
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
6364 @example |
4509
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6365 XEmacs.default.attributeFont: monospace-12 |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6366 XEmacs.bold.attributeFont: monospace-12:style=Bold |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6367 XEmacs.italic.attributeFont: monospace-12:style=Oblique |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6368 XEmacs.bold-italic.attributeFont: monospace-12:style=Bold Oblique |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6369 XEmacs.modeline.attributeFont: sans-serif-11 |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6370 XEmacs.menubar.xftFont: sans-serif-11 |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6371 XEmacs*XftFont: sans-serif-11 |
4505
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
6372 @end example |
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
6373 |
4509
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6374 @strong{Warning}: These resource naming conventions are just hacks to |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6375 get the code running; you should expect them to change. (Sorry about |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6376 that, but this @emph{is} beta software!) |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6377 |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6378 Then run @code{xrdb -merge} before starting the new, XFT-enabled |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6379 xemacs. You can choose the available fonts from the list given by |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6380 @code{fc-list}; try @code{xfd -fa FONTNAME-SIZE} to preview a given |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6381 font. Note that ``monospace'' and ``sans-serif'' are generic aliases |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6382 defined by fontconfig which may correspond to any of many real fonts |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6383 based on local configuration and availability of the aliased fonts, |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6384 and so are likely to give good results in a well-set-up system. |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6385 |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6386 Although Customize does not yet handle fontconfig fontspecs, you can |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6387 pass them as strings directly to @samp{set-face-font} to set fonts from |
dd12adb12b8f
Fix broken Xft FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4505
diff
changeset
|
6388 Lisp. |
4505
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
6389 |
2459 | 6390 @unnumberedsec 5.1: Microsoft Windows |
6391 | |
4505
a5f1da0eb001
Document XFT support in the FAQ, better describe XEmacs pronunciation.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4311
diff
changeset
|
6392 @node Q5.1.1, Q5.1.2, Q5.0.7, External Subsystems |
2459 | 6393 @unnumberedsubsec Q5.1.1: Does XEmacs rename all the @samp{win32-*} symbols to @samp{w32-*}? |
2417 | 6394 |
6395 In his flavor of Emacs 20, Richard Stallman has renamed all the @samp{win32-*} | |
6396 symbols to @samp{w32-*}. Does XEmacs do the same? | |
6397 | |
6398 We consider such a move counter-productive, thus we do not use the | |
6399 @samp{w32} prefix. (His rather questionable justification was that he | |
6400 did not consider Windows to be a "winning" platform.) However, the name | |
6401 @samp{Win32} is not particularly descriptive outside the Windows world, | |
6402 and using just @samp{windows-} would be too generic. So we chose a | |
6403 compromise, the prefix @samp{mswindows-} for Windows-related variables | |
6404 and functions. | |
6405 | |
6406 Thus all the XEmacs variables and functions directly related to either | |
6407 the Windows GUI or OS are prefixed @samp{mswindows-} (except for a | |
6408 couple of debugging variables, prefixed @samp{debug-mswindows-}). From | |
6409 an architectural perspective, however, we believe that this is mostly a | |
6410 non-issue because there should be a very small number of | |
6411 window-systems-specific variables anyway. Whenever possible, we try to | |
6412 provide generic interfaces that apply to all window systems. | |
6413 | |
6414 @c not true: | |
6415 @c The user variables | |
6416 @c that share functionality with existing NT Emacs variables are be named | |
6417 @c with our convention, but we provide the GNU Emacs names as | |
6418 @c compatibility aliases. | |
6419 | |
2459 | 6420 @node Q5.1.2, Q5.2.1, Q5.1.1, External Subsystems |
6421 @unnumberedsubsec Q5.1.2: How do I get Windows Explorer to associate a file type with XEmacs? | |
2417 | 6422 |
6423 @unnumberedsubsubsec Associating a new file type with XEmacs. | |
6424 | |
6425 In Explorer select @samp{View->Options->File Types}, press @samp{[New | |
6426 Type...]} and fill in the dialog box, e.g.: | |
6427 | |
6428 @example | |
6429 Description of type: Emacs Lisp source | |
6430 Associated extension: el | |
6431 Content Type (MIME): text/plain | |
6432 @end example | |
6433 | |
6434 then press @samp{[New...]} and fill in the @samp{Action} dialog box as | |
6435 follows: | |
6436 | |
6437 @example | |
6438 Action: | |
6439 Open | |
6440 | |
6441 Application used to perform action: | |
6442 D:\Full\path\for\xemacs.exe "%1" | |
6443 | |
6444 [x] Use DDE | |
6445 | |
6446 DDE Message: | |
6447 open("%1") | |
6448 | |
6449 Application: | |
6450 <leave blank> | |
6451 | |
6452 DDE Application Not Running: | |
6453 <leave blank> | |
6454 | |
6455 Topic: | |
6456 <leave blank> | |
6457 @end example | |
6458 | |
6459 @unnumberedsubsubsec Associating an existing file type with XEmacs. | |
6460 | |
6461 In Explorer select @samp{View->Options->File Types}. Click on the file | |
6462 type in the list and press @samp{[Edit...]}. If the file type already | |
6463 has an @samp{Open} action, double click on it and fill in the | |
6464 @samp{Action} dialog box as described above; otherwise create a new | |
6465 action. | |
6466 | |
6467 If the file type has more than one action listed, you probably want to | |
6468 make the @samp{Open} action that you just edited the default by clicking on | |
6469 it and pressing @samp{Set Default}. | |
6470 | |
6471 Note for Windows 2000 users: Under Windows 2000, get to @samp{File Types} | |
6472 using @samp{Control Panel->Folder Options->File Types}. | |
6473 | |
2459 | 6474 @unnumberedsec 5.2: Printing |
6475 | |
6476 @node Q5.2.1, Q5.2.2, Q5.1.2, External Subsystems | |
6477 @unnumberedsubsec Q5.2.1: What do I need to change to make printing work? | |
2417 | 6478 |
6479 For regular printing there are two variables that can be customized. | |
6480 | |
6481 @table @code | |
6482 @item lpr-command | |
6483 This should be set to a command that takes standard input and sends | |
6484 it to a printer. Something like: | |
6485 | |
6486 @lisp | |
6487 (setq lpr-command "lp") | |
6488 @end lisp | |
6489 | |
6490 @item lpr-switches | |
6491 This should be set to a list that contains whatever the print command | |
6492 requires to do its job. Something like: | |
6493 | |
6494 @lisp | |
6495 (setq lpr-switches '("-depson")) | |
6496 @end lisp | |
6497 @end table | |
6498 | |
6499 For postscript printing there are three analogous variables to | |
6500 customize. | |
6501 | |
6502 @table @code | |
6503 @item ps-lpr-command | |
6504 This should be set to a command that takes postscript on standard input | |
6505 and directs it to a postscript printer. | |
6506 | |
6507 @item ps-lpr-switches | |
6508 This should be set to a list of switches required for | |
6509 @code{ps-lpr-command} to do its job. | |
6510 | |
6511 @item ps-print-color-p | |
6512 This boolean variable should be set @code{t} if printing will be done in | |
6513 color, otherwise it should be set to @code{nil}. | |
6514 @end table | |
6515 | |
6516 NOTE: It is an undocumented limitation in XEmacs that postscript | |
6517 printing (the @code{Pretty Print Buffer} menu item) @strong{requires} a | |
6518 window system environment. It cannot be used outside of X11. | |
6519 | |
2459 | 6520 @node Q5.2.2, Q5.2.3, Q5.2.1, External Subsystems |
6521 @unnumberedsubsec Q5.2.2: How can I print WYSIWYG a font-locked buffer? | |
2417 | 6522 |
6523 Font-lock looks nice. How can I print (WYSIWYG) the highlighted | |
6524 document? | |
6525 | |
6526 The package @code{ps-print}, which is now included with XEmacs, provides | |
6527 the ability to do this. The source code contains complete instructions | |
6528 on its use, in | |
6529 @file{$prefix/lib/xemacs/xemacs-packages/lisp/ps-print/ps-print.el}, | |
6530 being the default location of an installed ps-print package. | |
6531 | |
2459 | 6532 @node Q5.2.3, Q5.2.4, Q5.2.2, External Subsystems |
6533 @unnumberedsubsec Q5.2.3: Getting @kbd{M-x lpr} to work with postscript printer. | |
2417 | 6534 |
6535 My printer is a Postscript printer and @code{lpr} only works for | |
6536 Postscript files, so how do I get @kbd{M-x lpr-region} and @kbd{M-x | |
6537 lpr-buffer} to work? | |
6538 | |
6539 Put something like this in your @file{init.el}: | |
428 | 6540 |
6541 @lisp | |
2417 | 6542 (setq lpr-command "a2ps") |
6543 (setq lpr-switches '("-p" "-1")) | |
6544 @end lisp | |
6545 | |
6546 If you don't use a2ps to convert ASCII to postscript (why not, it's | |
6547 free?), replace with the command you do use. Note also that some | |
6548 versions of a2ps require a @samp{-Pprinter} to ensure spooling. | |
6549 | |
2459 | 6550 @node Q5.2.4, Q5.3.1, Q5.2.3, External Subsystems |
6551 @unnumberedsubsec Q5.2.4: Can you print under MS Windows? | |
2417 | 6552 |
6553 As of 21.4, printing works on Windows, using simply | |
6554 @samp{File->Print BUFFER...}, and can be configured with | |
6555 @samp{File->Page Setup...}. | |
6556 | |
6557 Prior to 21.4, there is no built-in support, but there are some clever | |
6558 hacks out there. If you know how, please let us know and we'll put it | |
6559 here. | |
6560 | |
2459 | 6561 @unnumberedsec 5.3: Sound |
6562 | |
6563 @node Q5.3.1, Q5.3.2, Q5.2.4, External Subsystems | |
6564 @unnumberedsubsec Q5.3.1: How do I turn off the sound? | |
2417 | 6565 |
6566 Add the following line to your @file{init.el}: | |
6567 | |
6568 @lisp | |
6569 (setq bell-volume 0) | |
6570 (setq sound-alist nil) | |
6571 @end lisp | |
6572 | |
6573 That will make your XEmacs totally silent---even the default ding sound | |
6574 (TTY beep on TTY-s) will be gone. | |
6575 | |
6576 You can also change these with Customize. Select from the | |
6577 @code{Options} menu @code{Advanced | |
6578 (Customize)->Emacs->Environment->Sound->Sound...} or type @kbd{M-x | |
6579 customize @key{RET} sound @key{RET}}. | |
6580 | |
6581 | |
2459 | 6582 @node Q5.3.2, Q5.3.3, Q5.3.1, External Subsystems |
6583 @unnumberedsubsec Q5.3.2: How do I get funky sounds instead of a boring beep? | |
2417 | 6584 |
6585 Make sure your XEmacs was compiled with sound support, and then put this | |
6586 in your @file{init.el}: | |
6587 | |
6588 @lisp | |
6589 (load-default-sounds) | |
6590 @end lisp | |
6591 | |
2459 | 6592 @node Q5.3.3, Q5.3.4, Q5.3.2, External Subsystems |
6593 @unnumberedsubsec Q5.3.3: What are NAS and ESD (EsounD)? | |
6594 | |
6595 @dfn{Network Audio System} (NAS) is a client-server sound library for X. | |
6596 | |
6597 @uref{http://radscan.com/nas.html}. | |
6598 | |
3018 | 6599 To build XEmacs with it, use the @file{configure} flag |
6600 @samp{--with-sound=nas} (@samp{--enable-sound=nas} in 21.5 or later). | |
2459 | 6601 |
6602 @dfn{Enlightened Sound Daemon} (ESD or EsounD) is yet another sound system. | |
6603 | |
6604 @uref{http://www.tux.org/~ricdude/EsounD.html}. | |
6605 | |
3018 | 6606 To build XEmacs with it, use the @file{configure} flag |
6607 @samp{--with-sound=esd} (@samp{--enable-sound=esd} in 21.5 or later). | |
6608 | |
6609 You can specify support for both with a flag like | |
6610 @samp{--with-sound=nas,esd} (@samp{--enable-sound=nas,esd} in 21.5 or | |
6611 later). | |
2459 | 6612 |
6613 @node Q5.3.4, Q5.4.1, Q5.3.3, External Subsystems | |
6614 @unnumberedsubsec Q5.3.4: Sunsite sounds don't play. | |
2417 | 6615 |
6616 I'm having some trouble with sounds I've downloaded from sunsite. They | |
6617 play when I run them through @code{showaudio} or cat them directly to | |
6618 @file{/dev/audio}, but XEmacs refuses to play them. | |
6619 | |
6620 @email{gutschk@@uni-muenster.de, Markus Gutschke} writes: | |
6621 | |
6622 @quotation | |
6623 [Many of] These files have an (erroneous) 24byte header that tells about | |
6624 the format that they have been recorded in. If you cat them to | |
6625 @file{/dev/audio}, the header will be ignored and the default behavior | |
6626 for /dev/audio will be used. This happens to be 8kHz uLaw. It is | |
6627 probably possible to fix the header by piping through @code{sox} and | |
6628 passing explicit parameters for specifying the sampling format; you then | |
6629 need to perform a 'null' conversion from SunAudio to SunAudio. | |
6630 @end quotation | |
6631 | |
2459 | 6632 @unnumberedsec 5.4: Running an Interior Shell, Invoking Subprocesses |
6633 | |
6634 @node Q5.4.1, Q5.4.2, Q5.3.4, External Subsystems | |
6635 @unnumberedsubsec Q5.4.1: What is an interior shell? | |
2417 | 6636 |
6637 #### Write me. | |
6638 | |
2459 | 6639 @node Q5.4.2, Q5.4.3, Q5.4.1, External Subsystems |
6640 @unnumberedsubsec Q5.4.2: How do I start up a second shell buffer? | |
2417 | 6641 |
6642 In the @code{*shell*} buffer: | |
6643 | |
6644 @lisp | |
6645 M-x rename-buffer @key{RET} *shell-1* @key{RET} | |
6646 M-x shell RET | |
6647 @end lisp | |
6648 | |
6649 This will then start a second shell. The key is that no buffer named | |
6650 @samp{*shell*} can exist. It might be preferable to use @kbd{M-x | |
6651 rename-uniquely} to rename the @code{*shell*} buffer instead of @kbd{M-x | |
6652 rename-buffer}. | |
6653 | |
6654 Alternately, you can set the variable @code{shell-multiple-shells}. | |
6655 If the value of this variable is non-nil, each time shell mode is invoked, | |
6656 a new shell is made | |
6657 | |
2459 | 6658 @node Q5.4.3, Q5.4.4, Q5.4.2, External Subsystems |
6659 @unnumberedsubsec Q5.4.3: Telnet from shell filters too much | |
2417 | 6660 |
6661 I'm using the Emacs @kbd{M-x shell} function, and I would like to invoke | |
6662 and use a telnet session within it. Everything works fine except that | |
6663 now all @samp{^M}'s are filtered out by Emacs. Fixes? | |
6664 | |
6665 Use @kbd{M-x rsh} or @kbd{M-x telnet} to open remote sessions rather | |
6666 than doing rsh or telnet within the local shell buffer. You can also | |
6667 use @kbd{M-x ssh} to open secure remote session if you have @code{ssh} | |
6668 installed. | |
6669 | |
2459 | 6670 @node Q5.4.4, Q5.4.5, Q5.4.3, External Subsystems |
6671 @unnumberedsubsec Q5.4.4: Strange things are happening in Shell Mode. | |
2417 | 6672 |
6673 Sometimes (i.e. it's not repeatable, and I can't work out why it | |
6674 happens) when I'm typing into shell mode, I hit return and only a | |
6675 portion of the command is given to the shell, and a blank prompt is | |
6676 returned. If I hit return again, the rest of the previous command is | |
6677 given to the shell. | |
6678 | |
6679 @email{martin@@xemacs.org, Martin Buchholz} writes: | |
6680 | |
6681 @quotation | |
6682 There is a known problem with interaction between @code{csh} and the | |
6683 @code{filec} option and XEmacs. You should add the following to your | |
6684 @file{.cshrc}: | |
6685 | |
6686 @example | |
6687 if ( "$TERM" == emacs || "$TERM" == unknown ) unset filec | |
6688 @end example | |
6689 @end quotation | |
6690 | |
2995 | 6691 @node Q5.4.5, Q5.4.6, Q5.4.4, External Subsystems |
2459 | 6692 @unnumberedsubsec Q5.4.5: XEmacs complains "No such file or directory, diff" |
2417 | 6693 |
6694 or "ispell" or other commands that seem related to whatever you just | |
6695 tried to do (M-x ediff or M-$, for example). | |
6696 | |
6697 There are a large number of common (in the sense that "everyone has | |
6698 these, they really do") Unix utilities that are not provided with | |
6699 XEmacs. The GNU Project's implementations are available for Windows in | |
6700 the the Cygwin distribution (@uref{http://www.cygwin.com/}), which also | |
6701 provides a complete Unix emulation environment (and thus makes ports of | |
6702 Unix utilities nearly trivial). Another implementation is that from | |
6703 MinGW (@uref{http://www.mingw.org/msys.shtml}). If you know of others, | |
6704 please let us know! | |
6705 | |
2995 | 6706 @node Q5.4.6, Q5.5.1, Q5.4.5, External Subsystems |
6707 @unnumberedsubsec Q5.4.6: Cygwin error "fork_copy: linked dll/bss pass 0 failed" | |
6708 | |
6709 If you are getting an error like | |
6710 | |
6711 @example | |
6712 17797832 [main] bash 3468 fork_copy: linked dll/bss pass 0 failed, | |
6713 0x675000..0x6756A0, done 0, windows pid 2708, Win 32 error 487 | |
6714 bash: fork: resource temporarily unavailable | |
6715 @end example | |
6716 | |
6717 when trying to run bash using @kbd{M-x shell}, then you need to rebase | |
6718 your Cygwin DLL's. This is a known problem with Cygwin. To fix: | |
6719 | |
6720 @enumerate | |
6721 @item | |
6722 Download the @file{rebase} utility from Cygwin setup (it's under | |
6723 @samp{System}). | |
6724 @item | |
6725 Kill @strong{all} of your Cygwin processes, including all of your | |
6726 shells and all background processes. Use @code{ps -a} to list all the | |
6727 processes you need to kill. | |
6728 @item | |
6729 From a DOS prompt, run @file{ash} (@strong{not} @file{bash}, | |
6730 @file{tcsh} or @file{zsh}). Do not try to be clever and @code{exec | |
6731 /bin/ash} from your last shell; it won't work. | |
6732 @item | |
6733 Type @code{/bin/rebaseall -v}. | |
6734 @end enumerate | |
6735 | |
6736 The problem should now be fixed -- at least, until you install another | |
6737 Cygwin package with DLL's, in which case you may have to repeat the | |
6738 procedure. | |
6739 | |
2459 | 6740 @unnumberedsec 5.5: Multiple Device Support |
6741 | |
2995 | 6742 @node Q5.5.1, Q5.5.2, Q5.4.6, External Subsystems |
2459 | 6743 @unnumberedsubsec Q5.5.1: How do I open a frame on another screen of my multi-headed display? |
2417 | 6744 |
6745 Use the command @kbd{M-x make-frame-on-display}. This command is also | |
6746 on the File menu in the menubar. | |
6747 | |
6748 The command @code{make-frame-on-tty} also exists, which will establish a | |
6749 connection to any tty-like device. Opening the TTY devices should be | |
6750 left to @code{gnuclient}, though. | |
6751 | |
2459 | 6752 @node Q5.5.2, Q5.5.3, Q5.5.1, External Subsystems |
6753 @unnumberedsubsec Q5.5.2: Can I really connect to a running XEmacs after calling up over a modem? How? | |
6754 | |
6755 Yes. Use @code{gnuclient -nw}. | |
6756 | |
6757 Also see @ref{Q5.5.3, How do I disable gnuserv from opening a new frame?}. | |
6758 | |
6759 @node Q5.5.3, Q5.5.4, Q5.5.2, External Subsystems | |
6760 @unnumberedsubsec Q5.5.3: How do I disable gnuserv from opening a new frame? | |
2417 | 6761 |
6762 If you set the @code{gnuserv-frame} variable to the frame that should be | |
6763 used to display buffers that are pulled up, a new frame will not be | |
6764 created. For example, you could put | |
6765 | |
6766 @lisp | |
6767 (setq gnuserv-frame (selected-frame)) | |
428 | 6768 @end lisp |
6769 | |
2417 | 6770 early on in your @file{init.el}, to ensure that the first frame created |
6771 is the one used for your gnuserv buffers. | |
6772 | |
6773 There is an option to set the gnuserv target to the current frame. See | |
6774 @code{Options->Display->"Other Window" Location->Make Current Frame Gnuserv Target} | |
6775 | |
6776 You can also change this with Customize. Select from the | |
6777 @code{Options} menu @code{Advanced | |
6778 (Customize)->Emacs->Environment->Gnuserv->Gnuserv Frame...} or type | |
6779 @kbd{M-x customize @key{RET} gnuserv @key{RET}}. | |
6780 | |
6781 | |
2459 | 6782 @node Q5.5.4, Q5.5.5, Q5.5.3, External Subsystems |
6783 @unnumberedsubsec Q5.5.4: How do I start gnuserv so that each subsequent XEmacs is a client? | |
2417 | 6784 |
6785 Put the following in your @file{init.el} file to start the server: | |
6786 | |
6787 @lisp | |
6788 (gnuserv-start) | |
6789 @end lisp | |
6790 | |
6791 Start your first XEmacs as usual. After that, you can do: | |
6792 | |
6793 @example | |
6794 gnuclient randomfilename | |
6795 @end example | |
6796 | |
6797 from the command line to get your existing XEmacs process to open a new | |
6798 frame and visit randomfilename in that window. When you're done editing | |
6799 randomfilename, hit @kbd{C-x #} to kill the buffer and get rid of the | |
6800 frame. | |
6801 | |
6802 See also man page of gnuclient. | |
6803 | |
2459 | 6804 @node Q5.5.5, , Q5.5.4, External Subsystems |
6805 @unnumberedsubsec Q5.5.5: Is there a way to start a new XEmacs if there's no gnuserv running, and otherwise use gnuclient? | |
2417 | 6806 |
6807 @email{vroonhof@@math.ethz.ch, Jan Vroonhof} writes: | |
6808 @quotation | |
6809 Here is one of the solutions, we have this in a script called | |
6810 @file{etc/editclient.sh}. | |
6811 @example | |
6812 #!/bin/sh | |
6813 if gnuclient -batch -eval t >/dev/null 2>&1 | |
6814 then | |
6815 exec gnuclient $@{1+"$@@"@} | |
6816 else | |
6817 xemacs -unmapped -f gnuserv-start & | |
6818 until gnuclient -batch -eval t >/dev/null 2>&1 | |
6819 do | |
6820 sleep 1 | |
6821 done | |
6822 exec gnuclient $@{1+"$@@"@} | |
6823 fi | |
6824 @end example | |
6825 | |
6826 Note that there is a known problem when running XEmacs and 'gnuclient | |
6827 -nw' on the same TTY. | |
6828 @end quotation | |
6829 | |
2459 | 6830 @node Internet, Advanced, External Subsystems, Top |
6831 @unnumbered 6 Connecting to the Internet | |
6832 | |
6833 This is part 6 of the XEmacs Frequently Asked Questions list. This | |
6834 section is devoted connecting to the Internet. | |
6835 | |
6836 @menu | |
6837 6.0: General Mail and News | |
6838 * Q6.0.1:: What are the various packages for reading mail? | |
6839 * Q6.0.2:: How can I send mail? | |
6840 * Q6.0.3:: How do I get my outgoing mail archived? | |
6841 * Q6.0.4:: How can I read and/or compose MIME messages? | |
6842 * Q6.0.5:: How do I customize the From line? | |
6843 * Q6.0.6:: How do I get my MUA to filter mail for me? | |
6844 * Q6.0.7:: Remote mail reading with an MUA. | |
6845 * Q6.0.8:: An MUA gets an error incorporating new mail. | |
6846 * Q6.0.9:: Why isn't @file{movemail} working? | |
6847 * Q6.0.10:: How do I make my MUA display graphical smilies? | |
6848 * Q6.0.11:: How can I get those oh-so-neat X-Face lines? | |
6849 | |
6850 6.1: Reading Mail with VM | |
6851 * Q6.1.1:: How do I set up VM to retrieve mail from a remote site using POP? | |
6852 * Q6.1.2:: How can I get VM to automatically check for new mail? | |
6853 * Q6.1.3:: I have various addresses at which I receive mail. How can I tell VM to ignore them when doing a "reply-all"? | |
6854 * Q6.1.4:: Is there a mailing list or FAQ for VM? | |
6855 * Q6.1.5:: How do I make VM stay in a single frame? | |
6856 * Q6.1.6:: Customization of VM not covered in the manual, or here. | |
6857 | |
6858 6.2: Reading Netnews and Mail with Gnus | |
6859 * Q6.2.1:: GNUS, (ding) Gnus, Gnus 5, September Gnus, Red Gnus, Quassia Gnus, argh! | |
6860 * Q6.2.2:: How do I make Gnus stay within a single frame? | |
6861 | |
6862 6.3: FTP Access | |
6863 * Q6.3.1:: Can I edit files on other hosts? | |
6864 * Q6.3.2:: What is EFS? | |
6865 | |
6866 6.4: Web Browsing with W3 | |
6867 * Q6.4.1:: What is W3? | |
6868 * Q6.4.2:: How do I run W3 from behind a firewall? | |
6869 * Q6.4.3:: Is it true that W3 supports style sheets and tables? | |
6870 @end menu | |
6871 | |
6872 @unnumberedsec 6.0: General Mail and News | |
6873 | |
6874 @node Q6.0.1, Q6.0.2, Internet, Internet | |
6875 @unnumberedsubsec Q6.0.1: What are the various packages for reading mail? | |
6876 | |
6877 #### Write me. | |
6878 | |
6879 @node Q6.0.2, Q6.0.3, Q6.0.1, Internet | |
6880 @unnumberedsubsec Q6.0.2: How can I send mail? | |
6881 | |
6882 Under Unix and Mac OS X, the @samp{sendmail} package is normally used | |
6883 for this. | |
6884 #### Write me. | |
6885 | |
6886 Under Windows, you need to use @samp{smtpmail}, which communicates | |
6887 directly with the mail server, as there is no @file{sendmail} program | |
6888 running. To get it working, use code like the following in your | |
6889 @file{init.el} file: | |
6890 | |
6891 @lisp | |
6892 ;; Get mail working under Windows. | |
6893 (setq message-send-mail-function 'smtpmail-send-it) ; for message/Gnus | |
6894 (setq send-mail-function 'smtpmail-send-it) ; for C-x m, etc. | |
6895 ;; the following ensures that mail problems can be debugged: it logs a trace | |
6896 ;; of the SMTP conversation to *trace of SMTP session to <somewhere>*. | |
6897 (setq smtpmail-debug-info t) | |
6898 ;; Substitute your info here. | |
6899 ;(setq user-mail-address "ben@@xemacs.org") | |
6900 ;(setq user-full-name "Ben Wing") | |
6901 ;(setq smtpmail-default-smtp-server "smtp.myserver.myisp.com") | |
6902 ;; The following two aren't completely necessary but may help. | |
6903 ;(setq smtpmail-local-domain "666.com") | |
6904 ;(setq smtpmail-sendto-domain "666.com") | |
6905 ;; If your SMTP server requires a username/password to authenticate, as | |
6906 ;; many do nowadays, set them like this: | |
6907 ;(setq smtpmail-auth-credentials ; or use ~/.authinfo | |
6908 ; '(("smtp.myserver.myisp.com" 25 "USER@@SOMEWHERE" "PASSWORD"))) | |
6909 | |
6910 ;; Other possibilities for getting smtpmail to work: | |
6911 ;; | |
6912 ;; If for some reason you need to authenticate using the STARTTLS protocol | |
6913 ;; (don't look into this unless you know what it is), use | |
6914 ;; (setq smtpmail-starttls-credentials | |
6915 ;; '(("YOUR SMTP HOST" 25 "~/.my_smtp_tls.key" "~/.my_smtp_tls.cert"))) | |
6916 ;; Requires external program | |
6917 ;; ftp://ftp.opaopa.org/pub/elisp/starttls-*.tar.gz. | |
6918 ;; See http://www.ietf.org/rfc/rfc2246.txt, | |
6919 ;; http://www.ietf.org/rfc/rfc2487.txt | |
6920 @end lisp | |
6921 | |
6922 The lines you need to care about are those that set | |
6923 @code{user-mail-address}, @code{user-full-name}, | |
6924 @code{smtpmail-default-smtp-server}, and | |
6925 @code{smtpmail-auth-credentials}. You need to set these with, | |
6926 respectively, your email address, your full name, the SMTP server you | |
6927 use for outgoing mail, and the username and password you need to log | |
6928 in to your SMTP server. (If for some reason your SMTP server doesn't | |
6929 require logging in to send mail, don't uncomment this last line.) | |
6930 | |
6931 The other settings may be useful in specific cases, but you should know what | |
6932 you're doing before enabling them. | |
6933 | |
6934 @node Q6.0.3, Q6.0.4, Q6.0.2, Internet | |
6935 @unnumberedsubsec Q6.0.3: How do I get my outgoing mail archived? | |
6936 | |
6937 @lisp | |
6938 (setq mail-archive-file-name "~/outbox") | |
6939 @end lisp | |
6940 | |
6941 @node Q6.0.4, Q6.0.5, Q6.0.3, Internet | |
6942 @unnumberedsubsec Q6.0.4: How can I read and/or compose MIME messages? | |
6943 | |
6944 VM, MH-E and GNUS support MIME natively. Other MUAs may or may not | |
6945 have MIME support; refer to their documentation and other resources, | |
6946 such as web pages and mailing lists. Packages like SEMI/WEMI may be | |
6947 useful in connection with MUAs like mew and Wanderlust. | |
6948 | |
6949 @node Q6.0.5, Q6.0.6, Q6.0.4, Internet | |
6950 @unnumberedsubsec Q6.0.5: How do I customize the From line? | |
6951 | |
6952 How do I change the @samp{From:} line? I have set gnus-user-from-line | |
6953 to | |
6954 @example | |
6955 Gail Gurman <gail.gurman@@sybase.com> | |
6956 @end example | |
6957 @noindent , but XEmacs Gnus doesn't use | |
6958 it. [This should apply to all MUA's. --ed] Instead it uses | |
6959 @example | |
6960 Gail Mara Gurman @email{gailg@@deall} | |
6961 @end example | |
6962 @noindent and then complains | |
6963 that it's incorrect. Also, as you perhaps can see, my Message-ID is | |
6964 screwy. How can I change that? | |
6965 | |
6966 @email{larsi@@ifi.uio.no, Lars Magne Ingebrigtsen} writes: | |
6967 | |
6968 @quotation | |
6969 Set @code{user-mail-address} to @samp{gail.gurman@@sybase.com} or | |
6970 @code{mail-host-address} to @samp{sybase.com}. | |
6971 @end quotation | |
6972 | |
6973 @node Q6.0.6, Q6.0.7, Q6.0.5, Internet | |
6974 @unnumberedsubsec Q6.0.6: How do I get my MUA to filter mail for me? | |
6975 | |
6976 One possibility is to use procmail to split your mail before it gets to | |
6977 the MUA. I prefer this personally, since there are many strange and | |
6978 wonderful things one can do with procmail. Procmail may be found at | |
6979 @uref{http://www.procmail.org/}. | |
6980 | |
6981 Also see the Mail Filtering FAQ at: | |
6982 @iftex | |
6983 @* | |
6984 @end iftex | |
6985 @uref{http://www.faqs.org/faqs/mail/filtering-faq/}. | |
6986 | |
6987 @node Q6.0.7, Q6.0.8, Q6.0.6, Internet | |
6988 @unnumberedsubsec Q6.0.7: Remote mail reading with an MUA. | |
6989 | |
6990 My mailbox lives at the office on a big honkin server. My regular INBOX | |
6991 lives on my honkin desktop machine. I now can PPP to the office from | |
6992 home which is far from honking... I'd like to be able to read mail at | |
6993 home without storing it here and I'd like to use xemacs and the MUA at | |
6994 home... Is there a recommended setup? | |
6995 | |
6996 @email{nuspl@@nvwls.cc.purdue.edu, Joseph J. Nuspl Jr.} writes: | |
6997 | |
6998 @quotation | |
6999 There are several ways to do this. | |
7000 | |
7001 @enumerate | |
7002 @item | |
7003 Set your display to your home machine and run dxpc or one of the other X | |
7004 compressors. | |
7005 | |
7006 @item | |
7007 NFS mount your desktop machine on your home machine and modify your pop | |
7008 command on your home machine to rsh to your desktop machine and actually | |
7009 do the pop get's. | |
7010 | |
7011 @item | |
7012 Run a POP server on your desktop machine as well and do a sort of two | |
7013 tiered POP get. | |
7014 @end enumerate | |
7015 @end quotation | |
7016 | |
7017 @email{wmperry@@monolith.spry.com, William Perry} adds: | |
7018 | |
7019 @quotation | |
7020 Or you could run a pop script periodically on your desktop machine, and | |
7021 just use ange-ftp or NFS to get to your mailbox. I used to do this all | |
7022 the time back at IU. | |
7023 @end quotation | |
7024 | |
7025 @node Q6.0.8, Q6.0.9, Q6.0.7, Internet | |
7026 @unnumberedsubsec Q6.0.8: An MUA gets an error incorporating new mail. | |
7027 | |
7028 rmail and VM, and probably other MUA's as well, get new mail from | |
7029 your mailbox (called @file{/var/mail/$USER} or @file{/var/spool/mail/$USER} | |
7030 or something similar) using a program called @code{movemail}. | |
7031 This program interlocks with @code{/bin/mail} using the protocol | |
7032 defined by @code{/bin/mail}. | |
7033 | |
7034 There are various different protocols in general use, which you need to | |
3018 | 7035 specify using the @samp{--mail-locking} option |
7036 (@samp{--with-mail-locking} in 21.5 or later) to @file{configure}: | |
2459 | 7037 |
7038 @table @samp | |
7039 @item lockf | |
7040 POSIX file locking with @code{lockf()} | |
7041 @item flock | |
7042 BSD file locking with @code{flock()} | |
7043 @item dot | |
7044 To manipulate mail file @file{foo}, first create file @file{foo.lock} | |
7045 @item locking | |
7046 Use @code{locking()}, Microsoft's renamed @code{flock()} | |
7047 @item mmdf | |
7048 Use @code{lk_open()} and @code{lk_close()} as defined by the Multi-channel | |
7049 Memo Distribution Facility | |
7050 @item pop | |
7051 Retrieve mail using POP (the Post Office Protocol). This is the | |
7052 default for Cygwin/MinGW. | |
7053 @end table | |
7054 | |
7055 @strong{IF YOU DON'T USE THE FORM OF INTERLOCKING THAT IS NORMAL ON YOUR | |
7056 SYSTEM, YOU CAN LOSE MAIL!} | |
7057 | |
7058 Usually the value is correctly determined automatically: | |
7059 @file{configure} tries to detect the method in use, and defaults exist | |
7060 on systems for which this doesn't work. | |
7061 | |
7062 However, if you run into problems incorporating new mail, it may be | |
7063 because an incorrect method is being used. | |
7064 | |
7065 If your system uses the lock file protocol, and permissions are set | |
7066 so that ordinary users cannot write lock files in the mail spool | |
7067 directory, you may need to make @file{movemail} setgid to a | |
7068 suitable group such as @samp{mail}. You can use these commands (as | |
7069 root): | |
7070 | |
7071 @example | |
7072 chgrp mail movemail | |
7073 chmod 2755 movemail | |
7074 @end example | |
7075 | |
7076 If you are using the @samp{pop} locking method, @file{movemail} must | |
7077 be setuid root. | |
7078 | |
7079 Installation normally copies movemail from the build directory to an | |
7080 installation directory which is usually under @file{/usr/local/lib}. | |
7081 The installed copy of @file{movemail} is usually in the directory | |
7082 @file{/usr/local/lib/xemacs-VERSION/TARGET} (for example, | |
7083 @file{/usr/local/lib/xemacs-21.4.15/i686-pc-cygwin}). You must change | |
7084 the group and mode of the installed copy; changing the group and mode | |
7085 of the build directory copy is ineffective. | |
7086 | |
7087 @node Q6.0.9, Q6.0.10, Q6.0.8, Internet | |
7088 @unnumberedsubsec Q6.0.9: Why isn't @file{movemail} working? | |
7089 | |
7090 @xref{Q6.0.8}. | |
7091 | |
7092 Note also that older versions of Mozilla came with a @file{movemail} | |
7093 program that is @strong{not} compatible with XEmacs. Do not use it. | |
7094 Always use the @file{movemail} installed with your XEmacs. Failure to | |
7095 do so can result in lost mail. | |
7096 | |
7097 @node Q6.0.10, Q6.0.11, Q6.0.9, Internet | |
7098 @unnumberedsubsec Q6.0.10: How do I make my MUA display graphical smilies? | |
7099 For mh-e use the following: | |
7100 | |
7101 @lisp | |
7102 (add-hook 'mh-show-mode-hook '(lambda () | |
7103 (smiley-region (point-min) | |
7104 (point-max)))) | |
7105 @end lisp | |
7106 | |
7107 @email{bill@@carpenter.ORG, WJCarpenter} writes: | |
7108 For VM use the following: | |
7109 @lisp | |
7110 (autoload 'smiley-region "smiley" nil t) | |
7111 (add-hook 'vm-select-message-hook | |
7112 '(lambda () | |
7113 (smiley-region (point-min) | |
7114 (point-max)))) | |
7115 @end lisp | |
7116 | |
7117 For tm use the following: | |
7118 @lisp | |
7119 (autoload 'smiley-buffer "smiley" nil t) | |
7120 (add-hook 'mime-viewer/plain-text-preview-hook 'smiley-buffer) | |
7121 @end lisp | |
7122 | |
7123 @node Q6.0.11, Q6.1.1, Q6.0.10, Internet | |
7124 @unnumberedsubsec Q6.0.11: How can I get those oh-so-neat X-Face lines? | |
7125 | |
7126 Firstly there is an ftp site which describes X-faces and has the | |
7127 associated tools mentioned below, at | |
7128 @uref{http://ftp.cs.indiana.edu/pub/faces/}. | |
7129 | |
7130 Then the steps are | |
7131 | |
7132 @enumerate | |
7133 @item | |
7134 Create 48x48x1 bitmap with your favorite tool | |
7135 | |
7136 @item | |
7137 Convert to "icon" format using one of xbm2ikon, pbmtoicon, etc., | |
7138 and then compile the face. | |
7139 | |
7140 @item | |
7141 @example | |
7142 cat file.xbm | xbm2ikon |compface > file.face | |
7143 @end example | |
7144 | |
7145 @item | |
7146 Then be sure to quote things that are necessary for emacs strings: | |
7147 | |
7148 @example | |
7149 cat ./file.face | sed 's/\\/\\\\/g' | |
7150 @iftex | |
7151 \ @* | |
7152 @end iftex | |
7153 | sed 's/\"/\\\"/g' > ./file.face.quoted | |
7154 @end example | |
7155 | |
7156 @item | |
7157 Then set up emacs to include the file as a mail header - there were a | |
7158 couple of suggestions here---either something like: | |
7159 | |
7160 @lisp | |
7161 (setq mail-default-headers | |
7162 "X-Face: @email{Ugly looking text string here}") | |
7163 @end lisp | |
7164 | |
7165 Or, alternatively, as: | |
7166 | |
7167 @lisp | |
7168 (defun mail-insert-x-face () | |
7169 (save-excursion | |
7170 (goto-char (point-min)) | |
7171 (search-forward mail-header-separator) | |
7172 (beginning-of-line) | |
7173 (insert "X-Face:") | |
7174 (insert-file-contents "~/.face"))) | |
7175 | |
7176 (add-hook 'mail-setup-hook 'mail-insert-x-face) | |
7177 @end lisp | |
7178 @end enumerate | |
7179 | |
7180 However, 2 things might be wrong: | |
7181 | |
7182 Some versions of pbmtoicon produces some header lines that is not | |
7183 expected by the version of compface that I grabbed. So I found I had to | |
7184 include a @code{tail +3} in the pipeline like this: | |
7185 | |
7186 @example | |
7187 cat file.xbm | xbm2ikon | tail +3 |compface > file.face | |
7188 @end example | |
7189 | |
7190 Some people have also found that if one uses the @code{(insert-file)} | |
7191 method, one should NOT quote the face string using the sed script . | |
7192 | |
7193 It might also be helpful to use @email{stig@@hackvan.com, Stig's} script | |
7194 xbm2face (included in the compface distribution at XEmacs.org) to do the | |
7195 conversion. | |
7196 | |
7197 Contributors for this item: | |
7198 | |
7199 Paul Emsley, | |
7200 Ricardo Marek, | |
7201 Amir J. Katz, | |
7202 Glen McCort, | |
7203 Heinz Uphoff, | |
7204 Peter Arius, | |
7205 Paul Harrison, and | |
7206 Vegard Vesterheim | |
7207 | |
7208 @unnumberedsec 6.1: Reading Mail with VM | |
7209 | |
7210 @node Q6.1.1, Q6.1.2, Q6.0.11, Internet | |
7211 @unnumberedsubsec Q6.1.1: How do I set up VM to retrieve mail from a remote site using POP? | |
7212 | |
7213 Use @code{vm-spool-files}, like this for example: | |
7214 | |
7215 @lisp | |
7216 (setq vm-spool-files '("/var/spool/mail/wing" | |
7217 "netcom23.netcom.com:110:pass:wing:MYPASS")) | |
7218 @end lisp | |
7219 | |
7220 Of course substitute your actual password for MYPASS. | |
7221 | |
7222 @node Q6.1.2, Q6.1.3, Q6.1.1, Internet | |
7223 @unnumberedsubsec Q6.1.2: How can I get VM to automatically check for new mail? | |
7224 | |
7225 @email{turner@@lanl.gov, John Turner} writes: | |
7226 | |
7227 @quotation | |
7228 Use the following: | |
7229 | |
7230 @lisp | |
7231 (setq vm-auto-get-new-mail 60) | |
7232 @end lisp | |
7233 @end quotation | |
7234 | |
7235 @node Q6.1.3, Q6.1.4, Q6.1.2, Internet | |
7236 @unnumberedsubsec Q6.1.3: I have various addresses at which I receive mail. How can I tell VM to ignore them when doing a "reply-all"? | |
7237 | |
7238 Set @code{vm-reply-ignored-addresses} to a list, like | |
7239 | |
7240 @lisp | |
7241 (setq vm-reply-ignored-addresses | |
7242 '("wing@@nuspl@@nvwls.cc.purdue.edu,netcom[0-9]*.netcom.com" | |
7243 "wing@@netcom.com" "wing@@xemacs.org")) | |
7244 @end lisp | |
7245 | |
7246 Note that each string is a regular expression. | |
7247 | |
7248 @node Q6.1.4, Q6.1.5, Q6.1.3, Internet | |
7249 @unnumberedsubsec Q6.1.4: Is there a mailing list or FAQ for VM? | |
7250 | |
7251 A FAQ for VM exists at @uref{http://www.wonderworks.com/vm/FAQ.html}. | |
7252 | |
7253 VM has its own newsgroups gnu.emacs.vm.info and gnu.emacs.vm.bug. | |
7254 | |
7255 @node Q6.1.5, Q6.1.6, Q6.1.4, Internet | |
7256 @unnumberedsubsec Q6.1.5: How do I make VM stay in a single frame? | |
7257 | |
7258 John.@email{Cooper@@Eng.Sun.COM, John S Cooper} writes: | |
7259 | |
7260 @quotation | |
7261 @lisp | |
7262 ; Don't use multiple frames | |
7263 (setq vm-frame-per-composition nil) | |
7264 (setq vm-frame-per-folder nil) | |
7265 (setq vm-frame-per-edit nil) | |
7266 (setq vm-frame-per-summary nil) | |
7267 @end lisp | |
7268 @end quotation | |
7269 | |
7270 @node Q6.1.6, Q6.2.1, Q6.1.5, Internet | |
7271 @unnumberedsubsec Q6.1.6: Customization of VM not covered in the manual, or here. | |
7272 | |
4311 | 7273 @email{boffi@@hp735.stru.polimi.it, Giacomo Boffi} writes: |
2459 | 7274 |
7275 @quotation | |
7276 The meta-answer is to look into the file @file{vm-vars.el}, in the vm | |
7277 directory of the lisp library. | |
7278 | |
7279 @file{vm-vars.el} contains, initializes and carefully describes, with | |
7280 examples of usage, the plethora of user options that @emph{fully} | |
7281 control VM's behavior. | |
7282 | |
7283 Enter vm-vars, @code{forward-search} for toolbar, find the variables | |
7284 that control the toolbar placement, appearance, existence, copy to your | |
7285 @file{init.el} or @file{.vm} and modify according to the | |
7286 detailed instructions. | |
7287 | |
7288 The above also applies to all the various features of VM: search for | |
7289 some keywords, maybe the first you conjure isn't appropriate, find the | |
7290 appropriate variables, copy and experiment. | |
7291 @end quotation | |
7292 | |
7293 @unnumberedsec 6.2: Reading Netnews and Mail with Gnus | |
7294 | |
7295 @node Q6.2.1, Q6.2.2, Q6.1.6, Internet | |
7296 @unnumberedsubsec Q6.2.1: GNUS, (ding) Gnus, Gnus 5, September Gnus, Red Gnus, Quassia Gnus, argh! | |
7297 | |
7298 The Gnus numbering issues are not meant for mere mortals to know them. | |
7299 If you feel you @emph{must} enter the muddy waters of Gnus, visit the | |
7300 excellent FAQ, maintained by Justin Sheehy, at: | |
7301 | |
7302 @example | |
7303 @uref{http://my.gnus.org/FAQ/} | |
7304 @end example | |
7305 | |
7306 See also Gnus home page | |
7307 @example | |
7308 @uref{http://www.gnus.org/} | |
7309 @end example | |
7310 | |
7311 @node Q6.2.2, Q6.3.1, Q6.2.1, Internet | |
7312 @unnumberedsubsec Q6.2.2: How do I make Gnus stay within a single frame? | |
7313 | |
7314 The toolbar code to start Gnus opens the new frame---and it's a feature | |
7315 rather than a bug. If you don't like it, but would still like to click | |
7316 on the seemly icon, use the following code: | |
7317 | |
7318 @lisp | |
7319 (defun toolbar-news () | |
7320 (gnus)) | |
7321 @end lisp | |
7322 | |
7323 It will redefine the callback function of the icon to just call | |
7324 @code{gnus}, without all the fancy frame stuff. | |
7325 | |
7326 @unnumberedsec 6.3: FTP Access | |
7327 | |
7328 @node Q6.3.1, Q6.3.2, Q6.2.2, Internet | |
7329 @unnumberedsubsec Q6.3.1: Can I edit files on other hosts? | |
7330 | |
7331 Yes. Of course XEmacs can use any network file system (such as NFS or | |
7332 Windows file sharing) you have available, and includes some | |
7333 optimizations and safety features appropriate to those environments. | |
7334 | |
7335 It is also possible to transparently edit files via FTP, ssh, or rsh. That | |
7336 is, XEmacs makes a local copy using the transport in the background, and | |
7337 automatically refreshes the remote original from that copy when you save | |
7338 it. XEmacs also is capable of doing file system manipulations like | |
7339 creating and removing directories and files. The FTP interface is | |
7340 provided by the standard @samp{efs} package @ref{Top, EFS, , efs}. The | |
7341 ssh/rsh interface is provided by the optional @samp{tramp} package | |
7342 @ref{Top, TRAMP, , tramp}. | |
7343 | |
7344 @node Q6.3.2, Q6.4.1, Q6.3.1, Internet | |
7345 @unnumberedsubsec Q6.3.2: What is EFS? | |
7346 | |
7347 #### Write me. | |
7348 | |
7349 @unnumberedsec 6.4: Web Browsing with W3 | |
7350 | |
7351 @node Q6.4.1, Q6.4.2, Q6.3.2, Internet | |
7352 @unnumberedsubsec Q6.4.1: What is W3? | |
7353 | |
7354 W3 is an advanced graphical browser written in Emacs lisp that runs on | |
7355 XEmacs. It has full support for cascaded style sheets, and more... | |
7356 | |
7357 It has a home web page at | |
7358 @uref{http://www.cs.indiana.edu/elisp/w3/docs.html}. | |
7359 | |
7360 @node Q6.4.2, Q6.4.3, Q6.4.1, Internet | |
7361 @unnumberedsubsec Q6.4.2: How do I run W3 from behind a firewall? | |
7362 | |
7363 There is a long, well-written, detailed section in the W3 manual that | |
7364 describes how to do this. Look in the section entitled "Firewalls". | |
7365 | |
7366 @node Q6.4.3, , Q6.4.2, Internet | |
7367 @unnumberedsubsec Q6.4.3: Is it true that W3 supports style sheets and tables? | |
7368 | |
7369 Yes, and much more. W3, as distributed with the latest XEmacs is a | |
7370 full-featured web browser. | |
7371 | |
7372 @node Advanced, Other Packages, Internet, Top | |
7373 @unnumbered 7 Advanced Customization Using XEmacs Lisp | |
7374 | |
7375 This is part 7 of the XEmacs Frequently Asked Questions list. This | |
7376 section is devoted to advanced customization using XEmacs Lisp. | |
7377 | |
7378 @menu | |
2537 | 7379 7.0: Emacs Lisp and @file{init.el} |
7380 * Q7.0.1:: What version of Emacs am I running? | |
7381 * Q7.0.2:: How can I evaluate Emacs-Lisp expressions? | |
7382 * Q7.0.3:: @code{(setq tab-width 6)} behaves oddly. | |
7383 * Q7.0.4:: How can I add directories to the @code{load-path}? | |
7384 * Q7.0.5:: How to check if a lisp function is defined? | |
7385 * Q7.0.6:: Can I force the output of @code{(face-list)} to a buffer? | |
7386 | |
7387 7.1: Emacs Lisp Programming Techniques | |
7388 * Q7.1.1:: What is the difference in key sequences between XEmacs and GNU Emacs? | |
7389 * Q7.1.2:: Can I generate "fake" keyboard events? | |
7390 * Q7.1.3:: Could you explain @code{read-kbd-macro} in more detail? | |
7391 * Q7.1.4:: What is the performance hit of @code{let}? | |
7392 * Q7.1.5:: What is the recommended use of @code{setq}? | |
7393 * Q7.1.6:: What is the typical misuse of @code{setq}? | |
7394 * Q7.1.7:: I like the @code{do} form of cl, does it slow things down? | |
7395 * Q7.1.8:: I like recursion, does it slow things down? | |
7396 * Q7.1.9:: How do I put a glyph as annotation in a buffer? | |
7397 * Q7.1.10:: @code{map-extents} won't traverse all of my extents! | |
7398 * Q7.1.11:: My elisp program is horribly slow. Is there an easy way to find out where it spends time? | |
7399 | |
7400 7.2: Mathematics | |
7401 * Q7.2.1:: What are bignums, ratios, and bigfloats in Lisp? | |
7402 * Q7.2.2:: XEmacs segfaults when I use very big numbers! | |
7403 * Q7.2.3:: Bignums are really slow! | |
7404 * Q7.2.4:: Equal bignums don't compare as equal! What gives? | |
2459 | 7405 @end menu |
7406 | |
2537 | 7407 @unnumberedsec 7.0: Emacs Lisp and @file{init.el} |
2459 | 7408 |
7409 @node Q7.0.1, Q7.0.2, Advanced, Advanced | |
2537 | 7410 @unnumberedsubsec Q7.0.1: What version of Emacs am I running? |
2459 | 7411 |
7412 How can @file{init.el} determine which of the family of | |
7413 Emacsen I am using? | |
7414 | |
7415 To determine if you are currently running GNU Emacs 18, GNU Emacs 19, | |
7416 XEmacs 19, XEmacs 20, or Epoch, and use appropriate code, check out the | |
7417 example given in @file{etc/sample.init.el} (@file{etc/sample.emacs} in | |
7418 XEmacs versions prior to 21.4). There are other nifty things in there | |
7419 as well! | |
7420 | |
7421 For all new code, all you really need to do is: | |
7422 | |
7423 @lisp | |
7424 (defvar running-xemacs (string-match "XEmacs\\|Lucid" emacs-version)) | |
7425 @end lisp | |
7426 | |
2537 | 7427 @node Q7.0.2, Q7.0.3, Q7.0.1, Advanced |
7428 @unnumberedsubsec Q7.0.2: How can I evaluate Emacs-Lisp expressions? | |
2459 | 7429 |
7430 I know I can evaluate Elisp expressions from @code{*scratch*} buffer | |
7431 with @kbd{C-j} after the expression. How do I do it from another | |
7432 buffer? | |
7433 | |
7434 Press @kbd{M-:} (the default binding of @code{eval-expression}), and | |
7435 enter the expression to the minibuffer. | |
7436 | |
2537 | 7437 @node Q7.0.3, Q7.0.4, Q7.0.2, Advanced |
7438 @unnumberedsubsec Q7.0.3: @code{(setq tab-width 6)} behaves oddly. | |
2459 | 7439 |
7440 If you put @code{(setq tab-width 6)} in your | |
7441 @file{init.el} file it does not work! Is there a reason | |
7442 for this? If you do it at the EVAL prompt it works fine!! How strange. | |
7443 | |
7444 Use @code{setq-default} instead, since @code{tab-width} is | |
7445 all-buffer-local. | |
7446 | |
2537 | 7447 @node Q7.0.4, Q7.0.5, Q7.0.3, Advanced |
7448 @unnumberedsubsec Q7.0.4: How can I add directories to the @code{load-path}? | |
2459 | 7449 |
7450 Here are two ways to do that, one that puts your directories at the | |
7451 front of the load-path, the other at the end: | |
7452 | |
7453 @lisp | |
7454 ;;; Add things at the beginning of the load-path, do not add | |
7455 ;;; duplicate directories: | |
7456 (pushnew "bar" load-path :test 'equal) | |
7457 | |
7458 (pushnew "foo" load-path :test 'equal) | |
7459 | |
7460 ;;; Add things at the end, unconditionally | |
7461 (setq load-path (nconc load-path '("foo" "bar"))) | |
7462 @end lisp | |
7463 | |
4311 | 7464 @email{keithh@@nortel.ca, Keith (k.p.) Hanlan} writes: |
2459 | 7465 |
7466 @quotation | |
7467 To add directories using Unix shell metacharacters use | |
7468 @file{expand-file-name} like this: | |
7469 | |
7470 @lisp | |
7471 (push (expand-file-name "~keithh/.emacsdir") load-path) | |
7472 @end lisp | |
7473 @end quotation | |
7474 | |
2537 | 7475 @node Q7.0.5, Q7.0.6, Q7.0.4, Advanced |
7476 @unnumberedsubsec Q7.0.5: How to check if a lisp function is defined? | |
2459 | 7477 |
7478 Use the following elisp: | |
7479 | |
7480 @lisp | |
7481 (fboundp 'foo) | |
7482 @end lisp | |
7483 | |
7484 It's almost always a mistake to test @code{emacs-version} or any similar | |
7485 variables. | |
7486 | |
7487 Instead, use feature-tests, such as @code{featurep}, @code{boundp}, | |
7488 @code{fboundp}, or even simple behavioral tests, eg.: | |
7489 | |
7490 @lisp | |
7491 (defvar foo-old-losing-code-p | |
7492 (condition-case nil (progn (losing-code t) nil) | |
7493 (wrong-number-of-arguments t))) | |
7494 @end lisp | |
7495 | |
7496 There is an incredible amount of broken code out there which could work | |
7497 much better more often in more places if it did the above instead of | |
7498 trying to divine its environment from the value of one variable. | |
7499 | |
2537 | 7500 @node Q7.0.6, Q7.1.1, Q7.0.5, Advanced |
7501 @unnumberedsubsec Q7.0.6: Can I force the output of @code{(face-list)} to a buffer? | |
2459 | 7502 |
7503 It would be good having it in a buffer, as the output of | |
7504 @code{(face-list)} is too wide to fit to a minibuffer. | |
7505 | |
7506 Evaluate the expression in the @samp{*scratch*} buffer with point after | |
7507 the rightmost paren and typing @kbd{C-j}. | |
7508 | |
7509 If the minibuffer smallness is the only problem you encounter, you can | |
7510 simply press @kbd{C-h l} to get the former minibuffer contents in a | |
7511 buffer. | |
7512 | |
2537 | 7513 @unnumberedsec 7.1: Emacs Lisp Programming Techniques |
7514 | |
7515 @node Q7.1.1, Q7.1.2, Q7.0.6, Advanced | |
7516 @unnumberedsubsec Q7.1.1: What is the difference in key sequences between XEmacs and GNU Emacs? | |
2459 | 7517 |
7518 @email{clerik@@naggum.no, Erik Naggum} writes; | |
7519 | |
7520 @quotation | |
7521 Emacs has a legacy of keyboards that produced characters with modifier | |
7522 bits, and therefore map a variety of input systems into this scheme even | |
7523 today. XEmacs is instead optimized for X events. This causes an | |
7524 incompatibility in the way key sequences are specified, but both Emacs | |
7525 and XEmacs will accept a key sequence as a vector of lists of modifiers | |
7526 that ends with a key, e.g., to bind @kbd{M-C-a}, you would say | |
7527 @code{[(meta control a)]} in both Emacsen. XEmacs has an abbreviated | |
7528 form for a single key, just (meta control a). Emacs has an abbreviated | |
7529 form for the Control and the Meta modifiers to string-characters (the | |
7530 ASCII characters), as in @samp{\M-\C-a}. XEmacs users need to be aware | |
7531 that the abbreviated form works only for one-character key sequences, | |
7532 while Emacs users need to be aware that the string-character is rather | |
7533 limited. Specifically, the string-character can accommodate only 256 | |
7534 different values, 128 of which have the Meta modifier and 128 of which | |
7535 have not. In each of these blocks, only 32 characters have the Control | |
7536 modifier. Whereas @code{[(meta control A)]} differs from @code{[(meta | |
7537 control a)]} because the case differs, @samp{\M-\C-a} and @samp{\M-\C-A} | |
7538 do not. Programmers are advised to use the full common form, both | |
7539 because it is more readable and less error-prone, and because it is | |
7540 supported by both Emacsen. | |
7541 @end quotation | |
7542 | |
7543 Another (even safer) way to be sure of the key-sequences is to use the | |
7544 @code{read-kbd-macro} function, which takes a string like @samp{C-c | |
7545 <up>}, and converts it to the internal key representation of the Emacs | |
7546 you use. The function is available both on XEmacs and GNU Emacs. | |
7547 | |
2537 | 7548 @node Q7.1.2, Q7.1.3, Q7.1.1, Advanced |
7549 @unnumberedsubsec Q7.1.2: Can I generate "fake" keyboard events? | |
2459 | 7550 |
7551 I wonder if there is an interactive function that can generate | |
7552 @dfn{fake} keyboard events. This way, I could simply map them inside | |
7553 XEmacs. | |
7554 | |
7555 This seems to work: | |
7556 | |
7557 @lisp | |
7558 (defun cg--generate-char-event (ch) | |
7559 "Generate an event, as if ch has been typed" | |
7560 (dispatch-event (character-to-event ch))) | |
7561 | |
7562 ;; Backspace and Delete stuff | |
7563 (global-set-key [backspace] | |
7564 (lambda () (interactive) (cg--generate-char-event 127))) | |
7565 (global-set-key [unknown_keysym_0x4] | |
7566 (lambda () (interactive) (cg--generate-char-event 4))) | |
7567 @end lisp | |
7568 | |
2537 | 7569 @node Q7.1.3, Q7.1.4, Q7.1.2, Advanced |
7570 @unnumberedsubsec Q7.1.3: Could you explain @code{read-kbd-macro} in more detail? | |
2459 | 7571 |
7572 The @code{read-kbd-macro} function returns the internal Emacs | |
7573 representation of a human-readable string (which is its argument). | |
7574 Thus: | |
7575 | |
7576 @lisp | |
7577 (read-kbd-macro "C-c C-a") | |
7578 @result{} [(control ?c) (control ?a)] | |
7579 | |
7580 (read-kbd-macro "C-c C-. <up>") | |
7581 @result{} [(control ?c) (control ?.) up] | |
7582 @end lisp | |
7583 | |
7584 In GNU Emacs the same forms will be evaluated to what GNU Emacs | |
7585 understands internally---the sequences @code{"\C-x\C-c"} and @code{[3 | |
7586 67108910 up]}, respectively. | |
7587 | |
7588 The exact @dfn{human-readable} syntax is defined in the docstring of | |
7589 @code{edmacro-mode}. I'll repeat it here, for completeness. | |
7590 | |
7591 @quotation | |
7592 Format of keyboard macros during editing: | |
7593 | |
7594 Text is divided into @dfn{words} separated by whitespace. Except for | |
7595 the words described below, the characters of each word go directly as | |
7596 characters of the macro. The whitespace that separates words is | |
7597 ignored. Whitespace in the macro must be written explicitly, as in | |
7598 @kbd{foo @key{SPC} bar @key{RET}}. | |
7599 | |
7600 @itemize @bullet | |
7601 @item | |
7602 The special words @kbd{RET}, @kbd{SPC}, @kbd{TAB}, @kbd{DEL}, @kbd{LFD}, | |
7603 @kbd{ESC}, and @kbd{NUL} represent special control characters. The | |
7604 words must be written in uppercase. | |
7605 | |
7606 @item | |
7607 A word in angle brackets, e.g., @code{<return>}, @code{<down>}, or | |
7608 @code{<f1>}, represents a function key. (Note that in the standard | |
7609 configuration, the function key @code{<return>} and the control key | |
7610 @key{RET} are synonymous.) You can use angle brackets on the words | |
7611 @key{RET}, @key{SPC}, etc., but they are not required there. | |
7612 | |
7613 @item | |
7614 Keys can be written by their @sc{ascii} code, using a backslash followed | |
7615 by up to six octal digits. This is the only way to represent keys with | |
7616 codes above \377. | |
7617 | |
7618 @item | |
7619 One or more prefixes @kbd{M-} (meta), @kbd{C-} (control), @kbd{S-} | |
7620 (shift), @kbd{A-} (alt), @kbd{H-} (hyper), and @kbd{s-} (super) may | |
7621 precede a character or key notation. For function keys, the prefixes | |
7622 may go inside or outside of the brackets: @code{C-<down>} @equiv{} | |
7623 @code{<C-down>}. The prefixes may be written in any order: @kbd{M-C-x} | |
7624 @equiv{} @kbd{C-M-x}. | |
7625 | |
7626 Prefixes are not allowed on multi-key words, e.g., @kbd{C-abc}, except | |
7627 that the Meta prefix is allowed on a sequence of digits and optional | |
7628 minus sign: @kbd{M--123} @equiv{} @kbd{M-- M-1 M-2 M-3}. | |
7629 | |
7630 @item | |
7631 The @code{^} notation for control characters also works: @kbd{^M} | |
7632 @equiv{} @kbd{C-m}. | |
7633 | |
7634 @item | |
7635 Double angle brackets enclose command names: @code{<<next-line>>} is | |
7636 shorthand for @kbd{M-x next-line @key{RET}}. | |
7637 | |
7638 @item | |
7639 Finally, @code{REM} or @code{;;} causes the rest of the line to be | |
7640 ignored as a comment. | |
7641 @end itemize | |
7642 | |
7643 Any word may be prefixed by a multiplier in the form of a decimal number | |
7644 and @code{*}: @code{3*<right>} @equiv{} @code{<right> <right> <right>}, | |
7645 and @code{10*foo} @equiv{} | |
7646 @iftex | |
7647 @* | |
7648 @end iftex | |
7649 @code{foofoofoofoofoofoofoofoofoofoo}. | |
7650 | |
7651 Multiple text keys can normally be strung together to form a word, but | |
7652 you may need to add whitespace if the word would look like one of the | |
7653 above notations: @code{; ; ;} is a keyboard macro with three semicolons, | |
7654 but @code{;;;} is a comment. Likewise, @code{\ 1 2 3} is four keys but | |
7655 @code{\123} is a single key written in octal, and @code{< right >} is | |
7656 seven keys but @code{<right>} is a single function key. When in doubt, | |
7657 use whitespace. | |
7658 @end quotation | |
7659 | |
2537 | 7660 @node Q7.1.4, Q7.1.5, Q7.1.3, Advanced |
7661 @unnumberedsubsec Q7.1.4: What is the performance hit of @code{let}? | |
2459 | 7662 |
7663 In most cases, not noticeable. Besides, there's no avoiding | |
7664 @code{let}---you have to bind your local variables, after all. Some | |
7665 pose a question whether to nest @code{let}s, or use one @code{let} per | |
7666 function. I think because of clarity and maintenance (and possible | |
7667 future implementation), @code{let}-s should be used (nested) in a way to | |
7668 provide the clearest code. | |
7669 | |
2537 | 7670 @node Q7.1.5, Q7.1.6, Q7.1.4, Advanced |
7671 @unnumberedsubsec Q7.1.5: What is the recommended use of @code{setq}? | |
2459 | 7672 |
7673 @itemize @bullet | |
7674 @item Global variables | |
7675 | |
7676 You will typically @code{defvar} your global variable to a default | |
7677 value, and use @code{setq} to set it later. | |
7678 | |
7679 It is never a good practice to @code{setq} user variables (like | |
7680 @code{case-fold-search}, etc.), as it ignores the user's choice | |
7681 unconditionally. Note that @code{defvar} doesn't change the value of a | |
7682 variable if it was bound previously. If you wish to change a | |
7683 user-variable temporarily, use @code{let}: | |
7684 | |
7685 @lisp | |
7686 (let ((case-fold-search nil)) | |
7687 ... ; code with searches that must be case-sensitive | |
7688 ...) | |
7689 @end lisp | |
7690 | |
7691 You will notice the user-variables by their docstrings beginning with an | |
7692 asterisk (a convention). | |
7693 | |
7694 @item Local variables | |
7695 | |
7696 Bind them with @code{let}, which will unbind them (or restore their | |
7697 previous value, if they were bound) after exiting from the @code{let} | |
7698 form. Change the value of local variables with @code{setq} or whatever | |
7699 you like (e.g. @code{incf}, @code{setf} and such). The @code{let} form | |
7700 can even return one of its local variables. | |
7701 | |
7702 Typical usage: | |
7703 | |
7704 @lisp | |
7705 ;; iterate through the elements of the list returned by | |
7706 ;; `hairy-function-that-returns-list' | |
7707 (let ((l (hairy-function-that-returns-list))) | |
7708 (while l | |
7709 ... do something with (car l) ... | |
7710 (setq l (cdr l)))) | |
7711 @end lisp | |
7712 | |
7713 Another typical usage includes building a value simply to work with it. | |
7714 | |
7715 @lisp | |
7716 ;; Build the mode keymap out of the key-translation-alist | |
7717 (let ((inbox (file-truename (expand-file-name box))) | |
7718 (i 0)) | |
7719 ... code dealing with inbox ... | |
7720 inbox) | |
7721 @end lisp | |
7722 | |
7723 This piece of code uses the local variable @code{inbox}, which becomes | |
7724 unbound (or regains old value) after exiting the form. The form also | |
7725 returns the value of @code{inbox}, which can be reused, for instance: | |
7726 | |
7727 @lisp | |
7728 (setq foo-processed-inbox | |
7729 (let .....)) | |
7730 @end lisp | |
7731 @end itemize | |
7732 | |
2537 | 7733 @node Q7.1.6, Q7.1.7, Q7.1.5, Advanced |
7734 @unnumberedsubsec Q7.1.6: What is the typical misuse of @code{setq}? | |
2459 | 7735 |
7736 A typical misuse is probably @code{setq}ing a variable that was meant to | |
7737 be local. Such a variable will remain bound forever, never to be | |
7738 garbage-collected. For example, the code doing: | |
7739 | |
7740 @lisp | |
7741 (defun my-function (whatever) | |
7742 (setq a nil) | |
7743 ... build a large list ... | |
7744 ... and exit ...) | |
7745 @end lisp | |
7746 | |
7747 does a bad thing, as @code{a} will keep consuming memory, never to be | |
7748 unbound. The correct thing is to do it like this: | |
7749 | |
7750 @lisp | |
7751 (defun my-function (whatever) | |
7752 (let (a) ; default initialization is to nil | |
7753 ... build a large list ... | |
7754 ... and exit, unbinding `a' in the process ...) | |
7755 @end lisp | |
7756 | |
7757 Not only is this prettier syntactically, but it makes it possible for | |
7758 Emacs to garbage-collect the objects which @code{a} used to reference. | |
7759 | |
7760 Note that even global variables should not be @code{setq}ed without | |
7761 @code{defvar}ing them first, because the byte-compiler issues warnings. | |
7762 The reason for the warning is the following: | |
7763 | |
7764 @lisp | |
7765 (defun flurgoze nil) ; ok, global internal variable | |
7766 ... | |
7767 | |
7768 (setq flurghoze t) ; ops! a typo, but semantically correct. | |
7769 ; however, the byte-compiler warns. | |
7770 | |
7771 While compiling toplevel forms: | |
7772 ** assignment to free variable flurghoze | |
7773 @end lisp | |
7774 | |
2537 | 7775 @node Q7.1.7, Q7.1.8, Q7.1.6, Advanced |
7776 @unnumberedsubsec Q7.1.7: I like the @code{do} form of cl, does it slow things down? | |
2459 | 7777 |
7778 It shouldn't. Here is what Dave Gillespie has to say about cl.el | |
7779 performance: | |
7780 | |
7781 @quotation | |
7782 Many of the advanced features of this package, such as @code{defun*}, | |
7783 @code{loop}, and @code{setf}, are implemented as Lisp macros. In | |
7784 byte-compiled code, these complex notations will be expanded into | |
7785 equivalent Lisp code which is simple and efficient. For example, the | |
7786 forms | |
7787 | |
7788 @lisp | |
7789 (incf i n) | |
7790 (push x (car p)) | |
7791 @end lisp | |
7792 | |
7793 are expanded at compile-time to the Lisp forms | |
7794 | |
7795 @lisp | |
7796 (setq i (+ i n)) | |
7797 (setcar p (cons x (car p))) | |
7798 @end lisp | |
7799 | |
7800 which are the most efficient ways of doing these respective operations | |
7801 in Lisp. Thus, there is no performance penalty for using the more | |
7802 readable @code{incf} and @code{push} forms in your compiled code. | |
7803 | |
7804 @emph{Interpreted} code, on the other hand, must expand these macros | |
7805 every time they are executed. For this reason it is strongly | |
4905
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4759
diff
changeset
|
7806 recommended that code making heavy use of macros be compiled. A loop |
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4759
diff
changeset
|
7807 using @code{incf} a hundred times will execute considerably faster if |
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4759
diff
changeset
|
7808 compiled, and will also garbage-collect less because the macro expansion |
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4759
diff
changeset
|
7809 will not have to be generated, used, and thrown away a hundred times. |
2459 | 7810 |
7811 You can find out how a macro expands by using the @code{cl-prettyexpand} | |
7812 function. | |
7813 @end quotation | |
7814 | |
2537 | 7815 @node Q7.1.8, Q7.1.9, Q7.1.7, Advanced |
7816 @unnumberedsubsec Q7.1.8: I like recursion, does it slow things down? | |
2459 | 7817 |
7818 Yes. The Emacs byte-compiler cannot do much to optimize recursion. But | |
7819 think well whether this is a real concern in Emacs. Much of the Emacs | |
7820 slowness comes from internal mechanisms such as redisplay, or from the | |
7821 fact that it is an interpreter. | |
7822 | |
7823 Please try not to make your code much uglier to gain a very small speed | |
7824 gain. It's not usually worth it. | |
7825 | |
2537 | 7826 @node Q7.1.9, Q7.1.10, Q7.1.8, Advanced |
7827 @unnumberedsubsec Q7.1.9: How do I put a glyph as annotation in a buffer? | |
2459 | 7828 |
7829 Here is a solution that will insert the glyph annotation at the | |
7830 beginning of buffer: | |
7831 | |
7832 @lisp | |
7833 (make-annotation (make-glyph '([FORMAT :file FILE] | |
7834 [string :data "fallback-text"])) | |
7835 (point-min) | |
7836 'text | |
7837 (current-buffer)) | |
7838 @end lisp | |
7839 | |
7840 Replace @samp{FORMAT} with an unquoted symbol representing the format of | |
7841 the image (e.g. @code{xpm}, @code{xbm}, @code{gif}, @code{jpeg}, etc.) | |
7842 Instead of @samp{FILE}, use the image file name | |
7843 (e.g. | |
7844 @iftex | |
7845 @* | |
7846 @end iftex | |
7847 @file{/usr/local/lib/xemacs-21.4/etc/recycle.xpm}). | |
7848 | |
7849 You can turn this to a function (that optionally prompts you for a file | |
7850 name), and inserts the glyph at @code{(point)} instead of | |
7851 @code{(point-min)}. | |
7852 | |
2537 | 7853 @node Q7.1.10, Q7.1.11, Q7.1.9, Advanced |
7854 @unnumberedsubsec Q7.1.10: @code{map-extents} won't traverse all of my extents! | |
2459 | 7855 |
7856 I tried to use @code{map-extents} to do an operation on all the extents | |
7857 in a region. However, it seems to quit after processing a random number | |
7858 of extents. Is it buggy? | |
7859 | |
7860 No. The documentation of @code{map-extents} states that it will iterate | |
7861 across the extents as long as @var{function} returns @code{nil}. | |
7862 Unexperienced programmers often forget to return @code{nil} explicitly, | |
7863 which results in buggy code. For instance, the following code is | |
7864 supposed to delete all the extents in a buffer, and issue as many | |
7865 @samp{fubar!} messages. | |
7866 | |
7867 @lisp | |
7868 (map-extents (lambda (ext ignore) | |
7869 (delete-extent ext) | |
7870 (message "fubar!"))) | |
7871 @end lisp | |
7872 | |
7873 Instead, it will delete only the first extent, and stop right there -- | |
7874 because @code{message} will return a non-nil value. The correct code | |
7875 is: | |
7876 | |
7877 @lisp | |
7878 (map-extents (lambda (ext ignore) | |
7879 (delete-extent ext) | |
7880 (message "fubar!") | |
7881 nil)) | |
7882 @end lisp | |
7883 | |
2537 | 7884 @node Q7.1.11, Q7.2.1, Q7.1.10, Advanced |
7885 @unnumberedsubsec Q7.1.11: My elisp program is horribly slow. Is there an easy way to find out where it spends time? | |
2459 | 7886 @c New |
7887 | |
7888 @email{hniksic@@xemacs.org, Hrvoje Niksic} writes: | |
7889 @quotation | |
7890 Under XEmacs 20.4 and later you can use @kbd{M-x profile-key-sequence}, | |
7891 press a key (say @key{RET} in the Gnus Group buffer), and get the | |
7892 results using @kbd{M-x profile-results}. It should give you an idea of | |
7893 where the time is being spent. | |
7894 @end quotation | |
7895 | |
2537 | 7896 @unnumberedsec 7.2: Mathematics |
7897 | |
7898 @node Q7.2.1, Q7.2.2, Q7.1.11, Advanced | |
7899 @unnumberedsubsec Q7.2.1: What are bignums, ratios, and bigfloats in Lisp? | |
2459 | 7900 |
7901 Thanks to @email{james@@xemacs.org, Jerry James}, XEmacs 21.5.18 and | |
7902 later can use the capabilities of multiple-precision libraries that may | |
7903 be available for your platform. The GNU Multiple Precision (GMP) and | |
7904 BSD Multiple Precision (MP) libraries are partially supported. GMP | |
7905 gives you @dfn{bignums} (arbitrary precision integers), @dfn{ratios} | |
7906 (arbitrary precision fractions), and @dfn{bigfloats} (arbitrary | |
7907 precision floating point numbers). GNU MP is better-supported by XEmacs | |
7908 at the time of writing (2004-04-06). BSD MP support does not include | |
7909 ratios or bigfloats, and it throws errors that aren't understood. | |
7910 | |
7911 In most cases, bignum support should be transparent to users and Lisp | |
7912 programmers. A bignum-enabled XEmacs will automatically convert from | |
7913 fixnums to bignums and back in pure integer arithmetic, and for GNU MP, | |
7914 from floats to bigfloats. (Bigfloats must be explicitly coerced to | |
7915 other types, even if they are exactly representable by less precise | |
7916 types.) The Lisp reader and printer have been enhanced to handle | |
7917 bignums, as have the mathematical functions. Rationals (fixnums, | |
7918 bignums, and ratios) are printed using the @samp{%d}, @samp{%o}, | |
7919 @samp{%x}, and @samp{%u} format conversions. The read syntax for ratios | |
7920 is @samp{3/5}. | |
7921 | |
7922 User-visible changes in behavior include (in probable order of annoyance) | |
7923 | |
7924 @itemize | |
7925 @item | |
7926 Arithmetic can cause a segfault, depending on your MP library | |
2537 | 7927 @ref{Q7.2.2, XEmacs segfaults when I use very big numbers!}. |
2459 | 7928 |
7929 @item | |
7930 Terminology is not Common-Lisp-conforming. For example, ``integer'' for | |
7931 Emacs Lisp means what Common Lisp calls ``fixnum''. This issue is being | |
7932 investigated, but the use of ``integer'' for fixnum is pervasive and may | |
7933 cause backward-compatibility and GNU-Emacs-compatibility problems. | |
7934 | |
7935 @item | |
7936 Many operations that used to cause a range error now succeed, with | |
7937 intermediate results and return values coerced to bignums as needed. | |
7938 | |
7939 @item | |
7940 An atom with ratio read syntax now returns a number, not a symbol. | |
7941 | |
7942 @item | |
7943 The @samp{%u} format conversion will now give an error if its argument | |
7944 is negative. (Without MP, it prints a number which Lisp can't read.) | |
7945 @end itemize | |
7946 | |
7947 @emph{Surgeon General's Warning}: The automatic conversions cannot be | |
7948 disabled at runtime. New functions have been added which produce | |
7949 ratios, so there should be few surprises with type conflicts, but they | |
7950 can't be ruled out. ``Arbitrary'' precision means precisely what it | |
7951 says. If you work with extremely large numbers, your machine may | |
7952 arbitrarily decide to hand you an unpleasant surprise rather than a | |
2537 | 7953 bignum @ref{Q7.2.2, XEmacs segfaults when I use very big numbers!}. |
2459 | 7954 |
3018 | 7955 To configure with GNU MP, add @samp{--use-number-lib=gmp} |
7956 (@samp{--enable-bignum=gmp} in 21.5 or later) to your invocation of | |
7957 @file{configure}. For BSD MP, use @samp{--use-number-lib=mp} | |
7958 (@samp{--enable-bignum=mp} for 21.5). | |
2459 | 7959 |
7960 If you would like to help with bignum support, especially on BSD MP, | |
7961 please subscribe to the @uref{http://www.xemacs.org/Lists/#xemacs-beta, | |
7962 XEmacs Beta mailing list}, and book up on @file{number-gmp.h} and | |
7963 @file{number-mp.h}. Jerry has promised to write internals documentation | |
7964 eventually, but if your skills run more to analysis and documentation | |
7965 than to writing new code, feel free to fill in the gap! | |
7966 | |
7967 | |
2537 | 7968 @node Q7.2.2, Q7.2.3, Q7.2.1, Advanced |
7969 @unnumberedsubsec Q7.2.2: XEmacs segfaults when I use very big numbers! | |
2459 | 7970 |
7971 GMP by default allocates temporaries on the stack. If you run out of | |
7972 stack space, you're dead; there is no way that we know of to reliably | |
7973 detect this condition, because @samp{alloca} is typically implemented to | |
7974 be @emph{fast} rather than robust. If you just need a little more | |
7975 oomph, use a bigger stack (@emph{e.g.}, the @file{ulimit -s} command in | |
7976 bash(1)). If you want robustness at the cost of speed, configure GMP | |
7977 with @samp{--disable-alloca} and rebuild the GMP library. | |
7978 | |
7979 We do not know whether BSD MP uses @samp{alloca} or not. Please send | |
7980 any information you have as a bug report (@kbd{M-x report-xemacs-bug | |
7981 @key{RET}}), which will give us platform information. (We do know that | |
7982 BSD MP implementations vary across vendors, but how much, we do not know | |
7983 yet.) | |
7984 | |
7985 | |
2537 | 7986 @node Q7.2.3, Q7.2.4, Q7.2.2, Advanced |
7987 @unnumberedsubsec Q7.2.3: Bignums are really slow! | |
2459 | 7988 |
7989 Many Linux distributions compile all their packages for the i386, and | |
7990 this is costly. An optimized version can give you two or three orders | |
7991 of magnitude better performance for a Pentium III or IV. (Yes, really. | |
7992 See @uref{http://www.swox.com/gmp/gmp-speed.html}.) | |
7993 | |
7994 | |
2537 | 7995 @node Q7.2.4, , Q7.2.3, Advanced |
7996 @unnumberedsubsec Q7.2.4: Equal bignums don't compare as equal! What gives? | |
2459 | 7997 |
7998 Ah, Grasshopper, I see you are using @code{(eq x y)}. The Bodhisattva | |
7999 CLTL2 warned of the illusion that equal numbers would be @samp{eq}! | |
8000 Meditate on the deeper truths of @samp{eql}, in which numbers of the same | |
8001 type which have equal values compare equal, and @samp{=}, which does any | |
8002 necessary type coercions before comparing for equality. | |
8003 | |
8004 Yeah, yeah, it has always worked for integer types, because fixnums and | |
8005 characters have an immediate representation. Sorry about that; | |
8006 arbitrary precision obviously requires consing new objects because the | |
8007 objects are ``large'' and of variable size, and the definition of | |
8008 @samp{eq} does not permit different objects to compare as equal. | |
8009 | |
8010 @node Other Packages, Current Events, Advanced, Top | |
8011 @unnumbered 8 Other External Packages | |
8012 | |
8013 This is part 8 of the XEmacs Frequently Asked Questions list. This | |
8014 section is devoted to miscellaneous external packages not covered | |
8015 elsewhere in XEmacs. | |
8016 | |
8017 @menu | |
2537 | 8018 8.0: TeX |
2459 | 8019 * Q8.0.1:: Is there something better than LaTeX mode? |
8020 * Q8.0.2:: What is AUCTeX? Where do you get it? | |
8021 * Q8.0.3:: Problems installing AUCTeX. | |
8022 * Q8.0.4:: How do I turn off current chapter from AUCTeX modeline? | |
8023 | |
8024 8.1: Other Unbundled Packages | |
8025 * Q8.1.1:: Is there a reason for an Emacs package not to be included in XEmacs? | |
8026 * Q8.1.2:: Are there any Emacs Lisp Spreadsheets? | |
8027 * Q8.1.3:: Is there a MatLab mode? | |
8028 | |
8029 8.2: Environments Built Around XEmacs | |
8030 * Q8.2.1:: What are SPARCworks, EOS, and WorkShop? | |
8031 * Q8.2.2:: How do I start the Sun Workshop support in XEmacs 21? | |
8032 * Q8.2.3:: What is/was Energize? | |
8033 * Q8.2.4:: What is Infodock? | |
8034 @end menu | |
8035 | |
8036 @unnumberedsec 8.0: TeX | |
8037 | |
8038 @node Q8.0.1, Q8.0.2, Other Packages, Other Packages | |
8039 @unnumberedsubsec Q8.0.1: Is there something better than LaTeX mode? | |
2417 | 8040 |
8041 @email{dak@@fsnif.neuroinformatik.ruhr-uni-bochum.de, David Kastrup} writes: | |
8042 | |
8043 @quotation | |
8044 The standard TeX modes leave much to be desired, and are somewhat | |
2459 | 8045 leniently maintained. Serious TeX users use AUCTeX (@pxref{Q8.0.2, |
2417 | 8046 What is AUCTeX? Where do you get it?}). |
8047 @end quotation | |
8048 | |
2459 | 8049 @node Q8.0.2, Q8.0.3, Q8.0.1, Other Packages |
8050 @unnumberedsubsec Q8.0.2: What is AUCTeX? Where do you get it? | |
2417 | 8051 |
8052 AUCTeX is a complex and sophisticated editing package dedicated to TeX | |
8053 and related text formatting languages, including LaTeX and Texinfo. | |
8054 It provides support for running TeX on a file or part of a file, | |
8055 include files, and of course shortcuts for entering common TeX macros, | |
8056 LaTeX environments, etc, and for fontlock. | |
8057 | |
8058 AUCTeX is a standard package provided by XEmacs. You can get it as | |
8059 usual through the @kbd{M-x list-packages} interface. It is also | |
8060 included in the (non-Mule) SUMO package. The AUCTeX XEmacs package is | |
8061 maintained by Uwe Brauer <GET MAIL ADDRESS>. | |
8062 | |
8063 AUCTeX is extremely complicated, and its developers primarily | |
8064 use GNU Emacs. Not all features of the bleeding edge version | |
8065 of AUCTeX are immediately ported to XEmacs; if you need | |
8066 these, you may be better off getting the most recent versions | |
8067 from the GNU AUCTeX project on @uref{http://savannah.gnu.org}. | |
8068 | |
2459 | 8069 @node Q8.0.3, Q8.0.4, Q8.0.2, Other Packages |
8070 @unnumberedsubsec Q8.0.3: Problems installing AUCTeX. | |
2417 | 8071 |
8072 @email{vroonhof@@math.ethz.ch, Jan Vroonhof} writes: | |
8073 | |
8074 @quotation | |
8075 AUCTeX works fine on both stock Emacs and XEmacs has been doing so for | |
8076 a very very long time. This is mostly due to the work of | |
8077 @email{abraham@@dina.kvl.dk, Per Abrahamsen} (clap clap) in particular his @file{easymenu} | |
8078 package. Which leads to what is probably the problem... | |
8079 @end quotation | |
8080 | |
8081 Most problems with AUCTeX are one of two things: | |
8082 | |
8083 @itemize @bullet | |
8084 @item | |
8085 The TeX-lisp-directory in @file{tex-site.el} and the makefile don't | |
8086 match. | |
8087 | |
8088 Fix: make sure you configure AUCTeX properly @strong{before} installing. | |
8089 | |
8090 @item | |
8091 You have an old version of easymenu.el in your path. | |
8092 | |
8093 Fix: use @code{locate-library} and remove old versions to make sure it | |
8094 @strong{only} finds the one that came with XEmacs. | |
8095 @end itemize | |
8096 | |
2459 | 8097 @node Q8.0.4, Q8.1.1, Q8.0.3, Other Packages |
8098 @unnumberedsubsec Q8.0.4: How do I turn off current chapter from AUCTeX modeline? | |
2417 | 8099 |
8100 With AUCTeX, fast typing is hard because the current chapter, section | |
8101 etc. are given in the modeline. How can I turn this off? | |
8102 | |
8103 It's not AUCTeX, it comes from @code{func-menu} in @file{func-menu.el}. | |
8104 | |
8105 @c Add this code to your @file{init.el} to turn it off: | |
8106 @c | |
8107 @c @lisp | |
8108 @c (setq fume-display-in-modeline-p nil) | |
8109 @c @end lisp | |
8110 @c | |
8111 @c Or just add a hook to @code{TeX-mode-hook} to turn it off only for TeX | |
8112 @c mode: | |
8113 @c | |
8114 @c @lisp | |
8115 @c (add-hook 'TeX-mode-hook | |
8116 @c '(lambda () (setq fume-display-in-modeline-p nil))) | |
8117 @c @end lisp | |
8118 @c | |
8119 @email{dhughes@@origin-at.co.uk, David Hughes} writes: | |
8120 | |
8121 @quotation | |
8122 Try this; you'll still get the function name displayed in the modeline, | |
8123 but it won't attempt to keep track when you modify the file. To refresh | |
8124 when it gets out of synch, you simply need click on the @samp{Rescan | |
8125 Buffer} option in the function-menu. | |
8126 | |
8127 @lisp | |
8128 (setq-default fume-auto-rescan-buffer-p nil) | |
8129 @end lisp | |
8130 @end quotation | |
8131 | |
2459 | 8132 @unnumberedsec 8.1: Other Unbundled Packages |
8133 | |
8134 @node Q8.1.1, Q8.1.2, Q8.0.4, Other Packages | |
8135 @unnumberedsubsec Q8.1.1: Is there a reason for an Emacs package not to be included in XEmacs? | |
2417 | 8136 |
8137 The reason for an Emacs package not to be included in XEmacs is | |
8138 usually one or more of the following: | |
8139 | |
8140 @enumerate | |
8141 @item | |
8142 The package has not been ported to XEmacs. This will typically happen | |
8143 when it uses GNU-Emacs-specific features, which make it fail under | |
8144 XEmacs. | |
8145 | |
8146 Porting a package to XEmacs can range from a trivial amount of change to | |
8147 a partial or full rewrite. Fortunately, the authors of modern packages | |
8148 usually choose to support both Emacsen themselves. | |
8149 | |
8150 @item | |
8151 The package has been decided not to be appropriate for XEmacs. It may | |
8152 have an equivalent or better replacement within XEmacs, in which case | |
8153 the developers may choose not to burden themselves with supporting an | |
8154 additional package. | |
8155 | |
8156 Each package bundled with XEmacs means more work for the maintainers, | |
8157 whether they want it or not. If you are ready to take over the | |
8158 maintenance responsibilities for the package you port, be sure to say | |
8159 so---we will more likely include it. | |
8160 | |
8161 @item | |
8162 The package simply hasn't been noted by the XEmacs development. If | |
8163 that's the case, the messages like yours are very useful for attracting | |
8164 our attention. | |
8165 | |
8166 @item | |
8167 The package was noted by the developers, but they simply haven't yet | |
8168 gotten around to including/porting it. Wait for the next release or, | |
8169 even better, offer your help. It will be gladly accepted and | |
8170 appreciated. | |
8171 @end enumerate | |
8172 | |
2459 | 8173 @node Q8.1.2, Q8.1.3, Q8.1.1, Other Packages |
8174 @unnumberedsubsec Q8.1.2: Are there any Emacs Lisp Spreadsheets? | |
2417 | 8175 |
8176 Yes. Check out @dfn{dismal} (which stands for Dis' Mode Ain't Lotus) at | |
428 | 8177 @iftex |
8178 @* | |
8179 @end iftex | |
2459 | 8180 @uref{http://acs.ist.psu.edu/dismal/dismal.html}. |
8181 | |
8182 @node Q8.1.3, Q8.2.1, Q8.1.2, Other Packages | |
8183 @unnumberedsubsec Q8.1.3: Is there a MatLab mode? | |
2417 | 8184 |
8185 Yes, a matlab mode and other items are available at the | |
2459 | 8186 @uref{http://www.mathworks.com/matlabcentral/files/104/matlab.el}. |
8187 | |
8188 @unnumberedsec 8.2: Environments Built Around XEmacs | |
8189 | |
8190 @node Q8.2.1, Q8.2.2, Q8.1.3, Other Packages | |
8191 @unnumberedsubsec Q8.2.1: What are SPARCworks, EOS, and WorkShop? | |
2417 | 8192 |
8193 SPARCworks was a development environment from Sun (circa 1993-1996) | |
8194 and consisted of compilers (C, C++, FORTRAN 77, Fortran 90, Ada, and | |
8195 Pascal), a debugger, and other tools such as TeamWare (for | |
8196 configuration management), MakeTool, etc. | |
428 | 8197 |
8198 EOS is the integration of XEmacs with the SPARCworks debugger. It | |
8199 allows one to use an XEmacs frame to view code (complete with | |
8200 fontification, etc.), set breakpoints, print variables, etc., while | |
2417 | 8201 using the SPARCworks debugger. |
8202 | |
8203 EOS stands for "Era on SPARCworks"; Era stood for "Emacs Rewritten | |
8204 Again" and was the name used by Sun for its modified version of Lucid | |
8205 Emacs (later XEmacs) in the early-mid 90's. This is documented in | |
8206 more detail in the history section of the XEmacs About page. | |
8207 | |
8208 EOS was replaced around 1996 with a newer graphical development | |
8209 environment called Sun WorkShop. The current status of this is | |
8210 unknown. | |
8211 | |
2459 | 8212 @node Q8.2.2, Q8.2.3, Q8.2.1, Other Packages |
8213 @unnumberedsubsec Q8.2.2: How do I start the Sun Workshop support in XEmacs 21? | |
428 | 8214 |
8215 Add the switch ---with-workshop to the configure command when building | |
8216 XEmacs and put the following in one of your startup files | |
8217 (e.g. site-start.el or .emacs): | |
8218 | |
8219 @lisp | |
8220 (when (featurep 'tooltalk) | |
8221 (load "tooltalk-macros") | |
8222 (load "tooltalk-util") | |
8223 (load "tooltalk-init")) | |
8224 (when (featurep 'sparcworks) | |
8225 (load "sunpro-init") | |
8226 (load "ring") | |
8227 (load "comint") | |
8228 (load "annotations") | |
8229 (sunpro-startup)) | |
8230 @end lisp | |
8231 | |
8232 If you are not using the latest Workshop (5.0) you have to apply the | |
8233 following patch: | |
8234 | |
8235 @format | |
8236 --- /opt/SUNWspro/lib/eserve.el.ORIG Fri May 14 15:23:26 1999 | |
8237 +++ /opt/SUNWspro/lib/eserve.el Fri May 14 15:24:54 1999 | |
8238 @@@@ -42,7 +42,7 @@@@ | |
8239 (defvar running-xemacs nil "t if we're running XEmacs") | |
8240 (defvar running-emacs nil "t if we're running GNU Emacs 19") | |
438 | 8241 |
428 | 8242 -(if (string-match "^\\(19\\|20\\)\..*\\(XEmacs\\|Lucid\\)" emacs-version) |
8243 +(if (string-match "\\(XEmacs\\|Lucid\\)" emacs-version) | |
8244 (setq running-xemacs t) | |
8245 (setq running-emacs t)) | |
438 | 8246 @end format |
428 | 8247 |
2459 | 8248 @node Q8.2.3, Q8.2.4, Q8.2.2, Other Packages |
8249 @unnumberedsubsec Q8.2.3: What is/was Energize? | |
2417 | 8250 |
8251 The "Energize Programming System" was a C and C++ development environment | |
8252 sold by Lucid, Inc. It was the reason why Lucid Emacs, now XEmacs, was | |
8253 created in the first place. Unfortunately, Lucid went out of business in | |
8254 1994. The rights to sell it in Japan were purchased by INS | |
8255 Engineering (which briefly employed Stig Hackvan aka Jonathan | |
8256 Stigelman to work on Japanese support for XEmacs, in late 1994 and | |
8257 early 1995) and Tartan bought the rights to sell it in the rest of the | |
8258 world. However, INS is not selling Energize at this point and may or | |
8259 may not have ever done so; Tartan certainly never did. | |
8260 | |
2459 | 8261 @node Q8.2.4, , Q8.2.3, Other Packages |
8262 @unnumberedsubsec Q8.2.4: What is Infodock? | |
428 | 8263 |
660 | 8264 @uref{http://sourceforge.net/projects/infodock/, InfoDock} is an |
8265 integrated productivity toolset, mainly aimed at technical people, | |
8266 hosted at SourceForge. | |
428 | 8267 |
8268 InfoDock is built atop the XEmacs variant of GNU Emacs and so has all of | |
8269 the power of Emacs, but with an easier to use and more comprehensive | |
8270 menu-based user interface. The bottom portion of this text describes | |
8271 how it differs from XEmacs and GNU Emacs from the Free Software | |
8272 Foundation. | |
8273 | |
8274 InfoDock is aimed at people who want a free, turn-key productivity | |
8275 environment. Although InfoDock is customizable, it is not intended for | |
8276 people who like basic versions of Emacs which need to be customized | |
8277 extensively for local use; standard Emacs distributions are better for | |
8278 such uses. InfoDock is for those people who want a complete, | |
8279 pre-customized environment in one package, which they need not touch | |
8280 more than once or twice a year to update to new revisions. | |
8281 | |
8282 InfoDock is pre-built for SPARC SunOS/Solaris systems, PA-RISC HP-UX, | |
8283 and Intel Linux systems. It is intended for use on a color display, | |
8284 although most features will work on monochrome monitors. Simply unpack | |
8285 InfoDock according to the instructions in the ID-INSTALL file and you | |
8286 are ready to run. | |
8287 | |
8288 The InfoDock Manual is concise, yet sufficient as a user guide for users | |
8289 who have never used an Emacs-type editor before. For users who are | |
8290 already familiar with Emacs, it supplements the information in the GNU | |
8291 Emacs Manual. | |
8292 | |
8293 InfoDock menus are much more extensive and more mature than standard | |
8294 Emacs menus. Each menu offers a @samp{Manual} item which displays | |
8295 documentation associated with the menu's functions. | |
8296 | |
8297 @noindent | |
8298 Four types of menubars are provided: | |
8299 @enumerate | |
8300 @item | |
8301 An extensive menubar providing access to global InfoDock commands. | |
8302 @item | |
8303 Mode-specific menubars tailored to the current major mode. | |
8304 @item | |
8305 A simple menubar for basic editing to help novices get started with InfoDock. | |
8306 @item | |
8307 The standard XEmacs menubar. | |
8308 @end enumerate | |
8309 | |
8310 Most modes also include mode-specific popup menus. Additionally, region and | |
8311 rectangle popup menus are included. | |
8312 | |
8313 @samp{Hyperbole}, the everyday information manager, is a core part of | |
8314 InfoDock. This provides context-sensitive mouse keys, a rolodex-type | |
8315 contact manager, programmable hypertext buttons, and an autonumbered | |
8316 outliner with embedded hyperlink anchors. | |
8317 | |
8318 The @samp{OO-Browser}, a multi-language object-oriented code browser, is a | |
8319 standard part of InfoDock. | |
8320 | |
8321 InfoDock saves a more extensive set of user options than other Emacs | |
8322 versions. | |
8323 | |
8324 InfoDock inserts a useful file header in many file types, showing the | |
8325 author, summary, and last modification time of each file. A summary | |
8326 program can then be used to summarize all of the files in a directory, | |
8327 for easy MANIFEST file creation. | |
8328 | |
8329 Your working set of buffers is automatically saved and restored (if you | |
8330 answer yes to a prompt) between InfoDock sessions. | |
8331 | |
8332 Refined color choices for code highlighting are provided for both dark and | |
8333 light background display frames. | |
8334 | |
8335 The @kbd{C-z} key prefix performs frame-based commands which parallel the | |
8336 @kbd{C-x} key prefix for window-based commands. | |
8337 | |
8338 The Smart Menu system is included for producing command menus on dumb | |
8339 terminals. | |
8340 | |
8341 Lisp libraries are better categorized according to function. | |
8342 | |
8343 Extensions and improvements to many areas of Emacs are included, such as: | |
8344 paragraph filling, mail reading with Rmail, shell handling, outlining, code | |
8345 highlighting and browsing, and man page browsing. | |
8346 | |
8347 InfoDock questions, answers and discussion should go to the mail list | |
8348 @iftex | |
8349 @* | |
8350 @end iftex | |
8351 @email{infodock@@infodock.com}. Use | |
8352 @email{infodock-request@@infodock.com} to be added or removed from the | |
8353 list. Always include your InfoDock version number when sending help | |
8354 requests. | |
8355 | |
2459 | 8356 @node Current Events, Legacy Versions, Other Packages, Top |
8357 @unnumbered 9 What the Future Holds | |
8358 | |
8359 This is part 9 of the XEmacs Frequently Asked Questions list. This | |
611 | 8360 section will change frequently, and (in theory) should contain any |
8361 interesting items that have transpired recently. (But in practice it's | |
8362 not getting updated like this.) | |
8363 | |
8364 This section also contains descriptions of the new features in all the | |
8365 recent releases of XEmacs. For the most part, the information below is | |
8366 a synopsis of the more complete information that can be found in the | |
8367 file @file{NEWS} in the @file{etc} directory of the XEmacs distribution. | |
8368 You can view this file in XEmacs using @kbd{C-h n} or the @samp{Help} | |
8369 menu. | |
8370 | |
8371 Information on older versions of XEmacs can be find in @file{ONEWS} in | |
8372 the same directory, or @file{OONEWS} for really old versions. | |
8373 | |
428 | 8374 @menu |
2537 | 8375 9.0: Changes |
2459 | 8376 * Q9.0.1:: What new features will be in XEmacs soon? |
8377 * Q9.0.2:: What's new in XEmacs 21.4? | |
8378 * Q9.0.3:: What's new in XEmacs 21.1? | |
8379 * Q9.0.4:: What's new in XEmacs 20.4? | |
8380 * Q9.0.5:: What's new in XEmacs 20.3? | |
8381 * Q9.0.6:: What's new in XEmacs 20.2? | |
428 | 8382 @end menu |
8383 | |
2459 | 8384 @unnumberedsec 9.0: Changes |
8385 | |
8386 @node Q9.0.1, Q9.0.2, Current Events, Current Events | |
8387 @unnumberedsubsec Q9.0.1: What new features will be in XEmacs soon? | |
611 | 8388 |
2417 | 8389 #### Write me. |
428 | 8390 |
2459 | 8391 @node Q9.0.2, Q9.0.3, Q9.0.1, Current Events |
8392 @unnumberedsubsec Q9.0.2: What's new in XEmacs 21.4? | |
611 | 8393 |
8394 21.4 was the "stable" version of the 21.2 series, which was considered | |
8395 "experimental" throughout its life; thus there were no "official" | |
8396 releases at all. In essence, XEmacs is now following the "alternating" | |
8397 scheme of Linux, where at any point there are at least two different | |
8398 development branches, one "stable" and one "experimental". Periodic | |
8399 releases happen in both branches, but those in the experimental branch | |
8400 are not tested as well, and there's no guarantee they will work at all. | |
4311 | 8401 The experimental branch is open to any and all code that's acceptable |
611 | 8402 to the developers; the stable branch, however, is in general limited |
8403 only to bug fixes, and all contributions are carefully reviewed to make | |
8404 sure they will increase and not decrease stability. | |
8405 | |
8406 21.3 never existed at all; it was decided to follow the Linux scheme | |
8407 exactly, where odd-numbered series are experimental and even-numbered | |
8408 ones stable. | |
8409 | |
8410 The following lists summarizes the essential changes made in this | |
8411 version. For a fuller list, see the @file{NEWS} in the @file{etc} | |
8412 directory of the XEmacs distribution, or use @kbd{C-h n} or the | |
8413 @samp{Help} menu to view this file inside of XEmacs. | |
8414 | |
676 | 8415 @unnumberedsubsubsec User-visible changes in XEmacs 21.4 |
611 | 8416 |
8417 @itemize @bullet | |
8418 | |
8419 @item | |
8420 The delete key now deletes forward by default. | |
8421 @item | |
8422 Shifted motion keys now select text by default. | |
8423 @item | |
8424 You can now build XEmacs with support for GTK+ widget set. | |
8425 @item | |
8426 ~/.xemacs/init.el is now the preferred location for the init | |
8427 file. (XEmacs now supports a `~/.xemacs/init.el' startup file. Custom | |
8428 file will move to ~/.xemacs/custom.el.) | |
8429 @item | |
8430 Much-improved sample init.el, showing how to use many useful features. | |
8431 @item | |
8432 XEmacs support for menu accelerators has been much improved. | |
8433 @item | |
8434 Default menubar improvements. (Default menubar has many new commands and | |
8435 better organization. The font-menu is now available under MS Windows.) | |
8436 @item | |
2417 | 8437 Dialog box improvements, including a real file dialog box. (XEmacs now |
8438 has a proper file dialog box under MS Windows (and GTK)! The old | |
8439 clunky file dialog box is improved. Keyboard traversal now works | |
8440 correctly in MS Windows dialog boxes. There is a Search dialog box | |
8441 available from @samp{Edit->Find...}) | |
611 | 8442 @item |
8443 New buffer tabs. | |
8444 @item | |
8445 There is a new MS Windows installer, netinstall, ported from Cygwin. | |
8446 @item | |
8447 The subprocess quote-handling mechanism under Windows is much improved. | |
8448 @item | |
8449 Printing support now available under MS Windows. | |
8450 @item | |
8451 Selection improvements. (Kill and yank now interact with the clipboard under Windows. MS Windows support for selection is now much more robust. Motif selection support is now more correct (but slower).) | |
8452 @item | |
8453 Mail spool locking now works correctly. | |
8454 @item | |
8455 International support changes. (The default coding-priority-list is now | |
8456 safer. International keysyms are now supported under X. MS Windows | |
8457 1251 code page now supported. Czech, Thai, Cyrillic-KOI8, Vietnamese, | |
8458 Ethiopic now supported. Proper support for words in Latin 3 and Latin | |
8459 4.) | |
8460 @item | |
8461 Help buffers contain hyperlinks, and other changes. | |
8462 @item | |
8463 The modeline's text is now scrollable. | |
8464 @item | |
8465 The mouse wheel under MS Windows now functions correctly. | |
8466 @item | |
8467 Interactive searching and matching case improvements. (Incremental search will now highlight all visible matches. Interactive searches always respect uppercase characters.) | |
8468 @item | |
8469 Rectangle functions rewritten to avoid inserting extra spaces. | |
8470 @item | |
8471 New command `kill-entire-line' that always kills the entire line. | |
8472 @item | |
8473 Default values correctly stored in minibuffer histories. | |
8474 @item | |
8475 You can now create "indirect buffers", like in GNU Emacs. | |
8476 @item | |
8477 Pixel-based scrolling has been implemented. | |
8478 @item | |
8479 Operation progress can be displayed using graphical widgets. | |
8480 @item | |
8481 User names following a tilde can now be completed at file name prompts. | |
8482 @item | |
8483 XEmacs can now play sound using Enlightenment Sound Daemon (ESD). | |
8484 @item | |
8485 X-Face support is now available under MS Windows. | |
8486 @item | |
8487 The PostgreSQL Relational Database Management System is now supported. | |
8488 @item | |
8489 Indentation no longer indents comments that begin at column zero. | |
8490 @item | |
8491 Face and variable settings can have comments in Customize. | |
8492 @item | |
8493 New locations for early package hierarchies. | |
8494 @item | |
8495 The `auto-save' library has been greatly improved. | |
8496 @item | |
8497 New variable `mswindows-alt-by-itself-activates-menu'. | |
8498 @item | |
8499 Other init-file-related changes. (Init file in your home directory may be called `.emacs.el'. New command-line switches -user-init-file and -user-init-directory.) | |
8500 @item | |
8501 Etags changes. See @file{NEWS} for full details. | |
8502 @end itemize | |
8503 | |
676 | 8504 @unnumberedsubsubsec Lisp and internal changes in XEmacs 21.4 |
611 | 8505 |
8506 Not yet written. | |
8507 | |
661 | 8508 @c APA: Texi2html produces invalid HTML from an empty list of bullets! |
8509 @c Please uncomment following list when it does contain bullets. | |
8510 @c @itemize @bullet | |
8511 @c @end itemize | |
611 | 8512 |
2459 | 8513 @node Q9.0.3, Q9.0.4, Q9.0.2, Current Events |
8514 @unnumberedsubsec Q9.0.3: What's new in XEmacs 21.1? | |
611 | 8515 |
8516 21.1 was the "stable" version of "experimental" 21.0 series. | |
2459 | 8517 @xref{Q9.0.2, What's new in XEmacs 21.4?}. |
611 | 8518 |
8519 The following lists summarizes the essential changes made in this | |
8520 version. For a fuller list, see the @file{NEWS} in the @file{etc} | |
8521 directory of the XEmacs distribution, or use @kbd{C-h n} or the | |
8522 @samp{Help} menu to view this file inside of XEmacs. | |
8523 | |
676 | 8524 @unnumberedsubsubsec User-visible changes in XEmacs 21.1 |
611 | 8525 |
8526 @itemize @bullet | |
8527 | |
8528 @item | |
2459 | 8529 XEmacs is now supported under Microsoft Windows 95/98 and Windows |
2417 | 8530 NT/2000/XP operating systems. To discuss Windows-specific issues, |
8531 subscribe to the mailing list at | |
8532 @email{xemacs-winnt-request@@xemacs.org}. | |
611 | 8533 |
8534 @item | |
8535 XEmacs has been unbundled into constituent installable packages. | |
8536 | |
8537 @item | |
8538 @strong{Other notable changes}: The @samp{Options} menu has been ported to | |
8539 Custom; XEmacs now is able to choose X visuals and use private | |
8540 colormaps; You can drag the vertical divider of "horizontally" | |
8541 (side-by-side) split windows. | |
8542 | |
8543 @item | |
8544 @strong{Building changes}: XEmacs can be built with support for 31-bit Lisp | |
8545 integers and 32-bit pointers (previously, it was 28-bit integers and | |
8546 pointers); XEmacs can be built with LDAP support; @file{dir} files can be | |
8547 removed in the Info subsystem, and will be regenerated on-the-fly. | |
8548 | |
8549 @item | |
8550 @strong{New packages}: @file{imenu}, @file{popper}, @file{gdb-highlight} | |
8551 | |
8552 @item | |
8553 @strong{Package changes}: Many changes to @file{cc-mode}, @file{gnus}, | |
8554 @file{gnuclient}. See @file{NEWS} for full details. | |
8555 | |
8556 @item | |
8557 @strong{New commands, variables and functions}: | |
8558 @code{center-to-window-line} (like @code{recenter} but doesn't force a | |
8559 redisplay); variable @code{user-full-name} (customize what your full | |
8560 name looks like in mail); @kbd{M-x customize-changed-options} (customize | |
8561 options whose default values changes because you upgraded your XEmacs); | |
8562 @kbd{M-x add-log-convert} (converts an old-style ChangeLog buffer to | |
8563 new-style); @kbd{M-x zap-up-to-char} (like @code{zap-to-char} but | |
8564 doesn't delete the char searched for); commands to store, retrieve and | |
8565 increment numbers in registers, useful for macros. | |
8566 | |
8567 @item | |
8568 @strong{Changes to commands, variables, and functions}: @kbd{M-x | |
8569 query-replace} and friends operate only on the region when it's active; | |
8570 @code{echo-keystrokes} can now be a floating-point number; @kbd{M-.} | |
8571 searches exact tag matches before inexact ones; function | |
8572 @code{user-full-name} with no arguments returns the var | |
8573 @code{user-full-name}; a prefix arg to @kbd{M-:} and @kbd{C-h c} inserts | |
8574 the result in the current buffer. | |
1138 | 8575 |
611 | 8576 @item |
8577 @strong{Other changes}: Under X, new application class @samp{XEmacs}; | |
8578 byte-compilation of user-specs now works. | |
8579 | |
8580 @item | |
8581 @strong{XEmacs/Mule (internationalization) changes}: Mule support now | |
8582 works on TTY's; Egg/SJ3 input method now officially supported (Quail and | |
8583 Egg/Skk already available through LEIM since 20.3); localized Japanese | |
8584 menubars if XEmacs is built with the right support. | |
8585 | |
8586 @end itemize | |
8587 | |
676 | 8588 @unnumberedsubsubsec Lisp and internal changes in XEmacs 21.1 |
611 | 8589 |
8590 @itemize @bullet | |
8591 | |
8592 @item | |
8593 @strong{Specifier changes}: The window locale now has a higher | |
8594 precedence than the buffer locale when instantiating; new macro | |
8595 @code{let-specifier}; new specifiers | |
8596 @code{vertical-scrollbar-visible-p}, horizontal-scrollbar-visible-p', | |
8597 @code{scrollbar-on-left-p}, @code{scrollbar-on-top-p}, | |
8598 @code{vertical-divider-always-visible-p}, | |
8599 @code{vertical-divider-shadow-thickness}, | |
8600 @code{vertical-divider-line-width}, @code{vertical-divider-spacing}; | |
8601 specifiers and symbols whose value is a specifier allowed as modeline | |
8602 specifications. | |
8603 | |
8604 @item | |
8605 @strong{Frame focus changes}: @code{focus-follows-mouse} works like FSF, | |
8606 prevents any attempt to permanently change the selected frame; new | |
8607 function @code{focus-frame} sets the window system focus a frame; new | |
4905
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4759
diff
changeset
|
8608 macros @code{save-selected-frame} and @code{with-selected-frame}. |
611 | 8609 |
8610 @item | |
8611 @strong{Window function changes}: @code{select-window} now has optional | |
8612 argument @var{NORECORD} to inhibit recording a buffer change; | |
8613 @code{vertical-motion} now correctly handles optional @var{WINDOW} | |
8614 argument and has new optional argument @var{PIXELS}, to have the | |
8615 returned values be in pixels; new function | |
8616 @code{vertical-motion-pixels}; new functions | |
8617 @code{window-text-area-pixel-@{width,height,edges@}}; new functions | |
8618 @code{shrink-window-pixels} and @code{enlarge-window-pixels}; new | |
8619 function @code{window-displayed-text-pixel-height}. | |
8620 | |
8621 @item | |
8622 @strong{Other function changes}: Arithmetic comparison functions | |
8623 @code{<}, @code{>}, @code{=}, @code{/=} now accept a variable number of | |
8624 arguments; hashtables now have a consistent read/print syntax; keyword | |
8625 symbols cannot be set to a value other than themselves; @code{concat} no | |
8626 longer accepts integer arguments; new function @code{string}, like | |
8627 @code{list}, @code{vector}, etc.; new function @code{temp-directory} | |
8628 (OS-independent way to get a temp directory); @code{load-average} has | |
8629 optional argument @var{USE-FLOATS}; @code{make-event} implemented | |
8630 completely; new function @code{function-interactive} (returns a | |
8631 function's interactive spec); new functions @code{lmessage}, | |
8632 @code{lwarn} (printf-like versions of @code{display-wessage}, | |
8633 @code{display-warning}); new keyword @code{:version} to | |
8634 @code{defcustom}. | |
8635 | |
8636 @item | |
8637 @strong{Performance}: when the new GNU Malloc aka Doug Lea Malloc is | |
8638 available, it will be used (better performance on libc6 Linux systems); | |
8639 tracking line-numbers in modeline is now efficient; profiling records a | |
8640 call-count of all called functions, retrievable through | |
8641 @code{profile-call-count-results}. | |
8642 | |
8643 @item | |
8644 @strong{Startup and path searching}: code to assemble paths at startup | |
8645 rewritten for new package system; new function @code{split-path} (splits | |
8646 by @code{path-separator}); @code{Info-default-directory-list} obsolete, | |
8647 use @code{Info-directory-list} instead; site-lisp is deprecated and no | |
8648 longer on the load-path by default. | |
8649 | |
8650 @end itemize | |
8651 | |
2459 | 8652 @node Q9.0.4, Q9.0.5, Q9.0.3, Current Events |
8653 @unnumberedsubsec Q9.0.4: What's new in XEmacs 20.4? | |
611 | 8654 |
8655 XEmacs 20.4 is a bugfix release with no user-visible changes. | |
8656 @c Filled in from NEWS file of 20.5-b33 | |
8657 | |
2459 | 8658 @node Q9.0.5, Q9.0.6, Q9.0.4, Current Events |
8659 @unnumberedsubsec Q9.0.5: What's new in XEmacs 20.3? | |
428 | 8660 |
8661 XEmacs 20.3 was released in November 1997. It contains many bugfixes, | |
8662 and a number of new features, including Autoconf 2 based configuration, | |
8663 additional support for Mule (Multi-language extensions to Emacs), many | |
8664 more customizations, multiple frames on TTY-s, support for multiple info | |
8665 directories, an enhanced gnuclient, improvements to regexp matching, | |
8666 increased MIME support, and many, many synches with GNU Emacs 20. | |
8667 | |
8668 The XEmacs/Mule support has been only seriously tested in a Japanese | |
8669 locale, and no doubt many problems still remain. The support for | |
8670 ISO-Latin-1 and Japanese is fairly strong. MULE support comes at a | |
440 | 8671 price---about a 30% slowdown from 19.16. We're making progress on |
428 | 8672 improving performance and XEmacs 20.3 compiled without Mule (which is |
8673 the default) is definitely faster than XEmacs 19.16. | |
8674 | |
8675 XEmacs 20.3 is the first non-beta v20 release, and will be the | |
8676 basis for all further development. | |
8677 | |
2459 | 8678 @node Q9.0.6, , Q9.0.5, Current Events |
8679 @unnumberedsubsec Q9.0.6: What's new in XEmacs 20.2? | |
611 | 8680 |
8681 The biggest changes in 20.2 include integration of EFS (the next | |
8682 generation of ange-ftp) and AUC Tex (the Emacs subsystem that includes a | |
8683 major mode for editing Tex and LaTeX, and a lot of other stuff). Many | |
8684 bugs from 20.0 have been fixed for this release. 20.2 also contains a | |
8685 new system for customizing XEmacs options, invoked via @kbd{M-x | |
8686 customize}. | |
8687 | |
8688 XEmacs 20.2 is the development release (20.0 was beta), and is no longer | |
8689 considered unstable. | |
8690 | |
8691 For older news, see the file @file{ONEWS} in the @file{etc} directory of | |
8692 the XEmacs distribution. | |
428 | 8693 |
5028
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8694 @node Legacy Versions, Bleeding Edge, Current Events, Top |
2459 | 8695 @unnumbered 10 New information about old XEmacsen |
8696 | |
8697 This is part 10 of the XEmacs Frequently Asked Questions list. It will | |
1495 | 8698 occasionally be updated to reflect new information about versions which |
8699 are no longer being revised by the XEmacs Project. The primary purpose | |
8700 is advice on compatibility of older XEmacsen with new packages and | |
8701 updated versions of packages, but bug fixes (which will not be applied | |
8702 to released XEmacsen, but users can apply themselves) are also accepted. | |
8703 | |
8704 @menu | |
2537 | 8705 10.0: XEmacs 21.1 |
2459 | 8706 * Q10.0.1:: Gnus 5.10 won't display smileys in XEmacs 21.1. |
2559 | 8707 * Q10.0.2:: XEmacs won't start on Windows in XEmacs 21.1. |
1495 | 8708 @end menu |
8709 | |
2459 | 8710 @unnumberedsec 10.0: XEmacs 21.1 |
8711 | |
2559 | 8712 @node Q10.0.1, Q10.0.2, Legacy Versions, Legacy Versions |
2459 | 8713 @unnumberedsubsec Q10.0.1: Gnus 5.10 won't display smileys in XEmacs 21.1. |
1495 | 8714 |
8715 @email{eeide@@cs.utah.edu, Eric Eide} wrote: | |
8716 | |
8717 @quotation | |
8718 Previously I wrote: | |
8719 | |
8720 Eric> Summary: with Gnus 5.10.1 in XEmacs 21.1.14, I don't see | |
8721 Eric> any smileys :-(. | |
8722 | |
8723 After a bit of sleuthing, I discovered the essence of the problem. | |
8724 For me, the form: | |
8725 | |
8726 @lisp | |
8727 (with-temp-buffer | |
8728 (insert-file-contents "foo.xpm") | |
8729 (buffer-string)) | |
8730 @end lisp | |
8731 | |
8732 returns the empty string. This is because something somewhere | |
8733 replaces the XPM data with a glyph --- I haven't figured out where | |
8734 this occurs. | |
8735 @end quotation | |
8736 | |
8737 @email{kyle_jones@@wonderworks.com, Kyle Jones} replies: | |
8738 | |
8739 @quotation | |
8740 Do this: | |
8741 | |
8742 @lisp | |
8743 (setq format-alist nil) | |
8744 @end lisp | |
8745 | |
8746 The image-mode stuff is gone from format-alist in the 21.4 | |
8747 branch, praise be. | |
8748 @end quotation | |
8749 | |
2559 | 8750 @node Q10.0.2, , Q10.0.1, Legacy Versions |
8751 @unnumberedsubsec Q10.0.2: XEmacs won't start on Windows in XEmacs 21.1. | |
8752 | |
8753 XEmacs relies on a process called "dumping" to generate a working | |
8754 executable. Under MS-Windows this process effectively fixes the memory | |
8755 addresses of information in the executable. When XEmacs starts up it tries | |
8756 to reserve these memory addresses so that the dumping process can be | |
8757 reversed -- putting the information back at the correct addresses. | |
8758 Unfortunately some .DLLs (for instance the soundblaster driver) occupy | |
8759 memory addresses that can conflict with those needed by the dumped XEmacs | |
8760 executable. In this instance XEmacs will fail to start without any | |
8761 explanation. Note that this is extremely machine specific. | |
8762 | |
8763 21.1.10 includes a fix for this that makes more intelligent guesses | |
8764 about which memory addresses will be free, and this should cure the | |
8765 problem for most people. 21.4 implements "portable dumping", which | |
8766 eliminates the problem altogether. We recommend you use the 21.4 | |
8767 binaries, but you can use the 21.1 binaries if you are very paranoid | |
8768 about stability. @xref{Q1.1.2, Are binaries available?}. | |
8769 | |
5028
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8770 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8771 @node Bleeding Edge, , Legacy Versions, Top |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8772 @unnumbered 10 Working with XEmacs Source Code Repositories. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8773 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8774 This is part 11 of the XEmacs Frequently Asked Questions list. The |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8775 primary purpose is advice on use of the version control systems used to |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8776 keep the history of XEmacs development. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8777 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8778 @menu |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8779 11.0: The XEmacs repositories |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8780 * Q11.0.1:: Where is the most recent XEmacs development code? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8781 * Q11.0.2:: Where is the most recent XEmacs stable code? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8782 * Q11.0.3:: Where is the most recent XEmacs package code? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8783 * Q11.0.4:: Why isn't @var{package} available? and what to do about it. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8784 * Q11.0.5:: How do I get commit access? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8785 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8786 11.1: Working with CVS |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8787 * Q11.1.1:: How do I keep cool using CVS? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8788 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8789 11.2: Working with Mercurial |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8790 * Q11.2.1:: What is Mercurial? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8791 * Q11.2.2:: Where do I get Mercurial? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8792 * Q11.2.3:: Do I really have to waste space on history? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8793 * Q11.2.4:: @code{hg diff} gives bizarre output. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8794 * Q11.2.5:: How do I recover from a bad commit? (I already pushed.) |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8795 * Q11.2.6:: How do I recover from a bad commit? (I haven't pushed yet.) |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8796 * Q11.2.7:: Testing patches with Mercurial Queues. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8797 @end menu |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8798 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8799 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8800 @node Q11.0.1, Q11.0.2, Bleeding Edge, Bleeding Edge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8801 @unnumberedsubsec Where is the most recent XEmacs development code? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8802 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8803 The most recent XEmacs @emph{development} code is kept in a Mercurial |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8804 repository, hosted by the Debian project. The read-only URL, for |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8805 anybody who doesn't intend to push upstream directly, is |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8806 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8807 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8808 http://hg.debian.org/hg/xemacs/xemacs |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8809 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8810 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8811 The read-write URL for committers is |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8812 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8813 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8814 ssh://sperber-guest@@hg.debian.org//hg/xemacs/xemacs |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8815 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8816 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8817 Yes, Virginia, that doubled slash is correct. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8818 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8819 @xref{Q11.0.5, How do I get commit access?}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8820 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8821 @xref{Q11.2.1, What is Mercurial?}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8822 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8823 @node Q11.0.2, Q11.0.3, Q11.0.1, Bleeding Edge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8824 @unnumberedsubsec Where is the most recent XEmacs stable code? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8825 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8826 The most recent XEmacs @emph{stable} code is kept in a Mercurial |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8827 repository, hosted by the Debian project. The read-only URL is |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8828 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8829 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8830 http://hg.debian.org/hg/xemacs/xemacs-21.4 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8831 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8832 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8833 If you're @emph{not} Vin, you don't need commit access. If you |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8834 @emph{are} Vin, you shouldn't need to refer to this FAQ. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8835 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8836 @xref{Q11.2.1, What is Mercurial?}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8837 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8838 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8839 @node Q11.0.3, Q11.0.4, Q11.0.2, Bleeding Edge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8840 @unnumberedsubsec Where is the most recent XEmacs package code? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8841 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8842 The most recent XEmacs @emph{packages} code is kept in a CVS |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8843 repository, hosted by the Debian project. The read-only @code{CVSROOT}, |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8844 for anybody who doesn't intend to push upstream directly, is |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8845 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8846 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8847 CVSROOT=:pserver:anonymous@@cvs.alioth.debian.org:/cvsroot/xemacs |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8848 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8849 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8850 The read-write @code{CVSROOT} for committers is |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8851 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8852 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8853 CVSROOT=:ext:@var{aliothuser}@@cvs.alioth.debian.org:/cvsroot/xemacs |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8854 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8855 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8856 where @var{aliothuser} is your account on @code{alioth.debian.org}. Then |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8857 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8858 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8859 cvs checkout packages |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8860 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8861 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8862 as usual. For more information, see |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8863 @uref{http://www.xemacs.org/Develop/cvsaccess.html, XEmacs CVS Archive} |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8864 on the website. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8865 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8866 @xref{Q11.1.1, How do I stay cool using CVS?}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8867 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8868 @xref{Q11.0.5, How do I get commit access?}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8869 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8870 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8871 @node Q11.0.4, Q11.0.5, Q11.0.3, Bleeding Edge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8872 @unnumberedsubsec Why isn't @var{package} available? and what to do about it. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8873 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8874 If a package isn't available from the Packages repository, probably |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8875 nobody has shown enough interest to add it yet. (Occasionally, there is |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8876 a better package already in the XEmacs repository, of course.) |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8877 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8878 The first step is to ask about it, and propose addition, on |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8879 @email{xemacs-beta@@xemacs.org, the XEmacs Contributors list}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8880 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8881 Most regular XEmacs contributors already shoulder primary responsibility |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8882 for several packages, and contribute to maintenance of the rest, so you |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8883 are unlikely to get a massively enthusiastic response unless you |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8884 volunteer to become the maintainer of the version packaged for XEmacs |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8885 yourself. The duties are not terribly onerous if you're an active user |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8886 of the package @ref{(xemacs-devguide)XEmacs Package Maintainer}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8887 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8888 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8889 @node Q11.0.5, Q11.1.1, Q11.0.4, Bleeding Edge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8890 @unnumberedsubsec How do I get commit access? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8891 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8892 To get commit access to XEmacs code, write to |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8893 @email{xemacs-review@@xemacs.org, the XEmacs Review Board} and request |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8894 it. Once approved, for the development code, you also need to send |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8895 @email{mike@@xemacs.org, Michael Sperber} your SSH v2 RSA key (Alioth |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8896 policy; v1 and DSA keys aren't acceptable). A CC to |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8897 @email{xemacs-services@@xemacs.org, the XEmacs Services team} is a good |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8898 idea, although not absolutely necessary. You should also get an Alioth |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8899 account so that you can publish branches for review. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8900 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8901 For packages code, you must get an Alioth account. Send your account |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8902 name information to @email{xemacs-services@@xemacs.org, the XEmacs |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8903 Services team}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8904 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8905 The stable repository is gated; only the gatekeeper (currently Vin |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8906 Shelton) has commit access. Patches for the stable repository should be |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8907 submitted to @email{xemacs-patches@@xemacs.org, XEmacs Patches}, as usual. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8908 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8909 @uref{http://www.xemacs.org/Develop/hgaccess.html, XEmacs Mercurial Archive} |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8910 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8911 @uref{http://www.xemacs.org/Develop/cvsaccess.html, XEmacs CVS Archive} |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8912 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8913 @xref{Q11.1.1, How do I stay cool using CVS?}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8914 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8915 @xref{Q11.2.1, What is Mercurial?}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8916 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8917 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8918 @node Q11.1.1, Q11.2.1, Q11.0.5, Bleeding Edge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8919 @unnumberedsubsec How do I keep cool using CVS? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8920 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8921 You don't. CVS is just basically and in detail @emph{un}-cool. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8922 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8923 What would be really cool is if you would help us out in moving the |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8924 packages repository to Mercurial. Volunteer on |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8925 @email{xemacs-beta@@xemacs.org, the XEmacs Contributors list}. What's |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8926 needed is to figure out how to provide a one step checkout for the whole |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8927 package hierarchy, while restricting commits to one package at a time. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8928 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8929 For help using CVS, Google or ask on @email{xemacs-beta@@xemacs.org}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8930 Please update this FAQ with one or two of the best references you find. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8931 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8932 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8933 @node Q11.2.1, Q11.2.2, Q11.1.1, Bleeding Edge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8934 @unnumberedsubsec What is Mercurial? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8935 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8936 Mercurial is a @dfn{distributed version control system}, or DVCS. This |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8937 means that versioning information can be easily exchanged between |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8938 different lines of development, even if located on different hosts. In |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8939 the older @dfn{centralize version control system} model, when you |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8940 @dfn{commit} a change, it is immediately reflected in the public |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8941 repository. In a DVCS, each user has a @dfn{local repository}, and |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8942 the commit operation creates a version in that repository. To |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8943 communicate with the public repository, a separate @dfn{push} operation |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8944 must be executed. The DVCS model is more appropriate for open source |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8945 development. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8946 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8947 @itemize |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8948 @item |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8949 The VCS model mirrors the development organization, where developers |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8950 tend to work independently or in very small groups. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8951 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8952 @item |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8953 Users without commit access can conveniently manage their local changes. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8954 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8955 @item |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8956 Developers can work, and commit changes, while disconnected from the |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8957 Internet. Then they merge and push their changes later. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8958 @end itemize |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8959 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8960 Use of a DVCS does require some changes in workflow, but the XEmacs |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8961 developers consider that inconvenience to be far more than balanced by |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8962 the advantages. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8963 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8964 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8965 @node Q11.2.2, Q11.2.3, Q11.2.1, Bleeding Edge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8966 @unnumberedsubsec Where do I get Mercurial? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8967 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8968 Most OS distributions (including add-on distributions like |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8969 @uref{http://www.cygwin.com/, Cygwin} and |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8970 @uref{http://www.macports.org/, MacPorts}) include Mercurial packages. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8971 Of course, you can get the source distribution, as well as pre-built |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8972 packages for most major platforms, from |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8973 @uref{http://mercurial.selenic.com/wiki/, the Mercurial developers}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8974 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8975 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8976 @node Q11.2.3, Q11.2.4, Q11.2.2, Bleeding Edge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8977 @unnumberedsubsec Do I really have to waste space on history? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8978 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8979 Yes, you do. It's really not that much, though. In one of my current |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8980 workspaces, I see |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8981 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8982 @table @code |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8983 @item XEmacs source files (and other cruft, such as editor backups) |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8984 115464KB |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8985 @item Build products |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8986 49676 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8987 @item Mercurial control files and history |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8988 25644 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8989 @end table |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8990 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8991 That really does include all of the history available in the main XEmacs |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8992 development branch, and the build products are near twice the size of |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8993 all of the Mercurial-specific information. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8994 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8995 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8996 @node Q11.2.4, Q11.2.5, Q11.2.3, Bleeding Edge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8997 @unnumberedsubsec @code{hg diff} gives bizarre output. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8998 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
8999 You may see an unreasonable diff (often large) that doesn't seem to |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9000 reflect your work. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9001 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9002 This is usually due to using @code{hg diff} on a @dfn{merge commit}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9003 That means the commit has multiple parents, and joins together two lines |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9004 of development that occured concurrently. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9005 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9006 You're diffing against the "wrong" one; try the other one. You get the |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9007 relevent revision number or ID from @code{hg log}. In more detail: |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9008 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9009 When there is a merge in Mercurial, it will often be the case that |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9010 one of the parents is the immediate predecessor of the merge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9011 commit. @code{hg log} will report something like |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9012 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9013 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9014 changeset: 4789:56049bea9231 # revision D, below |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9015 parent: 4788:5cca06f930ea # your commit |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9016 parent: 4787:6e6f7b79c1fc # diff against this |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9017 user: you (or somebody else) |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9018 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9019 changeset: 4788:5cca06f930ea # revision B, below |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9020 parent: 4760:217abcf015c4 # revision A, below |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9021 user: you |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9022 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9023 changeset: 4787:6e6f7b79c1fc # revision C, below |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9024 parent: 4786:d6cfba1cc388 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9025 user: somebody else |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9026 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9027 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9028 Note that the divergence took place a long time ago (r4760). |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9029 It's natural to diff against (tip - 1), in the example above, |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9030 @code{hg diff -r 4788}. But this will give unexpected output! |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9031 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9032 A picture of this history looks something like |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9033 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9034 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9035 B --- D |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9036 / / |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9037 A ... C |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9038 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9039 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9040 where A is the common ancestor, B is the commit you did, C is the |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9041 mainline at the time of the merge, and D is the merge commit. The |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9042 three dots between A and C can represent many commits, and a lot |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9043 of work. Given no conflicts in the merge, @code{hg diff -r C -r D} is |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9044 the same as @code{hg diff -r A -r B}, @emph{i.e.}, it shows your work. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9045 Similarly, @code{hg diff -r B -r D} is the same as |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9046 @code{hg diff -r A -r C}. This latter diff is likely to be quite large, |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9047 and it doesn't show your work. Unfortunately, that is the typical |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9048 result of diffing against the "previous" commit. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9049 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9050 @node Q11.2.5, Q11.2.6, Q11.2.4, Bleeding Edge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9051 @unnumberedsubsec How do I recover from a bad commit? (I already pushed.) |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9052 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9053 Once upon a time, an XEmacs developer wrote: |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9054 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9055 > GAAAAK! What's the best way to restore ChangeLog and its history? |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9056 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9057 He had just inadvertantly pushed a commit which deleted |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9058 @file{src/ChangeLog}! The history is still there, not to worry. (In |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9059 this case, another developer had restored src/ChangeLog already.) The |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9060 best way depends on a number of things. First, let's look at the log |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9061 and the state of the DAG (the graph of commits). Here's the log, |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9062 formatted somewhat differently from the usual output for compactness. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9063 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9064 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9065 5025 anne Restore src/ChangeLog. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9066 5024 barb merge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9067 parents: 5023 5010 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9068 5023 barb Error-checking. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9069 5020 barb merge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9070 parents: 5019 5006 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9071 5019 barb Fix non-Mule build. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9072 5011 barb Some internals-manual updates. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9073 parents: 5002 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9074 5010 cary Windows fixes for Visual Studio 6. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9075 parents: 5008 5009 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9076 5009 cary Miscellaneous small fixes to Windows VS6 build. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9077 parents: 5006 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9078 5008 dana Add license information. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9079 5007 dana Relicense emodules.texi. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9080 5006 cary Instantiate compile fix for nt.c. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9081 5005 edna Cast correctly. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9082 5003 edna #'union doesn't preserve relative order |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9083 5002 barb Fix some compile bugs. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9084 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9085 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9086 (The gaps at 5003...5005, 5011...5019, and 5020...5023 are filled with |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9087 sequences of commits by the same developers.) Let's visualize this as a |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9088 graph. Time increases to the right, the leading "50" is omitted for |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9089 brevity, and the dotted links indicate that several irrelevant commits |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9090 were omitted, also for brevity. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9091 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9092 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9093 ,------ 09 -----. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9094 / \ |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9095 02 --- 03 ... 05 --- 06 --- 07 --- 08 --- 10 --- 24 --- 25 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9096 \ \ / |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9097 `-- 11 ... 19 -------`-- 20 ... 23 ---------' |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9098 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9099 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9100 The "problem commit" is 5010, which merges 5008 with 5009, and somehow |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9101 managed to "lose" @file{src/ChangeLog}. The unobvious consequence is |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9102 that, although the @emph{other} changes made in 5007 and 5008 were |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9103 successfully merged and are present in 5010, the log entry made by |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9104 Dana for 5008 "just disappeared". (The log entry for 5007 is in a |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9105 different @file{ChangeLog}, so it's safe.) |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9106 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9107 @subsubheading The safe and simple way for Cary |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9108 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9109 To recover state file-by-file (also for whole directories), use @code{hg |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9110 revert}. This does not change the "current" version, @emph{i.e.}, the |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9111 commit that will be the parent for your next commit. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9112 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9113 If it's not a merge commit, it's simple to restore the ChangeLog. It's |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9114 best to do it before making any other commits in your own workspace, and |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9115 before pulling in new commits from others. If there are a lot of such |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9116 commits in your workspace already, ask for help. But in this case, |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9117 there was no such problem. Just |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9118 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9119 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9120 hg revert -r 5009 src/ChangeLog |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9121 # Add Dana's log entry by hand. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9122 hg commit -m "Restore src/ChangeLog." |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9123 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9124 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9125 5009 is the revision id of the most recent commit that had the correct |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9126 version of the file. You get that from the "parent" field in @code{hg |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9127 log}, or from the DAG browser (@code{hg view}, requires @code{hgk} |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9128 extension enabled). |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9129 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9130 Alternatively, Cary could revert from 5008. This would leave her with |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9131 @emph{her} log entry for 5009 missing, and that would have to be added |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9132 by hand. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9133 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9134 Note that in the actual history, Cary didn't realize that Dana's log |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9135 went missing, so Anne had to pick up the slack in 5025. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9136 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9137 @subsubheading Recovery by another developer |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9138 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9139 Another way to recover earlier state is with @code{hg checkout} (or |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9140 @code{hg update}, which is another way to spell the same command). This |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9141 changes the version that hg sees as "current", as well as reverting the |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9142 workspace. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9143 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9144 A common scenario is that another developer, such as Barb in the log |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9145 above, was already working on @file{src/ChangeLog}, saves her copy, then |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9146 tries to merge. She would then get a modify/delete conflict. It's |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9147 tempting to just resolve that in favor of keeping the file, and commit. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9148 This often works, but an alternative way uses the VCS: |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9149 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9150 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9151 hg checkout 5010 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9152 hg revert -r 5009 src/ChangeLog |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9153 # Add Dana's log entry by hand. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9154 hg commit -m "Restore src/ChangeLog." |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9155 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9156 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9157 to get the same effect as described above, then |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9158 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9159 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9160 hg merge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9161 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9162 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9163 (making her changes "float to the top" of the log) or |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9164 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9165 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9166 hg checkout 5023 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9167 hg merge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9168 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9169 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9170 (putting the Cary's branch at the top of the log). This assumes she has |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9171 no other heads in her workspace. If she does have other heads she would |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9172 have to use an explicit argument to @code{hg merge}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9173 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9174 Note that in the actual history, Barb didn't realize that Dana's log |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9175 went missing, so Anne (or somebody) had to pick up the slack in 5025. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9176 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9177 @subsubheading The hard but accurate way |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9178 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9179 Suppose Barb did @code{hg pull -u}, but notices the problem before |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9180 resolving conflicts and committing the merge. Assume Barb was fully committed |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9181 before doing @code{hg pull -u}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9182 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9183 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9184 # Restore the ChangeLog, "covering up" the broken commit. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9185 # Check out Cary's head. This nukes the merged files in the workspace, |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9186 # but @emph{the history and versions in Barb's rev. 5023 are preserved |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9187 # in the repository}. The -C is necessary to overwrite files. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9188 hg checkout -C 5010 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9189 hg revert -r 5009 src/ChangeLog |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9190 # Merge Dana's branch (yes, again). |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9191 # The repeated merge outside of src/ChangeLog should resolve to a |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9192 # no-op, but the ChangeLog probably conflicts. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9193 # The -f is needed because revert leaves uncommitted changes. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9194 hg merge -f 5008 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9195 hg commit -m "Re-merge Dana's branch to recover her logs." |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9196 # Merge Barb's work. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9197 # If Barb has only two heads, which seems likely, the argument to |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9198 # merge is optional. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9199 hg merge 5023 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9200 hg commit -m merge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9201 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9202 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9203 Visualizing this with a graph, we have: |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9204 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9205 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9206 ,------ 09 -----. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9207 / \ |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9208 02 --- 03 ... 05 --- 06 --- 07 --- 08 --- 10 *** 24 --- 25 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9209 \ \ \ / / |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9210 \ \ `--------' / |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9211 \ \ / |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9212 `-- 11 ... 19 -------`-- 20 ... 23 ------------' |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9213 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9214 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9215 Note that the versions 5024 and 5025 in this graph denote |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9216 @emph{different} versions from the actual history. The starred link |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9217 means that editing work (aside from resolving conflicts) was done, on |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9218 top of the merge. However, the editing work is actually done by |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9219 Mercurial (the revert command)! |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9220 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9221 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9222 @node Q11.2.6, Q11.2.7, Q11.2.5, Bleeding Edge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9223 @unnumberedsubsec How do I recover from a bad commit? (I haven't pushed yet.) |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9224 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9225 If you hadn't yet pushed the commit you now regret, and realize it |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9226 before doing further commits, you can use @code{hg strip tip}. Then |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9227 just redo the commit, possibly with additional changes before |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9228 committing. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9229 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9230 @code{hg strip} is dangerous; for practical purposes it destroys |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9231 history, and it also reverts the files in your workspace. It's |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9232 probably possible to recover the history, but I don't know how. And any |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9233 uncommitted changes that might be lost are gone forever. However, it |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9234 is useful in cases like this. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9235 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9236 When in doubt, use the safer method @ref{Q11.2.5}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9237 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9238 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9239 @node Q11.2.7, , Q11.2.6, Bleeding Edge |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9240 @unnumberedsubsec Testing patches with Mercurial Queues. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9241 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9242 When testing a patch proposed on xemacs-beta or xemacs-patches, |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9243 conflicts or new heads often appear later, when using @code{hg pull -u}. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9244 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9245 There are both theoretical and practical reasons why this happens, |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9246 and it's unlikely to change. The current workflow of XEmacs is also |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9247 unlikely to change soon; testing patches is also probably going to |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9248 remain necessary. One way to avoid this issue is to use Mercurial |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9249 Queues (mq), an extension distributed with Mercurial. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9250 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9251 Enable mq by adding |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9252 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9253 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9254 [extensions] |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9255 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9256 hgext.mq = |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9257 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9258 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9259 to your @file{~/.hgrc}. (Yes, the right hand side is empty.) If you |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9260 already have an @code{[extensions]} section, don't repeat it. Add |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9261 @code{hgext.mq =} to the existing extensions section. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9262 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9263 When you want to test a patch, you need an hg workspace with no |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9264 uncommitted changes. If you already have some uncommitted changes, |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9265 you can preserve them with mq as follows: |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9266 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9267 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9268 $ hg qnew -f -m "Preserve local changes." local-changes |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9269 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9270 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9271 The @code{-m} flag specifies the commit message for the new patch. The |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9272 @code{-f} flag "forces" qnew to put all of the uncommitted local changes |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9273 into an mq patch, and commits it (you will see a commit with summary |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9274 "Preserve local changes." if you do an @code{hg log} now). |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9275 "local-changes" is the name of the patch. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9276 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9277 Now, create an mq patch for the test patch (which we assume was saved |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9278 to @file{/tmp/xemacs.patch}): |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9279 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9280 $ hg qimport -P -n test-xemacs-patch /tmp/xemacs.patch |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9281 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9282 The @code{-n} flag specifies the name of the patch. Give it a name |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9283 sufficiently explicit so you'll know what it is later. Remember, it |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9284 may take several weeks for the patch to be pushed to the public |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9285 mainline. The @code{-P} flag says "apply this patch to the workspace |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9286 now". |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9287 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9288 When you want to update the workspace, you need to remove the mq |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9289 commits, update, and restore your local changes and the test patch. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9290 You do it this way: |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9291 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9292 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9293 $ hg qpop --all |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9294 $ hg pull -u # use your usual method, hg fetch etc. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9295 $ hg qpush --all |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9296 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9297 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9298 @code{hg qpop --all} undoes all the mq commits, but leaves the patches |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9299 in @file{.hg/patches}. @code{hg qpush --all} reapplies the patches and |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9300 restores the mq commits. Of course you hope that the patch will be |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9301 committed upstream. When it is, you do this: |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9302 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9303 @example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9304 $ hg qpop --all |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9305 $ hg pull -u |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9306 $ hg qdelete test-xemacs-patch |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9307 $ hg qpush --all |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9308 @end example |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9309 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9310 and you're back in business with the official version of the patch you |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9311 tested, and all your local changes applied. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9312 |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9313 It's also possible to split your local changes into smaller mq |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9314 patches, but that's out of scope for this answer. |
b7232de2a937
Add information about repos and VCSes to FAQ.
Stephen J. Turnbull <stephen@xemacs.org>
parents:
4905
diff
changeset
|
9315 |
428 | 9316 @bye |