Commit | Line | Data |
---|---|---|
35f07cbc | 1 | \input texinfo @c -*-texinfo-*- -*- coding: latin-1 -*- |
71e68827 | 2 | @c %**start of header |
35ab2989 | 3 | @setfilename ../info/efaq |
71e68827 DL |
4 | @settitle GNU Emacs FAQ |
5 | @c %**end of header | |
6 | ||
7 | @setchapternewpage odd | |
8 | ||
9 | @c The @ifinfo stuff only appears in the Info version | |
10 | @ifinfo | |
0d17cd5c DL |
11 | @dircategory Editors |
12 | @direntry | |
35ab2989 | 13 | * Emacs FAQ: (efaq). Frequently Asked Questions about Emacs. |
0d17cd5c DL |
14 | @end direntry |
15 | ||
010bb2f0 DL |
16 | Copyright 1994,1995,1996,1997,1998,1999 Reuven M. Lerner@* |
17 | Copyright 1992,1993 Steven Byrnes@* | |
18 | Copyright 1990,1991,1992 Joseph Brian Wells@* | |
71e68827 DL |
19 | |
20 | This list of frequently asked questions about GNU Emacs with answers | |
21 | ("FAQ") may be translated into other languages, transformed into other | |
22 | formats (e.g. Texinfo, Info, WWW, WAIS), and updated with new information. | |
23 | ||
24 | The same conditions apply to any derivative of the FAQ as apply to the FAQ | |
25 | itself. Every copy of the FAQ must include this notice or an approved | |
26 | translation, information on who is currently maintaining the FAQ and how to | |
27 | contact them (including their e-mail address), and information on where the | |
28 | latest version of the FAQ is archived (including FTP information). | |
29 | ||
30 | The FAQ may be copied and redistributed under these conditions, except that | |
31 | the FAQ may not be embedded in a larger literary work unless that work | |
32 | itself allows free copying and redistribution. | |
0d17cd5c DL |
33 | |
34 | [This version has been somewhat edited from the last-posted version | |
35 | (as of August 1999) for inclusion in the Emacs distribution.] | |
36 | ||
71e68827 DL |
37 | @end ifinfo |
38 | ||
39 | @c The @titlepage stuff only appears in the printed version | |
40 | @titlepage | |
41 | @sp 10 | |
42 | @center @titlefont{GNU Emacs FAQ} | |
43 | ||
44 | @c The following two commands start the copyright page. | |
45 | @page | |
46 | @vskip 0pt plus 1filll | |
010bb2f0 DL |
47 | Copyright @copyright{} 1994,1995,1996,1997,1998,1999 Reuven M. Lerner@* |
48 | Copyright @copyright{} 1992,1993 Steven Byrnes@* | |
49 | Copyright @copyright{} 1990,1991,1992 Joseph Brian Wells@* | |
71e68827 DL |
50 | |
51 | This list of frequently asked questions about GNU Emacs with answers | |
52 | ("FAQ") may be translated into other languages, transformed into other | |
53 | formats (e.g. Texinfo, Info, WWW, WAIS), and updated with new information. | |
54 | ||
55 | The same conditions apply to any derivative of the FAQ as apply to the FAQ | |
56 | itself. Every copy of the FAQ must include this notice or an approved | |
57 | translation, information on who is currently maintaining the FAQ and how to | |
58 | contact them (including their e-mail address), and information on where the | |
59 | latest version of the FAQ is archived (including FTP information). | |
60 | ||
61 | The FAQ may be copied and redistributed under these conditions, except that | |
62 | the FAQ may not be embedded in a larger literary work unless that work | |
63 | itself allows free copying and redistribution. | |
0d17cd5c DL |
64 | |
65 | [This version has been somewhat edited from the last-posted version | |
66 | (as of August 1999) for inclusion in the Emacs distribution.] | |
71e68827 DL |
67 | @end titlepage |
68 | ||
69 | @node Top, FAQ notation, (dir), (dir) | |
70 | ||
71 | This is the GNU Emacs FAQ, last updated on @today{}. | |
72 | ||
73 | The FAQ is slowly but surely being turned into a Texinfo document, | |
74 | allowing us to create HTML, Info, and TeX documents from a single source | |
75 | file. Please bear with us as we improve on this format. If you have | |
76 | any suggestions or questions, please contact | |
77 | @email{emacs-faq@@lerner.co.il, the FAQ maintainers}. | |
78 | ||
79 | @menu | |
80 | * FAQ notation:: | |
81 | * General questions:: | |
82 | * Getting help:: | |
83 | * Status of Emacs:: | |
84 | * Common requests:: | |
85 | * Bugs and problems:: | |
86 | * Compiling and installing Emacs:: | |
87 | * Finding Emacs and related packages:: | |
88 | * Major packages and programs:: | |
89 | * Key bindings:: | |
90 | * Alternate character sets:: | |
91 | * Mail and news:: | |
92 | * Concept index:: | |
93 | @end menu | |
94 | ||
95 | @c ------------------------------------------------------------ | |
96 | @node FAQ notation, General questions, Top, Top | |
97 | @chapter FAQ notation | |
98 | @cindex FAQ notation | |
99 | ||
100 | This section describes notation used in the GNU Emacs FAQ, as well as in | |
101 | the Emacs documentation. Consult this section if this is the first time | |
102 | you are reading the FAQ, or if you are confused by notation or terms | |
103 | used in the FAQ. | |
104 | ||
105 | @menu | |
106 | * Basic keys:: | |
107 | * Extended commands:: | |
108 | * On-line manual:: | |
109 | * Filename conventions:: | |
110 | * Common acronyms:: | |
111 | @end menu | |
112 | ||
113 | @node Basic keys, Extended commands, FAQ notation, FAQ notation | |
114 | @section What do these mean: @kbd{C-h}, @kbd{M-C-a}, @key{RET}, @kbd{@key{ESC} a}, etc.? | |
115 | @cindex Basic keys | |
116 | @cindex Control key, notation for | |
117 | @cindex @key{Meta} key, notation for | |
118 | @cindex Control-meta characters, notation for | |
119 | @cindex @kbd{C-h}, definition of | |
120 | @cindex @kbd{M-C-h}, definition of | |
121 | @cindex @key{DEL}, definition of | |
122 | @cindex @key{ESC}, definition of | |
123 | @cindex @key{LFD}, definition of | |
124 | @cindex @key{RET}, definition of | |
125 | @cindex @key{SPC}, definition of | |
126 | @cindex @key{TAB}, definition of | |
127 | ||
128 | @itemize @bullet | |
129 | ||
130 | @item | |
131 | @kbd{C-x}: press the @key{x} key while holding down the @key{Control} key | |
132 | ||
133 | @item | |
134 | @kbd{M-x}: press the @key{x} key while holding down the @key{Meta} key | |
0d17cd5c | 135 | (if your computer doesn't have a @key{Meta} key, see @pxref{No Meta key}) |
71e68827 DL |
136 | |
137 | @item | |
138 | @kbd{M-C-x}: press the @key{x} key while holding down both @key{Control} | |
139 | and @key{Meta} | |
140 | ||
141 | @item | |
142 | @kbd{C-M-x}: a synonym for the above | |
143 | ||
144 | @item | |
145 | @key{LFD}: Linefeed or Newline; same as @kbd{C-j} | |
146 | ||
147 | @item | |
148 | @key{RET}: @key{Return}, sometimes marked @key{Enter}; same as @kbd{C-m} | |
149 | ||
150 | @item | |
151 | @key{DEL}: @key{Delete}, usually not the same as @key{Backspace}; same | |
0d17cd5c | 152 | as @kbd{C-?} (@pxref{Backspace invokes help} if deleting invokes Emacs help) |
71e68827 DL |
153 | |
154 | @item | |
155 | @key{ESC}: Escape; same as @kbd{C-[} | |
156 | ||
157 | @item | |
158 | @key{TAB}: Tab; same as @kbd{C-i} | |
159 | ||
160 | @item | |
161 | @key{SPC}: Space bar | |
162 | ||
163 | @end itemize | |
164 | ||
165 | Key sequences longer than one key (and some single-key sequences) are | |
166 | inside double quotes or on lines by themselves. Any real spaces in such | |
167 | a key sequence should be ignored; only @key{SPC} really means press the | |
168 | space key. | |
169 | ||
170 | The ASCII code sent by @kbd{C-x} (except for @kbd{C-?}) is the value | |
171 | that would be sent by pressing just @key{x} minus 96 (or 64 for | |
172 | uppercase @key{X}) and will be from 0 to 31. The ASCII code sent by | |
173 | @kbd{M-x} is the sum of 128 and the ASCII code that would be sent by | |
174 | pressing just @key{x}. Essentially, @key{Control} turns off bits 5 and | |
175 | 6 and @key{Meta} turns on bit 7. | |
176 | ||
177 | @kbd{C-?} (aka @key{DEL}) is ASCII code 127. It is a misnomer to call | |
178 | @kbd{C-?} a "control" key, since 127 has both bits 5 and 6 turned ON. | |
179 | Also, on very few keyboards does @kbd{C-?} generate ASCII code 127. | |
180 | ||
181 | @inforef{Characters, Characters, emacs} and @inforef{Keys, Keys, emacs} | |
0d17cd5c | 182 | for more information. (@pxref{On-line manual} for more information about |
71e68827 DL |
183 | Info.) |
184 | ||
185 | @node Extended commands, On-line manual, Basic keys, FAQ notation | |
186 | @section What does @file{M-x @var{command}} mean? | |
187 | @cindex Extended commands | |
188 | @cindex Commands, extended | |
189 | @cindex M-x, meaning of | |
190 | ||
191 | @kbd{M-x @var{command}} means type @kbd{M-x}, then type the name of the | |
0d17cd5c | 192 | command, then type @key{RET}. (@pxref{Basic keys} if you're not sure |
71e68827 DL |
193 | what @kbd{M-x} and @key{RET} mean.) |
194 | ||
195 | @kbd{M-x} (by default) invokes the command | |
196 | @code{execute-extended-command}. This command allows you to run any | |
197 | Emacs command if you can remember the command's name. If you can't | |
198 | remember the command's name, you can type @key{TAB} and @key{SPC} for | |
199 | completion, @key{?} for a list of possibilities, and @kbd{M-p} and | |
200 | @kbd{M-n} to see previous commands entered. An Emacs "command" is any | |
201 | "interactive" Emacs function. | |
202 | ||
203 | Your system administrator may have bound other key sequences to invoke | |
204 | @code{execute-extended-command}. A function key labeled @kbd{Do} is a | |
205 | good candidate for this. | |
206 | ||
207 | To run non-interactive Emacs functions, @pxref{Evaluating Emacs Lisp code}. | |
208 | ||
209 | @node On-line manual, Filename conventions, Extended commands, FAQ notation | |
210 | @section How do I read topic XXX in the on-line manual? | |
211 | @cindex On-line manual, reading topics in | |
212 | @cindex Reading topics in the on-line manual | |
213 | @cindex Finding topics in the on-line manual | |
214 | @cindex Info, finding topics in | |
215 | ||
216 | When we refer you to topic XXX in the on-line manual, you can read this | |
217 | manual node inside Emacs (assuming nothing is broken) by typing @kbd{C-h | |
218 | i m emacs @key{RET} m XXX @key{RET}}. | |
219 | ||
220 | This invokes Info, the GNU hypertext documentation browser. If you don't | |
221 | already know how to use Info, type @key{?} from within Info. | |
222 | ||
223 | If we refer to topic XXX:YYY, type @kbd{C-h i m emacs @key{RET} m XXX | |
224 | @key{RET} m YYY @key{RET}}. | |
225 | ||
226 | Your system administrator may not have installed the Info files, or may | |
227 | have installed them improperly. In this case you should complain. | |
228 | ||
0d17cd5c | 229 | @xref{Getting a printed manual}, if you would like a paper copy of the |
71e68827 DL |
230 | Emacs manual. |
231 | ||
232 | @node Filename conventions, Common acronyms, On-line manual, FAQ notation | |
233 | @section What are @file{etc/SERVICE}, @file{src/config.h}, and @file{lisp/default.el}? | |
234 | @cindex Filename conventions | |
235 | @cindex Conventions for filenames | |
236 | @cindex Directories and files that come with Emacs | |
237 | ||
238 | These are files that come with Emacs. The Emacs distribution is divided | |
239 | into subdirectories; the important ones are @file{etc}, @file{lisp}, and | |
240 | @file{src}. | |
241 | ||
242 | If you use Emacs, but don't know where it is kept on your system, start | |
243 | Emacs, then type @kbd{C-h v data-directory @key{RET}}. The directory | |
244 | name displayed by this will be the full pathname of the installed | |
245 | @file{etc} directory. | |
246 | ||
247 | The location of your Info directory (i.e., where on-line documentation | |
248 | is stored) is kept in the variable @code{Info-default-directory-list}. Use | |
249 | @kbd{C-h v Info-default-directory-list @key{RET}} to see the contents of | |
250 | this variable, which will be a list of directory names. The last | |
251 | directory in that list is probably where most Info files are stored. By | |
252 | default, Info documentation is placed in @file{/usr/local/info}. | |
253 | ||
254 | Some of these files are available individually via FTP or e-mail; | |
255 | @pxref{Informational files for Emacs}. All are available in the source | |
256 | distribution. Many of the files in the @file{etc} directory are also | |
257 | available via the Emacs "help" menu, or by typing @kbd{C-h ?} (@kbd{M-x | |
258 | help-for-help}). | |
259 | ||
260 | Your system administrator may have removed the @file{src} directory and | |
261 | many files from the @file{etc} directory. | |
262 | ||
263 | @node Common acronyms, , Filename conventions, FAQ notation | |
264 | @section What are FSF, LPF, OSF, GNU, RMS, FTP, and GPL? | |
265 | @cindex FSF, definition of | |
266 | @cindex LPF, definition of | |
267 | @cindex OSF, definition of | |
268 | @cindex GNU, definition of | |
269 | @cindex RMS, definition of | |
270 | @cindex Stallman, Richard, acronym for | |
271 | @cindex Richard Stallman, acronym for | |
272 | @cindex FTP, definition of | |
273 | @cindex GPL, definition of | |
274 | @cindex Acronyms, definitions for | |
275 | @cindex Common acronyms, definitions for | |
276 | ||
277 | @table @asis | |
278 | ||
279 | @item FSF | |
280 | Free Software Foundation | |
281 | ||
282 | @item LPF | |
283 | League for Programming Freedom | |
284 | ||
285 | @item OSF | |
286 | Open Software Foundation | |
287 | ||
288 | @item GNU | |
289 | GNU's Not Unix | |
290 | ||
291 | @item RMS | |
292 | Richard Matthew Stallman | |
293 | ||
294 | @item FTP | |
295 | File Transfer Protocol | |
296 | ||
297 | @item GPL | |
298 | GNU General Public License | |
299 | ||
300 | @end table | |
301 | ||
302 | Avoid confusing the FSF, the LPF, and the OSF. The LPF opposes | |
303 | look-and-feel copyrights and software patents. The FSF aims to make | |
304 | high quality free software available for everyone. The OSF is a | |
305 | consortium of computer vendors which develops commercial software for | |
306 | Unix systems. | |
307 | ||
308 | The word "free" in the title of the Free Software Foundation refers to | |
309 | "freedom," not "zero dollars." Anyone can charge any price for | |
310 | GPL-covered software that they want to. However, in practice, the | |
311 | freedom enforced by the GPL leads to low prices, because you can always | |
312 | get the software for less money from someone else, because everyone has | |
313 | the right to resell or give away GPL-covered software. | |
314 | ||
315 | @c ------------------------------------------------------------ | |
316 | @node General questions, Getting help, FAQ notation, Top | |
317 | @chapter General questions | |
318 | @cindex General questions | |
319 | ||
320 | This section contains general questions having to do with Emacs, the | |
321 | Free Software Foundation, and related organizations. | |
322 | ||
323 | @menu | |
324 | * The LPF:: | |
325 | * Real meaning of copyleft:: | |
326 | * Guidelines for newsgroup postings:: | |
327 | * Newsgroup archives:: | |
328 | * Reporting bugs:: | |
329 | * Unsubscribing from Emacs lists:: | |
330 | * Contacting the FSF:: | |
331 | @end menu | |
332 | ||
333 | @node The LPF, Real meaning of copyleft, General questions, General questions | |
334 | @section What is the LPF? | |
335 | @cindex LPF, description of | |
336 | @cindex League for Programming Freedom | |
337 | @cindex Software patents, opposition to | |
338 | @cindex Patents for software, opposition to | |
339 | ||
340 | The LPF opposes the expanding danger of software patents and | |
341 | look-and-feel copyrights. To get more information, feel free to contact | |
342 | the LPF via e-mail or otherwise. You may also contact | |
343 | @email{jbw@@cs.bu.edu, Joe Wells}; he will be happy to talk with you | |
344 | about the LPF. | |
345 | ||
346 | You can find more information about the LPF in the file @file{etc/LPF}. | |
347 | More papers describing the LPF's views are available on the Internet and | |
348 | also from @uref{http://lpf.ai.mit.edu/, the LPF}. | |
349 | ||
350 | @node Real meaning of copyleft, Guidelines for newsgroup postings, The LPF, General questions | |
351 | @section What is the real legal meaning of the GNU copyleft? | |
352 | @cindex Copyleft, real meaning of | |
353 | @cindex GPL, real meaning of | |
354 | @cindex General Public License, real meaning of | |
355 | @cindex Discussion of the GPL | |
356 | ||
357 | The real legal meaning of the GNU General Public License (copyleft) will | |
358 | only be known if and when a judge rules on its validity and scope. | |
359 | There has never been a copyright infringement case involving the GPL to | |
360 | set any precedents. Please take any discussion regarding this issue to | |
361 | the newsgroup @uref{news:gnu.misc.discuss}, which was created to hold the | |
362 | extensive flame wars on the subject. | |
363 | ||
364 | RMS writes: | |
365 | ||
366 | @quotation | |
367 | The legal meaning of the GNU copyleft is less important than the spirit, | |
368 | which is that Emacs is a free software project and that work pertaining | |
369 | to Emacs should also be free software. "Free" means that all users have | |
370 | the freedom to study, share, change and improve Emacs. To make sure | |
371 | everyone has this freedom, pass along source code when you distribute | |
372 | any version of Emacs or a related program, and give the recipients the | |
373 | same freedom that you enjoyed. | |
374 | @end quotation | |
375 | ||
376 | @node Guidelines for newsgroup postings, Newsgroup archives, Real meaning of copyleft, General questions | |
377 | @section What are appropriate messages for @uref{news:gnu.emacs.help}, @uref{news:gnu.emacs.bug}, @uref{news:comp.emacs}, etc.? | |
378 | @cindex Newsgroups, appropriate messages for | |
379 | @cindex GNU newsgroups, appropriate messages for | |
380 | @cindex Usenet groups, appropriate messages for | |
381 | @cindex Mailing lists, appropriate messages for | |
382 | ||
383 | The file @file{etc/MAILINGLISTS} discusses the purpose of each GNU | |
0d17cd5c | 384 | mailing-list. (@pxref{Informational files for Emacs} if you want a copy |
71e68827 DL |
385 | of the file.) For those lists which are gatewayed with newsgroups, it |
386 | lists both the newsgroup name and the mailing list address. | |
387 | ||
388 | @uref{news:comp.emacs} is for discussion of Emacs programs in general. | |
389 | This includes Emacs along with various other implementations, such as | |
390 | JOVE, MicroEmacs, Freemacs, MG, Unipress, CCA, and Epsilon. | |
391 | ||
392 | Many people post Emacs questions to @uref{news:comp.emacs} because they | |
393 | don't receive any of the gnu.* newsgroups. Arguments have been made | |
394 | both for and against posting GNU-Emacs-specific material to | |
395 | @uref{news:comp.emacs}. You have to decide for yourself. | |
396 | ||
397 | Messages advocating "non-free" software are considered unacceptable on | |
398 | any of the gnu.* newsgroups except for @uref{news:gnu.misc.discuss}, | |
399 | which was created to hold the extensive flame-wars on the subject. | |
400 | "Non-free" software includes any software for which the end user can't | |
401 | freely modify the source code and exchange enhancements. Be careful to | |
402 | remove the gnu.* groups from the "Newsgroups:" line when posting a | |
403 | followup that recommends such software. | |
404 | ||
405 | @uref{news:gnu.emacs.bug} is a place where bug reports appear, but avoid | |
406 | posting bug reports to this newsgroup (@pxref{Reporting bugs}). | |
407 | ||
408 | @node Newsgroup archives, Reporting bugs, Guidelines for newsgroup postings, General questions | |
409 | @section Where can I get old postings to @uref{news:gnu.emacs.help} and other GNU groups? | |
410 | @cindex Archived postings from @uref{news:gnu.emacs.help} | |
411 | @cindex Usenet archives for GNU groups | |
412 | @cindex Old Usenet postings for GNU groups | |
413 | ||
414 | The FSF has maintained archives of all of the GNU mailing lists for many | |
415 | years, although there may be some unintentional gaps in coverage. The | |
416 | archive is not particularly well organized or easy to retrieve | |
417 | individual postings from, but pretty much everything is there. | |
418 | ||
419 | The archive is at @uref{ftp://ftp-mailing-list-archives.gnu.org}. | |
420 | ||
421 | As of this writing, the archives are not yet working. | |
422 | ||
423 | Web-based Usenet search services, such as | |
424 | @uref{http://www.dejanews.com, DejaNews}, also archive the | |
425 | gnu.* groups. | |
426 | ||
427 | @node Reporting bugs, Unsubscribing from Emacs lists, Newsgroup archives, General questions | |
428 | @section Where should I report bugs and other problems with Emacs? | |
429 | @cindex Bug reporting | |
430 | @cindex Good bug reports | |
431 | @cindex How to submit a bug report | |
432 | @cindex Reporting bugs | |
433 | ||
434 | The correct way to report Emacs bugs is by e-mail to | |
435 | @email{bug-gnu-emacs@@gnu.org}. Anything sent here also appears in the | |
436 | newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of | |
437 | news to submit the bug report. This ensures a reliable return address | |
438 | so you can be contacted for further details. | |
439 | ||
440 | Be sure to read the "Bugs" section of the Emacs manual before reporting | |
441 | a bug to bug-gnu-emacs! The manual describes in detail how to submit a | |
0d17cd5c | 442 | useful bug report. (@pxref{On-line manual} if you don't know how to read the |
71e68827 DL |
443 | manual.) |
444 | ||
445 | RMS says: | |
446 | ||
447 | @quotation | |
448 | Sending bug reports to @email{help-gnu-emacs@@gnu.org} (which has the | |
449 | effect of posting on @uref{news:gnu.emacs.help}) is undesirable because | |
450 | it takes the time of an unnecessarily large group of people, most of | |
451 | whom are just users and have no idea how to fix these problem. | |
452 | @email{bug-gnu-emacs@@gnu.org} reaches a much smaller group of people | |
453 | who are more likely to know what to do and have expressed a wish to | |
454 | receive more messages about Emacs than the others. | |
455 | @end quotation | |
456 | ||
457 | RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}: | |
458 | ||
459 | @quotation | |
460 | If you have reported a bug and you don't hear about a possible fix, | |
461 | then after a suitable delay (such as a week) it is okay to post on | |
462 | gnu.emacs.help asking if anyone can help you. | |
463 | @end quotation | |
464 | ||
465 | If you are unsure whether you have found a bug, consider the following | |
466 | non-exhaustive list, courtesy of RMS: | |
467 | ||
468 | @quotation | |
469 | If Emacs crashes, that is a bug. If Emacs gets compilation errors | |
470 | while building, that is a bug. If Emacs crashes while building, that | |
471 | is a bug. If Lisp code does not do what the documentation says it | |
472 | does, that is a bug. | |
473 | @end quotation | |
474 | ||
475 | @node Unsubscribing from Emacs lists, Contacting the FSF, Reporting bugs, General questions | |
476 | @section How do I unsubscribe from this mailing list? | |
477 | @cindex Unsubscribing from GNU mailing lists | |
478 | @cindex Removing yourself from GNU mailing lists | |
479 | ||
480 | If you are receiving a GNU mailing list named "XXX", you might be able | |
481 | to unsubscribe from it by sending a request to the address | |
482 | @email{XXX-request@@gnu.org}. However, this will not work if you are | |
483 | not listed on the main mailing list, but instead receive the mail from a | |
484 | distribution point. In that case, you will have to track down at which | |
485 | distribution point you are listed. Inspecting the @samp{Received} headers | |
486 | on the mail messages may help, along with liberal use of the "EXPN" or | |
487 | "VRFY" sendmail commands through "telnet <site-address> smtp". Ask your | |
488 | postmaster for help. | |
489 | ||
490 | @node Contacting the FSF, , Unsubscribing from Emacs lists, General questions | |
491 | @section What is the current address of the FSF? | |
492 | @cindex Snail mail address of the FSF | |
493 | @cindex Postal address of the FSF | |
494 | @cindex Contracting the FSF | |
495 | @cindex Free Software Foundation, contacting | |
496 | ||
497 | @table @asis | |
498 | ||
499 | @item E-mail | |
500 | gnu@@gnu.org | |
501 | ||
502 | @item Telephone | |
503 | +1-617-542-5942 | |
504 | ||
505 | @item Fax | |
506 | +1-617-542-2652 | |
507 | ||
508 | @item World Wide Web | |
509 | @uref{http://www.gnu.org/} | |
510 | ||
511 | @item Postal address | |
512 | Free Software Foundation@* | |
513 | 59 Temple Place - Suite 330@* | |
514 | Boston, MA 02111-1307@* | |
515 | USA@* | |
516 | ||
517 | @end table | |
518 | ||
519 | For details on how to order items directly from the FSF, see the file | |
520 | @file{etc/ORDERS}. | |
521 | ||
522 | @c ------------------------------------------------------------ | |
523 | @node Getting help, Status of Emacs, General questions, Top | |
524 | @chapter Getting help | |
525 | @cindex Getting help | |
526 | ||
527 | This section tells you how to get help with Emacs | |
528 | ||
529 | @menu | |
530 | * Basic editing:: | |
531 | * Learning how to do something:: | |
532 | * Getting a printed manual:: | |
533 | * Emacs Lisp documentation:: | |
534 | * Installing Texinfo documentation:: | |
535 | * Printing a Texinfo file:: | |
536 | * Viewing Info files outside of Emacs:: | |
537 | * Informational files for Emacs:: | |
538 | * Help installing Emacs:: | |
539 | * Obtaining the FAQ:: | |
540 | @end menu | |
541 | ||
542 | @node Basic editing, Learning how to do something, Getting help, Getting help | |
543 | @section I'm just starting Emacs; how do I do basic editing? | |
544 | @cindex Basic editing with Emacs | |
545 | @cindex Beginning editing | |
546 | @cindex Tutorial, invoking the | |
547 | @cindex Self-paced tutorial, invoking the | |
548 | @cindex Help system, entering the | |
549 | ||
550 | Type @kbd{C-h t} to invoke the self-paced tutorial. Just typing @kbd{C-h} | |
551 | enters the help system. | |
552 | ||
553 | Your system administrator may have changed @kbd{C-h} to act like | |
554 | @key{DEL} to deal with local keyboards. You can use @kbd{M-x | |
555 | help-for-help} instead to invoke help. To discover what key (if any) | |
556 | invokes help on your system, type @kbd{M-x where-is @key{RET} | |
557 | help-for-help @key{RET}}. This will print a comma-separated list of key | |
558 | sequences in the echo area. Ignore the last character in each key | |
559 | sequence listed. Each of the resulting key sequences invokes help. | |
560 | ||
561 | Emacs help works best if it is invoked by a single key whose value | |
562 | should be stored in the variable @code{help-char}. | |
563 | ||
564 | There is also a WWW-based tutorial for Emacs 18, much of which is also | |
565 | relevant for Emacs 20, available at | |
566 | ||
567 | @uref{http://kufacts.cc.ukans.edu/cwis/writeups/misc/emacsguide.html} | |
568 | ||
569 | @node Learning how to do something, Getting a printed manual, Basic editing, Getting help | |
570 | @section How do I find out how to do something in Emacs? | |
571 | @cindex Help for Emacs | |
572 | @cindex Learning to do something in Emacs | |
573 | @cindex Reference card for Emacs | |
574 | @cindex Overview of help systems | |
575 | ||
576 | There are several methods for finding out how to do things in Emacs. | |
577 | ||
578 | @itemize @bullet | |
579 | ||
580 | @item | |
581 | The complete text of the Emacs manual is available on-line via the Info | |
582 | hypertext reader. Type @kbd{C-h i} to invoke Info. Typing @key{h} | |
583 | immediately after entering Info will provide a short tutorial on how to | |
584 | use it. | |
585 | ||
586 | @item | |
587 | You can order a hardcopy of the manual from the FSF. @xref{Getting a | |
588 | printed manual}. | |
589 | ||
590 | @item | |
591 | You can get a printed reference card listing commands and keys to | |
592 | invoke them. You can order one from the FSF for $1 (or 10 for $5), | |
593 | or you can print your own from the @file{etc/refcard.tex} or | |
594 | @file{etc/refcard.ps} files in the Emacs distribution. | |
595 | ||
596 | @item | |
597 | You can list all of the commands whose names contain a certain word | |
598 | (actually which match a regular expression) using @kbd{C-h a} (@kbd{M-x | |
599 | command-apropos}). | |
600 | ||
601 | @item | |
602 | You can list all of the functions and variables whose names contain a | |
603 | certain word using @kbd{M-x apropos}. | |
604 | ||
605 | @item | |
606 | There are many other commands in Emacs for getting help and | |
607 | information. To get a list of these commands, type @samp{?} after | |
608 | @kbd{C-h}. | |
609 | ||
610 | @end itemize | |
611 | ||
612 | @node Getting a printed manual, Emacs Lisp documentation, Learning how to do something, Getting help | |
613 | @section How do I get a printed copy of the Emacs manual? | |
614 | @cindex Printed Emacs manual, obtaining | |
615 | @cindex Manual, obtaining a printed copy of | |
616 | @cindex Emacs manual, obtaining a printed copy of | |
617 | ||
618 | You can order a printed copy of the Emacs manual from the FSF. For | |
619 | details see the file @file{etc/ORDERS}. | |
620 | ||
621 | The full @TeX{} source for the manual also comes in the @file{man} | |
622 | directory of the Emacs distribution, if you're daring enough to try to | |
623 | print out this 440-page manual yourself (@pxref{Printing a Texinfo | |
624 | file}). | |
625 | ||
626 | If you absolutely have to print your own copy, and you don't have @TeX{}, | |
627 | you can get a PostScript version from | |
628 | ||
0d17cd5c | 629 | @uref{http://www.gnu.org/manual/emacs/ps/emacs.ps.gz} |
71e68827 | 630 | |
0d17cd5c | 631 | A WWW version of the manual is at |
71e68827 | 632 | |
0d17cd5c | 633 | @uref{www.gnu.org/manual/emacs/index.html} |
71e68827 | 634 | |
0d17cd5c | 635 | @xref{Learning how to do something}, for how to view the manual on-line. |
71e68827 DL |
636 | |
637 | @node Emacs Lisp documentation, Installing Texinfo documentation, Getting a printed manual, Getting help | |
638 | @section Where can I get documentation on Emacs Lisp? | |
639 | @cindex Documentation on Emacs Lisp | |
640 | @cindex Function documentation | |
641 | @cindex Variable documentation | |
642 | @cindex Emacs Lisp Reference Manual | |
643 | @cindex Reference manual for Emacs Lisp | |
644 | ||
645 | Within Emacs, you can type @kbd{C-h f} to get the documentation for a | |
646 | function, @kbd{C-h v} for a variable. | |
647 | ||
648 | For more information, obtain the Emacs Lisp Reference Manual. Details on | |
649 | ordering it from FSF are in file @file{etc/ORDERS}. | |
650 | ||
651 | The Emacs Lisp Reference Manual is also available on-line, in Info | |
652 | format. Texinfo source for the manual (along with pregenerated Info | |
653 | files) is available at | |
654 | ||
655 | @uref{ftp://ftp.gnu.org/pub/gnu/emacs/elisp-manual-20-2.5.tar.gz} | |
656 | ||
0d17cd5c DL |
657 | and all mirrors of @samp{ftp.gnu.org} (@pxref{Current GNU distributions} for a |
658 | list). @xref{Installing Texinfo documentation}, if you want to install | |
71e68827 DL |
659 | the Info files, or @ref{Printing a Texinfo file} if you want to use the |
660 | Texinfo source to print the manual yourself. | |
661 | ||
0d17cd5c | 662 | A WWW version of the Emacs Lisp Reference Manual is available at |
71e68827 | 663 | |
0d17cd5c | 664 | @uref{http://www.gnu.org/manual/elisp-manual-20-2.5/elisp.html} |
71e68827 DL |
665 | |
666 | @node Installing Texinfo documentation, Printing a Texinfo file, Emacs Lisp documentation, Getting help | |
667 | @section How do I install a piece of Texinfo documentation? | |
668 | @cindex Texinfo documentation, installing | |
669 | @cindex Installing Texinfo documentation | |
670 | @cindex New Texinfo files, installing | |
671 | @cindex Documentation, installing new Texinfo files | |
672 | ||
673 | First, you must turn the Texinfo files into Info files. You may do this | |
674 | using the stand-alone @file{makeinfo} program, available as part of the latest | |
675 | Texinfo package at | |
676 | ||
677 | @uref{ftp://ftp.gnu.org/pub/gnu/texinfo/texinfo-3.12.tar.gz} | |
678 | ||
0d17cd5c | 679 | and all mirrors of @samp{ftp.gnu.org} (@pxref{Current GNU distributions} for a list). |
71e68827 DL |
680 | |
681 | For information about the Texinfo format, read the Texinfo manual which | |
682 | comes with Emacs. This manual also comes installed in Info format, so | |
683 | you can read it on-line. | |
684 | ||
685 | Neither @code{texinfo-format-buffer} nor @file{makeinfo} installs the | |
686 | resulting Info files in Emacs's Info tree. To install Info files: | |
687 | ||
688 | @enumerate | |
689 | ||
690 | @item Move the files to the @file{info} directory in the installed Emacs | |
0d17cd5c | 691 | distribution. @xref{Filename conventions}, if you don't know where that is. |
71e68827 DL |
692 | |
693 | @item Edit the file @file{info/dir} in the installed Emacs distribution, | |
694 | and add a line for the top level node in the Info package that you are | |
695 | installing. Follow the examples already in this file. The format is: | |
696 | ||
697 | @example | |
698 | * Topic: (relative-pathname). Short description of topic. | |
699 | @end example | |
700 | ||
701 | @end enumerate | |
702 | ||
703 | If you want to install Info files and you don't have the necessary | |
704 | privileges, you have several options: | |
705 | ||
706 | @itemize @bullet | |
707 | ||
708 | @item | |
709 | Info files don't actually need to be installed before being used. You | |
710 | can feed a file name to the @code{Info-goto-node} command (invoked by | |
711 | pressing @key{g} in Info mode) by typing the name of the file in | |
712 | parentheses. This goes to the node named "Top" in that file. For | |
713 | example, to view a Info file named "XXX" in your home directory, you can | |
714 | type this: | |
715 | ||
716 | @lisp | |
717 | C-h i g (~/XXX) @key{RET} | |
718 | @end lisp | |
719 | ||
720 | @item | |
721 | You can create your own Info directory. You can tell Emacs where the | |
722 | Info directory is by adding its pathname to the value of the variable | |
723 | @code{Info-default-directory-list}. For example, to use a private Info | |
724 | directory which is a subdirectory of your home directory named "Info", | |
725 | you could put this in your @file{.emacs} file: | |
726 | ||
727 | @lisp | |
728 | (setq Info-default-directory-list | |
729 | (cons "~/Info" Info-default-directory-list)) | |
730 | @end lisp | |
731 | ||
732 | You will need a top-level Info file named @file{dir} in this directory | |
733 | which has everything the system dir file has in it, except it should | |
734 | list only entries for Info files in that directory. You might not need | |
735 | it if all files in this directory were referenced by other @file{dir} | |
736 | files. The node lists from all @file{dir} files in | |
737 | @code{Info-default-directory-list} are merged by the Info system. | |
738 | ||
739 | @end itemize | |
740 | ||
741 | @node Printing a Texinfo file, Viewing Info files outside of Emacs, Installing Texinfo documentation, Getting help | |
742 | @section How do I print a Texinfo file? | |
743 | @cindex Printing a Texinfo file | |
744 | @cindex Texinfo file, printing | |
745 | ||
746 | You can't get nicely printed output from Info files; you must still have | |
747 | the original Texinfo source file for the manual you want to print. | |
748 | ||
749 | Assuming you have @TeX{} installed on your system, follow these steps: | |
750 | ||
751 | @enumerate | |
752 | ||
753 | @item Make sure the first line of the Texinfo file looks like this: | |
754 | ||
755 | @example | |
756 | \input texinfo | |
757 | @end example | |
758 | ||
759 | You may need to change @samp{texinfo} to the full pathname of the | |
760 | texinfo.tex file, which comes with Emacs as @samp{man/texinfo.tex} (or | |
761 | copy or link it into the current directory). | |
762 | ||
763 | @item @code{tex XXX.texinfo} | |
764 | ||
765 | @item @code{texindex XXX.??} | |
766 | ||
767 | The @samp{texindex} program comes with Emacs as @file{man/texindex.c}. | |
768 | ||
769 | @item @code{tex XXX.texinfo} | |
770 | ||
771 | @item Print the DVI file @file{XXX.dvi} in the normal way for printing DVI files at your site. | |
772 | ||
773 | @end enumerate | |
774 | ||
775 | To get more general instructions, retrieve the latest Texinfo package | |
0d17cd5c | 776 | (@pxref{Installing Texinfo documentation}). |
71e68827 DL |
777 | |
778 | @node Viewing Info files outside of Emacs, Informational files for Emacs, Printing a Texinfo file, Getting help | |
779 | @section Can I view Info files without using Emacs? | |
780 | @cindex Viewing Info files | |
781 | @cindex Info file viewers | |
782 | @cindex Alternative Info file viewers | |
783 | ||
784 | Yes. Here are some alternative programs: | |
785 | ||
786 | @itemize @bullet | |
787 | ||
788 | @item Info, a stand-alone version of the Info program, comes as part of the | |
0d17cd5c | 789 | Texinfo package. @xref{Installing Texinfo documentation}, for details. |
71e68827 DL |
790 | |
791 | @item Xinfo, a stand-alone version of the Info program that runs under X | |
792 | Windows. You can get it at | |
793 | @uref{ftp://ftp.gnu.org/pub/gnu/xinfo/xinfo-1.01.01.tar.gz} and all | |
0d17cd5c | 794 | mirrors of @samp{ftp.gnu.org} (@pxref{Current GNU distributions} for a list). |
71e68827 DL |
795 | |
796 | @item Tkinfo, an Info viewer that runs under X Windows and uses Tcl/Tk. You | |
797 | can get Tkinfo at @uref{http://math-www.uni-paderborn.de/~axel/tkinfo/}. | |
798 | ||
799 | @end itemize | |
800 | ||
801 | @node Informational files for Emacs, Help installing Emacs, Viewing Info files outside of Emacs, Getting help | |
802 | @section What informational files are available for Emacs? | |
803 | @cindex Informational files included with Emacs | |
804 | @cindex Files included with Emacs | |
805 | @cindex @file{COPYING}, description of file | |
806 | @cindex @file{DISTRIB}, description of file | |
807 | @cindex @file{FAQ}, description of file | |
808 | @cindex @file{FTP}, description of file | |
809 | @cindex @file{GNU}, description of file | |
810 | @cindex @file{INTERVIEW}, description of file | |
811 | @cindex @file{LPF}, description of file | |
812 | @cindex @file{MACHINES}, description of file | |
813 | @cindex @file{MAILINGLISTS}, description of file | |
814 | @cindex @file{NEWS}, description of file | |
815 | @cindex @file{SERVICE}, description of file | |
816 | @cindex @file{SUN-SUPPORT}, description of file | |
817 | ||
818 | This isn't a frequently asked question, but it should be! A variety of | |
819 | informational files about Emacs and relevant aspects of the GNU project | |
820 | are available for you to read. | |
821 | ||
822 | The following files are available in the @file{etc} directory of the | |
823 | Emacs distribution (@pxref{Filename conventions} if you're not sure where that is). | |
824 | ||
825 | @table @file | |
826 | ||
827 | @item COPYING | |
828 | Emacs General Public License | |
829 | ||
830 | @item DISTRIB | |
831 | Emacs Availability Information, including the popular "Free Software | |
832 | Foundation Order Form" | |
833 | ||
834 | @item FAQ | |
835 | Emacs Frequently Asked Questions (You're reading it) | |
836 | ||
837 | @item FTP | |
838 | How to get GNU Software by Internet FTP or by UUCP | |
839 | ||
840 | @item GNU | |
841 | The GNU Manifesto | |
842 | ||
843 | @item INTERVIEW | |
844 | Richard Stallman discusses his public-domain UNIX-compatible software | |
845 | system with BYTE editors | |
846 | ||
847 | @item LPF | |
848 | Why you should join the League for Programming Freedom | |
849 | ||
850 | @item MACHINES | |
851 | Status of Emacs on Various Machines and Systems | |
852 | ||
853 | @item MAILINGLISTS | |
854 | GNU Project Electronic Mailing Lists | |
855 | ||
856 | @item NEWS | |
857 | Emacs news, a history of user-visible changes | |
858 | ||
859 | @item SERVICE | |
860 | GNU Service Directory | |
861 | ||
862 | @item SUN-SUPPORT | |
863 | including "Using Emacstool with GNU Emacs" | |
864 | ||
865 | @end table | |
866 | ||
867 | Latest versions of the above files also available at | |
868 | ||
869 | @uref{ftp://ftp.gnu.org/pub/gnu/GNUinfo/} | |
870 | ||
871 | More GNU information, including back issues of the "GNU's Bulletin", are | |
872 | at | |
873 | ||
874 | @uref{http://www.gnu.org/bulletins/bulletins.html} and | |
875 | ||
876 | @uref{http://www.cs.pdx.edu/~trent/gnu/gnu.html} | |
877 | ||
878 | @node Help installing Emacs, Obtaining the FAQ, Informational files for Emacs, Getting help | |
879 | @section Where can I get help in installing Emacs? | |
880 | @cindex Installation help | |
881 | @cindex Help installing Emacs | |
882 | ||
0d17cd5c | 883 | @xref{Installing Emacs}, for some basic installation hints, and question |
71e68827 DL |
884 | 83 if you have problems with the installation. |
885 | ||
886 | The file @file{etc/SERVICE} (@pxref{Filename conventions} if you're not | |
887 | sure where that is) lists companies and individuals willing to sell you | |
888 | help in installing or using Emacs. An up-to-date version this file is | |
889 | available on @samp{ftp.gnu.org} (@pxref{Informational files for Emacs}). | |
890 | ||
891 | @node Obtaining the FAQ, , Help installing Emacs, Getting help | |
892 | @section Where can I get the latest version of this FAQ? | |
893 | @cindex FAQ, obtaining the | |
894 | @cindex Latest FAQ version, obtaining the | |
895 | @cindex Retrieving the latest FAQ version | |
896 | @cindex E-mail, retrieving the FAQ via | |
897 | @cindex Web, reading the FAQ on the | |
898 | ||
899 | The Emacs FAQ is available in several ways: | |
900 | ||
901 | @itemize @bullet | |
902 | ||
903 | @item | |
904 | Inside of Emacs itself. You can get it from selecting the "Emacs FAQ" | |
905 | option from the "Help" menu at the top of any Emacs frame, or by typing | |
906 | @kbd{C-h F} (@kbd{M-x view-emacs-FAQ}). | |
907 | ||
908 | @item | |
909 | Via USENET. If you can read news, the FAQ should be available in your | |
910 | news spool, in both the @uref{news:gnu.emacs.help} and | |
911 | @uref{news:comp.emacs} newsgroups. Every news reader should allow you | |
912 | to read any news article that is still in the news spool, even if you | |
913 | have read the article before. You may need to read the instructions for | |
914 | your news reader to discover how to do this. In @file{rn}, this command | |
915 | will do this for you at the article selection level: | |
916 | ||
917 | @example | |
918 | ?GNU Emacs Frequently Asked Questions?rc:m | |
919 | @end example | |
920 | ||
921 | In Gnus, you should type @kbd{C-u C-x C-s} from the @file{*Summary*} | |
922 | buffer or @kbd{C-u @key{SPC}} from the @file{*Newsgroup*} buffer to view | |
923 | all articles in a newsgroup. | |
924 | ||
925 | If the FAQ articles have expired and been deleted from your news spool, | |
926 | it might (or might not) do some good to complain to your news | |
927 | administrator, because the most recent FAQ should not expire for a | |
928 | while. | |
929 | ||
930 | @item Via HTTP or FTP. You can always fetch the latest FAQ from | |
931 | ||
932 | @uref{http://www.lerner.co.il/emacs/} and | |
933 | ||
934 | @uref{ftp://ftp.lerner.co.il/pub/emacs/} | |
935 | ||
936 | @item | |
937 | In the Emacs distribution. Since Emacs 18.56, the FAQ at the time | |
938 | of release has been part of the Emacs distribution as @file{etc/FAQ} | |
939 | (@pxref{Filename conventions}). | |
940 | ||
941 | @item | |
942 | Via the World Wide Web. A hypertext version is available at | |
943 | ||
944 | @uref{http://www.lerner.co.il/emacs/} | |
945 | ||
946 | @item | |
947 | Via anonymous ftp and e-mail from @file{rtfm.mit.edu} (and its mirror in | |
948 | Europe), the main repository for FAQs and other items posted to | |
949 | news.answers. The Emacs FAQs are available at | |
950 | ||
951 | @uref{ftp://rtfm.mit.edu/pub/usenet/comp.emacs/} and | |
952 | ||
953 | @uref{ftp://ftp.uni-paderborn.de/pub/doc/FAQ/comp/emacs/} | |
954 | ||
955 | If you do not have access to anonymous FTP, you can access the archives | |
956 | using the @file{rtfm.mit.edu} mail server. The Emacs FAQ can be | |
957 | retrieved by sending mail to @email{mail-server@@rtfm.mit.edu} with a | |
958 | blank subject and containing | |
959 | ||
960 | @example | |
961 | send usenet/news.answers/GNU-Emacs-FAQ/diffs | |
962 | send usenet/news.answers/GNU-Emacs-FAQ/part1 | |
963 | send usenet/news.answers/GNU-Emacs-FAQ/part2 | |
964 | send usenet/news.answers/GNU-Emacs-FAQ/part3 | |
965 | send usenet/news.answers/GNU-Emacs-FAQ/part4 | |
966 | send usenet/news.answers/GNU-Emacs-FAQ/part5 | |
967 | @end example | |
968 | ||
969 | For more information, send email to @email{mail-server@@rtfm.mit.edu} | |
970 | with "help" and "index" in the body on separate lines. | |
971 | ||
972 | @item | |
973 | As the very last resort, you can e-mail a request to | |
974 | @email{emacs-faq@@lerner.co.il}. Don't do this unless you have made a | |
975 | serious effort to obtain the FAQ list via one of the methods listed | |
976 | above. | |
977 | ||
978 | @end itemize | |
979 | ||
980 | @c ------------------------------------------------------------ | |
981 | @node Status of Emacs, Common requests, Getting help, Top | |
982 | @chapter Status of Emacs | |
983 | @cindex Status of Emacs | |
984 | ||
985 | This section gives you basic information about Emacs, including its | |
986 | latest version status. | |
987 | ||
988 | @menu | |
989 | * Origin of the term Emacs:: | |
990 | * Latest version of Emacs:: | |
991 | * New in Emacs 20:: | |
992 | @end menu | |
993 | ||
994 | @node Origin of the term Emacs, Latest version of Emacs, Status of Emacs, Status of Emacs | |
995 | @section Where does the name "Emacs" come from? | |
996 | @cindex Origin of the term "Emacs" | |
997 | @cindex Emacs name origin | |
998 | @cindex TECO | |
999 | @cindex Original version of Emacs | |
1000 | ||
1001 | Emacs originally was an acronym for Editor MACroS. RMS says he "picked | |
1002 | the name Emacs because @key{E} was not in use as an abbreviation on ITS at | |
1003 | the time." The first Emacs was a set of macros written in 1976 at MIT | |
1004 | by RMS for the editor TECO (Text Editor and COrrector, originally Tape | |
1005 | Editor and COrrector) under ITS on a PDP-10. RMS had already extended | |
1006 | TECO with a "real-time" full screen mode with reprogrammable keys. | |
1007 | Emacs was started by @email{gls@@east.sun.com, Guy Steele} as a project | |
1008 | to unify the many divergent TECO command sets and key bindings at MIT, | |
1009 | and completed by RMS. | |
1010 | ||
1011 | Many people have said that TECO code looks a lot like line noise; you | |
1012 | can read more at @uref{news:alt.lang.teco}. Someone has written a TECO | |
1013 | implementation in Emacs Lisp (to find it, @ref{Packages that do not come | |
1014 | with Emacs}); it would be an interesting project to run the original | |
1015 | TECO Emacs inside of Emacs. | |
1016 | ||
1017 | For some not-so-serious alternative reasons for Emacs to have that | |
1018 | name, check out @file{etc/JOKES} (@pxref{Filename conventions}). | |
1019 | ||
1020 | @node Latest version of Emacs, New in Emacs 20, Origin of the term Emacs, Status of Emacs | |
1021 | @section What is the latest version of Emacs? | |
1022 | @cindex Version, latest | |
1023 | @cindex Latest version | |
1024 | ||
0d17cd5c | 1025 | Emacs 20.5 is the current version as of this writing. |
71e68827 DL |
1026 | |
1027 | @node New in Emacs 20, , Latest version of Emacs, Status of Emacs | |
1028 | @section What is different about Emacs 20? | |
1029 | @cindex Differences between Emacs 19 and Emacs 20 | |
1030 | @cindex Emacs 20, new features in | |
1031 | @cindex Recently introduced features | |
1032 | ||
1033 | To find out what has changed in recent versions, type @kbd{C-h n} | |
1034 | (@kbd{M-x view-emacs-news}). The oldest changes are at the bottom of | |
1035 | the file, so you might want to read it starting there, rather than at | |
1036 | the top. | |
1037 | ||
1038 | The differences between Emacs versions 18 and 19 was rather dramatic; | |
1039 | the introduction of frames, faces, and colors on windowing systems was | |
1040 | obvious to even the most casual user. | |
1041 | ||
1042 | There are differences between Emacs versions 19 and 20 as well, but many | |
1043 | are more subtle or harder to find. Among the changes are the inclusion | |
1044 | of MULE code for languages that use non-Latin characters, the "customize" | |
1045 | facility for modifying variables without having to use Lisp, and | |
1046 | automatic conversion of files from Macintosh, Microsoft, and Unix | |
1047 | platforms. | |
1048 | ||
1049 | A number of older Lisp packages, such as Gnus, Supercite and the | |
1050 | calendar/diary, have been updated and enhanced to work with Emacs 20, | |
1051 | and are now included with the standard distribution. | |
1052 | ||
1053 | ||
1054 | @c ------------------------------------------------------------ | |
1055 | @node Common requests, Bugs and problems, Status of Emacs, Top | |
1056 | @chapter Common requests | |
1057 | @cindex Common requests | |
1058 | ||
1059 | @menu | |
1060 | * Setting up a customization file:: | |
1061 | * Debugging a customization file:: | |
1062 | * Displaying the current line or column:: | |
1063 | * Displaying the current filename in the titlebar:: | |
1064 | * Turning on abbrevs by default:: | |
1065 | * Turning on auto-fill by default:: | |
1066 | * Associating modes with files:: | |
1067 | * Working with unprintable characters:: | |
1068 | * Highlighting a region:: | |
1069 | * Controlling case sensitivity:: | |
1070 | * Wrapping words automatically:: | |
1071 | * Spell-checkers:: | |
1072 | * Checking TeX and *roff documents:: | |
1073 | * Changing load-path:: | |
1074 | * Using an already running Emacs process:: | |
1075 | * Compiler error messages:: | |
1076 | * Indenting switch statements:: | |
1077 | * Horizontal scrolling:: | |
1078 | * Overwrite mode:: | |
1079 | * Turning off beeping:: | |
1080 | * Turning the volume down:: | |
1081 | * Automatic indentation:: | |
1082 | * Matching parentheses:: | |
1083 | * Hiding #ifdef lines:: | |
1084 | * Repeating commands:: | |
1085 | * Valid X resources:: | |
1086 | * Evaluating Emacs Lisp code:: | |
1087 | * Changing the length of a Tab:: | |
1088 | * Inserting > at the beginning of each line:: | |
1089 | * Underlining paragraphs:: | |
1090 | * Repeating a command as many times as possible:: | |
1091 | * Forcing the cursor to remain in the same column:: | |
1092 | * Forcing Emacs to iconify itself:: | |
1093 | * Using regular expressions:: | |
1094 | * Replacing text across multiple files:: | |
1095 | * Documentation for etags:: | |
1096 | * Disabling backups:: | |
1097 | * Disabling auto-save-mode:: | |
1098 | * Modifying pull-down menus:: | |
1099 | * Deleting menus and menu options:: | |
1100 | * Turning on syntax highlighting:: | |
1101 | * Scrolling only one line:: | |
1102 | * Replacing highlighted text:: | |
1103 | * Editing MS-DOS files:: | |
1104 | * Filling paragraphs with a single space:: | |
1105 | @end menu | |
1106 | ||
1107 | @node Setting up a customization file, Debugging a customization file, Common requests, Common requests | |
1108 | @section How do I set up a @file{.emacs} file properly? | |
1109 | @cindex @file{.emacs} file, setting up | |
1110 | @cindex Init file, setting up | |
1111 | @cindex Customization file, setting up | |
1112 | ||
1113 | @inforef{Init File, Init File, emacs} | |
1114 | ||
1115 | In general, new Emacs users should not have @file{.emacs} files, because | |
1116 | it causes confusing non-standard behavior. Then they send questions to | |
1117 | @email{help-gnu-emacs@@gnu.org} asking why Emacs isn't behaving as | |
1118 | documented. | |
1119 | ||
1120 | Emacs 20 includes the new @code{customize} facility, which can be | |
1121 | invoked using @kbd{M-x customize @key{RET}}. This allows users who are | |
1122 | unfamiliar with Emacs Lisp to modify their @file{.emacs} files in a | |
1123 | relatively straightforward way, using menus rather than Lisp code. Not | |
1124 | all packages support Customize as of this writing, but the number is | |
1125 | growing fairly steadily. | |
1126 | ||
1127 | While @code{customize} might indeed make it easier to configure Emacs, | |
1128 | consider taking a bit of time to learn Emacs Lisp and modifying your | |
1129 | @file{.emacs} directly. Simple configuration options are described | |
1130 | rather completely in @inforef{Init File, Init File, emacs}, for users | |
1131 | interested in performing frequently requested, basic tasks. | |
1132 | ||
1133 | @node Debugging a customization file, Displaying the current line or column, Setting up a customization file, Common requests | |
1134 | @section How do I debug a @file{.emacs} file? | |
1135 | @cindex Debugging @file{.emacs} file | |
1136 | @cindex @file{.emacs} debugging | |
1137 | @cindex Init file debugging | |
1138 | @cindex @samp{-debug-init} | |
1139 | ||
1140 | Start Emacs with the @samp{-debug-init} command-line option. This | |
1141 | enables the Emacs Lisp debugger before evaluating your @file{.emacs} | |
1142 | file, and places you in the debugger if something goes wrong. The top | |
1143 | line in the @file{trace-back} buffer will be the error message, and the | |
1144 | second or third line of that buffer will display the Lisp code from your | |
1145 | @file{.emacs} file that caused the problem. | |
1146 | ||
1147 | You can also evaluate an individual function or argument to a function | |
1148 | in your @file{.emacs} file by moving the cursor to the end of the | |
1149 | function or argument and typing @kbd{C-x C-e} (@kbd{M-x | |
1150 | eval-last-sexp}). | |
1151 | ||
1152 | Use @kbd{C-h v} (@kbd{M-x describe-variable}) to check the value of | |
1153 | variables which you are trying to set or use. | |
1154 | ||
1155 | @node Displaying the current line or column, Displaying the current filename in the titlebar, Debugging a customization file, Common requests | |
1156 | @section How do I make Emacs display the current line (or column) number? | |
1157 | @cindex @code{line-number-mode} | |
1158 | @cindex Displaying the current line or column | |
1159 | @cindex Line number, displaying the current | |
1160 | @cindex Column, displaying the current | |
1161 | @cindex @code{mode-line-format} | |
1162 | ||
1163 | To have Emacs automatically display the current line number of the point | |
1164 | in the mode line, do @kbd{M-x line-number-mode}. You can also put the | |
1165 | form | |
1166 | ||
1167 | @lisp | |
1168 | (setq line-number-mode t) | |
1169 | @end lisp | |
1170 | ||
1171 | in your @file{.emacs} file to achieve this whenever you start Emacs. | |
1172 | Note that Emacs will not display the line number if the buffer is larger | |
1173 | than the value of the variable @code{line-number-display-limit}. | |
1174 | ||
1175 | As of Emacs 20, you can similarly display the current column with | |
1176 | @kbd{M-x column-number-mode}, or by putting the form | |
1177 | ||
1178 | @lisp | |
1179 | (setq column-number-mode t) | |
1180 | @end lisp | |
1181 | ||
1182 | in your @file{.emacs} file. | |
1183 | ||
1184 | The "%c" format specifier in the variable @code{mode-line-format} will | |
1185 | insert the current column's value into the mode line. See the | |
1186 | documentation for @code{mode-line-format} (using @kbd{C-h v | |
1187 | mode-line-format @key{RET}}) for more information on how to set and use | |
1188 | this variable. | |
1189 | ||
1190 | Users of all Emacs versions can display the current column using | |
1191 | @email{abraham@@iesd.auc.dk, Per Abrahamsen's} "column" package. | |
0d17cd5c | 1192 | @xref{Packages that do not come with Emacs}, for instructions on how to |
71e68827 DL |
1193 | get it. |
1194 | ||
1195 | None of the vi emulation modes provide the "set number" capability of vi | |
1196 | (as far as we know). | |
1197 | ||
1198 | @node Displaying the current filename in the titlebar, Turning on abbrevs by default, Displaying the current line or column, Common requests | |
1199 | @section How can I modify the titlebar to contain the current filename? | |
1200 | @cindex Titlebar, displaying the current filename in | |
1201 | @cindex Filename, displaying in the titlebar | |
1202 | @cindex @code{frame-title-format} | |
1203 | ||
1204 | The contains of an Emacs frame's titlebar is controlled by the variable | |
1205 | @code{frame-title-format}, which has the same structure as the variable | |
1206 | @code{mode-line-format}. (Use @kbd{C-h v} or @kbd{M-x | |
1207 | describe-variable} to get information about one or both of these | |
1208 | variables.) | |
1209 | ||
1210 | By default, the titlebar for a frame does contain the name of the buffer | |
1211 | currently being visited, except if there is a single frame. In such a | |
1212 | case, the titlebar contains the name of the user and the machine at | |
1213 | which Emacs was invoked. This is done by setting | |
1214 | @code{frame-title-format} to the default value of | |
1215 | ||
1216 | @lisp | |
1217 | (multiple-frames "%b" ("" invocation-name "@@" system-name)) | |
1218 | @end lisp | |
1219 | ||
1220 | To modify the behavior such that frame titlebars contain the buffer's | |
1221 | name regardless of the number of existing frames, include the following | |
1222 | in your @file{.emacs}: | |
1223 | ||
1224 | @lisp | |
1225 | (setq frame-title-format "%b") | |
1226 | @end lisp | |
1227 | ||
1228 | @node Turning on abbrevs by default, Turning on auto-fill by default, Displaying the current filename in the titlebar, Common requests | |
1229 | @section How do I turn on abbrevs by default just in mode XXX? | |
1230 | @cindex Abbrevs, turning on by default | |
1231 | ||
1232 | Put this in your @file{.emacs} file: | |
1233 | ||
1234 | @lisp | |
1235 | (condition-case () | |
1236 | (quietly-read-abbrev-file) | |
1237 | (file-error nil)) | |
1238 | ||
1239 | (add-hook 'XXX-mode-hook | |
bed44076 SM |
1240 | (lambda () |
1241 | (setq abbrev-mode t))) | |
71e68827 DL |
1242 | @end lisp |
1243 | ||
1244 | @node Turning on auto-fill by default, Associating modes with files, Turning on abbrevs by default, Common requests | |
1245 | @section How do I turn on @code{auto-fill-mode} by default? | |
1246 | @cindex @code{auto-fill-mode}, activating automatically | |
1247 | @cindex Filling automatically | |
1248 | @cindex Automatic entry to @code{auto-fill-mode} | |
1249 | ||
1250 | To turn on @code{auto-fill-mode} just once for one buffer, use @kbd{M-x | |
1251 | auto-fill-mode}. | |
1252 | ||
1253 | To turn it on for every buffer in a certain mode, you must use the hook | |
1254 | for that mode. For example, to turn on @code{auto-fill} mode for all | |
1255 | text buffers, including the following in your @file{.emacs} file: | |
1256 | ||
1257 | @lisp | |
1258 | (add-hook 'text-mode-hook 'turn-on-auto-fill) | |
1259 | @end lisp | |
1260 | ||
1261 | If you want @code{auto-fill} mode on in all major modes, do this: | |
1262 | ||
1263 | @lisp | |
1264 | (setq-default auto-fill-function 'do-auto-fill) | |
1265 | @end lisp | |
1266 | ||
1267 | @node Associating modes with files, Working with unprintable characters, Turning on auto-fill by default, Common requests | |
1268 | @section How do I make Emacs use a certain major mode for certain files? | |
1269 | @cindex Associating modes with files | |
1270 | @cindex File extensions and modes | |
1271 | @cindex @code{auto-mode-alist}, modifying | |
1272 | @cindex Modes, associating with file extensions | |
1273 | ||
1274 | If you want to use XXX mode for all files which end with the extension | |
1275 | @samp{.YYY}, this will do it for you: | |
1276 | ||
1277 | @lisp | |
1278 | (setq auto-mode-alist (cons '("\\.YYY\\'" . XXX-mode) auto-mode-alist)) | |
1279 | @end lisp | |
1280 | ||
1281 | Otherwise put this somewhere in the first line of any file you want to | |
1282 | edit in XXX mode (in the second line, if the first line begins with | |
1283 | @samp{#!}): | |
1284 | ||
1285 | @example | |
1286 | -*-XXX-*- | |
1287 | @end example | |
1288 | ||
1289 | Beginning with Emacs 19, the variable @code{interpreter-mode-alist} | |
1290 | specifies which mode to use when loading a shell script. (Emacs | |
1291 | determines which interpreter you're using by examining the first line of | |
1292 | the file.) This feature only applies when the file name doesn't | |
1293 | indicate which mode to use. Use @kbd{C-h v} (or @kbd{M-x | |
1294 | describe-variable}) on @code{interpreter-mode-alist} to learn more. | |
1295 | ||
1296 | @node Working with unprintable characters, Highlighting a region, Associating modes with files, Common requests | |
1297 | @section How do I search for, delete, or replace unprintable (eight-bit or control) characters? | |
1298 | @cindex Unprintable characters, working with | |
1299 | @cindex Working with unprintable characters | |
1300 | @cindex Control characters, working with | |
1301 | @cindex Eight-bit characters, working with | |
1302 | @cindex Searching for unprintable characters | |
1303 | @cindex Regexps and unprintable characters | |
1304 | ||
1305 | To search for a single character that appears in the buffer as, for | |
1306 | example, @samp{\237}, you can type @kbd{C-s C-q 2 3 7}. (This assumes | |
1307 | the value of @code{search-quote-char} is 17 (i.e., @kbd{C-q}).) | |
1308 | Searching for ALL unprintable characters is best done with a regular | |
1309 | expression ("regexp") search. The easiest regexp to use for the | |
1310 | unprintable chars is the complement of the regexp for the printable | |
1311 | chars. | |
1312 | ||
1313 | @itemize @bullet | |
1314 | ||
1315 | @item | |
1316 | Regexp for the printable chars: @samp{[\t\n\r\f -~]} | |
1317 | ||
1318 | @item | |
1319 | Regexp for the unprintable chars: @samp{[^\t\n\r\f -~]} | |
1320 | ||
1321 | @end itemize | |
1322 | ||
1323 | To type these special characters in an interactive argument to | |
1324 | @code{isearch-forward-regexp} or @code{re-search-forward}, you need to | |
1325 | use @kbd{C-q}. (@samp{\t}, @samp{\n}, @samp{\r}, and @samp{\f} stand | |
1326 | respectively for @key{TAB}, @key{LFD}, @key{RET}, and @kbd{C-l}.) So, | |
1327 | to search for unprintable characters using @code{re-search-forward}: | |
1328 | ||
1329 | @kbd{M-x re-search-forward @key{RET} [^ @key{TAB} C-q @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~] @key{RET}} | |
1330 | ||
1331 | Using @code{isearch-forward-regexp}: | |
1332 | ||
1333 | @kbd{M-C-s [^ @key{TAB} @key{RET} C-q @key{RET} C-q C-l @key{SPC} -~]} | |
1334 | ||
1335 | To delete all unprintable characters, simply use replace-regexp: | |
1336 | ||
1337 | @kbd{M-x replace-regexp @key{RET} [^ @key{TAB} C-q @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~] @key{RET} @key{RET}} | |
1338 | ||
1339 | Replacing is similar to the above. To replace all unprintable | |
1340 | characters with a colon, use: | |
1341 | ||
1342 | M-x replace-regexp @key{RET} [^ @key{TAB} C-q @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~] @key{RET} : @key{RET} | |
1343 | ||
1344 | @itemize @bullet | |
1345 | ||
1346 | @item You don't need to quote @key{TAB} with either isearch or typing | |
1347 | something in the minibuffer. | |
1348 | ||
1349 | @end itemize | |
1350 | ||
1351 | @node Highlighting a region, Controlling case sensitivity, Working with unprintable characters, Common requests | |
1352 | @section How can I highlight a region of text in Emacs? | |
1353 | @cindex Highlighting text | |
1354 | @cindex Text, highlighting | |
1355 | @cindex @code{transient-mark-mode} | |
1356 | @cindex Region, highlighting a | |
1357 | ||
1358 | If you are using a windowing system such as X, you can cause the region | |
1359 | to be highlighted when the mark is active by including | |
1360 | ||
1361 | @lisp | |
1362 | (transient-mark-mode t) | |
1363 | @end lisp | |
1364 | ||
1365 | in your @file{.emacs} file. (Also see @xref{Turning on syntax highlighting}.) | |
1366 | ||
1367 | @node Controlling case sensitivity, Wrapping words automatically, Highlighting a region, Common requests | |
1368 | @section How do I control Emacs's case-sensitivity when searching/replacing? | |
1369 | @cindex @code{case-fold-search} | |
1370 | @cindex Case sensitivity of searches | |
1371 | @cindex @code{case-replace} | |
1372 | @cindex Searching without case sensitivity | |
1373 | @cindex Ignoring case in searches | |
1374 | ||
1375 | For searching, the value of the variable @code{case-fold-search} | |
1376 | determines whether they are case sensitive: | |
1377 | ||
1378 | @lisp | |
1379 | (setq case-fold-search nil) ; make searches case sensitive | |
1380 | (setq case-fold-search t) ; make searches case insensitive | |
1381 | @end lisp | |
1382 | ||
1383 | Similarly, for replacing the variable @code{case-replace} determines | |
1384 | whether replacements preserve case. | |
1385 | ||
1386 | To change the case sensitivity just for one major mode, use the major | |
1387 | mode's hook. For example: | |
1388 | ||
1389 | @lisp | |
1390 | (add-hook 'XXX-mode-hook | |
bed44076 SM |
1391 | (lambda () |
1392 | (setq case-fold-search nil))) | |
71e68827 DL |
1393 | @end lisp |
1394 | ||
1395 | @node Wrapping words automatically, Spell-checkers, Controlling case sensitivity, Common requests | |
1396 | @section How do I make Emacs wrap words for me? | |
1397 | @cindex Wrapping word automatically | |
1398 | @cindex @code{auto-fill-mode}, introduction to | |
1399 | @cindex Maximum line width, default value | |
1400 | @cindex @code{fill-column}, default value | |
1401 | ||
1402 | Use @code{auto-fill-mode}, activated by typing @kbd{M-x auto-fill-mode}. | |
1403 | The default maximum line width is 70, determined by the variable | |
1404 | @code{fill-column}. To learn how to turn this on automatically, @pxref{Turning on auto-fill by default}. | |
1405 | ||
1406 | @node Spell-checkers, Checking TeX and *roff documents, Wrapping words automatically, Common requests | |
1407 | @section Where can I get a better spelling checker for Emacs? | |
1408 | @cindex Checking spelling | |
1409 | @cindex Spelling, checking text documents | |
1410 | ||
1411 | Use Ispell. @xref{Ispell}. | |
1412 | ||
1413 | @node Checking TeX and *roff documents, Changing load-path, Spell-checkers, Common requests | |
1414 | @section How can I spell-check @TeX{} or *roff documents? | |
1415 | @cindex Spelling, checking @TeX{} documents | |
1416 | @cindex @TeX{} documents, checking spelling in | |
1417 | ||
1418 | Use Ispell. Ispell can handle @TeX{} and *roff documents. | |
1419 | @xref{Ispell}. | |
1420 | ||
1421 | @node Changing load-path, Using an already running Emacs process, Checking TeX and *roff documents, Common requests | |
1422 | @section How do I change @code{load-path}? | |
1423 | @cindex @code{load-path}, modifying | |
1424 | @cindex Modifying @code{load-path} | |
1425 | @cindex Adding to @code{load-path} | |
1426 | ||
1427 | In general, you should only add to the @code{load-path}. You can add | |
1428 | directory @var{/XXX/YYY} to the load path like this: | |
1429 | ||
1430 | @lisp | |
1431 | (setq load-path (cons "/XXX/YYY/" load-path)) | |
1432 | @end lisp | |
1433 | ||
1434 | To do this relative to your home directory: | |
1435 | ||
1436 | @lisp | |
1437 | (setq load-path (cons "~/YYY/" load-path) | |
1438 | @end lisp | |
1439 | ||
1440 | @node Using an already running Emacs process, Compiler error messages, Changing load-path, Common requests | |
1441 | @section How do I use an already running Emacs from another window? | |
1442 | @cindex @code{emacsclient} | |
1443 | @cindex Emacs server functions | |
1444 | @cindex Using an existing Emacs process | |
1445 | ||
1446 | @code{emacsclient}, which comes with Emacs, is for editing a file using | |
1447 | an already running Emacs rather than starting up a new Emacs. It does | |
1448 | this by sending a request to the already running Emacs, which must be | |
1449 | expecting the request. | |
1450 | ||
1451 | @itemize @bullet | |
1452 | ||
1453 | @item | |
1454 | Setup | |
1455 | ||
1456 | Emacs must have executed the @code{server-start} function for | |
1457 | @samp{emacsclient} to work. This can be done either by a command line | |
1458 | option: | |
1459 | ||
1460 | @example | |
1461 | emacs -f server-start | |
1462 | @end example | |
1463 | ||
1464 | or by invoking @code{server-start} from @file{.emacs}: | |
1465 | ||
1466 | @lisp | |
1467 | (if (some conditions are met) (server-start)) | |
1468 | @end lisp | |
1469 | ||
1470 | When this is done, Emacs starts a subprocess running a program called | |
1de6bfb1 GM |
1471 | @samp{server}. @samp{server} creates a Unix domain socket. The socket |
1472 | is either named @file{.emacs_server}, in the user's home directory, | |
1473 | or @file{esrv-@var{USER-ID}-@var{SYSTEM-NAME}}, in the @file{/tmp} | |
1474 | directory, depending on how @samp{emacsserver} was compiled. | |
71e68827 DL |
1475 | |
1476 | To get your news reader, mail reader, etc., to invoke | |
1477 | @samp{emacsclient}, try setting the environment variable @code{EDITOR} | |
1478 | (or sometimes @code{VISUAL}) to the value @samp{emacsclient}. You may | |
1479 | have to specify the full pathname of the @samp{emacsclient} program | |
1480 | instead. Examples: | |
1481 | ||
1482 | @example | |
1483 | # csh commands: | |
1484 | setenv EDITOR emacsclient | |
1485 | ||
1486 | # using full pathname | |
1487 | setenv EDITOR /usr/local/emacs/etc/emacsclient | |
1488 | ||
1489 | # sh command: | |
1490 | EDITOR=emacsclient ; export EDITOR | |
1491 | @end example | |
1492 | ||
1493 | @item Normal use | |
1494 | ||
1495 | When @samp{emacsclient} is run, it connects to the @file{.emacs_server} | |
1496 | socket and passes its command line options to @samp{server}. When | |
1497 | @samp{server} receives these requests, it sends this information on the | |
1498 | the Emacs process, which at the next opportunity will visit the files | |
1499 | specified. (Line numbers can be specified just like with Emacs.) The | |
1500 | user will have to switch to the Emacs window by hand. When the user is | |
1501 | done editing a file, the user can type @kbd{C-x #} (or @kbd{M-x | |
1502 | server-edit}) to indicate this. If there is another buffer requested by | |
1503 | emacsclient, Emacs will switch to it; otherwise emacsclient will exit, | |
1504 | signaling the calling program to continue. | |
1505 | ||
1506 | @samp{emacsclient} and @samp{server} must be running on machines which | |
1507 | share the same filesystem for this to work. The pathnames that | |
1508 | @samp{emacsclient} specifies should be correct for the filesystem that | |
1509 | the Emacs process sees. The Emacs process should not be suspended at | |
1510 | the time @samp{emacsclient} is invoked. @samp{emacsclient} should | |
1511 | either be invoked from another X window or from a shell window inside | |
1512 | Emacs itself. | |
1513 | ||
1514 | There is an enhanced version of @samp{emacsclient}/server called | |
1515 | @samp{gnuserv} by @email{ange@@hplb.hpl.hp.com, Andy Norman} which is | |
1516 | available in the Emacs Lisp Archive (@pxref{Packages that do not come | |
1517 | with Emacs}). @samp{gnuserv} uses Internet domain sockets, so it can | |
1518 | work across most network connections. It also supports the execution of | |
1519 | arbitrary Emacs Lisp forms and does not require the client program to | |
1520 | wait for completion. | |
1521 | ||
1522 | The alpha version of an enhanced @samp{gnuserv} is available | |
1523 | at | |
1524 | ||
1525 | @uref{ftp://ftp.wellfleet.com/netman/psmith/emacs/gnuserv-2.1alpha.tar.gz} | |
1526 | ||
1527 | @end itemize | |
1528 | ||
1529 | @node Compiler error messages, Indenting switch statements, Using an already running Emacs process, Common requests | |
1530 | @section How do I make Emacs recognize my compiler's funny error messages? | |
1531 | @cindex Compiler error messages, recognizing | |
1532 | @cindex Recognizing non-standard compiler errors | |
1533 | @cindex Regexps for recognizing compiler errors | |
1534 | @cindex Errors, recognizing compiler | |
1535 | ||
1536 | The variable @code{compilation-error-regexp-alist} helps control how | |
1537 | Emacs parses your compiler output. It is a list of triples of the form: | |
0d17cd5c DL |
1538 | @code{(@var{regexp} @var{file-idx} @var{line-idx})}, where @var{regexp}, @var{file-idx} and |
1539 | @var{line-idx} are strings. To help determine what the constituent | |
71e68827 DL |
1540 | elements should be, load @file{compile.el} and then use @kbd{C-h v |
1541 | compilation-error-regexp-alist @key{RET}} | |
1542 | ||
1543 | to see the current value. A good idea is to look at @file{compile.el} | |
1544 | itself as the comments included for this variable are quite useful --- | |
1545 | the regular expressions required for your compiler's output may be very | |
1546 | close to one already provided. Once you have determined the proper | |
1547 | regexps, use the following to inform Emacs of your changes: | |
1548 | ||
1549 | @lisp | |
1550 | (setq compilation-error-regexp-alist | |
1551 | (cons '(REGEXP FILE-IDX LINE-IDX) | |
1552 | compilation-error-regexp-alist)) | |
1553 | @end lisp | |
1554 | ||
1555 | @node Indenting switch statements, Horizontal scrolling, Compiler error messages, Common requests | |
1556 | @section How do I change the indentation for @code{switch}? | |
1557 | @cindex @code{switch}, indenting | |
1558 | @cindex Indenting of @code{switch} | |
1559 | ||
1560 | Many people want to indent their @code{switch} statements like this: | |
1561 | ||
1562 | @example | |
1563 | f() | |
1564 | @{ | |
1565 | switch(x) @{ | |
1566 | case A: | |
1567 | x1; | |
1568 | break; | |
1569 | case B: | |
1570 | x2; | |
1571 | break; | |
1572 | default: | |
1573 | x3; | |
1574 | @} | |
1575 | @} | |
1576 | @end example | |
1577 | ||
1578 | The solution at first appears to be: set @code{c-indent-level} to 4 and | |
1579 | @code{c-label-offset} to -2. However, this will give you an indentation | |
1580 | spacing of four instead of two. | |
1581 | ||
1582 | The solution is to use @code{cc-mode} (the default mode for C | |
1583 | programming in Emacs 20) and add the following line: | |
1584 | ||
1585 | @lisp | |
1586 | (c-set-offset 'case-label '+) | |
1587 | @end lisp | |
1588 | ||
1589 | There appears to be no way to do this with the old @code{c-mode}. | |
1590 | ||
1591 | @node Horizontal scrolling, Overwrite mode, Indenting switch statements, Common requests | |
1592 | @section How can I make Emacs automatically scroll horizontally? | |
1593 | @cindex @code{hscroll-mode} | |
1594 | @cindex Horizontal scrolling | |
1595 | @cindex Scrolling horizontally | |
1596 | ||
1597 | Use @code{hscroll-mode}, included in Emacs 20. Here is some information from | |
1598 | the documentation, available by typing @kbd{C-h f hscroll-mode @key{RET}}: | |
1599 | ||
1600 | Automatically scroll horizontally when the point moves off the | |
1601 | left or right edge of the window. | |
1602 | ||
1603 | @itemize @minus | |
1604 | ||
1605 | @item Type @kbd{M-x hscroll-mode} to enable it in the current buffer. | |
1606 | @item Type @kbd{M-x hscroll-global-mode} to enable it in every buffer. | |
1607 | @item @code{turn-on-hscroll} is useful in mode hooks as in: | |
1608 | ||
1609 | @lisp | |
1610 | (add-hook 'text-mode-hook 'turn-on-hscroll) | |
1611 | @end lisp | |
1612 | ||
1613 | @item @code{hscroll-margin} controls how close the cursor can get to the | |
1614 | edge of the window. | |
1615 | ||
1616 | @item @code{hscroll-step-percent} controls how far to jump once we decide to do so. | |
1617 | ||
1618 | @end itemize | |
1619 | ||
1620 | @node Overwrite mode, Turning off beeping, Horizontal scrolling, Common requests | |
1621 | @section How do I make Emacs "typeover" or "overwrite" instead of inserting? | |
1622 | @cindex @key{Insert} | |
1623 | @cindex @code{overwrite-mode} | |
1624 | @cindex Overwriting existing text | |
1625 | @cindex Toggling @code{overwrite-mode} | |
1626 | ||
1627 | @kbd{M-x overwrite-mode} (a minor mode). This toggles | |
1628 | @code{overwrite-mode} on and off, so exiting from @code{overwrite-mode} | |
1629 | is as easy as another @kbd{M-x overwrite-mode}. | |
1630 | ||
1631 | On some workstations, @key{Insert} toggles @code{overwrite-mode} on and off. | |
1632 | ||
1633 | @node Turning off beeping, Turning the volume down, Overwrite mode, Common requests | |
1634 | @section How do I stop Emacs from beeping on a terminal? | |
1635 | @cindex Beeping, turning off | |
1636 | @cindex Visible bell | |
1637 | @cindex Bell, visible | |
1638 | ||
1639 | @email{martin@@cc.gatech.edu, Martin R. Frank} writes: | |
1640 | ||
1641 | Tell Emacs to use the "visible bell" instead of the audible bell, and | |
1642 | set the visible bell to nothing. | |
1643 | ||
1644 | That is, put the following in your @code{TERMCAP} environment variable | |
1645 | (assuming you have one): | |
1646 | ||
1647 | @example | |
1648 | ... :vb=: ... | |
1649 | @end example | |
1650 | ||
1651 | And evaluate the following Lisp form: | |
1652 | ||
1653 | @example | |
1654 | (setq visible-bell t) | |
1655 | @end example | |
1656 | ||
1657 | @node Turning the volume down, Automatic indentation, Turning off beeping, Common requests | |
1658 | @section How do I turn down the bell volume in Emacs running under X Windows? | |
1659 | @cindex Bell, volume of | |
1660 | @cindex Volume of bell | |
1661 | ||
1662 | You can adjust the bell volume and duration for all programs with the | |
1663 | shell command @file{xset}. | |
1664 | ||
1665 | Invoking @file{xset} without any arguments produces some basic information, | |
1666 | including the following: | |
1667 | ||
1668 | @example | |
1669 | usage: xset [-display host:dpy] option ... | |
1670 | To turn bell off: | |
1671 | -b b off b 0 | |
1672 | To set bell volume, pitch and duration: | |
1673 | b [vol [pitch [dur]]] b on | |
1674 | @end example | |
1675 | ||
1676 | @node Automatic indentation, Matching parentheses, Turning the volume down, Common requests | |
1677 | @section How do I tell Emacs to automatically indent a new line to the indentation of the previous line? | |
1678 | @cindex Indenting new lines | |
1679 | @cindex New lines, indenting of | |
1680 | @cindex Previous line, indenting according to | |
1681 | ||
1682 | Such behavior is automatic in Emacs 20. From the NEWS file for Emacs | |
1683 | 20.2: | |
1684 | ||
1685 | @example | |
1686 | ** In Text mode, now only blank lines separate paragraphs. This makes | |
1687 | it possible to get the full benefit of Adaptive Fill mode in Text mode, | |
1688 | and other modes derived from it (such as Mail mode). @key{TAB} in Text | |
1689 | mode now runs the command @code{indent-relative}; this makes a practical | |
1690 | difference only when you use indented paragraphs. | |
1691 | ||
1692 | As a result, the old Indented Text mode is now identical to Text mode, | |
1693 | and is an alias for it. | |
1694 | ||
1695 | If you want spaces at the beginning of a line to start a paragraph, use | |
1696 | the new mode, Paragraph Indent Text mode. | |
1697 | @end example | |
1698 | ||
1699 | If you have @code{auto-fill-mode} on (@pxref{Turning on auto-fill by | |
1700 | default}), you can tell Emacs to prefix every line with a certain | |
1701 | character sequence, the "fill prefix." Type the prefix at the beginning | |
1702 | of a line, position point after it, and then type @kbd{C-x .} | |
1703 | (@code{set-fill-prefix}) to set the fill prefix. Thereafter, | |
1704 | auto-filling will automatically put the fill prefix at the beginning of | |
1705 | new lines, and @kbd{M-q} (@code{fill-paragraph}) will maintain any fill | |
1706 | prefix when refilling the paragraph. | |
1707 | ||
1708 | If you have paragraphs with different levels of indentation, you will | |
1709 | have to set the fill prefix to the correct value each time you move to a | |
1710 | new paragraph. To avoid this hassle, try one of the many packages | |
1711 | available from the Emacs Lisp Archive (@pxref{Packages that do not come | |
1712 | with Emacs}.) Look up "fill" and "indent" in the Lisp Code Directory | |
1713 | for guidance. | |
1714 | ||
1715 | @node Matching parentheses, Hiding #ifdef lines, Automatic indentation, Common requests | |
1716 | @section How do I show which parenthesis matches the one I'm looking at? | |
1717 | @cindex Parentheses, matching | |
1718 | @cindex @file{paren.el} | |
1719 | @cindex Highlighting matching parentheses | |
1720 | @cindex Pairs of parentheses, highlighting | |
1721 | @cindex Matching parentheses | |
1722 | ||
1723 | As of version 19, Emacs comes with @file{paren.el}, which (when loaded) | |
1724 | will automatically highlight matching parentheses whenever point (i.e., | |
1725 | the cursor) is located over one. To load @file{paren.el} automatically, | |
1726 | include the line | |
1727 | ||
1728 | @lisp | |
1729 | (require 'paren) | |
1730 | @end lisp | |
1731 | ||
1732 | in your @file{.emacs} file. @email{shutkoa@@ugsolutions.com, Alan Shutko} | |
1733 | reports that as of version 20.1, you must also call @code{show-paren-mode} in | |
1734 | your @file{.emacs} file: | |
1735 | ||
1736 | @lisp | |
1737 | (show-paren-mode 1) | |
1738 | @end lisp | |
1739 | ||
1740 | @code{customize} will let you turn on @code{show-paren-mode}. Use | |
1741 | @kbd{M-x customize-group @key{RET} paren-showing @key{RET}}. From | |
1742 | within @code{customize}, you can also go directly to the "paren-showing" | |
1743 | group. | |
1744 | ||
1745 | Alternatives to paren include: | |
1746 | ||
1747 | @itemize @bullet | |
1748 | ||
1749 | @item | |
1750 | If you're looking at a right parenthesis (or brace or bracket) you can | |
1751 | delete it and reinsert it. Emacs will blink the cursor on the matching | |
1752 | parenthesis. | |
1753 | ||
1754 | @item | |
1755 | @kbd{M-C-f} (@code{forward-sexp}) and @kbd{M-C-b} (@code{backward-sexp}) | |
1756 | will skip over one set of balanced parentheses, so you can see which | |
1757 | parentheses match. (You can train it to skip over balanced brackets | |
1758 | and braces at the same time by modifying the syntax @key{TAB}le.) | |
1759 | ||
1760 | @item | |
1761 | Here is some Emacs Lisp that will make the @key{%} key show the matching | |
1762 | parenthesis, like in vi. In addition, if the cursor isn't over a | |
1763 | parenthesis, it simply inserts a % like normal. | |
1764 | ||
1765 | @lisp | |
1766 | ;; By an unknown contributor | |
1767 | ||
1768 | (global-set-key "%" 'match-paren) | |
1769 | ||
1770 | (defun match-paren (arg) | |
1771 | "Go to the matching paren if on a paren; otherwise insert %." | |
1772 | (interactive "p") | |
1773 | (cond ((looking-at "\\s\(") (forward-list 1) (backward-char 1)) | |
1774 | ((looking-at "\\s\)") (forward-char 1) (backward-list 1)) | |
1775 | (t (self-insert-command (or arg 1))))) | |
1776 | @end lisp | |
1777 | ||
1778 | @end itemize | |
1779 | ||
1780 | @node Hiding #ifdef lines, Repeating commands, Matching parentheses, Common requests | |
1781 | @section In C mode, can I show just the lines that will be left after @code{#ifdef} commands are handled by the compiler? | |
1782 | @cindex @code{#ifdef}, selective display of | |
1783 | @cindex @code{hide-ifdef-mode} | |
1784 | @cindex Hiding @code{#ifdef} text | |
1785 | @cindex Selectively displaying @code{#ifdef} code | |
1786 | ||
1787 | @kbd{M-x hide-ifdef-mode}. (This is a minor mode.) You might also want | |
1788 | to try @file{cpp.el}, available at the Emacs Lisp Archive | |
1789 | (@pxref{Packages that do not come with Emacs}). | |
1790 | ||
1791 | @node Repeating commands, Valid X resources, Hiding #ifdef lines, Common requests | |
1792 | @section Is there an equivalent to the @code{.} (dot) command of vi? | |
1793 | @cindex Repeating commands as with vi | |
1794 | @cindex Command, repeat last | |
1795 | @cindex @code{.}, equivalent to vi command | |
1796 | ||
1797 | (@code{.} is the redo command in vi. It redoes the last insertion/deletion.) | |
1798 | ||
1799 | As of Emacs 20.3, there is indeed a @code{repeat} command (@kbd{C-x .}) | |
1800 | that repeats the last command. If you preface it with a prefix | |
1801 | argument, the prefix arg is applied to the command. | |
1802 | ||
1803 | You can also type @kbd{C-x @key{ESC} @key{ESC}} | |
1804 | (@code{repeat-complex-command}) to reinvoke commands that used the | |
1805 | minibuffer to get arguments. In @code{repeat-complex-command} you can | |
1806 | type @kbd{M-p} and @kbd{M-n} to scan through all the different complex | |
1807 | commands you've typed. | |
1808 | ||
1809 | To repeat a set of commands, use keyboard macros. (@inforef{Keyboard | |
1810 | Macros, Keyboard Macros, emacs}.) | |
1811 | ||
1812 | If you're really desperate for the @code{.} command, use VIPER, which comes | |
1813 | with Emacs, and which appears to support it. (@xref{VIPER}.) | |
1814 | ||
1815 | @node Valid X resources, Evaluating Emacs Lisp code, Repeating commands, Common requests | |
1816 | @section What are the valid X resource settings (i.e., stuff in .Xdefaults)? | |
1817 | @cindex Resources, X | |
1818 | @cindex X resources | |
1819 | @cindex Setting X resources | |
1820 | ||
1821 | @inforef{Resources X, Resources X, emacs}. | |
1822 | ||
1823 | You can also use a resource editor, such as editres (for X11R5 and | |
1824 | onwards), to look at the resource names for the menu bar, assuming Emacs | |
1825 | was compiled with the X toolkit. | |
1826 | ||
1827 | @node Evaluating Emacs Lisp code, Changing the length of a Tab, Valid X resources, Common requests | |
1828 | @section How do I execute ("evaluate") a piece of Emacs Lisp code? | |
1829 | @cindex Evaluating Lisp code | |
1830 | @cindex Lisp forms, evaluating | |
1831 | ||
1832 | There are a number of ways to execute ("evaluate," in Lisp lingo) an | |
1833 | Emacs Lisp "form": | |
1834 | ||
1835 | @itemize @bullet | |
1836 | ||
1837 | @item | |
1838 | If you want it evaluated every time you run Emacs, put it in a file | |
1839 | named @file{.emacs} in your home directory. This is known as your ".emacs | |
1840 | file," and contains all of your personal customizations. | |
1841 | ||
1842 | @item | |
1843 | You can type the form in the @file{*scratch*} buffer, and then type | |
1844 | @key{LFD} (or @kbd{C-j}) after it. The result of evaluating the form | |
1845 | will be inserted in the buffer. | |
1846 | ||
1847 | @item | |
1848 | In @code{emacs-lisp-mode}, typing @kbd{M-C-x} evaluates a top-level form | |
1849 | before or around point. | |
1850 | ||
1851 | @item | |
1852 | Typing @kbd{C-x C-e} in any buffer evaluates the Lisp form immediately | |
1853 | before point and prints its value in the echo area. | |
1854 | ||
1855 | @item | |
1856 | Typing @kbd{M-:} or @kbd{M-x eval-expression} allows you to type a Lisp | |
1857 | form in the minibuffer which will be evaluated. | |
1858 | ||
1859 | @item | |
1860 | You can use @kbd{M-x load-file} to have Emacs evaluate all the Lisp | |
1861 | forms in a file. (To do this from Lisp use the function @code{load} | |
1862 | instead.) | |
1863 | ||
1864 | The functions @code{load-library}, @code{eval-region}, | |
1865 | @code{eval-current-buffer}, @code{require}, and @code{autoload} are also | |
1866 | useful; @pxref{Emacs Lisp documentation} if you want to learn more about | |
1867 | them. | |
1868 | ||
1869 | @end itemize | |
1870 | ||
1871 | @node Changing the length of a Tab, Inserting > at the beginning of each line, Evaluating Emacs Lisp code, Common requests | |
1872 | @section How do I change Emacs's idea of the @key{TAB} character's length? | |
1873 | @cindex Tab length | |
1874 | @cindex Length of tab character | |
1875 | @cindex @code{default-tab-width} | |
1876 | ||
1877 | Set the variable @code{default-tab-width}. For example, to set | |
1878 | @key{TAB} stops every 10 characters, insert the following in your | |
1879 | @file{.emacs} file: | |
1880 | ||
1881 | @lisp | |
1882 | (setq default-tab-width 10) | |
1883 | @end lisp | |
1884 | ||
1885 | Do not confuse variable @code{tab-width} with variable | |
1886 | @code{tab-stop-list}. The former is used for the display of literal | |
1887 | @key{TAB} characters. The latter controls what characters are inserted | |
1888 | when you press the @key{TAB} character in certain modes. | |
1889 | ||
1890 | @node Inserting > at the beginning of each line, Underlining paragraphs, Changing the length of a Tab, Common requests | |
1891 | @section How do I insert @samp{>} at the beginning of every line? | |
1892 | @cindex Prefix character, inserting in mail/news replies | |
1893 | @cindex Replies to mail/news, inserting a prefix character | |
1894 | @cindex @code{mail-yank-prefix} | |
1895 | @cindex Mail replies, inserting a prefix character | |
1896 | @cindex News replies, inserting a prefix character | |
1897 | ||
1898 | To do this to an entire buffer, type @kbd{M-< M-x replace-regexp | |
1899 | @key{RET} ^ @key{RET} > @key{RET}}. | |
1900 | ||
1901 | To do this to a region, use @code{string-rectangle} (@kbd{C-x r t}). | |
1902 | Set the mark (@kbd{C-@key{SPC}}) at the beginning of the first line you | |
1903 | want to prefix, move the cursor to last line to be prefixed, and type | |
1904 | @kbd{C-x r t > @key{RET}}. To do this for the whole buffer, type | |
1905 | @kbd{C-x h C-x r t > @key{RET}}. | |
1906 | ||
1907 | If you are trying to prefix a yanked mail message with @samp{>}, you | |
1908 | might want to set the variable @code{mail-yank-prefix}. Better yet, get | |
1909 | the Supercite package (@pxref{Supercite}), which provides flexible | |
1910 | citation for yanked mail and news messages. @xref{Changing the included | |
0d17cd5c | 1911 | text prefix}, for additional information. |
71e68827 DL |
1912 | |
1913 | @node Underlining paragraphs, Repeating a command as many times as possible, Inserting > at the beginning of each line, Common requests | |
1914 | @section How do I insert "_^H" before each character in a region to get an underlined paragraph? | |
1915 | @cindex Underlining a region of text | |
1916 | @cindex @code{underline-region} | |
1917 | ||
1918 | @kbd{M-x underline-region}. | |
1919 | ||
1920 | @node Repeating a command as many times as possible, Forcing the cursor to remain in the same column, Underlining paragraphs, Common requests | |
1921 | @section How do I repeat a command as many times as possible? | |
1922 | @cindex Repeating commands | |
1923 | @cindex Commands, repeating | |
1924 | ||
1925 | Use @kbd{C-x (} and @kbd{C-x )} to make a keyboard macro that invokes | |
1926 | the command and then type @kbd{M-0 C-x e}. | |
1927 | ||
1928 | Any messages your command prints in the echo area will be suppressed. | |
1929 | ||
1930 | @node Forcing the cursor to remain in the same column, Forcing Emacs to iconify itself, Repeating a command as many times as possible, Common requests | |
1931 | @section How do I make Emacs behave like this: when I go up or down, the cursor should stay in the same column even if the line is too short? | |
1932 | @cindex @code{picture-mode} | |
1933 | @cindex Remaining in the same column, regardless of contents | |
1934 | @cindex Vertical movement in empty documents | |
1935 | ||
1936 | @kbd{M-x picture-mode}. | |
1937 | ||
1938 | @node Forcing Emacs to iconify itself, Using regular expressions, Forcing the cursor to remain in the same column, Common requests | |
1939 | @section How do I tell Emacs to iconify itself? | |
1940 | @cindex Iconification under X Windows | |
1941 | @cindex X Windows and iconification | |
1942 | @cindex Suspending Emacs | |
1943 | ||
1944 | @kbd{C-z} iconifies Emacs when running under X Windows and suspends Emacs | |
1945 | otherwise. @inforef{Misc X, Misc X, emacs}. | |
1946 | ||
1947 | @node Using regular expressions, Replacing text across multiple files, Forcing Emacs to iconify itself, Common requests | |
1948 | @section How do I use regexps (regular expressions) in Emacs? | |
1949 | @cindex Regexps | |
1950 | @cindex Regular expressions | |
1951 | @cindex Differences between Unix and Emacs regexps | |
1952 | @cindex Unix regeps, differences from Emacs | |
1953 | @cindex Text strings, putting regexps in | |
1954 | ||
1955 | @inforef{Regexps, Regexps, emacs}. | |
1956 | ||
1957 | The "or" operator is @samp{\|}, not @samp{|}, and the grouping operators | |
1958 | are @samp{\(} and @samp{\)}. Also, the string syntax for a backslash is | |
1959 | @samp{\\}. To specify a regular expression like @samp{xxx\(foo\|bar\)} | |
1960 | in a Lisp string, use @samp{xxx\\(foo\\|bar\\)}. | |
1961 | ||
1962 | Notice the doubled backslashes! | |
1963 | ||
1964 | @itemize @bullet | |
1965 | ||
1966 | @item Unlike in Unix @file{grep}, @file{sed}, etc., a complement | |
1967 | character set (@samp{[^...]}) can match a newline character (@key{LFD} | |
1968 | aka @kbd{C-j} aka @samp{\n}), unless newline is mentioned as one of the | |
1969 | characters not to match. | |
1970 | ||
1971 | @item The character syntax regexps (e.g., @samp{\sw}) are not | |
1972 | meaningful inside character set regexps (e.g., @samp{[aeiou]}). (This | |
1973 | is actually typical for regexp syntax.) | |
1974 | ||
1975 | @end itemize | |
1976 | ||
1977 | @node Replacing text across multiple files, Documentation for etags, Using regular expressions, Common requests | |
1978 | @section How do I perform a replace operation across more than one file? | |
1979 | @cindex Replacing strings across files | |
1980 | @cindex Multiple files, replacing across | |
1981 | @cindex Files, replacing strings across multiple | |
1982 | ||
1983 | The "tags" feature of Emacs includes the command | |
1984 | @code{tags-query-replace} which performs a query-replace across all the | |
1985 | files mentioned in the TAGS file. @inforef{Tags Search, Tags Search, | |
1986 | emacs}. | |
1987 | ||
1988 | As of Emacs 19.29, Dired mode (@kbd{M-x dired @key{RET}}, or @kbd{C-x | |
1989 | d}) supports the command @code{dired-do-query-replace}, which allows | |
1990 | users to replace regular expressions in multiple files. | |
1991 | ||
1992 | @node Documentation for etags, Disabling backups, Replacing text across multiple files, Common requests | |
1993 | @section Where is the documentation for @file{etags}? | |
1994 | @cindex Documentation for @file{etags} | |
1995 | @cindex @file{etags}, documentation for | |
1996 | ||
1997 | The @file{etags} man page should be in the same place as the | |
1998 | @file{emacs} man page. | |
1999 | ||
2000 | Quick command-line switch descriptions are also available. For example, | |
2001 | @samp{etags -H}. | |
2002 | ||
2003 | @node Disabling backups, Disabling auto-save-mode, Documentation for etags, Common requests | |
2004 | @section How do I disable backup files? | |
2005 | @cindex Backups, disabling | |
2006 | @cindex Disabling backups | |
2007 | ||
2008 | You probably don't want to do this, since backups are useful. | |
2009 | ||
2010 | To avoid seeing backup files (and other "uninteresting" files) in Dired, | |
2011 | load dired-x by adding the following to your @file{.emacs} file: | |
2012 | ||
2013 | @lisp | |
2014 | (add-hook 'dired-load-hook | |
bed44076 SM |
2015 | (lambda () |
2016 | (load "dired-x"))) | |
71e68827 DL |
2017 | @end lisp |
2018 | ||
2019 | With dired-x loaded, @kbd{M-o} toggles omitting in each dired buffer. | |
2020 | You can make omitting the default for new dired buffers by putting the | |
2021 | following in your @file{.emacs}: | |
2022 | ||
2023 | @lisp | |
2024 | (setq initial-dired-omit-files-p t) | |
2025 | @end lisp | |
2026 | ||
2027 | If you're tired of seeing backup files whenever you do an "ls" at the | |
2028 | Unix shell, try GNU ls with the "-B" option. GNU ls is part of the GNU | |
2029 | fileutils package, available at mirrors of @samp{ftp.gnu.org} (@pxref{Current GNU distributions} ). | |
2030 | ||
2031 | To disable or change how backups are made, see "Backup Names" in the | |
2032 | on-line manual. | |
2033 | ||
2034 | @node Disabling auto-save-mode, Modifying pull-down menus, Disabling backups, Common requests | |
2035 | @section How do I disable @code{auto-save-mode}? | |
2036 | @cindex Disabling @code{auto-save-mode} | |
2037 | @cindex Auto-saving | |
2038 | @cindex Saving at frequent intervals | |
2039 | ||
2040 | You probably don't want to do this, since auto-saving is useful, | |
2041 | especially when Emacs or your computer crashes while you are editing a | |
2042 | document. | |
2043 | ||
2044 | Instead, you might want to change the variable | |
2045 | @code{auto-save-interval}, which specifies how many keystrokes Emacs | |
2046 | waits before auto-saving. Increasing this value forces Emacs to wait | |
2047 | longer between auto-saves, which might annoy you less. | |
2048 | ||
2049 | You might also want to look into Sebastian Kremer's @code{auto-save} | |
2050 | package, available from the Lisp Code Archive (@pxref{Packages that do not come | |
2051 | with Emacs}). This | |
2052 | package also allows you to place all auto-save files in one directory, | |
2053 | such as @file{/tmp}. | |
2054 | ||
2055 | To disable or change how @code{auto-save-mode} works, see "Auto Save" in the | |
2056 | on-line manual. | |
2057 | ||
2058 | @node Modifying pull-down menus, Deleting menus and menu options, Disabling auto-save-mode, Common requests | |
2059 | @section How can I create or modify new pull-down menu options? | |
2060 | @cindex Pull-down menus, creating or modifying | |
2061 | @cindex Menus, creating or modifying | |
2062 | @cindex Creating new menu options | |
2063 | @cindex Modifying pull-down menus | |
2064 | @cindex Menus and keymaps | |
2065 | @cindex Keymaps and menus | |
2066 | ||
2067 | Each menu title (e.g., Buffers, File, Edit) represents a local or global | |
2068 | keymap. Selecting a menu title with the mouse displays that keymap's | |
2069 | non-nil contents in the form of a menu. | |
2070 | ||
2071 | So to add a menu option to an existing menu, all you have to do is add a | |
2072 | new definition to the appropriate keymap. Adding a "forward word" | |
2073 | command to the "Edit" menu thus requires the following Lisp code: | |
2074 | ||
2075 | @lisp | |
2076 | (define-key global-map | |
2077 | [menu-bar edit forward] | |
2078 | '("Forward word" . forward-word)) | |
2079 | @end lisp | |
2080 | ||
2081 | The first line adds the entry to the global keymap, which includes | |
2082 | global menu bar entries. Replacing the reference to @code{global-map} | |
2083 | with a local keymap would add this menu option only within a particular | |
2084 | mode. | |
2085 | ||
2086 | The second line describes the path from the menu-bar to the new entry. | |
2087 | Placing this menu entry underneath the "File" menu would mean changing | |
2088 | the word "edit" in the second line to "file." | |
2089 | ||
2090 | The third line is a cons cell whose first element is the title that will | |
2091 | be displayed, and whose second element is the function that will be | |
2092 | called when that menu option is invoked. | |
2093 | ||
2094 | To add a new menu, rather than a new option to an existing menu, we must | |
2095 | define an entirely new keymap: | |
2096 | ||
2097 | @lisp | |
2098 | (define-key global-map [menu-bar words] | |
2099 | (cons "Words" (make-sparse-keymap "Words"))) | |
2100 | @end lisp | |
2101 | ||
2102 | The above code creates a new sparse keymap, gives it the name "Words", | |
2103 | and attaches it to the global menu bar. Adding the "forward word" | |
2104 | command to this new menu would thus require the following code: | |
2105 | ||
2106 | @lisp | |
2107 | (define-key global-map | |
2108 | [menu-bar words forward] | |
2109 | '("Forward word" . forward-word)) | |
2110 | @end lisp | |
2111 | ||
2112 | Note that because of the way keymaps work, menu options are displayed | |
2113 | with the more recently defined items at the top. Thus if you were to | |
2114 | define menu options "foo", "bar", and "baz" (in that order), menu option | |
2115 | "baz" would appear at the top, and "foo" would be at the bottom. | |
2116 | ||
2117 | One way to avoid this problem is to use the function @code{define-key-after}, | |
2118 | which works the same as @code{define-key}, but lets you modify where items | |
2119 | appear. The following Lisp code would insert the "forward word" function | |
2120 | in the "edit" menu immediately following the "undo" option: | |
2121 | ||
2122 | @lisp | |
2123 | (define-key-after | |
2124 | (lookup-key global-map [menu-bar edit]) | |
2125 | [forward] | |
2126 | '("Forward word" . forward-word) | |
2127 | 'undo) | |
2128 | @end lisp | |
2129 | ||
2130 | Note how the second and third arguments to @code{define-key-after} are | |
2131 | different from those of @code{define-key}, and that we have added a new | |
2132 | (final) argument, the function after which our new key should be | |
2133 | defined. | |
2134 | ||
2135 | To move a menu option from one position to another, simply evaluate | |
2136 | @code{define-key-after} with the appropriate final argument. | |
2137 | ||
2138 | More detailed information --- and more examples of how to create and | |
2139 | modify menu options --- are in the Emacs Lisp Reference Manual, under | |
0d17cd5c | 2140 | "Keymaps". (@pxref{Emacs Lisp documentation} for information on this |
71e68827 DL |
2141 | manual.) |
2142 | ||
2143 | @node Deleting menus and menu options, Turning on syntax highlighting, Modifying pull-down menus, Common requests | |
2144 | @section How do I delete menus and menu options? | |
2145 | @cindex Deleting menus and menu options | |
2146 | @cindex Menus, deleting | |
2147 | ||
2148 | The simplest way to remove a menu is to set its keymap to @samp{nil}. | |
2149 | For example, to delete the "Words" menu (@pxref{Modifying pull-down | |
2150 | menus}), use: | |
2151 | ||
2152 | @lisp | |
2153 | (define-key global-map [menu-bar words] nil) | |
2154 | @end lisp | |
2155 | ||
2156 | Similarly, removing a menu option requires redefining a keymap entry to | |
2157 | @code{nil}. For example, to delete the "Forward word" menu option from the | |
2158 | "Edit" menu (we added it in @ref{Modifying pull-down menus}), use: | |
2159 | ||
2160 | @lisp | |
2161 | (define-key global-map [menu-bar edit forward] nil) | |
2162 | @end lisp | |
2163 | ||
2164 | @node Turning on syntax highlighting, Scrolling only one line, Deleting menus and menu options, Common requests | |
2165 | @section How do I turn on syntax highlighting? | |
2166 | @cindex Syntax highlighting | |
2167 | @cindex @code{font-lock-mode} | |
2168 | @cindex Highlighting based on syntax | |
2169 | @cindex Colorizing text | |
2170 | @cindex FAQ, @code{font-lock-mode} | |
2171 | ||
2172 | @code{font-lock-mode} is the standard way to have Emacs perform syntax | |
2173 | highlighting. With @code{font-lock-mode} invoked, different types of | |
2174 | text will appear in different colors. For instance, if you turn on | |
2175 | @code{font-lock-mode} in a programming mode, variables will appear in one | |
2176 | face, keywords in a second, and comments in a third. | |
2177 | ||
2178 | Earlier versions of Emacs supported hilit19, a similar package. Use of | |
2179 | hilit19 is now considered non-standard, although @file{hilit19.el} comes | |
2180 | with the stock Emacs distribution. It is no longer maintained. | |
2181 | ||
2182 | To turn @code{font-lock-mode} on within an existing buffer, use @kbd{M-x | |
2183 | font-lock-mode @key{RET}}. | |
2184 | ||
2185 | To automatically invoke @code{font-lock-mode} when a particular major | |
2186 | mode is invoked, set the major mode's hook. For example, to fontify all | |
2187 | @code{c-mode} buffers, add the following to your @file{.emacs} file: | |
2188 | ||
2189 | @lisp | |
2190 | (add-hook 'c-mode-hook 'turn-on-font-lock) | |
2191 | @end lisp | |
2192 | ||
2193 | To automatically invoke @code{font-lock-mode} for all major modes, you | |
2194 | can turn on @code{global-font-lock-mode} by including the following line | |
2195 | in your @file{.emacs} file: | |
2196 | ||
2197 | @lisp | |
2198 | (global-font-lock-mode 1) | |
2199 | @end lisp | |
2200 | ||
2201 | This instructs Emacs to turn on font-lock mode in those buffers for | |
2202 | which a font-lock mode definition has been provided (in the variable | |
2203 | @code{font-lock-global-modes}). If you edit a file in | |
2204 | @code{pie-ala-mode}, and no font-lock definitions have been provided for | |
2205 | @code{pie-ala} files, then the above setting will have no effect on that | |
2206 | particular buffer. | |
2207 | ||
2208 | Highlighting with @code{font-lock-mode} can take quite a while, and thus | |
2209 | different levels of decoration are available, from slight to gaudy. To | |
2210 | control how decorated your buffers should become, set the value of | |
2211 | @code{font-lock-maximum-decoration} in your @file{.emacs} file, with a | |
2212 | @code{nil} value indicating default (usually minimum) decoration, and a | |
2213 | @code{t} value indicating the maximum decoration. For the gaudiest | |
2214 | possible look, then, include the line | |
2215 | ||
2216 | @lisp | |
2217 | (setq font-lock-maximum-decoration t) | |
2218 | @end lisp | |
2219 | ||
2220 | in your @file{.emacs} file. You can also set this variable such that | |
2221 | different modes are highlighted in a different ways; for more | |
2222 | information, see the documentation for | |
2223 | @code{font-lock-maximum-decoration} with @kbd{C-h v} (or @kbd{M-x | |
2224 | describe-variable @key{RET}}). | |
2225 | ||
2226 | You might also want to investigate @code{fast-lock-mode} and | |
2227 | @code{lazy-lock-mode}, versions of @code{font-lock-mode} that speed up | |
2228 | highlighting. The advantage of @code{lazy-lock-mode} is that it only | |
2229 | fontifies buffers when certain conditions are met, such as after a | |
2230 | certain amount of idle time, or after you have finished scrolling | |
2231 | through text. See the documentation for @code{lazy-lock-mode} by typing @kbd{C-h f | |
2232 | @code{lazy-lock-mode}} (@kbd{M-x describe-function @key{RET} | |
2233 | lazy-lock-mode @key{RET}}). | |
2234 | ||
2235 | Also see the documentation for the function @code{font-lock-mode}, | |
2236 | available by typing @kbd{C-h f font-lock-mode} (@kbd{M-x | |
2237 | describe-function @key{RET} font-lock-mode @key{RET}}). | |
2238 | ||
2239 | For more information on font-lock mode, take a look at the | |
2240 | @code{font-lock-mode} FAQ, maintained by | |
2241 | @email{jari.aalto@@ntc.nokia.com, Jari Aalto} at | |
2242 | ||
2243 | @uref{ftp://cs.uta.fi/pub/ssjaaa/ema-font.gui} | |
2244 | ||
2245 | To print buffers with the faces (i.e., colors and fonts) intact, use | |
2246 | @kbd{M-x ps-print-buffer-with-faces} or @kbd{M-x | |
2247 | ps-print-region-with-faces}. | |
2248 | ||
2249 | @node Scrolling only one line, Replacing highlighted text, Turning on syntax highlighting, Common requests | |
2250 | @section How can I force Emacs to scroll only one line when I move past the bottom of the screen? | |
2251 | @cindex Scrolling only one line | |
2252 | @cindex Reducing the increment when scrollng | |
2253 | ||
2254 | Place the following Lisp form in your @file{.emacs} file: | |
2255 | ||
2256 | @lisp | |
2257 | (setq scroll-step 1) | |
2258 | @end lisp | |
2259 | ||
2260 | @inforef{Scrolling, Scrolling, emacs}. | |
2261 | ||
2262 | @node Replacing highlighted text, Editing MS-DOS files, Scrolling only one line, Common requests | |
2263 | @section How can I replace highlighted text with what I type? | |
2264 | @cindex @code{delete-selection-mode} | |
2265 | @cindex Replacing highlighted text | |
2266 | @cindex Highlighing and replacing text | |
2267 | ||
2268 | Use @code{delete-selection mode}, which you can start automatically by | |
2269 | placing the following Lisp form in your @file{.emacs} file: | |
2270 | ||
2271 | @lisp | |
2272 | (delete-selection-mode t) | |
2273 | @end lisp | |
2274 | ||
2275 | According to the documentation string for delete-selection mode (which | |
2276 | you can read using @kbd{M-x describe-function @key{RET} | |
2277 | delete-selection-mode @key{RET}}): | |
2278 | ||
2279 | @quotation | |
2280 | When ON, typed text replaces the selection if the selection is active. | |
2281 | When OFF, typed text is just inserted at point. | |
2282 | @end quotation | |
2283 | ||
2284 | This mode also allows you to delete (not kill) the highlighted region by | |
2285 | pressing @key{DEL}. | |
2286 | ||
2287 | @node Editing MS-DOS files, Filling paragraphs with a single space, Replacing highlighted text, Common requests | |
2288 | @section How can I edit MS-DOS files using Emacs? | |
2289 | @cindex Editing MS-DOS files | |
2290 | @cindex MS-DOS files, editing | |
2291 | @cindex Microsoft files, editing | |
2292 | @cindex Windows files, editing | |
2293 | ||
2294 | As of Emacs 20, detection and handling of MS-DOS (and Windows) files is | |
2295 | performed transparently. You can open MS-DOS files on a Unix system, | |
2296 | edit it, and save it without having to worry about the file format. | |
2297 | ||
2298 | When editing an MS-DOS style file, a backslash (@samp{\}) will appear in | |
2299 | the mode line. | |
2300 | ||
2301 | If you are running an earlier version of Emacs, get @code{crypt++} from | |
2302 | the Emacs Lisp Archive (@pxref{Packages that do not come with Emacs}). | |
2303 | Among other things, @code{crypt++} transparently modifies MS-DOS files | |
2304 | as they are loaded and saved, allowing you to ignore the different | |
2305 | conventions that Unix and MS-DOS have for delineating the end of a line. | |
2306 | ||
2307 | @node Filling paragraphs with a single space, , Editing MS-DOS files, Common requests | |
2308 | @section How can I tell Emacs to fill paragraphs with a single space after each period? | |
2309 | @cindex One space following periods | |
2310 | @cindex Single space following periods | |
2311 | @cindex Periods, one space following | |
2312 | ||
2313 | @email{ulm@@vsnhd1.cern.ch, Ulrich Mueller} suggests adding the | |
2314 | following two lines to your @file{.emacs} file: | |
2315 | ||
2316 | @lisp | |
2317 | (setq sentence-end "[.?!][]\"')@}]*\\($\\|[ \t]\\)[ \t\n]*") | |
2318 | (setq sentence-end-double-space nil) | |
2319 | @end lisp | |
2320 | ||
2321 | @c ------------------------------------------------------------ | |
2322 | @node Bugs and problems, Compiling and installing Emacs, Common requests, Top | |
2323 | @chapter Bugs and problems | |
2324 | @cindex Bugs and problems | |
2325 | ||
2326 | @menu | |
2327 | * Problems with very large files:: | |
2328 | * ^M in the shell buffer:: | |
2329 | * Shell process exits abnormally:: | |
2330 | * Termcap/Terminfo entries for Emacs:: | |
2331 | * Spontaneous entry into isearch-mode:: | |
2332 | * Problems talking to certain hosts:: | |
2333 | * Errors with init files:: | |
2334 | * Emacs ignores X resources:: | |
2335 | * Emacs takes a long time to visit files:: | |
2336 | * Editing files with $ in the name:: | |
2337 | * Shell mode loses the current directory:: | |
2338 | * Security risks with Emacs:: | |
2339 | * Dired claims that no file is on this line:: | |
2340 | @end menu | |
2341 | ||
2342 | @node Problems with very large files, ^M in the shell buffer, Bugs and problems, Bugs and problems | |
2343 | @section Does Emacs have problems with files larger than 8 megabytes? | |
2344 | @cindex Very large files, opening | |
2345 | @cindex Large files, opening | |
2346 | @cindex Opening very large files | |
2347 | @cindex Maximum file size | |
2348 | @cindex Files, maximum size | |
2349 | ||
2350 | Old versions (i.e., anything before 19.29) of Emacs had problems editing | |
2351 | files larger than 8 megabytes. As of version 19.29, the maximum buffer | |
2352 | size is at least 2^27-1, or 134,217,727 bytes. | |
2353 | ||
2354 | If you are using an older version of Emacs and cannot upgrade, you will | |
2355 | have to recompile. @email{lnz@@lucid.com, Leonard N. Zubkoff} suggests | |
2356 | putting the following two lines in @file{src/config.h} before compiling | |
2357 | Emacs to allow for 26-bit integers and pointers (and thus file sizes of | |
2358 | up to 33,554,431 bytes): | |
2359 | ||
2360 | @example | |
2361 | #define VALBITS 26 | |
2362 | #define GCTYPEBITS 5 | |
2363 | @end example | |
2364 | ||
2365 | This method may result in "ILLEGAL DATATYPE" and other random errors on | |
2366 | some machines. | |
2367 | ||
2368 | @email{daveg@@csvax.cs.caltech.edu, David Gillespie} explains how this | |
2369 | problems crops up; while his numbers are true only for pre-19.29 | |
2370 | versions of Emacs, the theory remains the same with current versions. | |
2371 | ||
2372 | @quotation | |
2373 | Emacs is largely written in a dialect of Lisp; Lisp is a freely-typed | |
2374 | language in the sense that you can put any value of any type into any | |
2375 | variable, or return it from a function, and so on. So each value | |
2376 | must carry a "tag" along with it identifying what kind of thing it is, | |
2377 | e.g., integer, pointer to a list, pointer to an editing buffer, and so | |
2378 | on. Emacs uses standard 32-bit integers for data objects, taking the | |
2379 | top 8 bits for the tag and the bottom 24 bits for the value. So | |
2380 | integers (and pointers) are somewhat restricted compared to true C | |
2381 | integers and pointers. | |
2382 | @end quotation | |
2383 | ||
2384 | @node ^M in the shell buffer, Shell process exits abnormally, Problems with very large files, Bugs and problems | |
2385 | @section How do I get rid of @samp{^M} or echoed commands in my shell buffer? | |
2386 | @cindex Shell buffer, echoed commands and @samp{^M} in | |
2387 | @cindex Echoed commands in @code{shell-mode} | |
2388 | ||
2389 | Try typing @kbd{M-x shell-strip-ctrl-m @key{RET}} while in @code{shell-mode} to | |
2390 | make them go away. If that doesn't work, you have several options: | |
2391 | ||
2392 | For tcsh, put this in your @file{.cshrc} (or @file{.tcshrc}) file: | |
2393 | ||
2394 | @example | |
2395 | if ($?EMACS) then | |
2396 | if ("$EMACS" == t) then | |
2397 | if ($?tcsh) unset edit | |
2398 | stty nl | |
2399 | endif | |
2400 | endif | |
2401 | @end example | |
2402 | ||
2403 | Or put this in your @file{.emacs_tcsh} file: | |
2404 | ||
2405 | @example | |
2406 | unset edit | |
2407 | stty nl | |
2408 | @end example | |
2409 | ||
2410 | Alternatively, use @file{csh} in your shell buffers instead of | |
2411 | @file{tcsh}. One way is: | |
2412 | ||
2413 | @lisp | |
2414 | (setq explicit-shell-file-name "/bin/csh") | |
2415 | @end lisp | |
2416 | ||
2417 | and another is to do this in your @file{.cshrc} (or @file{.tcshrc}) | |
2418 | file: | |
2419 | ||
2420 | @example | |
2421 | setenv ESHELL /bin/csh | |
2422 | @end example | |
2423 | ||
2424 | (You must start Emacs over again with the environment variable properly | |
2425 | set for this to take effect.) | |
2426 | ||
2427 | You can also set the @code{ESHELL} environment variable in Emacs Lisp | |
2428 | with the following Lisp form, | |
2429 | ||
2430 | @lisp | |
2431 | (setenv "ESHELL" "/bin/csh") | |
2432 | @end lisp | |
2433 | ||
2434 | On a related note: If your shell is echoing your input line in the shell | |
2435 | buffer, you might want to try the following command in your shell | |
2436 | start-up file: | |
2437 | ||
2438 | @example | |
2439 | stty -icrnl -onlcr -echo susp ^Z | |
2440 | @end example | |
2441 | ||
2442 | @node Shell process exits abnormally, Termcap/Terminfo entries for Emacs, ^M in the shell buffer, Bugs and problems | |
2443 | @section Why do I get "Process shell exited abnormally with code 1"? | |
2444 | @cindex Abnormal exits from @code{shell-mode} | |
2445 | @cindex @code{shell-mode} exits | |
2446 | ||
2447 | The most likely reason for this message is that the @samp{env} program | |
2448 | is not properly installed. Compile this program for your architecture, | |
2449 | and install it with @samp{a+x} permission in the architecture-dependent | |
2450 | Emacs program directory. (You can find what this directory is at your | |
2451 | site by inspecting the value of the variable @code{exec-directory} by | |
2452 | typing @kbd{C-h v exec-directory @key{RET}}.) | |
2453 | ||
2454 | You should also check for other programs named @samp{env} in your path | |
2455 | (e.g., SunOS has a program named @file{/usr/bin/env}). We don't | |
2456 | understand why this can cause a failure and don't know a general | |
2457 | solution for working around the problem in this case. | |
2458 | ||
2459 | The @samp{make clean} command will remove @samp{env} and other vital | |
2460 | programs, so be careful when using it. | |
2461 | ||
2462 | It has been reported that this sometimes happened when Emacs was started | |
2463 | as an X client from an xterm window (i.e., had a controlling tty) but the | |
2464 | xterm was later terminated. | |
2465 | ||
2466 | See also @samp{PROBLEMS} (in the top-level directory when you unpack the | |
2467 | Emacs source) for other possible causes of this message. | |
2468 | ||
2469 | @node Termcap/Terminfo entries for Emacs, Spontaneous entry into isearch-mode, Shell process exits abnormally, Bugs and problems | |
2470 | @section Where is the termcap/terminfo entry for terminal type "emacs"? | |
2471 | @cindex Termcap | |
2472 | @cindex Terminfo | |
2473 | @cindex Emacs entries for termcap/terminfo | |
2474 | ||
2475 | The termcap entry for terminal type @samp{emacs} is ordinarily put in | |
2476 | the @samp{TERMCAP} environment variable of subshells. It may help in | |
2477 | certain situations (e.g., using rlogin from shell buffer) to add an | |
2478 | entry for @samp{emacs} to the system-wide termcap file. Here is a | |
2479 | correct termcap entry for @samp{emacs}: | |
2480 | ||
2481 | @example | |
2482 | emacs:tc=unknown: | |
2483 | @end example | |
2484 | ||
2485 | To make a terminfo entry for "emacs", use "tic" or "captoinfo." You need | |
2486 | to generate @file{/usr/lib/terminfo/e/emacs}. It may work to simply copy | |
2487 | @file{/usr/lib/terminfo/d/dumb} to @file{/usr/lib/terminfo/e/emac}s. | |
2488 | ||
2489 | Having a termcap/terminfo entry will not enable the use of full screen | |
2490 | programs in shell buffers. Use @kbd{M-x terminal-emulator} for that | |
2491 | instead. | |
2492 | ||
2493 | A workaround to the problem of missing termcap/terminfo entries is to | |
2494 | change terminal type "emacs" to type "dumb" or "unknown" in your shell | |
2495 | start up file. "csh" users could put this in their .cshrc files: | |
2496 | ||
2497 | @example | |
2498 | if ("$term" == emacs) set term=dumb | |
2499 | @end example | |
2500 | ||
2501 | @node Spontaneous entry into isearch-mode, Problems talking to certain hosts, Termcap/Terminfo entries for Emacs, Bugs and problems | |
2502 | @section Why does Emacs spontaneously start displaying "I-search:" and beeping? | |
2503 | @cindex Spontaneous entry into isearch-mode | |
2504 | @cindex isearch-mode, spontaneous entry into | |
2505 | @cindex Beeping without obvious reason | |
2506 | ||
2507 | Your terminal (or something between your terminal and the computer) is | |
2508 | sending @kbd{C-s} and @kbd{C-q} for flow control, and Emacs is receiving | |
2509 | these characters and interpreting them as commands. (The @kbd{C-s} | |
2510 | character normally invokes the @code{isearch-forward} command.) For | |
2511 | possible solutions, @pxref{Handling C-s and C-q with flow control}. | |
2512 | ||
2513 | @node Problems talking to certain hosts, Errors with init files, Spontaneous entry into isearch-mode, Bugs and problems | |
2514 | @section Why can't Emacs talk to certain hosts (or certain hostnames)? | |
2515 | @cindex Hosts, Emacs cannot talk to | |
2516 | @cindex @code{gethostbyname}, problematic version | |
2517 | ||
2518 | The problem may be that Emacs is linked with a wimpier version of | |
2519 | @code{gethostbyname} than the rest of the programs on the machine. This | |
2520 | is often manifested as a message on startup of "X server not responding. | |
2521 | Check your @samp{DISPLAY} environment variable." or a message of | |
2522 | "Unknown host" from @code{open-network-stream}. | |
2523 | ||
2524 | On a Sun, this may be because Emacs had to be linked with the static C | |
2525 | library. The version of @code{gethostbyname} in the static C library | |
2526 | may only look in @file{/etc/hosts} and the NIS (YP) maps, while the | |
2527 | version in the dynamic C library may be smart enough to check DNS in | |
2528 | addition to or instead of NIS. On a Motorola Delta running System V | |
2529 | R3.6, the version of @code{gethostbyname} in the standard library works, | |
2530 | but the one that works with NIS doesn't (the one you get with -linet). | |
2531 | Other operating systems have similar problems. | |
2532 | ||
2533 | Try these options: | |
2534 | ||
2535 | @itemize @bullet | |
2536 | ||
2537 | @item | |
2538 | Explicitly add the host you want to communicate with to @file{/etc/hosts}. | |
2539 | ||
2540 | @item | |
2541 | Relink Emacs with this line in @file{src/config.h}: | |
2542 | ||
2543 | @example | |
2544 | #define LIBS_SYSTEM -lresolv | |
2545 | @end example | |
2546 | ||
2547 | @item | |
2548 | Replace @code{gethostbyname} and friends in @file{libc.a} with more | |
2549 | useful versions such as the ones in @file{libresolv.a}. Then relink | |
2550 | Emacs. | |
2551 | ||
2552 | @item | |
2553 | If you are actually running NIS, make sure that "ypbind" is properly | |
2554 | told to do DNS lookups with the correct command line switch. | |
2555 | ||
2556 | @end itemize | |
2557 | ||
2558 | @node Errors with init files, Emacs ignores X resources, Problems talking to certain hosts, Bugs and problems | |
2559 | @section Why does Emacs say "Error in init file"? | |
2560 | @cindex Error in @file{.emacs} | |
2561 | @cindex Error in init file | |
2562 | @cindex Init file, errors in | |
2563 | @cindex @file{.emacs} file, errors in | |
2564 | @cindex Debugging @file{.emacs} file | |
2565 | ||
2566 | An error occurred while loading either your @file{.emacs} file or the | |
2567 | system-wide file @file{lisp/default.el}. | |
2568 | ||
2569 | For information on how to debug your @file{.emacs} file, | |
2570 | @pxref{Debugging a customization file}. | |
2571 | ||
2572 | It may be the case that you need to load some package first, or use a | |
2573 | hook that will be evaluated after the package is loaded. A common case | |
2574 | of this is explained in @ref{Terminal setup code works after Emacs has | |
2575 | begun}. | |
2576 | ||
2577 | @node Emacs ignores X resources, Emacs takes a long time to visit files, Errors with init files, Bugs and problems | |
2578 | @section Why does Emacs ignore my X resources (my .Xdefaults file)? | |
2579 | @cindex X resources being ignored | |
2580 | @cindex Ignored X resources | |
2581 | @cindex @file{.Xdefaults} | |
2582 | ||
2583 | As of version 19, Emacs searches for X resources in the files specified | |
2584 | by the following environment variables: | |
2585 | ||
2586 | @itemize @bullet | |
2587 | ||
2588 | @item @code{XFILESEARCHPATH} | |
2589 | @item @code{XUSERFILESEARCHPATH} | |
2590 | @item @code{XAPPLRESDIR} | |
2591 | ||
2592 | @end itemize | |
2593 | ||
2594 | This emulates the functionality provided by programs written using Xt. | |
2595 | ||
2596 | @code{XFILESEARCHPATH} and @code{XUSERFILESEARCHPATH} should be a list | |
2597 | of file names separated by colons. @code{XAPPLRESDIR} should be a list | |
2598 | of directory names separated by colons. | |
2599 | ||
2600 | Emacs searches for X resources: | |
2601 | ||
2602 | @enumerate | |
2603 | ||
2604 | @item specified on the command line, with the @samp{-xrm RESOURCESTRING} option, | |
2605 | @item then in the value of the @samp{XENVIRONMENT} environment variable, | |
2606 | ||
2607 | @itemize @minus | |
2608 | ||
2609 | @item or if that is unset, in the file named @samp{~/.Xdefaults-HOSTNAME} if it exists (where @samp{HOSTNAME} is the hostname of the machine Emacs is running on), | |
2610 | ||
2611 | @end itemize | |
2612 | ||
2613 | @item then in the screen-specific and server-wide resource properties provided by the server, | |
2614 | ||
2615 | @itemize @minus | |
2616 | ||
2617 | @item or if those properties are unset, in the file named ~/.Xdefaults if it exists, | |
2618 | ||
2619 | @end itemize | |
2620 | ||
2621 | @item then in the files listed in @samp{XUSERFILESEARCHPATH}, | |
2622 | ||
2623 | @itemize @minus | |
2624 | ||
2625 | @item or in files named @file{LANG/Emacs} in directories listed in @samp{XAPPLRESDIR} (where @samp{LANG} is the value of the @samp{LANG} environment variable), if the @samp{LANG} environment variable is set, | |
2626 | @item or in files named Emacs in the directories listed in @samp{XAPPLRESDIR} | |
2627 | @item or in @file{~/LANG/Emacs} (if the @samp{LANG} environment variable is set), | |
2628 | @item or in @file{~/Emacs}, | |
2629 | ||
2630 | @end itemize | |
2631 | ||
2632 | @item then in the files listed in @code{XFILESEARCHPATH}. | |
2633 | ||
2634 | @end enumerate | |
2635 | ||
2636 | @node Emacs takes a long time to visit files, Editing files with $ in the name, Emacs ignores X resources, Bugs and problems | |
2637 | @section Why does Emacs take 20 seconds to visit a file? | |
2638 | @cindex Visiting files takes a long time | |
2639 | @cindex Delay when visiting files | |
2640 | @cindex Files, take a long time to visit | |
2641 | ||
2642 | Old versions of Emacs (i.e., versions before Emacs 20.x) often | |
2643 | encountered this when the master lock file, @file{!!!SuperLock!!!} has | |
2644 | been left in the lock directory somehow. Delete it. | |
2645 | ||
2646 | @email{meuer@@geom.umn.edu, Mark Meuer} says that NeXT NFS has a bug | |
2647 | where an exclusive create succeeds but returns an error status. This | |
2648 | can cause the same problem. Since Emacs's file locking doesn't work | |
2649 | over NFS anyway, the best solution is to recompile Emacs with | |
2650 | @code{CLASH_DETECTION} undefined. | |
2651 | ||
2652 | @node Editing files with $ in the name, Shell mode loses the current directory, Emacs takes a long time to visit files, Bugs and problems | |
2653 | @section How do I edit a file with a @samp{$} in its name? | |
2654 | @cindex Editing files with @samp{$} in the name | |
2655 | @cindex @samp{$} in filenames | |
2656 | @cindex Filenames containing @samp{$}, editing | |
2657 | ||
2658 | When entering a filename in the minibuffer, Emacs will attempt to expand | |
2659 | a @samp{$} followed by a word as an environment variable. To suppress | |
2660 | this behavior, type @kbd{$$} instead. | |
2661 | ||
2662 | @node Shell mode loses the current directory, Security risks with Emacs, Editing files with $ in the name, Bugs and problems | |
2663 | @section Why does shell mode lose track of the shell's current directory? | |
2664 | @cindex Current directory and @code{shell-mode} | |
2665 | @cindex @code{shell-mode} and current directory | |
2666 | @cindex Directory, current in @code{shell-mode} | |
2667 | ||
2668 | Emacs has no way of knowing when the shell actually changes its | |
2669 | directory. This is an intrinsic limitation of Unix. So it tries to | |
2670 | guess by recognizing @samp{cd} commands. If you type "cd" followed by a | |
2671 | directory name with a variable reference (@samp{cd $HOME/bin}) or with a | |
2672 | shell metacharacter (@samp{cd ../lib*}), Emacs will fail to correctly | |
2673 | guess the shell's new current directory. A huge variety of fixes and | |
2674 | enhancements to shell mode for this problem have been written to handle | |
2675 | this problem. Check the Lisp Code Directory (@pxref{Finding a package | |
2676 | with particular functionality}). | |
2677 | ||
2678 | You can tell Emacs the shell's current directory with the command | |
2679 | @kbd{M-x dirs}. | |
2680 | ||
2681 | @node Security risks with Emacs, Dired claims that no file is on this line, Shell mode loses the current directory, Bugs and problems | |
2682 | @section Are there any security risks in Emacs? | |
2683 | @cindex Security with Emacs | |
2684 | @cindex @samp{movemail} and security | |
2685 | @cindex @code{file-local-variable} and security | |
2686 | @cindex Synthetic X events and security | |
2687 | @cindex X events and security | |
2688 | ||
2689 | @itemize @bullet | |
2690 | ||
2691 | @item The @file{movemail} incident (No, this is not a risk.) | |
2692 | ||
2693 | In his book @emph{The Cuckoo's Egg}, Cliff Stoll describes this in | |
2694 | chapter 4. The site at LBL had installed the @file{etc/movemail} | |
2695 | program setuid root. (As of version 19, @file{movemail} is in your | |
2696 | architecture-specific directory; type @kbd{C-h v exec-directory | |
2697 | @key{RET}} to see what it is.) Since @file{movemail} had not been | |
2698 | designed for this situation, a security hole was created and users could | |
2699 | get root privileges. | |
2700 | ||
2701 | @file{movemail} has since been changed so that this security hole will | |
2702 | not exist, even if it is installed setuid root. However, | |
2703 | @file{movemail} no longer needs to be installed setuid root, which | |
2704 | should eliminate this particular risk. | |
2705 | ||
2706 | We have heard unverified reports that the 1988 Internet worm took | |
2707 | advantage of this configuration problem. | |
2708 | ||
2709 | @item The @code{file-local-variable} feature (Yes, a risk, but easy to change.) | |
2710 | ||
2711 | There is an Emacs feature that allows the setting of local values for | |
2712 | variables when editing a file by including specially formatted text near | |
2713 | the end of the file. This feature also includes the ability to have | |
2714 | arbitrary Emacs Lisp code evaluated when the file is visited. | |
2715 | Obviously, there is a potential for Trojan horses to exploit this | |
2716 | feature. | |
2717 | ||
2718 | Emacs 18 allowed this feature by default; users could disable it by | |
2719 | setting the variable @code{inhibit-local-variables} to a non-nil value. | |
2720 | ||
2721 | As of Emacs 19, Emacs has a list of local variables that create a | |
2722 | security risk. If a file tries to set one of them, it asks the user to | |
2723 | confirm whether the variables should be set. You can also tell Emacs | |
2724 | whether to allow the evaluation of Emacs Lisp code found at the bottom | |
2725 | of files by setting the variable @code{enable-local-eval}. | |
2726 | ||
2727 | For more information, @inforef{File Variables, File Variables, emacs}. | |
2728 | ||
2729 | @item Synthetic X events (Yes, a risk; use @samp{MIT-MAGIC-COOKIE-1} or better.) | |
2730 | ||
2731 | Emacs accepts synthetic X events generated by the SendEvent request as | |
2732 | though they were regular events. As a result, if you are using the | |
2733 | trivial host-based authentication, other users who can open X | |
2734 | connections to your X workstation can make your Emacs process do | |
2735 | anything, including run other processes with your privileges. | |
2736 | ||
2737 | The only fix for this is to prevent other users from being able to open | |
2738 | X connections. The standard way to prevent this is to use a real | |
2739 | authentication mechanism, such as @samp{MIT-MAGIC-COOKIE-1}. If using | |
2740 | the @file{xauth} program has any effect, then you are probably using | |
2741 | @samp{MIT-MAGIC-COOKIE-1}. Your site may be using a superior | |
2742 | authentication method; ask your system administrator. | |
2743 | ||
2744 | If real authentication is not a possibility, you may be satisfied by | |
2745 | just allowing hosts access for brief intervals while you start your X | |
2746 | programs, then removing the access. This reduces the risk somewhat by | |
2747 | narrowing the time window when hostile users would have access, but | |
2748 | @emph{does not eliminate the risk}. | |
2749 | ||
2750 | On most computers running Unix and X Windows, you enable and disable | |
2751 | access using the @file{xhost} command. To allow all hosts access to | |
2752 | your X server, use | |
2753 | ||
2754 | @example | |
2755 | xhost + | |
2756 | @end example | |
2757 | ||
2758 | at the shell prompt, which (on an HP machine, at least) produces the | |
2759 | following message: | |
2760 | ||
2761 | @example | |
2762 | access control disabled, clients can connect from any host | |
2763 | @end example | |
2764 | ||
2765 | To deny all hosts access to your X server (except those explicitly | |
2766 | allowed by name), use | |
2767 | ||
2768 | @example | |
2769 | xhost - | |
2770 | @end example | |
2771 | ||
2772 | On the test HP computer, this command generated the following message: | |
2773 | ||
2774 | @example | |
2775 | access control enabled, only authorized clients can connect | |
2776 | @end example | |
2777 | ||
2778 | @end itemize | |
2779 | ||
2780 | @node Dired claims that no file is on this line, , Security risks with Emacs, Bugs and problems | |
2781 | @section Dired says, "no file on this line" when I try to do something. | |
2782 | @cindex Dired does not see a file | |
2783 | ||
2784 | Chances are you're using a localized version of Unix that doesn't use US | |
2785 | date format in dired listings. You can check this by looking at dired | |
2786 | listings or by typing @code{ls -l} to a shell and looking at the dates that | |
2787 | come out. | |
2788 | ||
2789 | Dired uses a regular expression to find the beginning of a file name. | |
2790 | In a long Unix-style directory listing ("ls -l"), the file name starts | |
2791 | after the date. The regexp has thus been written to look for the date, | |
2792 | the format of which can vary on non-US systems. | |
2793 | ||
2794 | There are two approaches to solving this. The first one involves | |
2795 | setting things up so that "ls -l" outputs US date format. This can be | |
2796 | done by setting the locale. See your OS manual for more information. | |
2797 | ||
2798 | The second approach involves changing the regular expression used by | |
2799 | dired, @code{dired-move-to-filename-regexp}. | |
2800 | ||
2801 | @c ------------------------------------------------------------ | |
2802 | @node Compiling and installing Emacs, Finding Emacs and related packages, Bugs and problems, Top | |
2803 | @chapter Compiling and installing Emacs | |
2804 | @cindex Compiling and installing Emacs | |
2805 | ||
2806 | @menu | |
2807 | * Installing Emacs:: | |
2808 | * Updating Emacs:: | |
2809 | * Problems building Emacs:: | |
2810 | * Linking with -lX11 fails:: | |
2811 | @end menu | |
2812 | ||
2813 | @node Installing Emacs, Updating Emacs, Compiling and installing Emacs, Compiling and installing Emacs | |
2814 | @section How do I install Emacs? | |
2815 | @cindex Installing Emacs | |
2816 | @cindex Unix systems, installing Emacs on | |
2817 | @cindex Downloading and installing Emacs | |
2818 | @cindex Retrieving and installing Emacs | |
2819 | @cindex Building Emacs from source | |
2820 | @cindex Source code, building Emacs from | |
2821 | @cindex Unpacking and installing Emacs | |
2822 | ||
2823 | This answer is meant for users of Unix and Unix-like systems. Users of | |
2824 | other operating systems should see the series of questions beginning | |
2825 | with @ref{Emacs for MS-DOS}, which describe where to get non-Unix source | |
2826 | and binaries. These packages should come with installation | |
2827 | instructions. | |
2828 | ||
2829 | For Unix and Unix-like systems, the easiest way is often to compile it | |
2830 | from scratch. You will need: | |
2831 | ||
2832 | @itemize @bullet | |
2833 | ||
2834 | @item | |
0d17cd5c | 2835 | Emacs sources. @xref{Current GNU distributions}, for a list of ftp sites |
71e68827 DL |
2836 | that make them available. On @file{ftp.gnu.org}, the main GNU |
2837 | distribution site, sources are available at | |
2838 | ||
0d17cd5c | 2839 | @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-20.5.tar.gz} |
71e68827 DL |
2840 | |
2841 | The above will obviously change as new versions of Emacs come out. For | |
0d17cd5c | 2842 | instance, when Emacs 21 is released, it will most probably be |
71e68827 DL |
2843 | available at |
2844 | ||
0d17cd5c | 2845 | @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-21.1.tar.gz} |
71e68827 DL |
2846 | |
2847 | Again, you should use one of the GNU mirror sites (@xref{Current GNU | |
0d17cd5c | 2848 | distributions}, and adjust the URL accordingly) so as to reduce load on |
71e68827 DL |
2849 | @file{ftp.gnu.org}. |
2850 | ||
2851 | @item | |
2852 | @code{gzip}, the GNU compression utility. You can get @code{gzip} via | |
2853 | anonymous ftp at mirrors of @file{ftp.gnu.org} sites; it should compile | |
2854 | and install without much trouble on most systems. Once you have | |
2855 | retrieved the Emacs sources, you will probably be able to uncompress | |
2856 | them with the command | |
2857 | ||
2858 | @example | |
0d17cd5c | 2859 | gunzip --verbose emacs-20.5.tar.gz |
71e68827 DL |
2860 | @end example |
2861 | ||
0d17cd5c DL |
2862 | changing the Emacs version (20.5), as necessary. Once gunzip has |
2863 | finished doing its job, a file by the name of "emacs-20.5.tar" should | |
71e68827 DL |
2864 | be in your build directory. |
2865 | ||
2866 | @item | |
2867 | @file{tar}, the "tape archiving" program, which moves multiple files | |
2868 | into and out of archive files, or "tarfiles." All of the files | |
2869 | comprising the Emacs source come in a single tarfile, and must be | |
2870 | extracted using @file{tar} before you can build Emacs. Typically, the | |
2871 | extraction command would look like | |
2872 | ||
2873 | @example | |
0d17cd5c | 2874 | tar -xvvf emacs-20.5.tar |
71e68827 DL |
2875 | @end example |
2876 | ||
2877 | The @samp{x} indicates that we want to extract files from this tarfile, | |
2878 | the two @samp{v}s force verbose output, and the @samp{f} tells | |
2879 | @file{tar} to use a disk file, rather than one on tape. | |
2880 | ||
2881 | If you're using GNU @file{tar} (available at mirrors of | |
2882 | @file{ftp.gnu.org}), you can combine this step and the previous one by | |
2883 | using the command | |
2884 | ||
2885 | @example | |
0d17cd5c | 2886 | tar -zxvvf emacs-20.5.tar.gz |
71e68827 DL |
2887 | @end example |
2888 | ||
2889 | The additional @samp{z} at the beginning of the options list tells GNU tar | |
2890 | to uncompress the file with gunzip before extracting the tarfile's | |
2891 | components. | |
2892 | ||
2893 | @end itemize | |
2894 | ||
2895 | At this point, the Emacs sources (all 25+ megabytes of them) should be | |
0d17cd5c | 2896 | sitting in a directory called @file{emacs-20.5}. On most common Unix and |
71e68827 DL |
2897 | Unix-like systems, you should be able to compile Emacs (with X Windows |
2898 | support) with the following commands: | |
2899 | ||
2900 | @example | |
0d17cd5c | 2901 | cd emacs-20.5 # change directory to emacs-20.5 |
71e68827 DL |
2902 | ./configure # configure Emacs for your particular system |
2903 | make # use Makefile to build components, then Emacs | |
2904 | @end example | |
2905 | ||
2906 | If the @code{make} completes successfully, the odds are fairly good that | |
0d17cd5c | 2907 | the build has gone well. (@pxref{Problems building Emacs} if you weren't |
71e68827 DL |
2908 | successful.) |
2909 | ||
2910 | By default, Emacs is installed in the following directories: | |
2911 | ||
2912 | @table @file | |
2913 | ||
2914 | @item /usr/local/bin | |
2915 | binaries | |
2916 | ||
2917 | @item /usr/local/share/emacs/20.xx | |
2918 | Lisp code and support files | |
2919 | ||
2920 | @item /usr/local/info | |
2921 | Info documentation | |
2922 | ||
2923 | @end table | |
2924 | ||
2925 | To install files in those default directories, become the superuser and | |
2926 | type | |
2927 | ||
2928 | @example | |
2929 | make install | |
2930 | @end example | |
2931 | ||
2932 | Note that @code{make install} will overwrite @file{/usr/local/bin/emacs} | |
2933 | and any Emacs Info files that might be in @file{/usr/local/info}. | |
2934 | ||
2935 | Much more verbose instructions (with many more hints and suggestions) | |
2936 | come with the Emacs sources, in the file @file{INSTALL}. | |
2937 | ||
2938 | @node Updating Emacs, Problems building Emacs, Installing Emacs, Compiling and installing Emacs | |
2939 | @section How do I update Emacs to the latest version? | |
2940 | @cindex Updating Emacs | |
2941 | ||
2942 | @xref{Installing Emacs}, and follow the instructions there for | |
2943 | installation. | |
2944 | ||
0d17cd5c DL |
2945 | Most files are placed in version-specific directories. Emacs 20.5, for |
2946 | instance, places files in @file{/usr/local/share/emacs/20.5}. | |
71e68827 DL |
2947 | |
2948 | Upgrading should overwrite only, @file{/usr/local/bin/emacs} (the Emacs | |
2949 | binary) and documentation in @file{/usr/local/info}. Back up these | |
2950 | files before you upgrade, and you shouldn't have too much trouble. | |
2951 | ||
2952 | @node Problems building Emacs, Linking with -lX11 fails, Updating Emacs, Compiling and installing Emacs | |
2953 | @section What should I do if I have trouble building Emacs? | |
2954 | @cindex Problems building Emacs | |
2955 | @cindex Errors when building Emacs | |
2956 | ||
2957 | First look in the file @file{PROBLEMS} (in the top-level directory when | |
2958 | you unpack the Emacs source) to see if there is already a solution for | |
2959 | your problem. Next, look for other questions in this FAQ that have to | |
2960 | do with Emacs installation and compilation problems. | |
2961 | ||
2962 | If you'd like to have someone look at your problem and help solve it, | |
2963 | @pxref{Help installing Emacs}. | |
2964 | ||
2965 | If you cannot find a solution in the documentation, send a message to | |
2966 | @email{bug-gnu-emacs@@gnu.org}. | |
2967 | ||
2968 | Please do not post it to @uref{news:gnu.emacs.help} or send e-mail to | |
2969 | @email{help-gnu-emacs@@gnu.org}. For further guidelines, | |
2970 | @pxref{Guidelines for newsgroup postings} and @ref{Reporting bugs}. | |
2971 | ||
2972 | @node Linking with -lX11 fails, , Problems building Emacs, Compiling and installing Emacs | |
2973 | @section Why does linking Emacs with -lX11 fail? | |
2974 | @cindex Linking with -lX11 fails | |
2975 | @cindex lX11, linking fails with | |
2976 | ||
2977 | Emacs needs to be linked with the static version of the X11 library, | |
2978 | @file{libX11.a}. This may be missing. | |
2979 | ||
2980 | Under OpenWindows, you may need to use "add_services" to add the | |
2981 | "OpenWindows Programmers" optional software category from the CD-ROM. | |
2982 | ||
2983 | Under HP-UX 8.0, you may need to run "update" again to load the X11-PRG | |
2984 | "fileset". This may be missing even if you specified "all filesets" the | |
2985 | first time. If @file{libcurses.a} is missing, you may need to load the | |
2986 | "Berkeley Development Option." | |
2987 | ||
2988 | @email{zoo@@armadillo.com, David Zuhn} says that MIT X builds shared | |
2989 | libraries by default, and only shared libraries, on those platforms that | |
2990 | support them. These shared libraries can't be used when undumping | |
2991 | temacs (the last stage of the Emacs build process). To get regular | |
2992 | libraries in addition to shared libraries, add this to @file{site.cf}: | |
2993 | ||
2994 | @example | |
2995 | #define ForceNormalLib YES | |
2996 | @end example | |
2997 | ||
2998 | Other systems may have similar problems. You can always define | |
2999 | CANNOT_DUMP and link with the shared libraries instead. | |
3000 | ||
3001 | To get the Xmenu stuff to work, you need to find a copy of MIT's | |
3002 | @file{liboldX.a}. | |
3003 | ||
3004 | @c ------------------------------------------------------------ | |
3005 | @node Finding Emacs and related packages, Major packages and programs, Compiling and installing Emacs, Top | |
3006 | @chapter Finding Emacs and related packages | |
3007 | @cindex Finding Emacs and related packages | |
3008 | ||
3009 | @menu | |
3010 | * Finding Emacs on the Internet:: | |
3011 | * Finding a package with particular functionality:: | |
3012 | * Packages that do not come with Emacs:: | |
3013 | * Submitting to the Emacs Lisp Archive:: | |
3014 | * Current GNU distributions:: | |
3015 | * Difference between Emacs and XEmacs:: | |
3016 | * Emacs for MS-DOS:: | |
3017 | * Emacs for Windows:: | |
3018 | * Emacs for OS/2:: | |
3019 | * Emacs for Atari ST:: | |
3020 | * Emacs for the Amiga :: | |
3021 | * Emacs for NeXTSTEP:: | |
3022 | * Emacs for Apple computers:: | |
3023 | * Emacs for VMS and DECwindows:: | |
3024 | * Modes for various languages:: | |
3025 | * Translating names to IP addresses:: | |
3026 | @end menu | |
3027 | ||
3028 | @node Finding Emacs on the Internet, Finding a package with particular functionality, Finding Emacs and related packages, Finding Emacs and related packages | |
3029 | @section Where can I get Emacs on the net (or by snail mail)? | |
3030 | @cindex Finding Emacs on the Internet | |
3031 | @cindex Snail mail, ordering Emacs via | |
3032 | @cindex Postal service, ordering Emacs via | |
3033 | @cindex Distribution, retrieving Emacs | |
3034 | @cindex Internet, retreiving from | |
3035 | ||
3036 | Look in the files @file{etc/DISTRIB} and @file{etc/FTP} for information | |
3037 | on nearby archive sites and @file{etc/ORDERS} for mail orders. If you | |
3038 | don't already have Emacs, @pxref{Informational files for Emacs} for how | |
3039 | to get these files. | |
3040 | ||
0d17cd5c | 3041 | @xref{Installing Emacs}, for information on how to obtain and build the latest |
71e68827 DL |
3042 | version of Emacs, and @pxref{Current GNU distributions} for a list of |
3043 | archive sites that make GNU software available. | |
3044 | ||
3045 | @node Finding a package with particular functionality, Packages that do not come with Emacs, Finding Emacs on the Internet, Finding Emacs and related packages | |
3046 | @section How do I find a Emacs Lisp package that does XXX? | |
3047 | @cindex Package, finding | |
3048 | @cindex Finding an Emacs Lisp package | |
3049 | @cindex Functionality, finding a particular package | |
3050 | ||
3051 | First of all, you should check to make sure that the package isn't | |
3052 | already available. For example, typing @kbd{M-x apropos @key{RET} | |
3053 | wordstar @key{RET}} lists all functions and variables containing the | |
3054 | string @samp{wordstar}. | |
3055 | ||
3056 | It is also possible that the package is on your system, but has not been | |
3057 | loaded. To see which packages are available for loading, look through | |
3058 | your computer's lisp directory (@pxref{Filename conventions}). The Lisp | |
3059 | source to most most packages contains a short description of how they | |
3060 | should be loaded, invoked, and configured --- so before you use or | |
3061 | modify a Lisp package, see if the author has provided any hints in the | |
3062 | source code. | |
3063 | ||
3064 | If a package does not come with Emacs, check the Lisp Code Directory. | |
3065 | The LCD was originally maintained by @email{brennan@@hal.com, Dave | |
3066 | Brennan}, but was recently taken over by @email{toby@@world.std.com, | |
3067 | toby knudsen}, who maintains @uref{http://www.emacs.org}. The LCD is | |
3068 | currently being reorganized and updated, but you can meanwhile find many | |
3069 | packages at @uref{ftp://ftp.emacs.org/pub}. | |
3070 | ||
3071 | For now, you can search through the LCD with @file{lispdir.el}, which is | |
3072 | in the process of being updated. Download it from the LCD, in the | |
3073 | @file{emacs-lisp-attic/misc} directory, and then evaluate the following | |
3074 | Lisp form (@pxref{Evaluating Emacs Lisp code}): | |
3075 | ||
3076 | @lisp | |
3077 | (setq lisp-code-directory | |
3078 | "/anonymous@@ftp.emacs.org:pub/emacs-lisp-attic/emacs-lisp/LCD-datafile.gz" | |
3079 | elisp-archive-host "ftp.emacs.org" | |
3080 | elisp-archive-directory "/pub/emacs-lisp-attic/emacs-lisp/") | |
3081 | @end lisp | |
3082 | ||
3083 | Once you have installed @file{lispdir.el}, you can use @kbd{M-x | |
3084 | lisp-dir-apropos} to search the listing. For example, @kbd{M-x | |
3085 | lisp-dir-apropos @key{RET} ange-ftp @key{RET}} produces this output: | |
3086 | ||
3087 | @example | |
3088 | GNU Emacs Lisp Code Directory Apropos --- "ange-ftp" | |
3089 | "~/" refers to archive.cis.ohio-state.edu:pub/elisp-archive/ | |
3090 | ||
3091 | ange-ftp (4.18) 15-Jul-1992 | |
3092 | Andy Norman, <ange@@hplb.hpl.hp.com> | |
3093 | ~/packages/ange-ftp.tar.Z | |
3094 | transparent FTP Support for GNU Emacs | |
3095 | auto-save (1.19) 01-May-1992 | |
3096 | Sebastian Kremer, <sk@@thp.uni-koeln.de> | |
3097 | ~/misc/auto-save.el.Z | |
3098 | Safer autosaving with support for ange-ftp and /tmp | |
3099 | ftp-quik (1.0) 28-Jul-1993 | |
3100 | Terrence Brannon, <tb06@@pl122f.eecs.lehigh.edu> | |
3101 | ~/modes/ftp-quik.el.Z | |
3102 | Quik access to dired'ing of ange-ftp and normal paths | |
3103 | @end example | |
3104 | ||
3105 | @node Packages that do not come with Emacs, Submitting to the Emacs Lisp Archive, Finding a package with particular functionality, Finding Emacs and related packages | |
3106 | @section Where can I get Emacs Lisp packages that don't come with Emacs? | |
3107 | @cindex Unbundled packages | |
3108 | @cindex Finding other packages | |
3109 | @cindex Lisp packages that do not come with Emacs | |
3110 | @cindex Packages, those that do not come with Emacs | |
3111 | @cindex Emacs Lisp Archive, description of | |
3112 | @cindex Archive, description of the Emacs Lisp | |
3113 | ||
3114 | First, check the Lisp Code Directory to find the name of the package you | |
3115 | are looking for (@pxref{Finding a package with particular | |
3116 | functionality}). Next, check local archives and the Emacs Lisp Archive | |
3117 | to find a copy of the relevant files. If you still haven't found it, | |
3118 | you can send e-mail to the author asking for a copy. If you find Emacs | |
3119 | Lisp code that doesn't appear in the LCD, please submit a copy to the | |
3120 | LCD (@pxref{Submitting to the Emacs Lisp Archive}). | |
3121 | ||
3122 | You can access the Emacs Lisp Archive at | |
3123 | ||
3124 | @uref{ftp://archive.cis.ohio-state.edu/pub/emacs-lisp/} | |
3125 | ||
3126 | Retrieve and read the file @file{README} first. | |
3127 | ||
3128 | @itemize @bullet | |
3129 | ||
3130 | @item The archive maintainers do not have time to answer individual | |
3131 | requests for packages or the list of packages in the archive. If you | |
3132 | cannot use FTP or UUCP to access the archive yourself, try to find a | |
3133 | friend who can, but please don't ask the maintainers. | |
3134 | ||
3135 | @item Any files with names ending in @samp{.Z}, @samp{.z}, or @samp{.gz} are | |
3136 | compressed, so you should use "binary" mode in FTP to retrieve them. | |
3137 | You should also use binary mode whenever you retrieve any files with | |
3138 | names ending in @samp{.elc}. | |
3139 | ||
3140 | @end itemize | |
3141 | ||
3142 | @node Submitting to the Emacs Lisp Archive, Current GNU distributions, Packages that do not come with Emacs, Finding Emacs and related packages | |
3143 | @section How do I submit code to the Emacs Lisp Archive? | |
3144 | @cindex Submitting code to the Emacs Lisp Archive | |
3145 | @cindex Emacs Lisp Archive, submissions to | |
3146 | @cindex Lisp Archive, submissions to | |
3147 | @cindex Archive, submitting to the Emacs Lisp | |
3148 | ||
3149 | Guidelines and procedures for submission to the archive can be found in | |
3150 | the file @file{GUIDELINES} in the archive directory (@ref{Packages that | |
3151 | do not come with Emacs}). It covers documentation, copyrights, | |
3152 | packaging, submission, and the Lisp Code Directory Record. Anonymous | |
3153 | FTP uploads are not permitted. Instead, all submissions are mailed to | |
3154 | @email{elisp-archive@@cis.ohio-state.edu}. The @file{lispdir.el} | |
3155 | package has a function named @code{submit-lcd-entry} which will help you | |
3156 | with this. | |
3157 | ||
3158 | @node Current GNU distributions, Difference between Emacs and XEmacs, Submitting to the Emacs Lisp Archive, Finding Emacs and related packages | |
3159 | @section Where can I get other up-to-date GNU stuff? | |
3160 | @cindex Current GNU distributions | |
3161 | @cindex Sources for current GNU distributions | |
3162 | @cindex Stuff, current GNU | |
3163 | @cindex Up-to-date GNU stuff | |
3164 | @cindex Finding current GNU software | |
3165 | @cindex Official GNU software sites | |
3166 | ||
3167 | The most up-to-date official GNU software is normally kept at | |
3168 | ||
3169 | @uref{ftp://ftp.gnu.org/pub/gnu} | |
3170 | ||
3171 | Read the files @file{etc/DISTRIB} and @file{etc/FTP} for more | |
3172 | information. | |
3173 | ||
3174 | A list of sites mirroring @samp{ftp.gnu.org} can be found at | |
3175 | ||
3176 | @uref{http://www.gnu.org/order/ftp.html} | |
3177 | ||
3178 | @node Difference between Emacs and XEmacs, Emacs for MS-DOS, Current GNU distributions, Finding Emacs and related packages | |
3179 | @section What is the difference between Emacs and XEmacs (formerly "Lucid Emacs")? | |
3180 | @cindex XEmacs | |
3181 | @cindex Difference Emacs and XEmacs | |
3182 | @cindex Lucid Emacs | |
3183 | @cindex Epoch | |
3184 | ||
3185 | First of all, they're both GNU Emacs. XEmacs is just as much a later | |
3186 | version of GNU Emacs as the FSF-distributed version. This FAQ refers to | |
3187 | the latest version to be distributed by the FSF as "Emacs," partly | |
3188 | because the XEmacs maintainers now refer to their product using the | |
3189 | "XEmacs" name, and partly because there isn't any accurate way to | |
3190 | differentiate between the two without getting mired in paragraphs of | |
3191 | legalese and history. | |
3192 | ||
3193 | XEmacs, which began life as Lucid Emacs, is based on an early version of | |
3194 | Emacs 19 and Epoch, an X-aware version of Emacs 18. | |
3195 | ||
3196 | Emacs (i.e., the version distributed by the FSF) has a larger installed | |
0d17cd5c DL |
3197 | base and now always contains the MULE multilingual facilities. |
3198 | XEmacs can do some clever tricks with X Windows, such as | |
3199 | putting arbitrary graphics in a buffer. Similar facilities have been | |
3200 | implemented for Emacs as part of a new redisplay implementation for | |
3201 | Emacs 21, expected to be released after Emacs 20.5. | |
3202 | Emacs and XEmacs each come with | |
71e68827 DL |
3203 | Lisp packages that are lacking in the other; RMS says that the FSF would |
3204 | include more packages that come with XEmacs, but that the XEmacs | |
3205 | maintainers don't always keep track of the authors of contributed code, | |
3206 | which makes it impossible for the FSF to have certain legal papers | |
3207 | signed. (Without these legal papers, the FSF will not distribute Lisp | |
0d17cd5c DL |
3208 | packages with Emacs.) The two versions have some |
3209 | significant differences at the Lisp programming level. | |
71e68827 DL |
3210 | |
3211 | Many XEmacs features have found their way into recent versions of Emacs, | |
3212 | and more features can be expected in the future, but there are still many | |
3213 | differences between the two. | |
3214 | ||
71e68827 DL |
3215 | @node Emacs for MS-DOS, Emacs for Windows, Difference between Emacs and XEmacs, Finding Emacs and related packages |
3216 | @section Where can I get Emacs for my PC running MS-DOS? | |
3217 | @cindex MS-DOS, Emacs for | |
3218 | @cindex DOS, Emacs for | |
3219 | @cindex Compiling Emacs for DOS | |
3220 | @cindex Emacs for MS-DOS | |
3221 | @cindex Tools needed to compile Emacs under DOS | |
3222 | ||
3223 | A pre-built binary distribution of Emacs is available from the Simtel | |
3224 | archives. This version apparently works under MS-DOS and Windows (3.x, | |
0d17cd5c DL |
3225 | 95x, and NT) and supports long file names under Windows 9x. More |
3226 | information is available from | |
71e68827 DL |
3227 | |
3228 | @uref{ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu/emacs.README} | |
3229 | ||
3230 | The binary itself is available in the files em1934*.zip in the | |
3231 | directory | |
3232 | ||
3233 | @uref{ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu/} | |
3234 | ||
0d17cd5c DL |
3235 | If you prefer to compile Emacs for yourself, you can do so with the |
3236 | current distribution directly. You will need a 386 (or | |
3237 | better) processor, and to be running MS-DOS 3.0 or later. According to | |
71e68827 DL |
3238 | @email{eliz@@is.elta.co.il, Eli Zaretskii} and |
3239 | @email{hankedr@@dms.auburn.edu, Darrel Hankerson}, you will need the | |
3240 | following: | |
3241 | ||
3242 | @table @emph | |
3243 | ||
3244 | @item Compiler | |
3245 | djgpp version 1.12 maint 1 or later. Djgpp 2.0 or later is | |
3246 | recommended, since 1.x is being phased out. Djgpp 2 supports | |
0d17cd5c | 3247 | long filenames under Windows 9x. |
71e68827 DL |
3248 | |
3249 | You can get the latest release of djgpp by retrieving all of | |
3250 | the files in | |
3251 | ||
3252 | @uref{ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp} | |
3253 | ||
3254 | @item Gunzip and tar | |
3255 | The easiest way is to use "djtar" which comes with djgpp v2.x, | |
3256 | because it can open gzip'ed tarfiles (i.e., those ending with | |
3257 | ".tar.gz") in one step. Djtar comes in "djdev201.zip", from | |
3258 | the URL mentioned above. | |
3259 | ||
3260 | @item make, mv, sed, and rm | |
3261 | All of these utilities are available at | |
3262 | ||
3263 | @uref{ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu} | |
3264 | ||
3265 | 16-bit utilities can be found in GNUish, at | |
3266 | ||
3267 | @uref{ftp://ftp.simtel.net/pub/simtelnet/gnu/gnuish} | |
3268 | ||
3269 | @end table | |
3270 | ||
3271 | The files @file{INSTALL} and @file{PROBLEMS} in the top-level directory | |
3272 | of the Emacs source contains some additional information regarding Emacs | |
3273 | under MS-DOS. | |
3274 | ||
3275 | For a list of other MS-DOS implementations of Emacs (and Emacs | |
3276 | look-alikes), consult the list of "Emacs implementations and literature," | |
3277 | available at | |
3278 | ||
3279 | @uref{ftp://rtfm.mit.edu/pub/usenet/comp.emacs/} | |
3280 | ||
3281 | Note that while many of these programs look similar to Emacs, they often | |
3282 | lack certain features, such as the Emacs Lisp extension language. | |
3283 | ||
3284 | @node Emacs for Windows, Emacs for OS/2, Emacs for MS-DOS, Finding Emacs and related packages | |
3285 | @section Where can I get Emacs for Microsoft Windows | |
3286 | @cindex FAQ for NT Emacs | |
3287 | @cindex Microsoft Windows, Emacs for | |
3288 | @cindex Windows NT, Emacs for | |
3289 | @cindex Windows '95 and '98, Emacs for | |
3290 | ||
3291 | For information on Emacs for Windows 95 and NT, read the FAQ produced by | |
3292 | @email{voelker@@cs.washington.edu, Geoff Voelker}, available at | |
3293 | ||
0d17cd5c | 3294 | @uref{http://www.gnu.org/software/emacs/windows/ntemacs.html} |
71e68827 | 3295 | |
0d17cd5c | 3296 | @xref{Emacs for MS-DOS}, for Windows 3.1. |
71e68827 DL |
3297 | |
3298 | @node Emacs for OS/2, Emacs for Atari ST, Emacs for Windows, Finding Emacs and related packages | |
3299 | @section Where can I get Emacs for my PC running OS/2? | |
3300 | @cindex OS/2, Emacs for | |
3301 | ||
3302 | Emacs 19.33 is ported for emx on OS/2 2.0 or 2.1, and is available at | |
3303 | ||
3304 | @uref{ftp://hobbes.nmsu.edu/pub/os2/apps/editors/emacs/v19.33/} | |
3305 | ||
3306 | @node Emacs for Atari ST, Emacs for the Amiga , Emacs for OS/2, Finding Emacs and related packages | |
3307 | @section Where can I get Emacs for my Atari ST? | |
3308 | @cindex Atari ST, Emacs for | |
3309 | @cindex TOS, Emacs for | |
3310 | ||
3311 |