Commit | Line | Data |
---|---|---|
4009494e GM |
1 | \input texinfo @c -*- mode: texinfo; -*- |
2 | @c %**start of header | |
db78a8cb | 3 | @setfilename ../../info/efaq |
4009494e GM |
4 | @settitle GNU Emacs FAQ |
5 | @c %**end of header | |
6 | ||
f7a31f11 | 7 | @include emacsver.texi |
4009494e GM |
8 | |
9 | @c This file is maintained by Romain Francoise <rfrancoise@gnu.org>. | |
10 | @c Feel free to install changes without prior permission (but I'd | |
11 | @c appreciate a notice if you do). | |
12 | ||
13 | @copying | |
16f6287e | 14 | Copyright @copyright{} 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, |
114f9c96 | 15 | 2009, 2010 Free Software Foundation, Inc.@* |
85b438b7 GM |
16 | Copyright @copyright{} 1994, 1995, 1996, 1997, 1998, 1999, 2000 |
17 | Reuven M. Lerner@* | |
18 | Copyright @copyright{} 1992, 1993 Steven Byrnes@* | |
19 | Copyright @copyright{} 1990, 1991, 1992 Joseph Brian Wells@* | |
4009494e GM |
20 | |
21 | @quotation | |
22 | This list of frequently asked questions about GNU Emacs with answers | |
23 | (``FAQ'') may be translated into other languages, transformed into other | |
24 | formats (e.g. Texinfo, Info, WWW, WAIS), and updated with new information. | |
25 | ||
26 | The same conditions apply to any derivative of the FAQ as apply to the FAQ | |
27 | itself. Every copy of the FAQ must include this notice or an approved | |
28 | translation, information on who is currently maintaining the FAQ and how to | |
29 | contact them (including their e-mail address), and information on where the | |
30 | latest version of the FAQ is archived (including FTP information). | |
31 | ||
32 | The FAQ may be copied and redistributed under these conditions, except that | |
33 | the FAQ may not be embedded in a larger literary work unless that work | |
34 | itself allows free copying and redistribution. | |
35 | ||
36 | [This version has been heavily edited since it was included in the Emacs | |
37 | distribution.] | |
38 | @end quotation | |
39 | @end copying | |
40 | ||
41 | @dircategory Emacs | |
42 | @direntry | |
9360256a | 43 | * Emacs FAQ: (efaq). Frequently Asked Questions about Emacs. |
4009494e GM |
44 | @end direntry |
45 | ||
46 | @c The @titlepage stuff only appears in the printed version | |
47 | @titlepage | |
48 | @sp 10 | |
49 | @center @titlefont{GNU Emacs FAQ} | |
50 | ||
51 | @c The following two commands start the copyright page. | |
52 | @page | |
53 | @vskip 0pt plus 1filll | |
54 | @insertcopying | |
55 | @end titlepage | |
56 | ||
5dc584b5 KB |
57 | @contents |
58 | ||
f0bf7708 GM |
59 | @node Top, FAQ notation, (dir), (dir) |
60 | @top The GNU Emacs FAQ | |
4009494e | 61 | |
85b438b7 | 62 | @c FIXME @today is just the day we ran `makeinfo'. |
4009494e GM |
63 | This is the GNU Emacs FAQ, last updated on @today{}. |
64 | ||
65 | This FAQ is maintained as a part of GNU Emacs. If you find any errors, | |
66 | or have any suggestions, please use @kbd{M-x report-emacs-bug} to report | |
67 | them. | |
68 | ||
f7a31f11 | 69 | This is the version of the FAQ distributed with Emacs @value{EMACSVER}, and |
b59a8457 | 70 | mainly describes that version. Although there is some information on |
f6adc23c | 71 | older versions, details about very old releases (now only of historical |
b59a8457 GM |
72 | interest) have been removed. If you are interested in this, consult |
73 | either the version of the FAQ distributed with older versions of Emacs, | |
74 | or the history of this document in the Emacs source repository. | |
75 | ||
76 | Since Emacs releases are very stable, we recommend always running the | |
77 | latest release. | |
78 | ||
79 | This FAQ is not updated very frequently. When you have a question about | |
80 | Emacs, the Emacs manual is often the best starting point. | |
81 | ||
5dc584b5 KB |
82 | @ifnottex |
83 | @insertcopying | |
84 | @end ifnottex | |
85 | ||
4009494e GM |
86 | @menu |
87 | * FAQ notation:: | |
88 | * General questions:: | |
89 | * Getting help:: | |
90 | * Status of Emacs:: | |
91 | * Common requests:: | |
92 | * Bugs and problems:: | |
93 | * Compiling and installing Emacs:: | |
94 | * Finding Emacs and related packages:: | |
95 | * Major packages and programs:: | |
96 | * Key bindings:: | |
97 | * Alternate character sets:: | |
98 | * Mail and news:: | |
99 | * Concept index:: | |
100 | @end menu | |
101 | ||
102 | @c ------------------------------------------------------------ | |
f0bf7708 | 103 | @node FAQ notation |
4009494e GM |
104 | @chapter FAQ notation |
105 | @cindex FAQ notation | |
106 | ||
107 | This chapter describes notation used in the GNU Emacs FAQ, as well as in | |
108 | the Emacs documentation. Consult this section if this is the first time | |
109 | you are reading the FAQ, or if you are confused by notation or terms | |
110 | used in the FAQ. | |
111 | ||
112 | @menu | |
113 | * Basic keys:: | |
114 | * Extended commands:: | |
85b438b7 | 115 | * Emacs manual:: |
4009494e GM |
116 | * File-name conventions:: |
117 | * Common acronyms:: | |
118 | @end menu | |
119 | ||
f0bf7708 | 120 | @node Basic keys |
4009494e GM |
121 | @section What do these mean: @kbd{C-h}, @kbd{C-M-a}, @key{RET}, @kbd{@key{ESC} a}, etc.? |
122 | @cindex Basic keys | |
123 | @cindex Control key, notation for | |
124 | @cindex @key{Meta} key, notation for | |
125 | @cindex Control-Meta characters, notation for | |
126 | @cindex @kbd{C-h}, definition of | |
127 | @cindex @kbd{C-M-h}, definition of | |
128 | @cindex @key{DEL}, definition of | |
129 | @cindex @key{ESC}, definition of | |
130 | @cindex @key{LFD}, definition of | |
131 | @cindex @key{RET}, definition of | |
132 | @cindex @key{SPC}, definition of | |
133 | @cindex @key{TAB}, definition of | |
134 | @cindex Notation for keys | |
135 | ||
136 | @itemize @bullet | |
137 | ||
138 | @item | |
139 | @kbd{C-x}: press the @key{x} key while holding down the @key{Control} key | |
140 | ||
141 | @item | |
142 | @kbd{M-x}: press the @key{x} key while holding down the @key{Meta} key | |
143 | (if your computer doesn't have a @key{Meta} key, @pxref{No Meta key}) | |
144 | ||
145 | @item | |
146 | @kbd{M-C-x}: press the @key{x} key while holding down both @key{Control} | |
147 | and @key{Meta} | |
148 | ||
149 | @item | |
150 | @kbd{C-M-x}: a synonym for the above | |
151 | ||
152 | @item | |
153 | @key{LFD}: Linefeed or Newline; same as @kbd{C-j} | |
154 | ||
155 | @item | |
156 | @key{RET}: @key{Return}, sometimes marked @key{Enter}; same as @kbd{C-m} | |
157 | ||
158 | @item | |
159 | @key{DEL}: @key{Delete}, usually @strong{not} the same as | |
160 | @key{Backspace}; same as @kbd{C-?} (see @ref{Backspace invokes help}, if | |
161 | deleting invokes Emacs help) | |
162 | ||
163 | @item | |
164 | @key{ESC}: Escape; same as @kbd{C-[} | |
165 | ||
166 | @item | |
167 | @key{TAB}: Tab; same as @kbd{C-i} | |
168 | ||
169 | @item | |
170 | @key{SPC}: Space bar | |
171 | ||
172 | @end itemize | |
173 | ||
174 | Key sequences longer than one key (and some single-key sequences) are | |
175 | written inside quotes or on lines by themselves, like this: | |
176 | ||
177 | @display | |
178 | @kbd{M-x frobnicate-while-foo RET} | |
179 | @end display | |
180 | ||
181 | @noindent | |
182 | Any real spaces in such a key sequence should be ignored; only @key{SPC} | |
183 | really means press the space key. | |
184 | ||
185 | The @acronym{ASCII} code sent by @kbd{C-x} (except for @kbd{C-?}) is the value | |
186 | that would be sent by pressing just @key{x} minus 96 (or 64 for | |
187 | upper-case @key{X}) and will be from 0 to 31. On Unix and GNU/Linux | |
188 | terminals, the @acronym{ASCII} code sent by @kbd{M-x} is the sum of 128 and the | |
189 | @acronym{ASCII} code that would be sent by pressing just @key{x}. Essentially, | |
190 | @key{Control} turns off bits 5 and 6 and @key{Meta} turns on bit | |
191 | 7@footnote{ | |
192 | DOS and Windows terminals don't set bit 7 when the @key{Meta} key is | |
193 | pressed.}. | |
194 | ||
195 | @kbd{C-?} (aka @key{DEL}) is @acronym{ASCII} code 127. It is a misnomer to call | |
196 | @kbd{C-?} a ``control'' key, since 127 has both bits 5 and 6 turned ON. | |
197 | Also, on very few keyboards does @kbd{C-?} generate @acronym{ASCII} code 127. | |
85b438b7 | 198 | @c FIXME I cannot understand the previous sentence. |
4009494e | 199 | |
85b438b7 GM |
200 | @inforef{Keys, Keys, emacs}, for more information. (@xref{Emacs |
201 | manual}, for more information about Info.) | |
4009494e | 202 | |
f0bf7708 | 203 | @node Extended commands |
4009494e GM |
204 | @section What does @file{M-x @var{command}} mean? |
205 | @cindex Extended commands | |
206 | @cindex Commands, extended | |
207 | @cindex M-x, meaning of | |
208 | ||
209 | @kbd{M-x @var{command}} means type @kbd{M-x}, then type the name of the | |
210 | command, then type @key{RET}. (@xref{Basic keys}, if you're not sure | |
211 | what @kbd{M-x} and @key{RET} mean.) | |
212 | ||
213 | @kbd{M-x} (by default) invokes the command | |
214 | @code{execute-extended-command}. This command allows you to run any | |
215 | Emacs command if you can remember the command's name. If you can't | |
216 | remember the command's name, you can type @key{TAB} and @key{SPC} for | |
217 | completion, @key{?} for a list of possibilities, and @kbd{M-p} and | |
f6adc23c GM |
218 | @kbd{M-n} (or up-arrow and down-arrow) to see previous commands entered. |
219 | An Emacs @dfn{command} is an @dfn{interactive} Emacs function. | |
4009494e GM |
220 | |
221 | @cindex @key{Do} key | |
222 | Your system administrator may have bound other key sequences to invoke | |
223 | @code{execute-extended-command}. A function key labeled @kbd{Do} is a | |
224 | good candidate for this, on keyboards that have such a key. | |
225 | ||
226 | If you need to run non-interactive Emacs functions, see @ref{Evaluating | |
227 | Emacs Lisp code}. | |
228 | ||
85b438b7 GM |
229 | @node Emacs manual |
230 | @section How do I read topic XXX in the Emacs manual? | |
231 | @cindex Emacs manual, reading topics in | |
232 | @cindex Reading topics in the Emacs manual | |
233 | @cindex Finding topics in the Emacs manual | |
4009494e GM |
234 | @cindex Info, finding topics in |
235 | ||
85b438b7 | 236 | When we refer you to some @var{topic} in the Emacs manual, you can |
4009494e GM |
237 | read this manual node inside Emacs (assuming nothing is broken) by |
238 | typing @kbd{C-h i m emacs @key{RET} m @var{topic} @key{RET}}. | |
239 | ||
240 | This invokes Info, the GNU hypertext documentation browser. If you don't | |
241 | already know how to use Info, type @key{?} from within Info. | |
242 | ||
243 | If we refer to @var{topic}:@var{subtopic}, type @kbd{C-h i m emacs | |
244 | @key{RET} m @var{topic} @key{RET} m @var{subtopic} @key{RET}}. | |
245 | ||
246 | If these commands don't work as expected, your system administrator may | |
247 | not have installed the Info files, or may have installed them | |
248 | improperly. In this case you should complain. | |
249 | ||
f6adc23c GM |
250 | If you are reading this FAQ in Info, you can simply press @key{RET} on a |
251 | reference to follow it. | |
252 | ||
4009494e GM |
253 | @xref{Getting a printed manual}, if you would like a paper copy of the |
254 | Emacs manual. | |
255 | ||
f0bf7708 | 256 | @node File-name conventions |
f6adc23c | 257 | @section What are @file{etc/GNU}, @file{src/config.h}, @file{site-lisp/default.el}, etc.? |
4009494e GM |
258 | @cindex File-name conventions |
259 | @cindex Conventions for file names | |
260 | @cindex Directories and files that come with Emacs | |
261 | ||
262 | These are files that come with Emacs. The Emacs distribution is divided | |
85b438b7 | 263 | into subdirectories; e.g. @file{etc}, @file{lisp}, and @file{src}. |
f6adc23c GM |
264 | Some of these (e.g. @file{etc} and @file{lisp}) are present both in |
265 | an installed Emacs and in the sources, but some (e.g. @file{src}) are | |
266 | only found in the sources. | |
4009494e GM |
267 | |
268 | If you use Emacs, but don't know where it is kept on your system, start | |
269 | Emacs, then type @kbd{C-h v data-directory @key{RET}}. The directory | |
270 | name displayed by this will be the full pathname of the installed | |
271 | @file{etc} directory. (This full path is recorded in the Emacs variable | |
272 | @code{data-directory}, and @kbd{C-h v} displays the value and the | |
273 | documentation of a variable.) | |
274 | ||
85b438b7 | 275 | The location of your Info directory (i.e., where Info documentation |
4009494e GM |
276 | is stored) is kept in the variable @code{Info-default-directory-list}. Use |
277 | @kbd{C-h v Info-default-directory-list @key{RET}} to see the value of | |
278 | this variable, which will be a list of directory names. The last | |
279 | directory in that list is probably where most Info files are stored. By | |
f6adc23c | 280 | default, Emacs Info documentation is placed in @file{/usr/local/share/info}. |
4009494e | 281 | |
f6adc23c GM |
282 | For information on some of the files in the @file{etc} directory, |
283 | @pxref{Informational files for Emacs}. | |
4009494e | 284 | |
f0bf7708 | 285 | @node Common acronyms |
30884d11 | 286 | @section What are FSF, LPF, GNU, RMS, FTP, and GPL? |
4009494e GM |
287 | @cindex FSF, definition of |
288 | @cindex LPF, definition of | |
4009494e GM |
289 | @cindex GNU, definition of |
290 | @cindex RMS, definition of | |
291 | @cindex Stallman, Richard, acronym for | |
292 | @cindex Richard Stallman, acronym for | |
293 | @cindex FTP, definition of | |
294 | @cindex GPL, definition of | |
295 | @cindex Acronyms, definitions for | |
296 | @cindex Common acronyms, definitions for | |
297 | ||
298 | @table @asis | |
299 | ||
300 | @item FSF | |
301 | Free Software Foundation | |
302 | ||
303 | @item LPF | |
304 | League for Programming Freedom | |
305 | ||
4009494e GM |
306 | @item GNU |
307 | GNU's Not Unix | |
308 | ||
309 | @item RMS | |
310 | Richard Matthew Stallman | |
311 | ||
312 | @item FTP | |
313 | File Transfer Protocol | |
314 | ||
315 | @item GPL | |
316 | GNU General Public License | |
317 | ||
318 | @end table | |
319 | ||
30884d11 | 320 | Avoid confusing the FSF and the LPF. The LPF opposes |
4009494e | 321 | look-and-feel copyrights and software patents. The FSF aims to make |
30884d11 | 322 | high quality free software available for everyone. |
4009494e GM |
323 | |
324 | The word ``free'' in the title of the Free Software Foundation refers to | |
325 | ``freedom,'' not ``zero cost.'' Anyone can charge any price for | |
326 | GPL-covered software that they want to. However, in practice, the | |
327 | freedom enforced by the GPL leads to low prices, because you can always | |
328 | get the software for less money from someone else, since everyone has | |
329 | the right to resell or give away GPL-covered software. | |
330 | ||
331 | @c ------------------------------------------------------------ | |
f0bf7708 | 332 | @node General questions |
4009494e GM |
333 | @chapter General questions |
334 | @cindex General questions | |
335 | ||
336 | This chapter contains general questions having to do with Emacs, the | |
337 | Free Software Foundation, and related organizations. | |
338 | ||
339 | @menu | |
340 | * The LPF:: | |
341 | * Real meaning of copyleft:: | |
342 | * Guidelines for newsgroup postings:: | |
343 | * Newsgroup archives:: | |
344 | * Reporting bugs:: | |
345 | * Unsubscribing from Emacs lists:: | |
346 | * Contacting the FSF:: | |
347 | @end menu | |
348 | ||
f0bf7708 | 349 | @node The LPF |
4009494e GM |
350 | @section What is the LPF? |
351 | @cindex LPF, description of | |
352 | @cindex League for Programming Freedom | |
353 | @cindex Software patents, opposition to | |
354 | @cindex Patents for software, opposition to | |
355 | ||
356 | The LPF opposes the expanding danger of software patents and | |
30884d11 GM |
357 | look-and-feel copyrights. More information on the LPF's views is |
358 | available at @uref{http://progfree.org/, the LPF home page}. | |
4009494e | 359 | |
f0bf7708 | 360 | @node Real meaning of copyleft |
4009494e GM |
361 | @section What is the real legal meaning of the GNU copyleft? |
362 | @cindex Copyleft, real meaning of | |
363 | @cindex GPL, real meaning of | |
364 | @cindex General Public License, real meaning of | |
365 | @cindex Discussion of the GPL | |
366 | ||
367 | The real legal meaning of the GNU General Public License (copyleft) will | |
368 | only be known if and when a judge rules on its validity and scope. | |
369 | There has never been a copyright infringement case involving the GPL to | |
85b438b7 GM |
370 | set any precedents. Although legal actions have been brought against |
371 | companies for violating the terms of the GPL, so far all have been | |
372 | settled out of court (in favour of the plaintiffs). Please take any | |
373 | discussion regarding this issue to the newsgroup | |
374 | @uref{news:gnu.misc.discuss}, which was created to hold the extensive | |
375 | flame wars on the subject. | |
4009494e GM |
376 | |
377 | RMS writes: | |
378 | ||
379 | @quotation | |
380 | The legal meaning of the GNU copyleft is less important than the spirit, | |
381 | which is that Emacs is a free software project and that work pertaining | |
382 | to Emacs should also be free software. ``Free'' means that all users | |
383 | have the freedom to study, share, change and improve Emacs. To make | |
384 | sure everyone has this freedom, pass along source code when you | |
385 | distribute any version of Emacs or a related program, and give the | |
386 | recipients the same freedom that you enjoyed. | |
387 | @end quotation | |
388 | ||
f0bf7708 | 389 | @node Guidelines for newsgroup postings |
85b438b7 | 390 | @section What are appropriate messages for the various Emacs newsgroups? |
4009494e GM |
391 | @cindex Newsgroups, appropriate messages for |
392 | @cindex GNU newsgroups, appropriate messages for | |
393 | @cindex Usenet groups, appropriate messages for | |
394 | @cindex Mailing lists, appropriate messages for | |
395 | @cindex Posting messages to newsgroups | |
396 | ||
397 | @cindex GNU mailing lists | |
398 | The file @file{etc/MAILINGLISTS} describes the purpose of each GNU | |
f6adc23c GM |
399 | mailing list (@pxref{Informational files for Emacs}). For those lists |
400 | which are gatewayed with newsgroups, it lists both the newsgroup name | |
401 | and the mailing list address. The Emacs mailing lists are also | |
402 | described at @uref{http://savannah.gnu.org/mail/?group=emacs, the Emacs | |
403 | Savannah page}. | |
4009494e GM |
404 | |
405 | The newsgroup @uref{news:comp.emacs} is for discussion of Emacs programs | |
85b438b7 | 406 | in general. The newsgroup @uref{news:gnu.emacs.help} is specifically |
b59a8457 GM |
407 | for GNU Emacs. It therefore makes no sense to cross-post to both |
408 | groups, since only one can be appropriate to any question. | |
4009494e GM |
409 | |
410 | Messages advocating ``non-free'' software are considered unacceptable on | |
411 | any of the @code{gnu.*} newsgroups except for @uref{news:gnu.misc.discuss}, | |
412 | which was created to hold the extensive flame-wars on the subject. | |
413 | ``Non-free'' software includes any software for which the end user can't | |
414 | freely modify the source code and exchange enhancements. Be careful to | |
415 | remove the @code{gnu.*} groups from the @samp{Newsgroups:} line when | |
416 | posting a followup that recommends such software. | |
417 | ||
418 | @uref{news:gnu.emacs.bug} is a place where bug reports appear, but avoid | |
419 | posting bug reports to this newsgroup directly (@pxref{Reporting bugs}). | |
420 | ||
f0bf7708 | 421 | @node Newsgroup archives |
4009494e GM |
422 | @section Where can I get old postings to @uref{news:gnu.emacs.help} and other GNU groups? |
423 | @cindex Archived postings from @code{gnu.emacs.help} | |
424 | @cindex Usenet archives for GNU groups | |
425 | @cindex Old Usenet postings for GNU groups | |
426 | ||
427 | The FSF has maintained archives of all of the GNU mailing lists for many | |
428 | years, although there may be some unintentional gaps in coverage. The | |
f6adc23c GM |
429 | archive can be browsed over the web at |
430 | @uref{http://lists.gnu.org/archive/html/, the GNU mail archive}. Raw | |
431 | files can be downloaded from @uref{ftp://lists.gnu.org/}. | |
4009494e GM |
432 | |
433 | Web-based Usenet search services, such as | |
85b438b7 | 434 | @uref{http://groups.google.com/groups/dir?q=gnu&, Google}, also |
4009494e GM |
435 | archive the @code{gnu.*} groups. |
436 | ||
f6adc23c | 437 | You can also read the archives of the @code{gnu.*} groups and post new |
85b438b7 | 438 | messages at @uref{http://gmane.org/, Gmane}. Gmane is a service that |
f6adc23c GM |
439 | presents mailing lists as newsgroups (even those without a traditional |
440 | mail-to-news gateway). | |
4009494e | 441 | |
f0bf7708 | 442 | @node Reporting bugs |
4009494e GM |
443 | @section Where should I report bugs and other problems with Emacs? |
444 | @cindex Bug reporting | |
445 | @cindex Good bug reports | |
446 | @cindex How to submit a bug report | |
447 | @cindex Reporting bugs | |
448 | ||
449 | The correct way to report Emacs bugs is to use the command | |
450 | @kbd{M-x report-emacs-bug}. It sets up a mail buffer with the | |
85b438b7 | 451 | essential information and the correct e-mail address, which is |
4009494e GM |
452 | @email{bug-gnu-emacs@@gnu.org} for the released versions of Emacs. |
453 | Anything sent to @email{bug-gnu-emacs@@gnu.org} also appears in the | |
454 | newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of | |
455 | news to submit the bug report. This ensures a reliable return address | |
456 | so you can be contacted for further details. | |
457 | ||
458 | Be sure to read the ``Bugs'' section of the Emacs manual before reporting | |
459 | a bug! The manual describes in detail how to submit a useful bug | |
460 | report (@pxref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}). | |
85b438b7 | 461 | (@xref{Emacs manual}, if you don't know how to read the manual.) |
4009494e GM |
462 | |
463 | RMS says: | |
464 | ||
465 | @quotation | |
466 | Sending bug reports to @email{help-gnu-emacs@@gnu.org} (which has the | |
467 | effect of posting on @uref{news:gnu.emacs.help}) is undesirable because | |
468 | it takes the time of an unnecessarily large group of people, most of | |
469 | whom are just users and have no idea how to fix these problem. | |
470 | @email{bug-gnu-emacs@@gnu.org} reaches a much smaller group of people | |
471 | who are more likely to know what to do and have expressed a wish to | |
472 | receive more messages about Emacs than the others. | |
473 | @end quotation | |
474 | ||
475 | RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}: | |
476 | ||
477 | @quotation | |
478 | If you have reported a bug and you don't hear about a possible fix, | |
479 | then after a suitable delay (such as a week) it is okay to post on | |
480 | @code{gnu.emacs.help} asking if anyone can help you. | |
481 | @end quotation | |
482 | ||
483 | If you are unsure whether you have found a bug, consider the following | |
484 | non-exhaustive list, courtesy of RMS: | |
485 | ||
486 | @quotation | |
487 | If Emacs crashes, that is a bug. If Emacs gets compilation errors | |
488 | while building, that is a bug. If Emacs crashes while building, that | |
489 | is a bug. If Lisp code does not do what the documentation says it | |
490 | does, that is a bug. | |
491 | @end quotation | |
492 | ||
f0bf7708 | 493 | @node Unsubscribing from Emacs lists |
85b438b7 | 494 | @section How do I unsubscribe from a mailing list? |
4009494e GM |
495 | @cindex Unsubscribing from GNU mailing lists |
496 | @cindex Removing yourself from GNU mailing lists | |
497 | ||
85b438b7 | 498 | If you are receiving a GNU mailing list named @var{list}, you should be |
4009494e | 499 | able to unsubscribe from it by sending a request to the address |
85b438b7 GM |
500 | @email{@var{list}-request@@gnu.org}. Mailing lists mails normally |
501 | contain information in either the message header | |
502 | (@samp{List-Unsubscribe:}) or as a footer that tells you how to | |
503 | unsubscribe. | |
4009494e | 504 | |
f0bf7708 | 505 | @node Contacting the FSF |
4009494e GM |
506 | @section What is the current address of the FSF? |
507 | @cindex Snail mail address of the FSF | |
508 | @cindex Postal address of the FSF | |
509 | @cindex Contracting the FSF | |
510 | @cindex Free Software Foundation, contacting | |
511 | ||
f6adc23c GM |
512 | For up-to-date information, see |
513 | @uref{http://www.fsf.org/about/contact.html, the FSF contact web-page}. | |
514 | ||
4009494e GM |
515 | @table @asis |
516 | ||
517 | @item E-mail | |
85b438b7 | 518 | info@@fsf.org |
4009494e GM |
519 | |
520 | @item Telephone | |
521 | +1-617-542-5942 | |
522 | ||
523 | @item Fax | |
524 | +1-617-542-2652 | |
525 | ||
526 | @item World Wide Web | |
85b438b7 | 527 | @uref{http://www.fsf.org/} |
4009494e GM |
528 | |
529 | @item Postal address | |
530 | Free Software Foundation@* | |
531 | 51 Franklin Street, Fifth Floor@* | |
532 | Boston, MA 02110-1301@* | |
533 | USA@* | |
534 | ||
535 | @end table | |
536 | ||
537 | @cindex Ordering GNU software | |
538 | For details on how to order items directly from the FSF, see the | |
85b438b7 | 539 | @uref{http://shop.fsf.org/, FSF on-line store}. |
4009494e GM |
540 | |
541 | @c ------------------------------------------------------------ | |
f0bf7708 | 542 | @node Getting help |
4009494e GM |
543 | @chapter Getting help |
544 | @cindex Getting help | |
545 | ||
85b438b7 | 546 | This chapter tells you how to get help with Emacs. |
4009494e GM |
547 | |
548 | @menu | |
549 | * Basic editing:: | |
550 | * Learning how to do something:: | |
551 | * Getting a printed manual:: | |
552 | * Emacs Lisp documentation:: | |
553 | * Installing Texinfo documentation:: | |
554 | * Printing a Texinfo file:: | |
555 | * Viewing Info files outside of Emacs:: | |
556 | * Informational files for Emacs:: | |
557 | * Help installing Emacs:: | |
558 | * Obtaining the FAQ:: | |
559 | @end menu | |
560 | ||
f0bf7708 | 561 | @node Basic editing |
4009494e GM |
562 | @section I'm just starting Emacs; how do I do basic editing? |
563 | @cindex Basic editing with Emacs | |
564 | @cindex Beginning editing | |
565 | @cindex Tutorial, invoking the | |
566 | @cindex Self-paced tutorial, invoking the | |
567 | @cindex Help system, entering the | |
568 | ||
569 | Type @kbd{C-h t} to invoke the self-paced tutorial. Just typing | |
570 | @kbd{C-h} enters the help system. Starting with Emacs 22, the tutorial | |
571 | is available in many foreign languages such as French, German, Japanese, | |
572 | Russian, etc. Use @kbd{M-x help-with-tutorial-spec-language @key{RET}} | |
573 | to choose your language and start the tutorial. | |
574 | ||
575 | Your system administrator may have changed @kbd{C-h} to act like | |
576 | @key{DEL} to deal with local keyboards. You can use @kbd{M-x | |
577 | help-for-help} instead to invoke help. To discover what key (if any) | |
578 | invokes help on your system, type @kbd{M-x where-is @key{RET} | |
579 | help-for-help @key{RET}}. This will print a comma-separated list of key | |
580 | sequences in the echo area. Ignore the last character in each key | |
85b438b7 GM |
581 | sequence listed. Each of the resulting key sequences (e.g. @key{F1} is |
582 | common) invokes help. | |
4009494e GM |
583 | |
584 | Emacs help works best if it is invoked by a single key whose value | |
585 | should be stored in the variable @code{help-char}. | |
586 | ||
f0bf7708 | 587 | @node Learning how to do something |
4009494e GM |
588 | @section How do I find out how to do something in Emacs? |
589 | @cindex Help for Emacs | |
590 | @cindex Learning to do something in Emacs | |
591 | @cindex Reference card for Emacs | |
592 | @cindex Overview of help systems | |
593 | ||
594 | There are several methods for finding out how to do things in Emacs. | |
595 | ||
596 | @itemize @bullet | |
597 | ||
598 | @cindex Reading the Emacs manual | |
599 | @item | |
85b438b7 | 600 | The complete text of the Emacs manual is available via the Info |
4009494e GM |
601 | hypertext reader. Type @kbd{C-h r} to display the manual in Info mode. |
602 | Typing @key{h} immediately after entering Info will provide a short | |
603 | tutorial on how to use it. | |
604 | ||
605 | @cindex Lookup a subject in a manual | |
606 | @cindex Index search in a manual | |
607 | @item | |
608 | To quickly locate the section of the manual which discusses a certain | |
609 | issue, or describes a command or a variable, type @kbd{C-h i m emacs | |
610 | @key{RET} i @var{topic} @key{RET}}, where @var{topic} is the name of the | |
611 | topic, the command, or the variable which you are looking for. If this | |
612 | does not land you on the right place in the manual, press @kbd{,} | |
613 | (comma) repeatedly until you find what you need. (The @kbd{i} and | |
614 | @kbd{,} keys invoke the index-searching functions, which look for the | |
615 | @var{topic} you type in all the indices of the Emacs manual.) | |
616 | ||
617 | @cindex Apropos | |
618 | @item | |
619 | You can list all of the commands whose names contain a certain word | |
620 | (actually which match a regular expression) using @kbd{C-h a} (@kbd{M-x | |
621 | command-apropos}). | |
622 | ||
623 | @cindex Command description in the manual | |
624 | @item | |
625 | The command @kbd{C-h F} (@code{Info-goto-emacs-command-node}) prompts | |
626 | for the name of a command, and then attempts to find the section in the | |
627 | Emacs manual where that command is described. | |
628 | ||
629 | @cindex Finding commands and variables | |
630 | @item | |
631 | You can list all of the functions and variables whose names contain a | |
632 | certain word using @kbd{M-x apropos}. | |
633 | ||
634 | @item | |
635 | You can list all of the functions and variables whose documentation | |
636 | matches a regular expression or a string, using @kbd{M-x | |
637 | apropos-documentation}. | |
638 | ||
639 | @item | |
640 | You can order a hardcopy of the manual from the FSF. @xref{Getting a | |
641 | printed manual}. | |
642 | ||
643 | @cindex Reference cards, in other languages | |
644 | @item | |
645 | You can get a printed reference card listing commands and keys to | |
30884d11 | 646 | invoke them. You can order one from the FSF for $2 (or 10 for $18), |
4009494e | 647 | or you can print your own from the @file{etc/refcards/refcard.tex} or |
30884d11 | 648 | @file{etc/refcards/refcard.pdf} files in the Emacs distribution. |
4009494e GM |
649 | Beginning with version 21.1, the Emacs distribution comes with |
650 | translations of the reference card into several languages; look for | |
651 | files named @file{etc/refcards/@var{lang}-refcard.*}, where @var{lang} | |
652 | is a two-letter code of the language. For example, the German version | |
653 | of the reference card is in the files @file{etc/refcards/de-refcard.tex} | |
30884d11 | 654 | and @file{etc/recards/de-refcard.pdf}. |
4009494e GM |
655 | |
656 | @item | |
657 | There are many other commands in Emacs for getting help and | |
658 | information. To get a list of these commands, type @samp{?} after | |
659 | @kbd{C-h}. | |
660 | ||
661 | @end itemize | |
662 | ||
f0bf7708 | 663 | @node Getting a printed manual |
4009494e GM |
664 | @section How do I get a printed copy of the Emacs manual? |
665 | @cindex Printed Emacs manual, obtaining | |
666 | @cindex Manual, obtaining a printed or HTML copy of | |
667 | @cindex Emacs manual, obtaining a printed or HTML copy of | |
668 | ||
669 | You can order a printed copy of the Emacs manual from the FSF. For | |
85b438b7 | 670 | details see the @uref{http://shop.fsf.org/, FSF on-line store}. |
4009494e | 671 | |
30884d11 | 672 | The full Texinfo source for the manual also comes in the @file{doc/emacs} |
4009494e | 673 | directory of the Emacs distribution, if you're daring enough to try to |
30884d11 | 674 | print out this several-hundred-page manual yourself (@pxref{Printing a Texinfo |
4009494e GM |
675 | file}). |
676 | ||
677 | If you absolutely have to print your own copy, and you don't have @TeX{}, | |
30884d11 | 678 | you can get a PostScript or PDF (or HTML) version from |
4009494e GM |
679 | |
680 | @uref{http://www.gnu.org/software/emacs/manual/} | |
681 | ||
f6adc23c | 682 | @xref{Learning how to do something}, for how to view the manual from Emacs. |
4009494e | 683 | |
f0bf7708 | 684 | @node Emacs Lisp documentation |
4009494e GM |
685 | @section Where can I get documentation on Emacs Lisp? |
686 | @cindex Documentation on Emacs Lisp | |
687 | @cindex Function documentation | |
688 | @cindex Variable documentation | |
689 | @cindex Emacs Lisp Reference Manual | |
690 | @cindex Reference manual for Emacs Lisp | |
691 | ||
692 | Within Emacs, you can type @kbd{C-h f} to get the documentation for a | |
693 | function, @kbd{C-h v} for a variable. | |
694 | ||
695 | For more information, the Emacs Lisp Reference Manual is available | |
f6adc23c GM |
696 | in Info format (@pxref{Top, Emacs Lisp,, elisp, The |
697 | Emacs Lisp Reference Manual}). | |
4009494e | 698 | |
f6adc23c GM |
699 | You can also order a hardcopy of the manual from the FSF, for details |
700 | see the @uref{http://shop.fsf.org/, FSF on-line store}. (This manual is | |
701 | not always in print.) | |
4009494e GM |
702 | |
703 | An HTML version of the Emacs Lisp Reference Manual is available at | |
704 | ||
705 | @uref{http://www.gnu.org/software/emacs/elisp-manual/elisp.html} | |
706 | ||
f0bf7708 | 707 | @node Installing Texinfo documentation |
4009494e GM |
708 | @section How do I install a piece of Texinfo documentation? |
709 | @cindex Texinfo documentation, installing | |
710 | @cindex Installing Texinfo documentation | |
711 | @cindex New Texinfo files, installing | |
712 | @cindex Documentation, installing new Texinfo files | |
713 | @cindex Info files, how to install | |
714 | ||
f6adc23c GM |
715 | Emacs releases come with pre-built Info files, and the normal install |
716 | process places them in the correct location. This is true for most | |
717 | applications that provide Info files. The following section is only | |
718 | relevant if you want to install extra Info files by hand. | |
719 | ||
720 | First, you must turn the Texinfo source files into Info files. You may | |
721 | do this using the stand-alone @file{makeinfo} program, available as part | |
722 | of the Texinfo package at | |
4009494e | 723 | |
85b438b7 | 724 | @uref{http://www.gnu.org/software/texinfo/} |
4009494e GM |
725 | |
726 | For information about the Texinfo format, read the Texinfo manual which | |
727 | comes with the Texinfo package. This manual also comes installed in | |
85b438b7 | 728 | Info format, so you can read it from Emacs; type @kbd{C-h i m texinfo |
4009494e GM |
729 | @key{RET}}. |
730 | ||
f6adc23c GM |
731 | @c FIXME is this a complete alternative? |
732 | @c Probably not, given that we require makeinfo to build Emacs. | |
4009494e GM |
733 | Alternatively, you could use the Emacs command @kbd{M-x |
734 | texinfo-format-buffer}, after visiting the Texinfo source file of the | |
735 | manual you want to convert. | |
736 | ||
737 | Neither @code{texinfo-format-buffer} nor @file{makeinfo} installs the | |
738 | resulting Info files in Emacs's Info tree. To install Info files, | |
739 | perform these steps: | |
740 | ||
741 | @enumerate | |
742 | @item | |
743 | Move the files to the @file{info} directory in the installed Emacs | |
744 | distribution. @xref{File-name conventions}, if you don't know where that | |
745 | is. | |
746 | ||
747 | @item | |
748 | Run the @code{install-info} command, which is part of the Texinfo | |
749 | distribution, to update the main Info directory menu, like this: | |
750 | ||
751 | @example | |
752 | install-info --info-dir=@var{dir-path} @var{dir-path}/@var{file} | |
753 | @end example | |
754 | ||
755 | @noindent | |
756 | where @var{dir-path} is the full path to the directory where you copied | |
757 | the produced Info file(s), and @var{file} is the name of the Info file | |
758 | you produced and want to install. | |
759 | ||
760 | If you don't have the @code{install-info} command installed, you can | |
761 | edit the file @file{info/dir} in the installed Emacs distribution, and | |
762 | add a line for the top level node in the Info package that you are | |
763 | installing. Follow the examples already in this file. The format is: | |
764 | ||
765 | @example | |
766 | * Topic: (relative-pathname). Short description of topic. | |
767 | @end example | |
768 | ||
769 | @end enumerate | |
770 | ||
771 | If you want to install Info files and you don't have the necessary | |
772 | privileges, you have several options: | |
773 | ||
774 | @itemize @bullet | |
775 | @item | |
776 | Info files don't actually need to be installed before being used. | |
777 | You can use a prefix argument for the @code{info} command and specify | |
778 | the name of the Info file in the minibuffer. This goes to the node | |
779 | named @samp{Top} in that file. For example, to view a Info file named | |
780 | @file{@var{info-file}} in your home directory, you can type this: | |
781 | ||
782 | @example | |
783 | @kbd{C-u C-h i ~/@var{info-file} @key{RET}} | |
784 | @end example | |
785 | ||
786 | Alternatively, you can feed a file name to the @code{Info-goto-node} | |
787 | command (invoked by pressing @key{g} in Info mode) by typing the name | |
788 | of the file in parentheses, like this: | |
789 | ||
790 | @example | |
791 | @kbd{C-h i g (~/@var{info-file}) @key{RET}} | |
792 | @end example | |
793 | ||
794 | @item | |
795 | You can create your own Info directory. You can tell Emacs where that | |
796 | Info directory is by adding its pathname to the value of the variable | |
797 | @code{Info-default-directory-list}. For example, to use a private Info | |
798 | directory which is a subdirectory of your home directory named @file{Info}, | |
799 | you could put this in your @file{.emacs} file: | |
800 | ||
801 | @lisp | |
f6adc23c | 802 | (add-to-list 'Info-default-directory-list "~/Info") |
4009494e GM |
803 | @end lisp |
804 | ||
805 | You will need a top-level Info file named @file{dir} in this directory | |
f6adc23c GM |
806 | which has everything the system @file{dir} file has in it, except it |
807 | should list only entries for Info files in that directory. You might | |
808 | not need it if (fortuitously) all files in this directory were | |
809 | referenced by other @file{dir} files. The node lists from all | |
810 | @file{dir} files in @code{Info-default-directory-list} are merged by the | |
811 | Info system. | |
4009494e GM |
812 | |
813 | @end itemize | |
814 | ||
f0bf7708 | 815 | @node Printing a Texinfo file |
4009494e GM |
816 | @section How do I print a Texinfo file? |
817 | @cindex Printing a Texinfo file | |
818 | @cindex Texinfo file, printing | |
819 | @cindex Printing documentation | |
820 | ||
821 | You can't get nicely printed output from Info files; you must still have | |
822 | the original Texinfo source file for the manual you want to print. | |
823 | ||
824 | Assuming you have @TeX{} installed on your system, follow these steps: | |
825 | ||
826 | @enumerate | |
827 | ||
828 | @item | |
829 | Make sure the first line of the Texinfo file looks like this: | |
830 | ||
831 | @example | |
832 | \input texinfo | |
833 | @end example | |
834 | ||
835 | You may need to change @samp{texinfo} to the full pathname of the | |
836 | @file{texinfo.tex} file, which comes with Emacs as | |
db78a8cb | 837 | @file{doc/misc/texinfo.tex} (or copy or link it into the current directory). |
4009494e GM |
838 | |
839 | @item | |
840 | Type @kbd{texi2dvi @var{texinfo-source}}, where @var{texinfo-source} is | |
841 | the name of the Texinfo source file for which you want to produce a | |
f6adc23c GM |
842 | printed copy. The @samp{texi2dvi} script is part of the GNU Texinfo |
843 | distribution. | |
4009494e | 844 | |
85b438b7 GM |
845 | Alternatively, @samp{texi2pdf} produces PDF files. |
846 | ||
4009494e GM |
847 | @item |
848 | Print the DVI file @file{@var{texinfo-source}.dvi} in the normal way for | |
849 | printing DVI files at your site. For example, if you have a PostScript | |
850 | printer, run the @code{dvips} program to print the DVI file on that | |
851 | printer. | |
852 | ||
853 | @end enumerate | |
854 | ||
855 | To get more general instructions, retrieve the latest Texinfo package | |
856 | (@pxref{Installing Texinfo documentation}). | |
857 | ||
f0bf7708 | 858 | @node Viewing Info files outside of Emacs |
4009494e GM |
859 | @section Can I view Info files without using Emacs? |
860 | @cindex Viewing Info files | |
861 | @cindex Info file viewers | |
862 | @cindex Alternative Info file viewers | |
863 | ||
864 | Yes. Here are some alternative programs: | |
865 | ||
866 | @itemize @bullet | |
867 | ||
868 | @item | |
869 | @code{info}, a stand-alone version of the Info program, comes as part of | |
870 | the Texinfo package. @xref{Installing Texinfo documentation}, for | |
871 | details. | |
872 | ||
4009494e GM |
873 | @item |
874 | Tkinfo, an Info viewer that runs under X Window system and uses Tcl/Tk. | |
875 | You can get Tkinfo at | |
876 | @uref{http://math-www.uni-paderborn.de/~axel/tkinfo/}. | |
877 | ||
878 | @end itemize | |
879 | ||
f0bf7708 | 880 | @node Informational files for Emacs |
4009494e GM |
881 | @section What informational files are available for Emacs? |
882 | @cindex Informational files included with Emacs | |
883 | @cindex Files included with Emacs | |
884 | @cindex @file{COPYING}, description of file | |
885 | @cindex @file{DISTRIB}, description of file | |
4009494e GM |
886 | @cindex @file{GNU}, description of file |
887 | @cindex @file{INTERVIEW}, description of file | |
4009494e GM |
888 | @cindex @file{MACHINES}, description of file |
889 | @cindex @file{MAILINGLISTS}, description of file | |
890 | @cindex @file{NEWS}, description of file | |
4009494e GM |
891 | |
892 | This isn't a frequently asked question, but it should be! A variety of | |
893 | informational files about Emacs and relevant aspects of the GNU project | |
894 | are available for you to read. | |
895 | ||
f6adc23c GM |
896 | The following files (and others) are available in the @file{etc} |
897 | directory of the Emacs distribution (see @ref{File-name conventions}, if | |
898 | you're not sure where that is). Many of these files are available via | |
899 | the Emacs @samp{Help} menu, or by typing @kbd{C-h ?} (@kbd{M-x | |
900 | help-for-help}). | |
4009494e GM |
901 | |
902 | @table @file | |
903 | ||
904 | @item COPYING | |
905 | GNU General Public License | |
906 | ||
907 | @item DISTRIB | |
30884d11 | 908 | Emacs Availability Information |
4009494e | 909 | |
4009494e GM |
910 | @item GNU |
911 | The GNU Manifesto | |
912 | ||
913 | @item INTERVIEW | |
914 | Richard Stallman discusses his public-domain UNIX-compatible software | |
915 | system with BYTE editors | |
916 | ||
4009494e GM |
917 | @item MACHINES |
918 | Status of Emacs on Various Machines and Systems | |
919 | ||
920 | @item MAILINGLISTS | |
921 | GNU Project Electronic Mailing Lists | |
922 | ||
923 | @item NEWS | |
924 | Emacs news, a history of recent user-visible changes | |
925 | ||
4009494e GM |
926 | @end table |
927 | ||
928 | More GNU information, including back issues of the @cite{GNU's | |
929 | Bulletin}, are at | |
930 | ||
931 | @uref{http://www.gnu.org/bulletins/bulletins.html} and | |
932 | ||
933 | @uref{http://www.cs.pdx.edu/~trent/gnu/gnu.html} | |
934 | ||
f0bf7708 | 935 | @node Help installing Emacs |
4009494e GM |
936 | @section Where can I get help in installing Emacs? |
937 | @cindex Installation help | |
938 | @cindex Help installing Emacs | |
939 | ||
940 | @xref{Installing Emacs}, for some basic installation hints, and see | |
93e2d996 | 941 | @ref{Problems building Emacs}, if you have problems with the installation. |
4009494e | 942 | |
f6adc23c GM |
943 | @uref{http://www.fsf.org/resources/service/, The GNU Service directory} |
944 | lists companies and individuals willing to sell you help in installing | |
945 | or using Emacs and other GNU software. | |
4009494e | 946 | |
f0bf7708 | 947 | @node Obtaining the FAQ |
4009494e GM |
948 | @section Where can I get the latest version of this FAQ? |
949 | @cindex FAQ, obtaining the | |
950 | @cindex Latest FAQ version, obtaining the | |
4009494e | 951 | |
30884d11 GM |
952 | The Emacs FAQ is distributed with Emacs in Info format. You can read it |
953 | by selecting the @samp{Emacs FAQ} option from the @samp{Help} menu of | |
954 | the Emacs menu bar at the top of any Emacs frame, or by typing @kbd{C-h | |
f6adc23c | 955 | C-f} (@kbd{M-x view-emacs-FAQ}). The very latest version is available |
54b31cbf | 956 | in the Emacs development repository (@pxref{Latest version of Emacs}). |
4009494e GM |
957 | |
958 | @c ------------------------------------------------------------ | |
f0bf7708 | 959 | @node Status of Emacs |
4009494e GM |
960 | @chapter Status of Emacs |
961 | @cindex Status of Emacs | |
962 | ||
2e17e05e GM |
963 | This chapter gives you basic information about Emacs, including the |
964 | status of its latest version. | |
4009494e GM |
965 | |
966 | @menu | |
967 | * Origin of the term Emacs:: | |
968 | * Latest version of Emacs:: | |
0e6d12ca | 969 | * New in Emacs 23:: |
4009494e | 970 | * New in Emacs 22:: |
0e6d12ca GM |
971 | * New in Emacs 21:: |
972 | * New in Emacs 20:: | |
4009494e GM |
973 | @end menu |
974 | ||
f0bf7708 | 975 | @node Origin of the term Emacs |
4009494e GM |
976 | @section Where does the name ``Emacs'' come from? |
977 | @cindex Origin of the term ``Emacs'' | |
978 | @cindex Emacs name origin | |
979 | @cindex TECO | |
980 | @cindex Original version of Emacs | |
981 | ||
982 | Emacs originally was an acronym for Editor MACroS. RMS says he ``picked | |
983 | the name Emacs because @key{E} was not in use as an abbreviation on ITS at | |
984 | the time.'' The first Emacs was a set of macros written in 1976 at MIT | |
985 | by RMS for the editor TECO (Text Editor and COrrector, originally Tape | |
f6adc23c GM |
986 | Editor and COrrector) under ITS (the Incompatible Timesharing System) on |
987 | a PDP-10. RMS had already extended TECO with a ``real-time'' | |
988 | full-screen mode with reprogrammable keys. Emacs was started by | |
989 | @email{gls@@east.sun.com, Guy Steele} as a project to unify the many | |
990 | divergent TECO command sets and key bindings at MIT, and completed by | |
991 | RMS. | |
4009494e GM |
992 | |
993 | Many people have said that TECO code looks a lot like line noise; you | |
994 | can read more at @uref{news:alt.lang.teco}. Someone has written a TECO | |
995 | implementation in Emacs Lisp (to find it, see @ref{Packages that do not | |
996 | come with Emacs}); it would be an interesting project to run the | |
997 | original TECO Emacs inside of Emacs. | |
998 | ||
999 | @cindex Why Emacs? | |
1000 | For some not-so-serious alternative reasons for Emacs to have that | |
1001 | name, check out the file @file{etc/JOKES} (@pxref{File-name | |
1002 | conventions}). | |
1003 | ||
f0bf7708 | 1004 | @node Latest version of Emacs |
4009494e GM |
1005 | @section What is the latest version of Emacs? |
1006 | @cindex Version, latest | |
1007 | @cindex Latest version of Emacs | |
54b31cbf GM |
1008 | @cindex Development, Emacs |
1009 | @cindex Repository, Emacs | |
6fbf7a75 | 1010 | @cindex Bazaar repository, Emacs |
4009494e | 1011 | |
f7a31f11 | 1012 | Emacs @value{EMACSVER} is the current version as of this writing. A version |
85b438b7 | 1013 | number with two components (e.g. @samp{22.1}) indicates a released |
0e6d12ca GM |
1014 | version; three components indicate a development |
1015 | version (e.g. @samp{23.0.50} is what will eventually become @samp{23.1}). | |
1016 | ||
54b31cbf GM |
1017 | Emacs is under active development, hosted at |
1018 | @uref{http://savannah.gnu.org/projects/emacs/, Savannah}. The source | |
1019 | code can be retrieved anonymously following the | |
6fbf7a75 GM |
1020 | @uref{http://savannah.gnu.org/bzr/?group=emacs, instructions}. |
1021 | The repository is GNU Bazaar. | |
54b31cbf | 1022 | |
0e6d12ca GM |
1023 | Because Emacs undergoes many changes before a release, the version |
1024 | number of a development version is not especially meaningful. It is | |
1025 | better to refer to the date on which the sources were retrieved from the | |
16f6287e GM |
1026 | development repository. The development version is usually quite robust |
1027 | for every-day use, but if stability is more important to you than the | |
1028 | latest features, you may want to stick to the releases. | |
0e6d12ca GM |
1029 | |
1030 | The following sections list some of the major new features in the last | |
1031 | few Emacs releases. For full details of the changes in any version of | |
1032 | Emacs, type @kbd{C-h C-n} (@kbd{M-x view-emacs-news}). As of Emacs 22, | |
1033 | you can give this command a prefix argument to read about which features | |
1034 | were new in older versions. | |
1035 | ||
1036 | @node New in Emacs 23 | |
1037 | @section What is different about Emacs 23? | |
1038 | @cindex Differences between Emacs 22 and Emacs 23 | |
1039 | @cindex Emacs 23, new features in | |
1040 | @cindex Recently introduced features | |
1041 | @cindex Default features | |
4009494e | 1042 | |
0e6d12ca | 1043 | @itemize |
4009494e | 1044 | |
0e6d12ca GM |
1045 | @cindex Anti-aliased fonts |
1046 | @cindex Freetype fonts | |
1047 | @item | |
1048 | Emacs has a new font code that can use multiple font backends, | |
1049 | including freetype and fontconfig. Emacs can use the Xft library for | |
1050 | anti-aliasing, and the otf and m17n libraries for complex text layout and | |
1051 | text shaping. | |
4009494e | 1052 | |
0e6d12ca GM |
1053 | @cindex Unicode |
1054 | @cindex Character sets | |
1055 | @item | |
1056 | The Emacs character set is now a superset of Unicode. Several new | |
1057 | language environments have been added. | |
4009494e | 1058 | |
0e6d12ca GM |
1059 | @cindex Multi-tty support |
1060 | @cindex X and tty displays | |
1061 | @item | |
1062 | Emacs now supports using both X displays and ttys in the same session | |
1063 | (@samp{multi-tty}). | |
4009494e | 1064 | |
0e6d12ca GM |
1065 | @cindex Daemon mode |
1066 | @item | |
1067 | Emacs can be started as a daemon in the background. | |
4009494e | 1068 | |
0e6d12ca GM |
1069 | @cindex NeXTSTEP port |
1070 | @cindex GNUstep port | |
1071 | @cindex Mac OS X Cocoa | |
1072 | @item | |
1073 | There is a new NeXTSTEP port of Emacs. This supports GNUstep and Mac OS | |
1074 | X (via the Cocoa libraries). The Carbon port of Emacs, which supported | |
1075 | Mac OS X in Emacs 22, has been removed. | |
4009494e | 1076 | |
0e6d12ca GM |
1077 | @cindex Directory-local variables |
1078 | @item | |
1079 | Directory-local variables can now be defined, in a similar manner to | |
1080 | file-local variables. | |
4009494e | 1081 | |
0e6d12ca GM |
1082 | @item |
1083 | Transient Mark mode (@pxref{Highlighting a region}) is on by default. | |
1084 | ||
1085 | @end itemize | |
1086 | ||
1087 | @noindent | |
1088 | Other changes include: support for serial port access; D-Bus bindings; a | |
1089 | new Visual Line mode for line-motion; improved completion; a new mode | |
1090 | (@samp{DocView}) for viewing of PDF, PostScript, and DVI documents; nXML | |
1091 | mode (for editing XML documents) is included; VC has been updated for | |
1092 | newer version control systems; etc. As always, consult the @file{NEWS} | |
1093 | file for more information. | |
4009494e | 1094 | |
4009494e | 1095 | |
f0bf7708 | 1096 | @node New in Emacs 22 |
4009494e GM |
1097 | @section What is different about Emacs 22? |
1098 | @cindex Differences between Emacs 21 and Emacs 22 | |
1099 | @cindex Emacs 22, new features in | |
4009494e GM |
1100 | |
1101 | @itemize | |
1102 | @cindex GTK+ Toolkit | |
1103 | @cindex Drag-and-drop | |
1104 | @item | |
1105 | Emacs can be built with GTK+ widgets, and supports drag-and-drop | |
1106 | operation on X. | |
1107 | ||
1108 | @cindex Supported systems | |
1109 | @item | |
1110 | Emacs 22 features support for GNU/Linux systems on S390 and x86-64 | |
1111 | machines, as well as support for the Mac OS X and Cygwin operating | |
1112 | systems. | |
1113 | ||
1114 | @item | |
9e2a2647 | 1115 | The native MS-Windows, and Mac OS X builds include full support |
4009494e GM |
1116 | for images, toolbar, and tooltips. |
1117 | ||
1118 | @item | |
1119 | Font Lock mode, Auto Compression mode, and File Name Shadow Mode are | |
1120 | enabled by default. | |
1121 | ||
1122 | @item | |
4970fbfe CY |
1123 | The maximum size of buffers is increased: on 32-bit machines, it is |
1124 | 256 MBytes for Emacs 23.1, and 512 MBytes for Emacs 23.2 and above. | |
4009494e GM |
1125 | |
1126 | @item | |
1127 | Links can be followed with @kbd{mouse-1}, in addition to @kbd{mouse-2}. | |
1128 | ||
1129 | @cindex Mouse wheel | |
1130 | @item | |
1131 | Mouse wheel support is enabled by default. | |
1132 | ||
1133 | @item | |
1134 | Window fringes are customizable. | |
1135 | ||
1136 | @item | |
1137 | The mode line of the selected window is now highlighted. | |
1138 | ||
1139 | @item | |
1140 | The minibuffer prompt is displayed in a distinct face. | |
1141 | ||
1142 | @item | |
1143 | Abbrev definitions are read automatically at startup. | |
1144 | ||
1145 | @item | |
1146 | Grep mode is separate from Compilation mode and has many new options and | |
1147 | commands specific to grep. | |
1148 | ||
1149 | @item | |
1150 | The original Emacs macro system has been replaced by the new Kmacro | |
1151 | package, which provides many new commands and features and a simple | |
1152 | interface that uses the function keys F3 and F4. Macros are stored in a | |
1153 | macro ring, and can be debugged and edited interactively. | |
1154 | ||
1155 | @item | |
1156 | The Grand Unified Debugger (GUD) can be used with a full graphical user | |
1157 | interface to GDB; this provides many features found in traditional | |
1158 | development environments, making it easy to manipulate breakpoints, add | |
1159 | watch points, display the call stack, etc. Breakpoints are visually | |
1160 | indicated in the source buffer. | |
1161 | ||
1162 | @item | |
1163 | @cindex New modes | |
1164 | Many new modes and packages have been included in Emacs, such as Calc, | |
1165 | TRAMP, URL, IDO, CUA, ERC, rcirc, Table, Image-Dired, SES, Ruler, Org, | |
1166 | PGG, Flymake, Password, Printing, Reveal, wdired, t-mouse, longlines, | |
1167 | savehist, Conf mode, Python mode, DNS mode, etc. | |
1168 | ||
1169 | @cindex Multilingual Environment | |
1170 | @item | |
1171 | Leim is now part of Emacs. Unicode support has been much improved, and | |
1172 | the following input methods have been added: belarusian, bulgarian-bds, | |
1173 | bulgarian-phonetic, chinese-sisheng, croatian, dutch, georgian, | |
1174 | latin-alt-postfix, latin-postfix, latin-prefix, latvian-keyboard, | |
1175 | lithuanian-numeric, lithuanian-keyboard, malayalam-inscript, rfc1345, | |
1176 | russian-computer, sgml, slovenian, tamil-inscript, ucs, | |
1177 | ukrainian-computer, vietnamese-telex, and welsh. | |
1178 | ||
1179 | The following language environments have also been added: Belarusian, | |
1180 | Bulgarian, Chinese-EUC-TW, Croatian, French, Georgian, Italian, Latin-6, | |
1181 | Latin-7, Latvian, Lithuanian, Malayalam, Russian, Slovenian, Swedish, | |
1182 | Tajik, Tamil, UTF-8, Ukrainian, Welsh, and Windows-1255. | |
1183 | ||
1184 | @cindex Documentation | |
1185 | @cindex Emacs Lisp Manual | |
1186 | @item | |
1187 | In addition, Emacs 22 now includes the Emacs Lisp Reference Manual | |
1188 | (@pxref{Emacs Lisp documentation}) and the Emacs Lisp Intro. | |
1189 | @end itemize | |
1190 | ||
0e6d12ca GM |
1191 | |
1192 | @node New in Emacs 21 | |
1193 | @section What is different about Emacs 21? | |
1194 | @cindex Differences between Emacs 20 and Emacs 21 | |
1195 | @cindex Emacs 21, new features in | |
1196 | ||
1197 | @cindex Variable-size fonts | |
1198 | @cindex Toolbar support | |
1199 | Emacs 21 features a thorough rewrite of the display engine. The new | |
1200 | display engine supports variable-size fonts, images, and can play sounds | |
1201 | on platforms which support that. As a result, the visual appearance of | |
1202 | Emacs, when it runs on a windowed display, is much more reminiscent of | |
1203 | modern GUI programs, and includes 3D widgets (used for the mode line and | |
1204 | the scroll bars), a configurable and extensible toolbar, tooltips | |
1205 | (a.k.a.@: balloon help), and other niceties. | |
1206 | ||
1207 | @cindex Colors on text-only terminals | |
1208 | @cindex TTY colors | |
1209 | In addition, Emacs 21 supports faces on text-only terminals. This means | |
1210 | that you can now have colors when you run Emacs on a GNU/Linux console | |
1211 | and on @code{xterm} with @kbd{emacs -nw}. | |
1212 | ||
1213 | ||
1214 | @node New in Emacs 20 | |
1215 | @section What is different about Emacs 20? | |
1216 | @cindex Differences between Emacs 19 and Emacs 20 | |
1217 | @cindex Emacs 20, new features in | |
1218 | ||
1219 | The differences between Emacs versions 18 and 19 were rather dramatic; | |
1220 | the introduction of frames, faces, and colors on windowing systems was | |
1221 | obvious to even the most casual user. | |
1222 | ||
1223 | There are differences between Emacs versions 19 and 20 as well, but many | |
1224 | are more subtle or harder to find. Among the changes are the inclusion | |
1225 | of MULE code for languages that use non-Latin characters and for mixing | |
1226 | several languages in the same document; the ``Customize'' facility for | |
1227 | modifying variables without having to use Lisp; and automatic conversion | |
1228 | of files from Macintosh, Microsoft, and Unix platforms. | |
4009494e GM |
1229 | |
1230 | @c ------------------------------------------------------------ | |
f0bf7708 | 1231 | @node Common requests |
4009494e GM |
1232 | @chapter Common requests |
1233 | @cindex Common requests | |
1234 | ||
1235 | @menu | |
1236 | * Setting up a customization file:: | |
1237 | * Using Customize:: | |
1238 | * Colors on a TTY:: | |
1239 | * Debugging a customization file:: | |
1240 | * Displaying the current line or column:: | |
1241 | * Displaying the current file name in the titlebar:: | |
1242 | * Turning on abbrevs by default:: | |
1243 | * Associating modes with files:: | |
1244 | * Highlighting a region:: | |
1245 | * Replacing highlighted text:: | |
1246 | * Controlling case sensitivity:: | |
1247 | * Working with unprintable characters:: | |
1248 | * Searching for/replacing newlines:: | |
1249 | * Yanking text in isearch:: | |
1250 | * Wrapping words automatically:: | |
1251 | * Turning on auto-fill by default:: | |
4009494e GM |
1252 | * Changing load-path:: |
1253 | * Using an already running Emacs process:: | |
1254 | * Compiler error messages:: | |
1255 | * Indenting switch statements:: | |
1256 | * Customizing C and C++ indentation:: | |
1257 | * Horizontal scrolling:: | |
1258 | * Overwrite mode:: | |
1259 | * Turning off beeping:: | |
1260 | * Turning the volume down:: | |
1261 | * Automatic indentation:: | |
1262 | * Matching parentheses:: | |
1263 | * Hiding #ifdef lines:: | |
1264 | * Repeating commands:: | |
1265 | * Valid X resources:: | |
1266 | * Evaluating Emacs Lisp code:: | |
1267 | * Changing the length of a Tab:: | |
1268 | * Inserting text at the beginning of each line:: | |
4009494e GM |
1269 | * Forcing the cursor to remain in the same column:: |
1270 | * Forcing Emacs to iconify itself:: | |
1271 | * Using regular expressions:: | |
1272 | * Replacing text across multiple files:: | |
1273 | * Documentation for etags:: | |
1274 | * Disabling backups:: | |
1275 | * Disabling auto-save-mode:: | |
1276 | * Going to a line by number:: | |
1277 | * Modifying pull-down menus:: | |
1278 | * Deleting menus and menu options:: | |
1279 | * Turning on syntax highlighting:: | |
1280 | * Scrolling only one line:: | |
1281 | * Editing MS-DOS files:: | |
1282 | * Filling paragraphs with a single space:: | |
1283 | * Escape sequences in shell output:: | |
1284 | * Fullscreen mode on MS-Windows:: | |
1285 | @end menu | |
1286 | ||
f0bf7708 | 1287 | @node Setting up a customization file |
4009494e GM |
1288 | @section How do I set up a @file{.emacs} file properly? |
1289 | @cindex @file{.emacs} file, setting up | |
1290 | @cindex @file{.emacs} file, locating | |
1291 | @cindex Init file, setting up | |
1292 | @cindex Customization file, setting up | |
1293 | ||
1294 | @inforef{Init File, Init File, emacs}. | |
1295 | ||
2e17e05e GM |
1296 | In general, new Emacs users should not be provided with @file{.emacs} |
1297 | files, because this can cause confusing non-standard behavior. Then | |
1298 | they send questions to @email{help-gnu-emacs@@gnu.org} asking why Emacs | |
1299 | isn't behaving as documented. | |
4009494e | 1300 | |
2e17e05e GM |
1301 | Emacs includes the Customize facility (@pxref{Using Customize}). This |
1302 | allows users who are unfamiliar with Emacs Lisp to modify their | |
1303 | @file{.emacs} files in a relatively straightforward way, using menus | |
1304 | rather than Lisp code. | |
4009494e GM |
1305 | |
1306 | While Customize might indeed make it easier to configure Emacs, | |
1307 | consider taking a bit of time to learn Emacs Lisp and modifying your | |
1308 | @file{.emacs} directly. Simple configuration options are described | |
1309 | rather completely in @inforef{Init File, Init File, emacs}, for users | |
1310 | interested in performing frequently requested, basic tasks. | |
1311 | ||
1312 | Sometimes users are unsure as to where their @file{.emacs} file should | |
1313 | be found. Visiting the file as @file{~/.emacs} from Emacs will find | |
1314 | the correct file. | |
1315 | ||
f0bf7708 | 1316 | @node Using Customize |
4009494e GM |
1317 | @section How do I start using Customize? |
1318 | @cindex Customize groups | |
1319 | @cindex Customizing variables | |
1320 | @cindex Customizing faces | |
1321 | ||
1322 | The main Customize entry point is @kbd{M-x customize @key{RET}}. This | |
1323 | command takes you to a buffer listing all the available Customize | |
1324 | groups. From there, you can access all customizable options and faces, | |
1325 | change their values, and save your changes to your init file. | |
1326 | @inforef{Easy Customization, Easy Customization, emacs}. | |
1327 | ||
1328 | If you know the name of the group in advance (e.g. ``shell''), use | |
1329 | @kbd{M-x customize-group @key{RET}}. | |
1330 | ||
1331 | If you wish to customize a single option, use @kbd{M-x customize-option | |
1332 | @key{RET}}. This command prompts you for the name of the option to | |
1333 | customize, with completion. | |
1334 | ||
f0bf7708 | 1335 | @node Colors on a TTY |
4009494e GM |
1336 | @section How do I get colors and syntax highlighting on a TTY? |
1337 | @cindex Colors on a TTY | |
1338 | @cindex Syntax highlighting on a TTY | |
1339 | @cindex Console, colors | |
1340 | ||
1341 | In Emacs 21.1 and later, colors and faces are supported in non-windowed mode, | |
1342 | i.e.@: on Unix and GNU/Linux text-only terminals and consoles, and when | |
9e2a2647 | 1343 | invoked as @samp{emacs -nw} on X, and MS-Windows. (Colors and faces were |
4009494e GM |
1344 | supported in the MS-DOS port since Emacs 19.29.) Emacs automatically |
1345 | detects color support at startup and uses it if available. If you think | |
1346 | that your terminal supports colors, but Emacs won't use them, check the | |
1347 | @code{termcap} entry for your display type for color-related | |
1348 | capabilities. | |
1349 | ||
1350 | The command @kbd{M-x list-colors-display} pops up a window which | |
1351 | exhibits all the colors Emacs knows about on the current display. | |
1352 | ||
1353 | Syntax highlighting is on by default since version 22.1. | |
1354 | ||
f0bf7708 | 1355 | @node Debugging a customization file |
4009494e GM |
1356 | @section How do I debug a @file{.emacs} file? |
1357 | @cindex Debugging @file{.emacs} file | |
1358 | @cindex @file{.emacs} debugging | |
1359 | @cindex Init file debugging | |
1360 | @cindex @samp{-debug-init} option | |
1361 | ||
1362 | Start Emacs with the @samp{-debug-init} command-line option. This | |
1363 | enables the Emacs Lisp debugger before evaluating your @file{.emacs} | |
1364 | file, and places you in the debugger if something goes wrong. The top | |
1365 | line in the @file{trace-back} buffer will be the error message, and the | |
1366 | second or third line of that buffer will display the Lisp code from your | |
1367 | @file{.emacs} file that caused the problem. | |
1368 | ||
1369 | You can also evaluate an individual function or argument to a function | |
1370 | in your @file{.emacs} file by moving the cursor to the end of the | |
1371 | function or argument and typing @kbd{C-x C-e} (@kbd{M-x | |
1372 | eval-last-sexp}). | |
1373 | ||
1374 | Use @kbd{C-h v} (@kbd{M-x describe-variable}) to check the value of | |
1375 | variables which you are trying to set or use. | |
1376 | ||
f0bf7708 | 1377 | @node Displaying the current line or column |
4009494e GM |
1378 | @section How do I make Emacs display the current line (or column) number? |
1379 | @cindex @code{line-number-mode} | |
1380 | @cindex Displaying the current line or column | |
1381 | @cindex Line number, displaying the current | |
1382 | @cindex Column, displaying the current | |
1383 | @cindex @code{mode-line-format} | |
1384 | ||
2e17e05e GM |
1385 | By default, Emacs displays the current line number of the point in the |
1386 | mode line. You can toggle this feature off or on with the command | |
1387 | @kbd{M-x line-number-mode}, or by setting the variable | |
1388 | @code{line-number-mode}. Note that Emacs will not display the line | |
4009494e GM |
1389 | number if the buffer's size in bytes is larger than the value of the |
1390 | variable @code{line-number-display-limit}. | |
1391 | ||
1392 | You can similarly display the current column with | |
1393 | @kbd{M-x column-number-mode}, or by putting the form | |
1394 | ||
1395 | @lisp | |
1396 | (setq column-number-mode t) | |
1397 | @end lisp | |
1398 | ||
1399 | @noindent | |
2e17e05e | 1400 | in your @file{.emacs} file. This feature is off by default. |
4009494e GM |
1401 | |
1402 | The @code{"%c"} format specifier in the variable @code{mode-line-format} | |
1403 | will insert the current column's value into the mode line. See the | |
1404 | documentation for @code{mode-line-format} (using @kbd{C-h v | |
1405 | mode-line-format @key{RET}}) for more information on how to set and use | |
1406 | this variable. | |
1407 | ||
4009494e | 1408 | @cindex Set number capability in @code{vi} emulators |
2e17e05e GM |
1409 | The @samp{linum} package (distributed with Emacs since version 23.1) |
1410 | displays line numbers in the left margin, like the ``set number'' | |
1411 | capability of @code{vi}. The packages @samp{setnu} and | |
1412 | @samp{wb-line-number} (not distributed with Emacs) also implement this | |
1413 | feature. | |
4009494e | 1414 | |
f0bf7708 | 1415 | @node Displaying the current file name in the titlebar |
4009494e GM |
1416 | @section How can I modify the titlebar to contain the current file name? |
1417 | @cindex Titlebar, displaying the current file name in | |
1418 | @cindex File name, displaying in the titlebar | |
1419 | @cindex @code{frame-title-format} | |
1420 | ||
1421 | The contents of an Emacs frame's titlebar is controlled by the variable | |
1422 | @code{frame-title-format}, which has the same structure as the variable | |
1423 | @code{mode-line-format}. (Use @kbd{C-h v} or @kbd{M-x | |
1424 | describe-variable} to get information about one or both of these | |
1425 | variables.) | |
1426 | ||
1427 | By default, the titlebar for a frame does contain the name of the buffer | |
1428 | currently being visited, except if there is a single frame. In such a | |
1429 | case, the titlebar contains Emacs invocation name and the name of the | |
1430 | machine at which Emacs was invoked. This is done by setting | |
1431 | @code{frame-title-format} to the default value of | |
1432 | ||
1433 | @lisp | |
1434 | (multiple-frames "%b" ("" invocation-name "@@" system-name)) | |
1435 | @end lisp | |
1436 | ||
1437 | To modify the behavior such that frame titlebars contain the buffer's | |
1438 | name regardless of the number of existing frames, include the following | |
1439 | in your @file{.emacs}: | |
1440 | ||
1441 | @lisp | |
1442 | (setq frame-title-format "%b") | |
1443 | @end lisp | |
1444 | ||
f0bf7708 | 1445 | @node Turning on abbrevs by default |
4009494e GM |
1446 | @section How do I turn on abbrevs by default just in mode @var{mymode}? |
1447 | @cindex Abbrevs, turning on by default | |
1448 | ||
2e17e05e GM |
1449 | Abbrev mode expands abbreviations as you type them. To turn it on in a |
1450 | specific buffer, use @kbd{M-x abbrev-mode}. To turn it on in every | |
1451 | buffer by default, put this in your @file{.emacs} file: | |
4009494e GM |
1452 | |
1453 | @lisp | |
2e17e05e GM |
1454 | (setq-default abbrev-mode t) |
1455 | @end lisp | |
1456 | ||
1457 | @noindent To turn it on in a specific mode, use: | |
4009494e | 1458 | |
2e17e05e | 1459 | @lisp |
4009494e GM |
1460 | (add-hook '@var{mymode}-mode-hook |
1461 | (lambda () | |
1462 | (setq abbrev-mode t))) | |
1463 | @end lisp | |
1464 | ||
2e17e05e GM |
1465 | @noindent If your Emacs version is older then 22.1, you will also need to use: |
1466 | ||
1467 | @lisp | |
1468 | (condition-case () | |
1469 | (quietly-read-abbrev-file) | |
1470 | (file-error nil)) | |
1471 | @end lisp | |
4009494e | 1472 | |
f0bf7708 | 1473 | @node Associating modes with files |
4009494e GM |
1474 | @section How do I make Emacs use a certain major mode for certain files? |
1475 | @cindex Associating modes with files | |
1476 | @cindex File extensions and modes | |
1477 | @cindex @code{auto-mode-alist}, modifying | |
1478 | @cindex Modes, associating with file extensions | |
1479 | ||
1480 | If you want to use a certain mode @var{foo} for all files whose names end | |
1481 | with the extension @file{.@var{bar}}, this will do it for you: | |
1482 | ||
1483 | @lisp | |
2e17e05e | 1484 | (add-to-list 'auto-mode-alist '("\\.@var{bar}\\'" . @var{foo}-mode)) |
4009494e GM |
1485 | @end lisp |
1486 | ||
2e17e05e | 1487 | Alternatively, put this somewhere in the first line of any file you want to |
4009494e GM |
1488 | edit in the mode @var{foo} (in the second line, if the first line begins |
1489 | with @samp{#!}): | |
1490 | ||
1491 | @example | |
1492 | -*- @var{foo} -*- | |
1493 | @end example | |
1494 | ||
1495 | @cindex Major mode for shell scripts | |
2e17e05e GM |
1496 | The variable @code{interpreter-mode-alist} specifies which mode to use |
1497 | when loading an interpreted script (e.g. shell, python, etc.). Emacs | |
4009494e | 1498 | determines which interpreter you're using by examining the first line of |
2e17e05e GM |
1499 | the script. Use @kbd{C-h v} (or @kbd{M-x describe-variable}) on |
1500 | @code{interpreter-mode-alist} to learn more. | |
4009494e | 1501 | |
f0bf7708 | 1502 | @node Highlighting a region |
4009494e GM |
1503 | @section How can I highlight a region of text in Emacs? |
1504 | @cindex Highlighting text | |
1505 | @cindex Text, highlighting | |
1506 | @cindex @code{transient-mark-mode} | |
1507 | @cindex Region, highlighting a | |
1508 | ||
1509 | You can cause the region to be highlighted when the mark is active by | |
1510 | including | |
1511 | ||
1512 | @lisp | |
2e17e05e | 1513 | (transient-mark-mode 1) |
4009494e GM |
1514 | @end lisp |
1515 | ||
1516 | @noindent | |
2e17e05e | 1517 | in your @file{.emacs} file. Since Emacs 23.1, this feature is on by default. |
4009494e | 1518 | |
f0bf7708 | 1519 | @node Replacing highlighted text |
4009494e GM |
1520 | @section How can I replace highlighted text with what I type? |
1521 | @cindex @code{delete-selection-mode} | |
1522 | @cindex Replacing highlighted text | |
1523 | @cindex Highlighting and replacing text | |
1524 | ||
1525 | Use @code{delete-selection-mode}, which you can start automatically by | |
1526 | placing the following Lisp form in your @file{.emacs} file: | |
1527 | ||
1528 | @lisp | |
1529 | (delete-selection-mode 1) | |
1530 | @end lisp | |
1531 | ||
1532 | According to the documentation string for @code{delete-selection-mode} | |
1533 | (which you can read using @kbd{M-x describe-function @key{RET} | |
1534 | delete-selection-mode @key{RET}}): | |
1535 | ||
1536 | @quotation | |
2e17e05e GM |
1537 | When Delete Selection mode is enabled, Transient Mark mode is also |
1538 | enabled and typed text replaces the selection if the selection is | |
1539 | active. Otherwise, typed text is just inserted at point regardless of | |
1540 | any selection. | |
4009494e GM |
1541 | @end quotation |
1542 | ||
1543 | This mode also allows you to delete (not kill) the highlighted region by | |
1544 | pressing @key{DEL}. | |
1545 | ||
f0bf7708 | 1546 | @node Controlling case sensitivity |
4009494e GM |
1547 | @section How do I control Emacs's case-sensitivity when searching/replacing? |
1548 | @cindex @code{case-fold-search} | |
1549 | @cindex Case sensitivity of searches | |
1550 | @cindex Searching without case sensitivity | |
1551 | @cindex Ignoring case in searches | |
1552 | ||
2e17e05e GM |
1553 | @c FIXME |
1554 | The value of the variable @code{case-fold-search} determines whether | |
1555 | searches are case sensitive: | |
4009494e GM |
1556 | |
1557 | @lisp | |
1558 | (setq case-fold-search nil) ; make searches case sensitive | |
1559 | (setq case-fold-search t) ; make searches case insensitive | |
1560 | @end lisp | |
1561 | ||
1562 | @cindex Case sensitivity in replacements | |
1563 | @cindex Replacing, and case sensitivity | |
1564 | @cindex @code{case-replace} | |
1565 | Similarly, for replacing, the variable @code{case-replace} determines | |
1566 | whether replacements preserve case. | |
1567 | ||
1568 | You can also toggle case sensitivity at will in isearch with @kbd{M-c}. | |
1569 | ||
1570 | To change the case sensitivity just for one major mode, use the major | |
1571 | mode's hook. For example: | |
1572 | ||
1573 | @lisp | |
1574 | (add-hook '@var{foo}-mode-hook | |
1575 | (lambda () | |
1576 | (setq case-fold-search nil))) | |
1577 | @end lisp | |
1578 | ||
f0bf7708 | 1579 | @node Working with unprintable characters |
4009494e GM |
1580 | @section How do I search for, delete, or replace unprintable (eight-bit or control) characters? |
1581 | @cindex Unprintable characters, working with | |
1582 | @cindex Working with unprintable characters | |
1583 | @cindex Control characters, working with | |
1584 | @cindex Eight-bit characters, working with | |
1585 | @cindex Searching for unprintable characters | |
1586 | @cindex Regexps and unprintable characters | |
1587 | ||
1588 | To search for a single character that appears in the buffer as, for | |
2e17e05e | 1589 | example, @samp{\237}, you can type @kbd{C-s C-q 2 3 7}. |
4009494e GM |
1590 | Searching for @strong{all} unprintable characters is best done with a |
1591 | regular expression (@dfn{regexp}) search. The easiest regexp to use for | |
1592 | the unprintable chars is the complement of the regexp for the printable | |
1593 | chars. | |
1594 | ||
1595 | @itemize @bullet | |
1596 | ||
1597 | @item | |
1598 | Regexp for the printable chars: @samp{[\t\n\r\f -~]} | |
1599 | ||
1600 | @item | |
1601 | Regexp for the unprintable chars: @samp{[^\t\n\r\f -~]} | |
1602 | ||
1603 | @end itemize | |
1604 | ||
1605 | To type these special characters in an interactive argument to | |
1606 | @code{isearch-forward-regexp} or @code{re-search-forward}, you need to | |
1607 | use @kbd{C-q}. (@samp{\t}, @samp{\n}, @samp{\r}, and @samp{\f} stand | |
1608 | respectively for @key{TAB}, @key{LFD}, @key{RET}, and @kbd{C-l}.) So, | |
1609 | to search for unprintable characters using @code{re-search-forward}: | |
1610 | ||
1611 | @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}} | |
1612 | ||
1613 | Using @code{isearch-forward-regexp}: | |
1614 | ||
1615 | @kbd{C-M-s [^ @key{TAB} @key{LFD} C-q @key{RET} C-q C-l @key{SPC} -~]} | |
1616 | ||
1617 | To delete all unprintable characters, simply use replace-regexp: | |
1618 | ||
1619 | @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}} | |
1620 | ||
1621 | Replacing is similar to the above. To replace all unprintable | |
1622 | characters with a colon, use: | |
1623 | ||
1624 | 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} | |
1625 | ||
f0bf7708 | 1626 | @node Searching for/replacing newlines |
4009494e GM |
1627 | @section How do I input a newline character in isearch or query-replace? |
1628 | @cindex Searching for newlines | |
1629 | @cindex Replacing newlines | |
1630 | ||
1631 | Use @kbd{C-q C-j}. For more information, see @inforef{Special Isearch, | |
1632 | Special Input for Incremental Search, emacs}. | |
1633 | ||
1634 | ||
f0bf7708 | 1635 | @node Yanking text in isearch |
4009494e GM |
1636 | @section How do I copy text from the kill ring into the search string? |
1637 | @cindex Yanking text into the search string | |
1638 | @cindex isearch yanking | |
1639 | ||
1640 | Use @kbd{M-y}. @inforef{Isearch Yank, Isearch Yanking, emacs}. | |
1641 | ||
f0bf7708 | 1642 | @node Wrapping words automatically |
4009494e GM |
1643 | @section How do I make Emacs wrap words for me? |
1644 | @cindex Wrapping word automatically | |
1645 | @cindex Wrapping lines | |
1646 | @cindex Line wrap | |
1647 | @cindex @code{auto-fill-mode}, introduction to | |
1648 | @cindex Maximum line width, default value | |
1649 | @cindex @code{fill-column}, default value | |
1650 | ||
1651 | Use @code{auto-fill-mode}, activated by typing @kbd{M-x auto-fill-mode}. | |
1652 | The default maximum line width is 70, determined by the variable | |
1653 | @code{fill-column}. To learn how to turn this on automatically, see | |
1654 | @ref{Turning on auto-fill by default}. | |
1655 | ||
f0bf7708 | 1656 | @node Turning on auto-fill by default |
4009494e GM |
1657 | @section How do I turn on @code{auto-fill-mode} by default? |
1658 | @cindex @code{auto-fill-mode}, activating automatically | |
1659 | @cindex Filling automatically | |
1660 | @cindex Automatic entry to @code{auto-fill-mode} | |
1661 | ||
1662 | To turn on @code{auto-fill-mode} just once for one buffer, use @kbd{M-x | |
1663 | auto-fill-mode}. | |
1664 | ||
1665 | To turn it on for every buffer in a certain mode, you must use the hook | |
1666 | for that mode. For example, to turn on @code{auto-fill} mode for all | |
1667 | text buffers, including the following in your @file{.emacs} file: | |
1668 | ||
1669 | @lisp | |
1670 | (add-hook 'text-mode-hook 'turn-on-auto-fill) | |
1671 | @end lisp | |
1672 | ||
1673 | If you want @code{auto-fill} mode on in all major modes, do this: | |
1674 | ||
1675 | @lisp | |
1676 | (setq-default auto-fill-function 'do-auto-fill) | |
1677 | @end lisp | |
1678 | ||
f0bf7708 | 1679 | @node Changing load-path |
4009494e GM |
1680 | @section How do I change @code{load-path}? |
1681 | @cindex @code{load-path}, modifying | |
1682 | @cindex Modifying @code{load-path} | |
1683 | @cindex Adding to @code{load-path} | |
1684 | ||
1685 | In general, you should only add to the @code{load-path}. You can add | |
1686 | directory @var{/dir/subdir} to the load path like this: | |
1687 | ||
1688 | @lisp | |
f6adc23c | 1689 | (add-to-list 'load-path "/dir/subdir/") |
4009494e GM |
1690 | @end lisp |
1691 | ||
1692 | To do this relative to your home directory: | |
1693 | ||
1694 | @lisp | |
f6adc23c | 1695 | (add-to-list 'load-path "~/mysubdir/") |
4009494e GM |
1696 | @end lisp |
1697 | ||
f0bf7708 | 1698 | @node Using an already running Emacs process |
4009494e GM |
1699 | @section How do I use an already running Emacs from another window? |
1700 | @cindex @code{emacsclient} | |
1701 | @cindex Emacs server functions | |
1702 | @cindex Using an existing Emacs process | |
1703 | ||
1704 | @code{emacsclient}, which comes with Emacs, is for editing a file using | |
1705 | an already running Emacs rather than starting up a new Emacs. It does | |
1706 | this by sending a request to the already running Emacs, which must be | |
1707 | expecting the request. | |
1708 | ||
1709 | @itemize @bullet | |
1710 | ||
1711 | @item | |
1712 | Setup: | |
1713 | ||
1714 | Emacs must have executed the @code{server-start} function for | |
1715 | @samp{emacsclient} to work. This can be done either by a command line | |
1716 | option: | |
1717 | ||
1718 | @example | |
1719 | emacs -f server-start | |
1720 | @end example | |
1721 | ||
1722 | or by invoking @code{server-start} from @file{.emacs}: | |
1723 | ||
1724 | @lisp | |
1725 | (if (@var{some conditions are met}) (server-start)) | |
1726 | @end lisp | |
1727 | ||
1728 | When this is done, Emacs creates a Unix domain socket named | |
1729 | @file{server} in @file{/tmp/emacs@var{userid}}. See | |
1730 | @code{server-socket-dir}. | |
1731 | ||
1732 | To get your news reader, mail reader, etc., to invoke | |
1733 | @samp{emacsclient}, try setting the environment variable @code{EDITOR} | |
1734 | (or sometimes @code{VISUAL}) to the value @samp{emacsclient}. You may | |
1735 | have to specify the full pathname of the @samp{emacsclient} program | |
1736 | instead. Examples: | |
1737 | ||
1738 | @example | |
1739 | # csh commands: | |
1740 | setenv EDITOR emacsclient | |
1741 | ||
1742 | # using full pathname | |
1743 | setenv EDITOR /usr/local/emacs/etc/emacsclient | |
1744 | ||
1745 | # sh command: | |
1746 | EDITOR=emacsclient ; export EDITOR | |
1747 | @end example | |
1748 | ||
1749 | @item | |
1750 | Normal use: | |
1751 | ||
1752 | When @samp{emacsclient} is run, it connects to the socket and passes its | |
1753 | command line options to Emacs, which at the next opportunity will visit | |
1754 | the files specified. (Line numbers can be specified just like with | |
1755 | Emacs.) The user will have to switch to the Emacs window by hand. When | |
1756 | the user is done editing a file, the user can type @kbd{C-x #} (or | |
1757 | @kbd{M-x server-edit}) to indicate this. If there is another buffer | |
1758 | requested by @code{emacsclient}, Emacs will switch to it; otherwise | |
1759 | @code{emacsclient} will exit, signaling the calling program to continue. | |
1760 | ||
1761 | @cindex @code{gnuserv} | |
2e17e05e | 1762 | There is an alternative version of @samp{emacsclient} called |
4009494e GM |
1763 | @samp{gnuserv}, written by @email{ange@@hplb.hpl.hp.com, Andy Norman} |
1764 | (@pxref{Packages that do not come with Emacs}). @samp{gnuserv} uses | |
1765 | Internet domain sockets, so it can work across most network connections. | |
1766 | ||
1767 | The most recent @samp{gnuserv} package is available at | |
1768 | ||
1769 | @uref{http://meltin.net/hacks/emacs/} | |
1770 | ||
1771 | @end itemize | |
1772 | ||
f0bf7708 | 1773 | @node Compiler error messages |
4009494e GM |
1774 | @section How do I make Emacs recognize my compiler's funny error messages? |
1775 | @cindex Compiler error messages, recognizing | |
1776 | @cindex Recognizing non-standard compiler errors | |
1777 | @cindex Regexps for recognizing compiler errors | |
1778 | @cindex Errors, recognizing compiler | |
1779 | ||
1780 | Customize the @code{compilation-error-regexp-alist} variable. | |
1781 | ||
f0bf7708 | 1782 | @node Indenting switch statements |
4009494e GM |
1783 | @section How do I change the indentation for @code{switch}? |
1784 | @cindex @code{switch}, indenting | |
1785 | @cindex Indenting of @code{switch} | |
1786 | ||
1787 | Many people want to indent their @code{switch} statements like this: | |
1788 | ||
1789 | @example | |
1790 | f() | |
1791 | @{ | |
1792 | switch(x) @{ | |
1793 | case A: | |
1794 | x1; | |
1795 | break; | |
1796 | case B: | |
1797 | x2; | |
1798 | break; | |
1799 | default: | |
1800 | x3; | |
1801 | @} | |
1802 | @} | |
1803 | @end example | |
1804 | ||
2e17e05e | 1805 | @noindent To achieve this, add the following line to your @file{.emacs}: |
4009494e GM |
1806 | |
1807 | @lisp | |
1808 | (c-set-offset 'case-label '+) | |
1809 | @end lisp | |
1810 | ||
f0bf7708 | 1811 | @node Customizing C and C++ indentation |
4009494e GM |
1812 | @section How to customize indentation in C, C@t{++}, and Java buffers? |
1813 | @cindex Indentation, how to customize | |
1814 | @cindex Customize indentation | |
1815 | ||
1816 | The Emacs @code{cc-mode} features an interactive procedure for | |
1817 | customizing the indentation style, which is fully explained in the | |
1818 | @cite{CC Mode} manual that is part of the Emacs distribution, see | |
1819 | @ref{Customizing Indentation, , Customization Indentation, ccmode, | |
1820 | The CC Mode Manual}. Here's a short summary of the procedure: | |
1821 | ||
1822 | @enumerate | |
1823 | @item | |
1824 | Go to the beginning of the first line where you don't like the | |
1825 | indentation and type @kbd{C-c C-o}. Emacs will prompt you for the | |
1826 | syntactic symbol; type @key{RET} to accept the default it suggests. | |
1827 | ||
1828 | @item | |
1829 | Emacs now prompts for the offset of this syntactic symbol, showing the | |
1830 | default (the current definition) inside parentheses. You can choose | |
1831 | one of these: | |
1832 | ||
1833 | @table @code | |
1834 | @item 0 | |
1835 | No extra indentation. | |
1836 | @item + | |
1837 | Indent one basic offset. | |
1838 | @item - | |
1839 | Outdent one basic offset. | |
1840 | @item ++ | |
1841 | Indent two basic offsets | |
1842 | @item -- | |
1843 | Outdent two basic offsets. | |
1844 | @item * | |
1845 | Indent half basic offset. | |
1846 | @item / | |
1847 | Outdent half basic offset. | |
1848 | @end table | |
1849 | ||
1850 | @item | |
1851 | After choosing one of these symbols, type @kbd{C-c C-q} to reindent | |
1852 | the line or the block according to what you just specified. | |
1853 | ||
1854 | @item | |
1855 | If you don't like the result, go back to step 1. Otherwise, add the | |
1856 | following line to your @file{.emacs}: | |
1857 | ||
1858 | @lisp | |
1859 | (c-set-offset '@var{syntactic-symbol} @var{offset}) | |
1860 | @end lisp | |
1861 | ||
1862 | @noindent | |
1863 | where @var{syntactic-symbol} is the name Emacs shows in the minibuffer | |
1864 | when you type @kbd{C-c C-o} at the beginning of the line, and | |
1865 | @var{offset} is one of the indentation symbols listed above (@code{+}, | |
1866 | @code{/}, @code{0}, etc.) that you've chosen during the interactive | |
1867 | procedure. | |
1868 | ||
1869 | @item | |
1870 | Go to the next line whose indentation is not to your liking and repeat | |
1871 | the process there. | |
1872 | @end enumerate | |
1873 | ||
1874 | It is recommended to put all the resulting @code{(c-set-offset ...)} | |
1875 | customizations inside a C mode hook, like this: | |
1876 | ||
1877 | @lisp | |
1878 | (defun my-c-mode-hook () | |
1879 | (c-set-offset ...) | |
1880 | (c-set-offset ...)) | |
1881 | (add-hook 'c-mode-hook 'my-c-mode-hook) | |
1882 | @end lisp | |
1883 | ||
1884 | @noindent | |
1885 | Using @code{c-mode-hook} avoids the need to put a @w{@code{(require | |
1886 | 'cc-mode)}} into your @file{.emacs} file, because @code{c-set-offset} | |
1887 | might be unavailable when @code{cc-mode} is not loaded. | |
1888 | ||
1889 | Note that @code{c-mode-hook} runs for C source files only; use | |
1890 | @code{c++-mode-hook} for C@t{++} sources, @code{java-mode-hook} for | |
1891 | Java sources, etc. If you want the same customizations to be in | |
1892 | effect in @emph{all} languages supported by @code{cc-mode}, use | |
1893 | @code{c-mode-common-hook}. | |
1894 | ||
f0bf7708 | 1895 | @node Horizontal scrolling |
4009494e GM |
1896 | @section How can I make Emacs automatically scroll horizontally? |
1897 | @cindex @code{hscroll-mode} | |
1898 | @cindex Horizontal scrolling | |
1899 | @cindex Scrolling horizontally | |
1900 | ||
1901 | In Emacs 21 and later, this is on by default: if the variable | |
1902 | @code{truncate-lines} is non-@code{nil} in the current buffer, Emacs | |
1903 | automatically scrolls the display horizontally when point moves off the | |
1904 | left or right edge of the window. | |
1905 | ||
1906 | Note that this is overridden by the variable | |
1907 | @code{truncate-partial-width-windows} if that variable is non-nil | |
1908 | and the current buffer is not full-frame width. | |
1909 | ||
2e17e05e | 1910 | In Emacs 20, use @code{hscroll-mode}. |
4009494e | 1911 | |
f0bf7708 | 1912 | @node Overwrite mode |
4009494e GM |
1913 | @section How do I make Emacs ``typeover'' or ``overwrite'' instead of inserting? |
1914 | @cindex @key{Insert} | |
1915 | @cindex @code{overwrite-mode} | |
1916 | @cindex Overwriting existing text | |
1917 | @cindex Toggling @code{overwrite-mode} | |
1918 | ||
1919 | @kbd{M-x overwrite-mode} (a minor mode). This toggles | |
1920 | @code{overwrite-mode} on and off, so exiting from @code{overwrite-mode} | |
1921 | is as easy as another @kbd{M-x overwrite-mode}. | |
1922 | ||
1923 | On some systems, @key{Insert} toggles @code{overwrite-mode} on and off. | |
1924 | ||
f0bf7708 | 1925 | @node Turning off beeping |
4009494e GM |
1926 | @section How do I stop Emacs from beeping on a terminal? |
1927 | @cindex Beeping, turning off | |
1928 | @cindex Visible bell | |
1929 | @cindex Bell, visible | |
1930 | ||
1931 | @email{martin@@cc.gatech.edu, Martin R. Frank} writes: | |
1932 | ||
1933 | Tell Emacs to use the @dfn{visible bell} instead of the audible bell, | |
1934 | and set the visible bell to nothing. | |
1935 | ||
1936 | That is, put the following in your @code{TERMCAP} environment variable | |
1937 | (assuming you have one): | |
1938 | ||
1939 | @example | |
1940 | ... :vb=: ... | |
1941 | @end example | |
1942 | ||
1943 | And evaluate the following Lisp form: | |
1944 | ||
1945 | @example | |
1946 | (setq visible-bell t) | |
1947 | @end example | |
1948 | ||
f0bf7708 | 1949 | @node Turning the volume down |
4009494e GM |
1950 | @section How do I turn down the bell volume in Emacs running under X? |
1951 | @cindex Bell, volume of | |
1952 | @cindex Volume of bell | |
1953 | ||
1954 | On X Window system, you can adjust the bell volume and duration for all | |
1955 | programs with the shell command @code{xset}. | |
1956 | ||
1957 | Invoking @code{xset} without any arguments produces some basic | |
1958 | information, including the following: | |
1959 | ||
1960 | @example | |
1961 | usage: xset [-display host:dpy] option ... | |
1962 | To turn bell off: | |
1963 | -b b off b 0 | |
1964 | To set bell volume, pitch and duration: | |
1965 | b [vol [pitch [dur]]] b on | |
1966 | @end example | |
1967 | ||
f0bf7708 | 1968 | @node Automatic indentation |
4009494e GM |
1969 | @section How do I tell Emacs to automatically indent a new line to the indentation of the previous line? |
1970 | @cindex Indenting new lines | |
1971 | @cindex New lines, indenting of | |
1972 | @cindex Previous line, indenting according to | |
1973 | @cindex Text indentation | |
1974 | ||
f6adc23c | 1975 | Such behavior is automatic (in Text mode) in Emacs 20 and later. From the |
4009494e GM |
1976 | @file{etc/NEWS} file for Emacs 20.2: |
1977 | ||
1978 | @example | |
1979 | ** In Text mode, now only blank lines separate paragraphs. This makes | |
1980 | it possible to get the full benefit of Adaptive Fill mode in Text mode, | |
1981 | and other modes derived from it (such as Mail mode). @key{TAB} in Text | |
1982 | mode now runs the command @code{indent-relative}; this makes a practical | |
1983 | difference only when you use indented paragraphs. | |
1984 | ||
4009494e GM |
1985 | If you want spaces at the beginning of a line to start a paragraph, use |
1986 | the new mode, Paragraph Indent Text mode. | |
1987 | @end example | |
1988 | ||
1989 | @cindex Prefixing lines | |
1990 | @cindex Fill prefix | |
1991 | If you have @code{auto-fill-mode} turned on (@pxref{Turning on auto-fill | |
1992 | by default}), you can tell Emacs to prefix every line with a certain | |
1993 | character sequence, the @dfn{fill prefix}. Type the prefix at the | |
1994 | beginning of a line, position point after it, and then type @kbd{C-x .} | |
1995 | (@code{set-fill-prefix}) to set the fill prefix. Thereafter, | |
1996 | auto-filling will automatically put the fill prefix at the beginning of | |
1997 | new lines, and @kbd{M-q} (@code{fill-paragraph}) will maintain any fill | |
1998 | prefix when refilling the paragraph. | |
1999 | ||
2000 | If you have paragraphs with different levels of indentation, you will | |
2001 | have to set the fill prefix to the correct value each time you move to a | |
2002 | new paragraph. There are many packages available to deal with this | |
2003 | (@pxref{Packages that do not come with Emacs}). Look for ``fill'' and | |
2004 | ``indent'' keywords for guidance. | |
2005 | ||
f0bf7708 | 2006 | @node Matching parentheses |
4009494e GM |
2007 | @section How do I show which parenthesis matches the one I'm looking at? |
2008 | @cindex Parentheses, matching | |
2009 | @cindex @file{paren.el} | |
2010 | @cindex Highlighting matching parentheses | |
2011 | @cindex Pairs of parentheses, highlighting | |
2012 | @cindex Matching parentheses | |
2013 | ||
2014 | Call @code{show-paren-mode} in your @file{.emacs} file: | |
2015 | ||
2016 | @lisp | |
2017 | (show-paren-mode 1) | |
2018 | @end lisp | |
2019 | ||
2020 | You can also enable this mode by selecting the @samp{Paren Match | |
2021 | Highlighting} option from the @samp{Options} menu of the Emacs menu bar | |
2022 | at the top of any Emacs frame. | |
2023 | ||
2024 | Alternatives to this mode include: | |
2025 | ||
2026 | @itemize @bullet | |
2027 | ||
2028 | @item | |
2029 | If you're looking at a right parenthesis (or brace or bracket) you can | |
2030 | delete it and reinsert it. Emacs will momentarily move the cursor to | |
2031 | the matching parenthesis. | |
2032 | ||
2033 | @item | |
2034 | @kbd{C-M-f} (@code{forward-sexp}) and @kbd{C-M-b} (@code{backward-sexp}) | |
2035 | will skip over one set of balanced parentheses, so you can see which | |
2036 | parentheses match. (You can train it to skip over balanced brackets | |
2037 | and braces at the same time by modifying the syntax table.) | |
2038 | ||
2039 | @cindex Show matching paren as in @code{vi} | |
2040 | @item | |
2041 | Here is some Emacs Lisp that will make the @key{%} key show the matching | |
2042 | parenthesis, like in @code{vi}. In addition, if the cursor isn't over a | |
2043 | parenthesis, it simply inserts a % like normal. | |
2044 | ||
2045 | @lisp | |
2046 | ;; By an unknown contributor | |
2047 | ||
2048 | (global-set-key "%" 'match-paren) | |
2049 | ||
2050 | (defun match-paren (arg) | |
2051 | "Go to the matching paren if on a paren; otherwise insert %." | |
2052 | (interactive "p") | |
2053 | (cond ((looking-at "\\s\(") (forward-list 1) (backward-char 1)) | |
2054 | ((looking-at "\\s\)") (forward-char 1) (backward-list 1)) | |
2055 | (t (self-insert-command (or arg 1))))) | |
2056 | @end lisp | |
2057 | ||
2058 | @end itemize | |
2059 | ||
f0bf7708 | 2060 | @node Hiding #ifdef lines |
4009494e GM |
2061 | @section In C mode, can I show just the lines that will be left after @code{#ifdef} commands are handled by the compiler? |
2062 | @cindex @code{#ifdef}, selective display of | |
2063 | @cindex @code{hide-ifdef-mode} | |
2064 | @cindex Hiding @code{#ifdef} text | |
2065 | @cindex Selectively displaying @code{#ifdef} code | |
2066 | ||
2067 | @kbd{M-x hide-ifdef-mode}. (This is a minor mode.) You might also want | |
2068 | to investigate @file{cpp.el}, which is distributed with Emacs. | |
2069 | ||
f0bf7708 | 2070 | @node Repeating commands |
4009494e GM |
2071 | @section How do I repeat a command as many times as possible? |
2072 | @cindex Repeating commands many times | |
2073 | @cindex Commands, repeating many times | |
2074 | @cindex @code{.}, equivalent to @code{vi} command | |
2075 | ||
2076 | As of Emacs 20.3, there is indeed a @code{repeat} command (@kbd{C-x z}) | |
2077 | that repeats the last command. If you preface it with a prefix | |
2078 | argument, the prefix arg is applied to the command. | |
2079 | ||
2080 | You can also type @kbd{C-x @key{ESC} @key{ESC}} | |
2081 | (@code{repeat-complex-command}) to reinvoke commands that used the | |
2082 | minibuffer to get arguments. In @code{repeat-complex-command} you can | |
2083 | type @kbd{M-p} and @kbd{M-n} (and also up-arrow and down-arrow, if your | |
2084 | keyboard has these keys) to scan through all the different complex | |
2085 | commands you've typed. | |
2086 | ||
2087 | To repeat a set of commands, use keyboard macros. Use @kbd{C-x (} and | |
2088 | @kbd{C-x )} to make a keyboard macro that invokes the command and then | |
2089 | type @kbd{C-x e}. (@inforef{Keyboard Macros, Keyboard Macros, emacs}.) | |
2090 | ||
2091 | If you're really desperate for the @code{.} command in @code{vi} that | |
2092 | redoes the last insertion/deletion, use VIPER, a @code{vi} emulation | |
2093 | mode which comes with Emacs, and which appears to support it. | |
4009494e | 2094 | |
f0bf7708 | 2095 | @node Valid X resources |
4009494e GM |
2096 | @section What are the valid X resource settings (i.e., stuff in .Xdefaults)? |
2097 | @cindex Resources, X | |
2098 | @cindex X resources | |
2099 | @cindex Setting X resources | |
2100 | ||
2101 | @inforef{X Resources, X Resources, emacs}. | |
2102 | ||
2103 | You can also use a resource editor, such as editres (for X11R5 and | |
2104 | onwards), to look at the resource names for the menu bar, assuming Emacs | |
2105 | was compiled with the X toolkit. | |
2106 | ||
f0bf7708 | 2107 | @node Evaluating Emacs Lisp code |
4009494e GM |
2108 | @section How do I execute (``evaluate'') a piece of Emacs Lisp code? |
2109 | @cindex Evaluating Lisp code | |
2110 | @cindex Lisp forms, evaluating | |
2111 | ||
2112 | There are a number of ways to execute (@dfn{evaluate}, in Lisp lingo) an | |
2113 | Emacs Lisp @dfn{form}: | |
2114 | ||
2115 | @itemize @bullet | |
2116 | ||
2117 | @item | |
2118 | If you want it evaluated every time you run Emacs, put it in a file | |
2119 | named @file{.emacs} in your home directory. This is known as ``your | |
2120 | @file{.emacs} file,'' and contains all of your personal customizations. | |
2121 | ||
2122 | @item | |
2123 | You can type the form in the @file{*scratch*} buffer, and then type | |
2124 | @key{LFD} (or @kbd{C-j}) after it. The result of evaluating the form | |
2125 | will be inserted in the buffer. | |
2126 | ||
2127 | @item | |
2128 | In @code{emacs-lisp-mode}, typing @kbd{C-M-x} evaluates a top-level form | |
2129 | before or around point. | |
2130 | ||
2131 | @item | |
2132 | Typing @kbd{C-x C-e} in any buffer evaluates the Lisp form immediately | |
2133 | before point and prints its value in the echo area. | |
2134 | ||
2135 | @item | |
2136 | Typing @kbd{M-:} or @kbd{M-x eval-expression} allows you to type a Lisp | |
2137 | form in the minibuffer which will be evaluated once you press @key{RET}. | |
2138 | ||
2139 | @item | |
2140 | You can use @kbd{M-x load-file} to have Emacs evaluate all the Lisp | |
2141 | forms in a file. (To do this from Lisp use the function @code{load} | |
2142 | instead.) | |
2143 | ||
2144 | The functions @code{load-library}, @code{eval-region}, | |
2145 | @code{eval-buffer}, @code{require}, and @code{autoload} are also | |
2146 | useful; see @ref{Emacs Lisp documentation}, if you want to learn more | |
2147 | about them. | |
2148 | ||
2149 | @end itemize | |
2150 | ||
f0bf7708 | 2151 | @node Changing the length of a Tab |
4009494e GM |
2152 | @section How do I change Emacs's idea of the @key{TAB} character's length? |
2153 | @cindex Tab length | |
2154 | @cindex Length of tab character | |
4009494e | 2155 | |
4e3b4528 | 2156 | Set the default value of the variable @code{tab-width}. For example, to set |
4009494e GM |
2157 | @key{TAB} stops every 10 characters, insert the following in your |
2158 | @file{.emacs} file: | |
2159 | ||
2160 | @lisp | |
4e3b4528 | 2161 | (setq-default tab-width 10) |
4009494e GM |
2162 | @end lisp |
2163 | ||
2164 | Do not confuse variable @code{tab-width} with variable | |
2165 | @code{tab-stop-list}. The former is used for the display of literal | |
2166 | @key{TAB} characters. The latter controls what characters are inserted | |
2167 | when you press the @key{TAB} character in certain modes. | |
2168 | ||
f0bf7708 | 2169 | @node Inserting text at the beginning of each line |
4009494e GM |
2170 | @section How do I insert <some text> at the beginning of every line? |
2171 | @cindex Prefixing a region with some text | |
2172 | @cindex Prefix character, inserting in mail/news replies | |
2173 | @cindex Replies to mail/news, inserting a prefix character | |
2174 | @cindex @code{mail-yank-prefix} | |
2175 | @cindex Mail replies, inserting a prefix character | |
2176 | @cindex News replies, inserting a prefix character | |
2177 | ||
2178 | To do this to an entire buffer, type @kbd{M-< M-x replace-regexp | |
2179 | @key{RET} ^ @key{RET} your text @key{RET}}. | |
2180 | ||
2181 | To do this to a region, use @code{string-insert-rectangle}. | |
2182 | Set the mark (@kbd{C-@key{SPC}}) at the beginning of the first line you | |
2183 | want to prefix, move the cursor to last line to be prefixed, and type | |
2184 | @kbd{M-x string-insert-rectangle @key{RET}}. To do this for the whole | |
2185 | buffer, type @kbd{C-x h M-x string-insert-rectangle @key{RET}}. | |
2186 | ||
2187 | If you are trying to prefix a yanked mail message with @samp{>}, you | |
2188 | might want to set the variable @code{mail-yank-prefix}. In Message | |
2189 | buffers, you can even use @kbd{M-;} to cite yanked messages (@kbd{M-;} | |
2190 | runs the function @code{comment-region}, it is a general-purpose | |
2191 | mechanism to comment regions) (@pxref{Changing the included text prefix}). | |
2192 | ||
f0bf7708 | 2193 | @node Forcing the cursor to remain in the same column |
4009494e GM |
2194 | @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? |
2195 | @cindex @code{picture-mode} | |
2196 | @cindex Remaining in the same column, regardless of contents | |
2197 | @cindex Vertical movement in empty documents | |
2198 | ||
2199 | Use @kbd{M-x picture-mode}. | |
2200 | ||
2201 | See also the variable @code{track-eol} and the command | |
2202 | @code{set-goal-column} bound to @kbd{C-x C-n} | |
2203 | (@pxref{Moving Point, , , emacs, The GNU Emacs Manual}). | |
2204 | ||
f0bf7708 | 2205 | @node Forcing Emacs to iconify itself |
4009494e GM |
2206 | @section How do I tell Emacs to iconify itself? |
2207 | @cindex Iconification under the X Window System | |
2208 | @cindex X Window System and iconification | |
2209 | @cindex Suspending Emacs | |
2210 | ||
2211 | @kbd{C-z} iconifies Emacs when running under X and suspends Emacs | |
2212 | otherwise. @inforef{Frame Commands, Frame Commands, emacs}. | |
2213 | ||
f0bf7708 | 2214 | @node Using regular expressions |
4009494e GM |
2215 | @section How do I use regexps (regular expressions) in Emacs? |
2216 | @cindex Regexps | |
2217 | @cindex Regular expressions | |
2218 | @cindex Differences between Unix and Emacs regexps | |
2219 | @cindex Unix regexps, differences from Emacs | |
2220 | @cindex Text strings, putting regexps in | |
2221 | ||
2222 | @inforef{Regexp Backslash, Regexp Backslash, emacs}. | |
2223 | ||
2224 | The @code{or} operator is @samp{\|}, not @samp{|}, and the grouping operators | |
2225 | are @samp{\(} and @samp{\)}. Also, the string syntax for a backslash is | |
2226 | @samp{\\}. To specify a regular expression like @samp{xxx\(foo\|bar\)} | |
2227 | in a Lisp string, use @samp{xxx\\(foo\\|bar\\)}. | |
2228 | ||
2229 | Note the doubled backslashes! | |
2230 | ||
2231 | @itemize @bullet | |
2232 | ||
2233 | @item | |
2234 | Unlike in Unix @file{grep}, @file{sed}, etc., a complement character set | |
2235 | (@samp{[^...]}) can match a newline character (@key{LFD} a.k.a.@: | |
2236 | @kbd{C-j} a.k.a.@: @samp{\n}), unless newline is mentioned as one of the | |
2237 | characters not to match. | |
2238 | ||
2239 | @item | |
2240 | The character syntax regexps (e.g., @samp{\sw}) are not | |
2241 | meaningful inside character set regexps (e.g., @samp{[aeiou]}). (This | |
2242 | is actually typical for regexp syntax.) | |
2243 | ||
2244 | @end itemize | |
2245 | ||
f0bf7708 | 2246 | @node Replacing text across multiple files |
4009494e GM |
2247 | @section How do I perform a replace operation across more than one file? |
2248 | @cindex Replacing strings across files | |
2249 | @cindex Multiple files, replacing across | |
2250 | @cindex Files, replacing strings across multiple | |
2251 | @cindex Recursive search/replace operations | |
2252 | ||
2e17e05e GM |
2253 | Dired mode (@kbd{M-x dired @key{RET}}, or @kbd{C-x d}) supports the |
2254 | command @code{dired-do-query-replace-regexp} (@kbd{Q}), which allows | |
2255 | users to replace regular expressions in multiple files. | |
4009494e GM |
2256 | |
2257 | You can use this command to perform search/replace operations on | |
2258 | multiple files by following the following steps: | |
2259 | ||
2260 | @itemize @bullet | |
2261 | @item | |
2262 | Assemble a list of files you want to operate on with either | |
2263 | @code{find-dired}, @code{find-name-dired} or @code{find-grep-dired}. | |
2264 | ||
2265 | @item | |
2266 | Mark all files in the resulting Dired buffer using @kbd{t}. | |
2267 | ||
2268 | @item | |
2269 | Use @kbd{Q} to start a @code{query-replace-regexp} session on the marked | |
2270 | files. | |
2271 | ||
2272 | @item | |
2273 | To accept all replacements in each file, hit @kbd{!}. | |
2274 | @end itemize | |
2275 | ||
2276 | Another way to do the same thing is to use the ``tags'' feature of | |
2277 | Emacs: it includes the command @code{tags-query-replace} which performs | |
2278 | a query-replace across all the files mentioned in the @file{TAGS} file. | |
2279 | @inforef{Tags Search, Tags Search, emacs}. | |
2280 | ||
f0bf7708 | 2281 | @node Documentation for etags |
4009494e GM |
2282 | @section Where is the documentation for @code{etags}? |
2283 | @cindex Documentation for @code{etags} | |
2284 | @cindex @code{etags}, documentation for | |
2285 | ||
2286 | The @code{etags} man page should be in the same place as the | |
2287 | @code{emacs} man page. | |
2288 | ||
2289 | Quick command-line switch descriptions are also available. For example, | |
2290 | @samp{etags -H}. | |
2291 | ||
f0bf7708 | 2292 | @node Disabling backups |
4009494e GM |
2293 | @section How do I disable backup files? |
2294 | @cindex Backups, disabling | |
2295 | @cindex Disabling backups | |
2296 | ||
2297 | You probably don't want to do this, since backups are useful, especially | |
2298 | when something goes wrong. | |
2299 | ||
2300 | To avoid seeing backup files (and other ``uninteresting'' files) in Dired, | |
2301 | load @code{dired-x} by adding the following to your @file{.emacs} file: | |
2302 | ||
2303 | @lisp | |
2304 | (add-hook 'dired-load-hook | |
2305 | (lambda () | |
2e17e05e | 2306 | (require 'dired-x))) |
4009494e GM |
2307 | @end lisp |
2308 | ||
2309 | With @code{dired-x} loaded, @kbd{M-o} toggles omitting in each dired buffer. | |
2310 | You can make omitting the default for new dired buffers by putting the | |
2311 | following in your @file{.emacs}: | |
2312 | ||
2313 | @lisp | |
2314 | (add-hook 'dired-mode-hook 'dired-omit-toggle) | |
2315 | @end lisp | |
2316 | ||
2317 | If you're tired of seeing backup files whenever you do an @samp{ls} at | |
2318 | the Unix shell, try GNU @code{ls} with the @samp{-B} option. GNU | |
2319 | @code{ls} is part of the GNU Fileutils package, available from | |
2320 | @samp{ftp.gnu.org} and its mirrors (@pxref{Current GNU distributions}). | |
2321 | ||
2322 | To disable or change the way backups are made, @inforef{Backup Names, , | |
2323 | emacs}. | |
2324 | ||
2325 | @cindex Backup files in a single directory | |
2326 | Beginning with Emacs 21.1, you can control where Emacs puts backup files | |
2327 | by customizing the variable @code{backup-directory-alist}. This | |
2328 | variable's value specifies that files whose names match specific patters | |
2329 | should have their backups put in certain directories. A typical use is | |
2330 | to add the element @code{("." . @var{dir})} to force Emacs to put | |
2331 | @strong{all} backup files in the directory @file{dir}. | |
2332 | ||
f0bf7708 | 2333 | @node Disabling auto-save-mode |
4009494e GM |
2334 | @section How do I disable @code{auto-save-mode}? |
2335 | @cindex Disabling @code{auto-save-mode} | |
2336 | @cindex Auto-saving | |
2337 | @cindex Saving at frequent intervals | |
2338 | ||
2339 | You probably don't want to do this, since auto-saving is useful, | |
2340 | especially when Emacs or your computer crashes while you are editing a | |
2341 | document. | |
2342 | ||
2343 | Instead, you might want to change the variable | |
2344 | @code{auto-save-interval}, which specifies how many keystrokes Emacs | |
2345 | waits before auto-saving. Increasing this value forces Emacs to wait | |
2346 | longer between auto-saves, which might annoy you less. | |
2347 | ||
2348 | You might also want to look into Sebastian Kremer's @code{auto-save} | |
2349 | package (@pxref{Packages that do not come with Emacs}). This | |
2350 | package also allows you to place all auto-save files in one directory, | |
2351 | such as @file{/tmp}. | |
2352 | ||
2353 | To disable or change how @code{auto-save-mode} works, @inforef{Auto | |
2354 | Save, , emacs}. | |
2355 | ||
f0bf7708 | 2356 | @node Going to a line by number |
4009494e GM |
2357 | @section How can I go to a certain line given its number? |
2358 | @cindex Going to a line by number | |
2359 | @cindex Compilation error messages | |
2360 | @cindex Recompilation | |
2361 | ||
2362 | Are you sure you indeed need to go to a line by its number? Perhaps all | |
2363 | you want is to display a line in your source file for which a compiler | |
2364 | printed an error message? If so, compiling from within Emacs using the | |
2365 | @kbd{M-x compile} and @kbd{M-x recompile} commands is a much more | |
2366 | effective way of doing that. Emacs automatically intercepts the compile | |
2367 | error messages, inserts them into a special buffer called | |
2368 | @code{*compilation*}, and lets you visit the locus of each message in | |
2369 | the source. Type @kbd{C-x `} to step through the offending lines one by | |
2370 | one (starting with Emacs 22, you can also use @kbd{M-g M-p} and | |
2371 | @kbd{M-g M-n} to go to the previous and next matches directly). Click | |
2372 | @kbd{Mouse-2} or press @key{RET} on a message text in the | |
2373 | @code{*compilation*} buffer to go to the line whose number is mentioned | |
2374 | in that message. | |
2375 | ||
2376 | But if you indeed need to go to a certain text line, type @kbd{M-g M-g} | |
2377 | (which is the default binding of the @code{goto-line} function starting | |
2378 | with Emacs 22). Emacs will prompt you for the number of the line and go | |
2379 | to that line. | |
2380 | ||
2381 | You can do this faster by invoking @code{goto-line} with a numeric | |
2382 | argument that is the line's number. For example, @kbd{C-u 286 M-g M-g} | |
2383 | will jump to line number 286 in the current buffer. | |
2384 | ||
f0bf7708 | 2385 | @node Modifying pull-down menus |
4009494e GM |
2386 | @section How can I create or modify new pull-down menu options? |
2387 | @cindex Pull-down menus, creating or modifying | |
2388 | @cindex Menus, creating or modifying | |
2389 | @cindex Creating new menu options | |
2390 | @cindex Modifying pull-down menus | |
2391 | @cindex Menus and keymaps | |
2392 | @cindex Keymaps and menus | |
2393 | ||
2394 | Each menu title (e.g., @samp{File}, @samp{Edit}, @samp{Buffers}) | |
2395 | represents a local or global keymap. Selecting a menu title with the | |
2396 | mouse displays that keymap's non-@code{nil} contents in the form of a menu. | |
2397 | ||
2398 | So to add a menu option to an existing menu, all you have to do is add a | |
2399 | new definition to the appropriate keymap. Adding a @samp{Forward Word} | |
2400 | item to the @samp{Edit} menu thus requires the following Lisp code: | |
2401 | ||
2402 | @lisp | |
2403 | (define-key global-map | |
2404 | [menu-bar edit forward] | |
2405 | '("Forward word" . forward-word)) | |
2406 | @end lisp | |
2407 | ||
2408 | @noindent | |
2409 | The first line adds the entry to the global keymap, which includes | |
2410 | global menu bar entries. Replacing the reference to @code{global-map} | |
2411 | with a local keymap would add this menu option only within a particular | |
2412 | mode. | |
2413 | ||
2414 | The second line describes the path from the menu-bar to the new entry. | |
2415 | Placing this menu entry underneath the @samp{File} menu would mean | |
2416 | changing the word @code{edit} in the second line to @code{file}. | |
2417 | ||
2418 | The third line is a cons cell whose first element is the title that will | |
2419 | be displayed, and whose second element is the function that will be | |
2420 | called when that menu option is invoked. | |
2421 | ||
2422 | To add a new menu, rather than a new option to an existing menu, we must | |
2423 | define an entirely new keymap: | |
2424 | ||
2425 | @lisp | |
2426 | (define-key global-map [menu-bar words] | |
2427 | (cons "Words" (make-sparse-keymap "Words"))) | |
2428 | @end lisp | |
2429 | ||
2430 | The above code creates a new sparse keymap, gives it the name | |
2431 | @samp{Words}, and attaches it to the global menu bar. Adding the | |
2432 | @samp{Forward Word} item to this new menu would thus require the | |
2433 | following code: | |
2434 | ||
2435 | @lisp | |
2436 | (define-key global-map | |
2437 | [menu-bar words forward] | |
2438 | '("Forward word" . forward-word)) | |
2439 | @end lisp | |
2440 | ||
2441 | @noindent | |
2442 | Note that because of the way keymaps work, menu options are displayed | |
2443 | with the more recently defined items at the top. Thus if you were to | |
2444 | define menu options @samp{foo}, @samp{bar}, and @samp{baz} (in that | |
2445 | order), the menu option @samp{baz} would appear at the top, and | |
2446 | @samp{foo} would be at the bottom. | |
2447 | ||
2448 | One way to avoid this problem is to use the function @code{define-key-after}, | |
2449 | which works the same as @code{define-key}, but lets you modify where items | |
2450 | appear. The following Lisp code would insert the @samp{Forward Word} | |
2451 | item in the @samp{Edit} menu immediately following the @samp{Undo} item: | |
2452 | ||
2453 | @lisp | |
2454 | (define-key-after | |
2455 | (lookup-key global-map [menu-bar edit]) | |
2456 | [forward] | |
2457 | '("Forward word" . forward-word) | |
2458 | 'undo) | |
2459 | @end lisp | |
2460 | ||
2461 | Note how the second and third arguments to @code{define-key-after} are | |
2462 | different from those of @code{define-key}, and that we have added a new | |
2463 | (final) argument, the function after which our new key should be | |
2464 | defined. | |
2465 | ||
2466 | To move a menu option from one position to another, simply evaluate | |
2467 | @code{define-key-after} with the appropriate final argument. | |
2468 | ||
2469 | More detailed information---and more examples of how to create and | |
2470 | modify menu options---are in the @cite{Emacs Lisp Reference Manual}, under | |
2471 | ``Menu Keymaps.'' (@xref{Emacs Lisp documentation}, for information on | |
2472 | this manual.) | |
2473 | ||
f0bf7708 | 2474 | @node Deleting menus and menu options |
4009494e GM |
2475 | @section How do I delete menus and menu options? |
2476 | @cindex Deleting menus and menu options | |
2477 | @cindex Menus, deleting | |
2478 | ||
2479 | The simplest way to remove a menu is to set its keymap to @samp{nil}. | |
2480 | For example, to delete the @samp{Words} menu (@pxref{Modifying pull-down | |
2481 | menus}), use: | |
2482 | ||
2483 | @lisp | |
2484 | (define-key global-map [menu-bar words] nil) | |
2485 | @end lisp | |
2486 | ||
2487 | Similarly, removing a menu option requires redefining a keymap entry to | |
2488 | @code{nil}. For example, to delete the @samp{Forward word} menu option | |
2489 | from the @samp{Edit} menu (we added it in @ref{Modifying pull-down | |
2490 | menus}), use: | |
2491 | ||
2492 | @lisp | |
2493 | (define-key global-map [menu-bar edit forward] nil) | |
2494 | @end lisp | |
2495 | ||
f0bf7708 | 2496 | @node Turning on syntax highlighting |
4009494e GM |
2497 | @section How do I turn on syntax highlighting? |
2498 | @cindex Syntax highlighting | |
2499 | @cindex @code{font-lock-mode} | |
2500 | @cindex Highlighting based on syntax | |
2501 | @cindex Colorizing text | |
2502 | @cindex FAQ, @code{font-lock-mode} | |
2503 | ||
2504 | @code{font-lock-mode} is the standard way to have Emacs perform syntax | |
2505 | highlighting in the current buffer. It is enabled by default in Emacs | |
2506 | 22.1 and later. | |
2507 | ||
2508 | With @code{font-lock-mode} turned on, different types of text will | |
2509 | appear in different colors. For instance, in a programming mode, | |
2510 | variables will appear in one face, keywords in a second, and comments in | |
2511 | a third. | |
2512 | ||
4009494e GM |
2513 | To turn @code{font-lock-mode} off within an existing buffer, use |
2514 | @kbd{M-x font-lock-mode @key{RET}}. | |
2515 | ||
2516 | In Emacs 21 and earlier versions, you could use the following code in | |
2517 | your @file{.emacs} file to turn on @code{font-lock-mode} globally: | |
2518 | ||
2519 | @lisp | |
2520 | (global-font-lock-mode 1) | |
2521 | @end lisp | |
2522 | ||
2523 | Highlighting a buffer with @code{font-lock-mode} can take quite a while, | |
2524 | and cause an annoying delay in display, so several features exist to | |
2525 | work around this. | |
2526 | ||
2527 | @cindex Just-In-Time syntax highlighting | |
2528 | In Emacs 21 and later, turning on @code{font-lock-mode} automatically | |
2529 | activates the new @dfn{Just-In-Time fontification} provided by | |
2530 | @code{jit-lock-mode}. @code{jit-lock-mode} defers the fontification of | |
2531 | portions of buffer until you actually need to see them, and can also | |
2532 | fontify while Emacs is idle. This makes display of the visible portion | |
2533 | of a buffer almost instantaneous. For details about customizing | |
2534 | @code{jit-lock-mode}, type @kbd{C-h f jit-lock-mode @key{RET}}. | |
2535 | ||
2536 | @cindex Levels of syntax highlighting | |
2537 | @cindex Decoration level, in @code{font-lock-mode} | |
2538 | In versions of Emacs before 21, different levels of decoration are | |
2539 | available, from slight to gaudy. More decoration means you need to wait | |
2540 | more time for a buffer to be fontified (or a faster machine). To | |
2541 | control how decorated your buffers should become, set the value of | |
2542 | @code{font-lock-maximum-decoration} in your @file{.emacs} file, with a | |
2543 | @code{nil} value indicating default (usually minimum) decoration, and a | |
2544 | @code{t} value indicating the maximum decoration. For the gaudiest | |
2545 | possible look, then, include the line | |
2546 | ||
2547 | @lisp | |
2548 | (setq font-lock-maximum-decoration t) | |
2549 | @end lisp | |
2550 | ||
2551 | @noindent | |
2552 | in your @file{.emacs} file. You can also set this variable such that | |
2553 | different modes are highlighted in a different ways; for more | |
2554 | information, see the documentation for | |
2555 | @code{font-lock-maximum-decoration} with @kbd{C-h v} (or @kbd{M-x | |
2556 | describe-variable @key{RET}}). | |
2557 | ||
2558 | Also see the documentation for the function @code{font-lock-mode}, | |
2559 | available by typing @kbd{C-h f font-lock-mode} (@kbd{M-x | |
2560 | describe-function @key{RET} font-lock-mode @key{RET}}). | |
2561 | ||
2562 | To print buffers with the faces (i.e., colors and fonts) intact, use | |
2563 | @kbd{M-x ps-print-buffer-with-faces} or @kbd{M-x | |
2564 | ps-print-region-with-faces}. You will need a way to send text to a | |
2565 | PostScript printer, or a PostScript interpreter such as Ghostscript; | |
2566 | consult the documentation of the variables @code{ps-printer-name}, | |
2567 | @code{ps-lpr-command}, and @code{ps-lpr-switches} for more details. | |
2568 | ||
f0bf7708 | 2569 | @node Scrolling only one line |
4009494e GM |
2570 | @section How can I force Emacs to scroll only one line when I move past the bottom of the screen? |
2571 | @cindex Scrolling only one line | |
2572 | @cindex Reducing the increment when scrolling | |
2573 | ||
2574 | Customize the @code{scroll-conservatively} variable with @kbd{M-x | |
2575 | customize-variable @key{RET} scroll-conservatively @key{RET}} and set it | |
2576 | to a large value like, say, 10000. For an explanation of what this | |
2577 | means, @inforef{Auto Scrolling, Auto Scrolling, emacs}. | |
2578 | ||
2579 | Alternatively, use the following Lisp form in your @file{.emacs}: | |
2580 | ||
2581 | @lisp | |
2582 | (setq scroll-conservatively most-positive-fixnum) | |
2583 | @end lisp | |
2584 | ||
f0bf7708 | 2585 | @node Editing MS-DOS files |
4009494e GM |
2586 | @section How can I edit MS-DOS files using Emacs? |
2587 | @cindex Editing MS-DOS files | |
2588 | @cindex MS-DOS files, editing | |
2589 | @cindex Microsoft files, editing | |
2590 | @cindex Windows files, editing | |
2591 | ||
2592 | As of Emacs 20, detection and handling of MS-DOS (and Windows) files is | |
2593 | performed transparently. You can open MS-DOS files on a Unix system, | |
2594 | edit it, and save it without having to worry about the file format. | |
2595 | ||
2596 | When editing an MS-DOS style file, the mode line will indicate that it | |
2597 | is a DOS file. On Unix and GNU/Linux systems, and also on a Macintosh, | |
2598 | the string @samp{(DOS)} will appear near the left edge of the mode line; | |
2599 | on DOS and Windows, where the DOS end-of-line (EOL) format is the | |
2600 | default, a backslash (@samp{\}) will appear in the mode line. | |
2601 | ||
f0bf7708 | 2602 | @node Filling paragraphs with a single space |
4009494e GM |
2603 | @section How can I tell Emacs to fill paragraphs with a single space after each period? |
2604 | @cindex One space following periods | |
2605 | @cindex Single space following periods | |
2606 | @cindex Periods, one space following | |
2607 | ||
2608 | Add the following line to your @file{.emacs} file: | |
2609 | ||
2610 | @lisp | |
2611 | (setq sentence-end-double-space nil) | |
2612 | @end lisp | |
2613 | ||
f0bf7708 | 2614 | @node Escape sequences in shell output |
4009494e GM |
2615 | @section Why these strange escape sequences from @code{ls} from the Shell mode? |
2616 | @cindex Escape sequences in @code{ls} output | |
2617 | @cindex @code{ls} in Shell mode | |
2618 | ||
d99aaebd CY |
2619 | In many systems, @code{ls} is aliased to @samp{ls --color}, which |
2620 | prints using ANSI color escape sequences. Emacs version 21.1 and | |
2621 | later includes the @code{ansi-color} package, which lets Shell mode | |
2622 | recognize these escape sequences. In Emacs 23.2 and later, the | |
2623 | package is enabled by default; in earlier versions you can enable it | |
2624 | by typing @kbd{M-x ansi-color-for-comint-mode} in the Shell buffer, or | |
2625 | by adding @code{(add-hook 'shell-mode-hook | |
2626 | 'ansi-color-for-comint-mode-on)} to your init file. | |
2627 | ||
2628 | In Emacs versions before 21.1, the @code{ansi-color} package is not | |
2629 | included. In that case, you need to unalias @code{ls} for interactive | |
2630 | shells running in Emacs; this can be done by checking the @code{EMACS} | |
2631 | variable in the environment. | |
4009494e | 2632 | |
f0bf7708 | 2633 | @node Fullscreen mode on MS-Windows |
4009494e GM |
2634 | @section How can I start Emacs in fullscreen mode on MS-Windows? |
2635 | @cindex Maximize frame | |
2636 | @cindex Fullscreen mode | |
2637 | ||
2638 | Use the function @code{w32-send-sys-command}. For example, you can | |
2639 | put the following in your @file{.emacs} file: | |
2640 | ||
2641 | @lisp | |
2642 | (add-hook 'term-setup-hook | |
2643 | #'(lambda () (w32-send-sys-command ?\xF030))) | |
2644 | @end lisp | |
2645 | ||
2646 | To avoid the slightly distracting visual effect of Emacs starting with | |
2647 | its default frame size and then growing to fullscreen, you can add an | |
2648 | @samp{Emacs.Geometry} entry to the Windows registry settings (see | |
2649 | @pxref{(emacs)X Resources}). | |
2650 | ||
2651 | To compute the correct values for width and height, first maximize the | |
2652 | Emacs frame and then evaluate @code{(frame-height)} and | |
2653 | @code{(frame-width)} with @kbd{M-:}. | |
2654 | ||
2655 | @c ------------------------------------------------------------ | |
f0bf7708 | 2656 | @node Bugs and problems |
4009494e GM |
2657 | @chapter Bugs and problems |
2658 | @cindex Bugs and problems | |
2659 | ||
2660 | The Emacs manual lists some common kinds of trouble users could get | |
2661 | into, see @ref{Lossage, , Dealing with Emacs Trouble, emacs, The GNU | |
2662 | Emacs Manual}, so you might look there if the problem you encounter | |
2663 | isn't described in this chapter. If you decide you've discovered a bug, | |
2664 | see @ref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}, for | |
2665 | instructions how to do that. | |
2666 | ||
2667 | The file @file{etc/PROBLEMS} in the Emacs distribution lists various | |
2668 | known problems with building and using Emacs on specific platforms; | |
b59a8457 | 2669 | type @kbd{C-h C-p} to read it. |
4009494e GM |
2670 | |
2671 | @menu | |
2672 | * Problems with very large files:: | |
2673 | * ^M in the shell buffer:: | |
b59a8457 | 2674 | * Problems with Shell Mode:: |
4009494e | 2675 | * Termcap/Terminfo entries for Emacs:: |
4009494e GM |
2676 | * Errors with init files:: |
2677 | * Emacs ignores X resources:: | |
2678 | * Emacs ignores frame parameters:: | |
4009494e GM |
2679 | * Editing files with $ in the name:: |
2680 | * Shell mode loses the current directory:: | |
2681 | * Security risks with Emacs:: | |
2682 | * Dired claims that no file is on this line:: | |
2683 | @end menu | |
2684 | ||
f0bf7708 | 2685 | @node Problems with very large files |
4009494e GM |
2686 | @section Does Emacs have problems with files larger than 8 megabytes? |
2687 | @cindex Very large files, opening | |
2688 | @cindex Large files, opening | |
2689 | @cindex Opening very large files | |
2690 | @cindex Maximum file size | |
2691 | @cindex Files, maximum size | |
2692 | ||
2693 | Old versions (i.e., anything before 19.29) of Emacs had problems editing | |
2694 | files larger than 8 megabytes. In versions 19.29 and later, the maximum | |
2695 | buffer size is at least 2^27-1, or 134,217,727 bytes, or 132 MBytes. | |
16f6287e GM |
2696 | The maximum buffer size on 32-bit machines increased to 256 MBytes in |
2697 | Emacs 22, and again to 512 MBytes in Emacs 23.2. | |
4009494e | 2698 | |
b59a8457 GM |
2699 | Emacs compiled on a 64-bit machine can handle much larger buffers. |
2700 | ||
f0bf7708 | 2701 | @node ^M in the shell buffer |
4009494e GM |
2702 | @section How do I get rid of @samp{^M} or echoed commands in my shell buffer? |
2703 | @cindex Shell buffer, echoed commands and @samp{^M} in | |
2704 | @cindex Echoed commands in @code{shell-mode} | |
2705 | ||
2706 | Try typing @kbd{M-x shell-strip-ctrl-m @key{RET}} while in @code{shell-mode} to | |
2707 | make them go away. If that doesn't work, you have several options: | |
2708 | ||
2709 | For @code{tcsh}, put this in your @file{.cshrc} (or @file{.tcshrc}) | |
2710 | file: | |
2711 | ||
2712 | @example | |
2713 | if ($?EMACS) then | |
2714 | if ("$EMACS" =~ /*) then | |
2715 | if ($?tcsh) unset edit | |
2716 | stty nl | |
2717 | endif | |
2718 | endif | |
2719 | @end example | |
2720 | ||
2721 | Or put this in your @file{.emacs_tcsh} or @file{~/.emacs.d/init_tcsh.sh} file: | |
2722 | ||
2723 | @example | |
2724 | unset edit | |
2725 | stty nl | |
2726 | @end example | |
2727 | ||
2728 | Alternatively, use @code{csh} in your shell buffers instead of | |
2729 | @code{tcsh}. One way is: | |
2730 | ||
2731 | @lisp | |
2732 | (setq explicit-shell-file-name "/bin/csh") | |
2733 | @end lisp | |
2734 | ||
2735 | @noindent | |
2736 | and another is to do this in your @file{.cshrc} (or @file{.tcshrc}) | |
2737 | file: | |
2738 | ||
2739 | @example | |
2740 | setenv ESHELL /bin/csh | |
2741 | @end example | |
2742 | ||
2743 | @noindent | |
2744 | (You must start Emacs over again with the environment variable properly | |
2745 | set for this to take effect.) | |
2746 | ||
2747 | You can also set the @code{ESHELL} environment variable in Emacs Lisp | |
2748 | with the following Lisp form, | |
2749 | ||
2750 | @lisp | |
2751 | (setenv "ESHELL" "/bin/csh") | |
2752 | @end lisp | |
2753 | ||
2754 | The above solutions try to prevent the shell from producing the | |
2755 | @samp{^M} characters in the first place. If this is not possible | |
2756 | (e.g., if you use a Windows shell), you can get Emacs to remove these | |
2757 | characters from the buffer by adding this to your @file{.emacs} init | |
2758 | file: | |
2759 | ||
2760 | @smalllisp | |
2761 | (add-hook 'comint-output-filter-functions 'shell-strip-ctrl-m) | |
2762 | @end smalllisp | |
2763 | ||
2764 | On a related note: if your shell is echoing your input line in the shell | |
2765 | buffer, you might want to customize the @code{comint-process-echoes} | |
2766 | variable in your shell buffers, or try the following command in your | |
2767 | shell start-up file: | |
2768 | ||
2769 | @example | |
2770 | stty -icrnl -onlcr -echo susp ^Z | |
2771 | @end example | |
2772 | ||
b59a8457 | 2773 | @node Problems with Shell Mode |
4009494e GM |
2774 | @section Why do I get an error message when I try to run @kbd{M-x shell}? |
2775 | ||
b59a8457 | 2776 | @cindex Shell Mode, problems |
4009494e | 2777 | @cindex @code{explicit-shell-file-name} |
b59a8457 GM |
2778 | This might happen because Emacs tries to look for the shell in a wrong |
2779 | place. If you know where your shell executable is, set the variable | |
2780 | @code{explicit-shell-file-name} in your @file{.emacs} file to point to | |
2781 | its full file name. | |
4009494e GM |
2782 | |
2783 | @cindex Antivirus programs, and Shell Mode | |
b59a8457 GM |
2784 | Some people have trouble with Shell Mode on MS-Windows because of |
2785 | intrusive antivirus software; disabling the resident antivirus program | |
2786 | solves the problems in those cases. | |
4009494e | 2787 | |
f0bf7708 | 2788 | @node Termcap/Terminfo entries for Emacs |
4009494e GM |
2789 | @section Where is the termcap/terminfo entry for terminal type @samp{emacs}? |
2790 | @cindex Termcap | |
2791 | @cindex Terminfo | |
2792 | @cindex Emacs entries for termcap/terminfo | |
2793 | ||
2794 | The termcap entry for terminal type @samp{emacs} is ordinarily put in | |
2795 | the @samp{TERMCAP} environment variable of subshells. It may help in | |
2796 | certain situations (e.g., using rlogin from shell buffer) to add an | |
2797 | entry for @samp{emacs} to the system-wide termcap file. Here is a | |
2798 | correct termcap entry for @samp{emacs}: | |
2799 | ||
2800 | @example | |
2801 | emacs:tc=unknown: | |
2802 | @end example | |
2803 | ||
2804 | To make a terminfo entry for @samp{emacs}, use @code{tic} or | |
2805 | @code{captoinfo}. You need to generate | |
2806 | @file{/usr/lib/terminfo/e/emacs}. It may work to simply copy | |
2807 | @file{/usr/lib/terminfo/d/dumb} to @file{/usr/lib/terminfo/e/emacs}. | |
2808 | ||
2809 | Having a termcap/terminfo entry will not enable the use of full screen | |
2810 | programs in shell buffers. Use @kbd{M-x terminal-emulator} for that | |
2811 | instead. | |
2812 | ||
2813 | A workaround to the problem of missing termcap/terminfo entries is to | |
2814 | change terminal type @samp{emacs} to type @samp{dumb} or @samp{unknown} | |
2815 | in your shell start up file. @code{csh} users could put this in their | |
2816 | @file{.cshrc} files: | |
2817 | ||
2818 | @example | |
2819 | if ("$term" == emacs) set term=dumb | |
2820 | @end example | |
2821 | ||
f0bf7708 | 2822 | @node Errors with init files |
4009494e GM |
2823 | @section Why does Emacs say @samp{Error in init file}? |
2824 | @cindex Error in @file{.emacs} | |
2825 | @cindex Error in init file | |
2826 | @cindex Init file, errors in | |
2827 | @cindex @file{.emacs} file, errors in | |
2828 | @cindex Debugging @file{.emacs} file | |
2829 | ||
2830 | An error occurred while loading either your @file{.emacs} file or the | |
85b438b7 | 2831 | system-wide file @file{site-lisp/default.el}. Emacs 21.1 and later pops the |
4009494e GM |
2832 | @file{*Messages*} buffer, and puts there some additional information |
2833 | about the error, to provide some hints for debugging. | |
2834 | ||
2835 | For information on how to debug your @file{.emacs} file, see | |
2836 | @ref{Debugging a customization file}. | |
2837 | ||
2838 | It may be the case that you need to load some package first, or use a | |
2839 | hook that will be evaluated after the package is loaded. A common case | |
2840 | of this is explained in @ref{Terminal setup code works after Emacs has | |
2841 | begun}. | |
2842 | ||
f0bf7708 | 2843 | @node Emacs ignores X resources |
4009494e GM |
2844 | @section Why does Emacs ignore my X resources (my .Xdefaults file)? |
2845 | @cindex X resources being ignored | |
2846 | @cindex Ignored X resources | |
2847 | @cindex @file{.Xdefaults} | |
2848 | ||
2849 | As of version 19, Emacs searches for X resources in the files specified | |
2850 | by the following environment variables: | |
2851 | ||
2852 | @itemize @bullet | |
2853 | ||
2854 | @item @code{XFILESEARCHPATH} | |
2855 | @item @code{XUSERFILESEARCHPATH} | |
2856 | @item @code{XAPPLRESDIR} | |
2857 | ||
2858 | @end itemize | |
2859 | ||
2860 | This emulates the functionality provided by programs written using the | |
2861 | Xt toolkit. | |
2862 | ||
2863 | @code{XFILESEARCHPATH} and @code{XUSERFILESEARCHPATH} should be a list | |
2864 | of file names separated by colons. @code{XAPPLRESDIR} should be a list | |
2865 | of directory names separated by colons. | |
2866 | ||
2867 | Emacs searches for X resources: | |
2868 | ||
2869 | @enumerate | |
2870 | ||
2871 | @item | |
2872 | specified on the command line, with the @samp{-xrm RESOURCESTRING} option, | |
2873 | ||
2874 | @item | |
2875 | then in the value of the @samp{XENVIRONMENT} environment variable, | |
2876 | ||
2877 | @itemize @minus | |
2878 | ||
2879 | @item | |
2880 | or if that is unset, in the file named | |
2881 | @file{~/.Xdefaults-@var{hostname}} if it exists (where @var{hostname} is | |
2882 | the name of the machine Emacs is running on), | |
2883 | ||
2884 | @end itemize | |
2885 | ||
2886 | @item | |
2887 | then in the screen-specific and server-wide resource properties provided | |
2888 | by the server, | |
2889 | ||
2890 | @itemize @minus | |
2891 | ||
2892 | @item | |
2893 | or if those properties are unset, in the file named @file{~/.Xdefaults} | |
2894 | if it exists, | |
2895 | ||
2896 | @end itemize | |
2897 | ||
2898 | @item | |
2899 | then in the files listed in @samp{XUSERFILESEARCHPATH}, | |
2900 | ||
2901 | @itemize @minus | |
2902 | ||
2903 | @item | |
2904 | or in files named @file{@var{lang}/Emacs} in directories listed in | |
2905 | @samp{XAPPLRESDIR} (where @var{lang} is the value of the @code{LANG} | |
2906 | environment variable), if the @samp{LANG} environment variable is set, | |
2907 | @item | |
2908 | or in files named Emacs in the directories listed in @samp{XAPPLRESDIR} | |
2909 | @item | |
2910 | or in @file{~/@var{lang}/Emacs} (if the @code{LANG} environment variable | |
2911 | is set), | |
2912 | @item | |
2913 | or in @file{~/Emacs}, | |
2914 | ||
2915 | @end itemize | |
2916 | ||
2917 | @item | |
2918 | then in the files listed in @code{XFILESEARCHPATH}. | |
2919 | ||
2920 | @end enumerate | |
2921 | ||
f0bf7708 | 2922 | @node Emacs ignores frame parameters |
4009494e GM |
2923 | @section Why don't my customizations of the frame parameters work? |
2924 | @cindex Frame parameters | |
2925 | ||
2926 | This probably happens because you have set the frame parameters in the | |
2927 | variable @code{initial-frame-alist}. That variable holds parameters | |
2928 | used only for the first frame created when Emacs starts. To customize | |
2929 | the parameters of all frames, change the variable | |
2930 | @code{default-frame-alist} instead. | |
2931 | ||
2932 | These two variables exist because many users customize the initial frame | |
2933 | in a special way. For example, you could determine the position and | |
2934 | size of the initial frame, but would like to control the geometry of the | |
2935 | other frames by individually positioning each one of them. | |
2936 | ||
2937 | ||
f0bf7708 | 2938 | @node Editing files with $ in the name |
4009494e GM |
2939 | @section How do I edit a file with a @samp{$} in its name? |
2940 | @cindex Editing files with @samp{$} in the name | |
2941 | @cindex @samp{$} in file names | |
2942 | @cindex File names containing @samp{$}, editing | |
2943 | ||
2944 | When entering a file name in the minibuffer, Emacs will attempt to expand | |
2945 | a @samp{$} followed by a word as an environment variable. To suppress | |
2946 | this behavior, type @kbd{$$} instead. | |
2947 | ||
f0bf7708 | 2948 | @node Shell mode loses the current directory |
4009494e GM |
2949 | @section Why does shell mode lose track of the shell's current directory? |
2950 | @cindex Current directory and @code{shell-mode} | |
2951 | @cindex @code{shell-mode} and current directory | |
2952 | @cindex Directory, current in @code{shell-mode} | |
2953 | ||
2954 | Emacs has no way of knowing when the shell actually changes its | |
2955 | directory. This is an intrinsic limitation of Unix. So it tries to | |
2956 | guess by recognizing @samp{cd} commands. If you type @kbd{cd} followed | |
2957 | by a directory name with a variable reference (@kbd{cd $HOME/bin}) or | |
2958 | with a shell metacharacter (@kbd{cd ../lib*}), Emacs will fail to | |
2959 | correctly guess the shell's new current directory. A huge variety of | |
2960 | fixes and enhancements to shell mode for this problem have been written | |
2961 | to handle this problem (@pxref{Finding a package with particular | |
2962 | functionality}). | |
2963 | ||
2964 | You can tell Emacs the shell's current directory with the command | |
2965 | @kbd{M-x dirs}. | |
2966 | ||
f0bf7708 | 2967 | @node Security risks with Emacs |
4009494e GM |
2968 | @section Are there any security risks in Emacs? |
2969 | @cindex Security with Emacs | |
2970 | @cindex @samp{movemail} and security | |
2971 | @cindex @code{file-local-variable} and security | |
2972 | @cindex Synthetic X events and security | |
2973 | @cindex X events and security | |
2974 | ||
2975 | @itemize @bullet | |
2976 | ||
2977 | @item | |
2978 | The @file{movemail} incident. (No, this is not a risk.) | |
2979 | ||
2980 | In his book @cite{The Cuckoo's Egg}, Cliff Stoll describes this in | |
2981 | chapter 4. The site at LBL had installed the @file{/etc/movemail} | |
2982 | program setuid root. (As of version 19, @file{movemail} is in your | |
2983 | architecture-specific directory; type @kbd{C-h v exec-directory | |
2984 | @key{RET}} to see what it is.) Since @code{movemail} had not been | |
2985 | designed for this situation, a security hole was created and users could | |
2986 | get root privileges. | |
2987 | ||
2988 | @code{movemail} has since been changed so that this security hole will | |
2989 | not exist, even if it is installed setuid root. However, | |
2990 | @code{movemail} no longer needs to be installed setuid root, which | |
2991 | should eliminate this particular risk. | |
2992 | ||
2993 | We have heard unverified reports that the 1988 Internet worm took | |
2994 | advantage of this configuration problem. | |
2995 | ||
2996 | @item | |
2997 | The @code{file-local-variable} feature. (Yes, a risk, but easy to | |
2998 | change.) | |
2999 | ||
3000 | There is an Emacs feature that allows the setting of local values for | |
3001 | variables when editing a file by including specially formatted text near | |
3002 | the end of the file. This feature also includes the ability to have | |
3003 | arbitrary Emacs Lisp code evaluated when the file is visited. | |
3004 | Obviously, there is a potential for Trojan horses to exploit this | |
3005 | feature. | |
3006 | ||
3007 | As of Emacs 22, Emacs has a list of local variables that are known to | |
3008 | be safe to set. If a file tries to set any variable outside this | |
3009 | list, it asks the user to confirm whether the variables should be set. | |
3010 | You can also tell Emacs whether to allow the evaluation of Emacs Lisp | |
3011 | code found at the bottom of files by setting the variable | |
3012 | @code{enable-local-eval}. | |
3013 | ||
3014 | For more information, @inforef{File Variables, File Variables, emacs}. | |
3015 | ||
3016 | @item | |
3017 | Synthetic X events. (Yes, a risk; use @samp{MIT-MAGIC-COOKIE-1} or | |
3018 | better.) | |
3019 | ||
3020 | Emacs accepts synthetic X events generated by the @code{SendEvent} | |
3021 | request as though they were regular events. As a result, if you are | |
3022 | using the trivial host-based authentication, other users who can open X | |
3023 | connections to your X workstation can make your Emacs process do | |
3024 | anything, including run other processes with your privileges. | |
3025 | ||
3026 | The only fix for this is to prevent other users from being able to open | |
3027 | X connections. The standard way to prevent this is to use a real | |
3028 | authentication mechanism, such as @samp{MIT-MAGIC-COOKIE-1}. If using | |
3029 | the @code{xauth} program has any effect, then you are probably using | |
3030 | @samp{MIT-MAGIC-COOKIE-1}. Your site may be using a superior | |
3031 | authentication method; ask your system administrator. | |
3032 | ||
3033 | If real authentication is not a possibility, you may be satisfied by | |
3034 | just allowing hosts access for brief intervals while you start your X | |
3035 | programs, then removing the access. This reduces the risk somewhat by | |
3036 | narrowing the time window when hostile users would have access, but | |
3037 | @emph{does not eliminate the risk}. | |
3038 | ||
3039 | On most computers running Unix and X, you enable and disable | |
3040 | access using the @code{xhost} command. To allow all hosts access to | |
3041 | your X server, use | |
3042 | ||
3043 | @example | |
3044 | xhost + | |
3045 | @end example | |
3046 | ||
3047 | @noindent | |
3048 | at the shell prompt, which (on an HP machine, at least) produces the | |
3049 | following message: | |
3050 | ||
3051 | @example | |
3052 | access control disabled, clients can connect from any host | |
3053 | @end example | |
3054 | ||
3055 | To deny all hosts access to your X server (except those explicitly | |
3056 | allowed by name), use | |
3057 | ||
3058 | @example | |
3059 | xhost - | |
3060 | @end example | |
3061 | ||
3062 | On the test HP computer, this command generated the following message: | |
3063 | ||
3064 | @example | |
3065 | access control enabled, only authorized clients can connect | |
3066 | @end example | |
3067 | ||
3068 | @end itemize | |
3069 | ||
f0bf7708 | 3070 | @node Dired claims that no file is on this line |
4009494e GM |
3071 | @section Dired says, @samp{no file on this line} when I try to do something. |
3072 | @cindex Dired does not see a file | |
3073 | ||
4009494e GM |
3074 | Dired uses a regular expression to find the beginning of a file name. |
3075 | In a long Unix-style directory listing (@samp{ls -l}), the file name | |
3076 | starts after the date. The regexp has thus been written to look for the | |
b59a8457 GM |
3077 | date. By default, it should understand dates and times regardless of |
3078 | the language, but if your directory listing has an unusual format, Dired | |
3079 | may get confused. | |
4009494e GM |
3080 | |
3081 | There are two approaches to solving this. The first one involves | |
b59a8457 GM |
3082 | setting things up so that @samp{ls -l} outputs a more standard format. |
3083 | See your OS manual for more information. | |
4009494e GM |
3084 | |
3085 | The second approach involves changing the regular expression used by | |
3086 | dired, @code{directory-listing-before-filename-regexp}. | |
3087 | ||
3088 | @c ------------------------------------------------------------ | |
f0bf7708 | 3089 | @node Compiling and installing Emacs |
4009494e GM |
3090 | @chapter Compiling and installing Emacs |
3091 | @cindex Compiling and installing Emacs | |
3092 | ||
3093 | @menu | |
3094 | * Installing Emacs:: | |
4009494e | 3095 | * Problems building Emacs:: |
4009494e GM |
3096 | @end menu |
3097 | ||
f0bf7708 | 3098 | @node Installing Emacs |
4009494e GM |
3099 | @section How do I install Emacs? |
3100 | @cindex Installing Emacs | |
3101 | @cindex Unix systems, installing Emacs on | |
3102 | @cindex Downloading and installing Emacs | |
4009494e GM |
3103 | @cindex Building Emacs from source |
3104 | @cindex Source code, building Emacs from | |
4009494e GM |
3105 | |
3106 | This answer is meant for users of Unix and Unix-like systems. Users of | |
3107 | other operating systems should see the series of questions beginning | |
3108 | with @ref{Emacs for MS-DOS}, which describe where to get non-Unix source | |
3109 | and binaries, and how to install Emacs on those systems. | |
3110 | ||
b59a8457 GM |
3111 | Most GNU/Linux distributions provide pre-built Emacs packages. |
3112 | If Emacs is not installed already, you can install it by running (as | |
3113 | root) a command such as @samp{yum install emacs} (Red Hat and | |
3114 | derivatives) or @samp{apt-get install emacs} (Debian and derivatives). | |
3115 | ||
3116 | If you want to compile Emacs yourself, read the file @file{INSTALL} in | |
3117 | the source distribution. In brief: | |
4009494e GM |
3118 | |
3119 | @itemize @bullet | |
3120 | ||
3121 | @item | |
b59a8457 GM |
3122 | First download the Emacs sources. @xref{Current GNU distributions}, for |
3123 | a list of ftp sites that make them available. On @file{ftp.gnu.org}, | |
3124 | the main GNU distribution site, sources are available as | |
4009494e | 3125 | |
b59a8457 GM |
3126 | @c Don't include VER in the file name, because pretests are not there. |
3127 | @uref{ftp://ftp.gnu.org/pub/gnu/emacs/emacs-VERSION.tar.gz} | |
4009494e | 3128 | |
b59a8457 | 3129 | (Replace @samp{VERSION} with the relevant version number, e.g. @samp{23.1}.) |
4009494e | 3130 | |
b59a8457 GM |
3131 | @item |
3132 | Next uncompress and extract the source files. This requires | |
3133 | the @code{gzip} and @code{tar} programs, which are standard utilities. | |
3134 | If your system does not have them, these can also be downloaded from | |
4009494e GM |
3135 | @file{ftp.gnu.org}. |
3136 | ||
b59a8457 | 3137 | GNU @code{tar} can uncompress and extract in a single-step: |
4009494e GM |
3138 | |
3139 | @example | |
b59a8457 | 3140 | tar -zxvf emacs-VERSION.tar.gz |
4009494e GM |
3141 | @end example |
3142 | ||
4009494e | 3143 | @item |
b59a8457 GM |
3144 | At this point, the Emacs sources should be sitting in a directory called |
3145 | @file{emacs-VERSION}. On most common Unix and Unix-like systems, | |
3146 | you should be able to compile Emacs with the following commands: | |
4009494e GM |
3147 | |
3148 | @example | |
b59a8457 | 3149 | cd emacs-VERSION |
4009494e GM |
3150 | ./configure # configure Emacs for your particular system |
3151 | make # use Makefile to build components, then Emacs | |
3152 | @end example | |
3153 | ||
3154 | If the @code{make} completes successfully, the odds are fairly good that | |
3155 | the build has gone well. (@xref{Problems building Emacs}, if you weren't | |
3156 | successful.) | |
3157 | ||
b59a8457 GM |
3158 | @item |
3159 | By default, Emacs is installed in @file{/usr/local}. To actually | |
3160 | install files, become the superuser and type | |
4009494e GM |
3161 | |
3162 | @example | |
3163 | make install | |
3164 | @end example | |
3165 | ||
3166 | Note that @samp{make install} will overwrite @file{/usr/local/bin/emacs} | |
b59a8457 | 3167 | and any Emacs Info files that might be in @file{/usr/local/share/info/}. |
4009494e | 3168 | |
b59a8457 | 3169 | @end itemize |
4009494e | 3170 | |
f0bf7708 | 3171 | @node Problems building Emacs |
4009494e GM |
3172 | @section What should I do if I have trouble building Emacs? |
3173 | @cindex Problems building Emacs | |
3174 | @cindex Errors when building Emacs | |
3175 | ||
3176 | First look in the file @file{etc/PROBLEMS} (where you unpack the Emacs | |
3177 | source) to see if there is already a solution for your problem. Next, | |
3178 | look for other questions in this FAQ that have to do with Emacs | |
3179 | installation and compilation problems. | |
3180 | ||
3181 | If you'd like to have someone look at your problem and help solve it, | |
3182 | see @ref{Help installing Emacs}. | |
3183 | ||
b59a8457 GM |
3184 | If you cannot find a solution in the documentation, please report the |
3185 | problem (@pxref{Reporting bugs}). | |
4009494e | 3186 | |
4009494e GM |
3187 | |
3188 | @c ------------------------------------------------------------ | |
f0bf7708 | 3189 | @node Finding Emacs and related packages |
4009494e GM |
3190 | @chapter Finding Emacs and related packages |
3191 | @cindex Finding Emacs and related packages | |
3192 | ||
3193 | @menu | |
3194 | * Finding Emacs on the Internet:: | |
3195 | * Finding a package with particular functionality:: | |
3196 | * Packages that do not come with Emacs:: | |
3197 | * Current GNU distributions:: | |
3198 | * Difference between Emacs and XEmacs:: | |
8a76755b | 3199 | * Emacs for minimalists:: |
4009494e | 3200 | * Emacs for MS-DOS:: |
b59a8457 | 3201 | * Emacs for MS-Windows:: |
93e2d996 | 3202 | * Emacs for GNUstep:: |
b59a8457 | 3203 | * Emacs for Mac OS X:: |
4009494e GM |
3204 | @end menu |
3205 | ||
f0bf7708 | 3206 | @node Finding Emacs on the Internet |
f6adc23c | 3207 | @section Where can I get Emacs on the net? |
4009494e | 3208 | @cindex Finding Emacs on the Internet |
f6adc23c | 3209 | @cindex Downloading Emacs |
4009494e | 3210 | |
85b438b7 GM |
3211 | Information on downloading Emacs is available at |
3212 | @uref{http://www.gnu.org/software/emacs/, the Emacs home-page}. | |
3213 | ||
4009494e GM |
3214 | @xref{Installing Emacs}, for information on how to obtain and build the latest |
3215 | version of Emacs, and see @ref{Current GNU distributions}, for a list of | |
3216 | archive sites that make GNU software available. | |
3217 | ||
f0bf7708 | 3218 | @node Finding a package with particular functionality |
4009494e GM |
3219 | @section How do I find a Emacs Lisp package that does XXX? |
3220 | @cindex Package, finding | |
3221 | @cindex Finding an Emacs Lisp package | |
3222 | @cindex Functionality, finding a particular package | |
3223 | ||
3224 | First of all, you should check to make sure that the package isn't | |
3225 | already available. For example, typing @kbd{M-x apropos @key{RET} | |
3226 | wordstar @key{RET}} lists all functions and variables containing the | |
3227 | string @samp{wordstar}. | |
3228 | ||
3229 | It is also possible that the package is on your system, but has not been | |
3230 | loaded. To see which packages are available for loading, look through | |
3231 | your computer's lisp directory (@pxref{File-name conventions}). The Lisp | |
3232 | source to most packages contains a short description of how they | |
3233 | should be loaded, invoked, and configured---so before you use or | |
3234 | modify a Lisp package, see if the author has provided any hints in the | |
3235 | source code. | |
3236 | ||
3237 | The command @kbd{C-h p} (@code{finder-by-keyword}) allows you to browse | |
3238 | the constituent Emacs packages. | |
3239 | ||
3240 | For advice on how to find extra packages that are not part of Emacs, | |
3241 | see @ref{Packages that do not come with Emacs}. | |
3242 | ||
f0bf7708 | 3243 | @node Packages that do not come with Emacs |
4009494e GM |
3244 | @section Where can I get Emacs Lisp packages that don't come with Emacs? |
3245 | @cindex Unbundled packages | |
3246 | @cindex Finding other packages | |
3247 | @cindex Lisp packages that do not come with Emacs | |
3248 | @cindex Packages, those that do not come with Emacs | |
3249 | @cindex Emacs Lisp List | |
3250 | @cindex Emacs Lisp Archive | |
3251 | ||
93e2d996 GM |
3252 | @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.html, The Emacs Lisp |
3253 | List (ELL)}, maintained by @email{S.J.Eglen@@damtp.cam.ac.uk, Stephen Eglen}, | |
4009494e GM |
3254 | aims to provide one compact list with links to all of the current Emacs |
3255 | Lisp files on the Internet. The ELL can be browsed over the web, or | |
93e2d996 | 3256 | from Emacs with @uref{http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.el, |
4009494e GM |
3257 | the @file{ell} package}. |
3258 | ||
3259 | Many authors post their packages to the @uref{news:gnu.emacs.sources, | |
3260 | Emacs sources newsgroup}. You can search the archives of this | |
3261 | group with @uref{http://groups.google.com/group/gnu.emacs.sources, Google}, | |
3262 | or @uref{http://dir.gmane.org/gmane.emacs.sources, Gmane}, for example. | |
3263 | ||
3264 | Several packages are stored in | |
3265 | @uref{http://emacswiki.org/elisp/, the Lisp area of the Emacs Wiki}. | |
3266 | ||
4009494e GM |
3267 | Read the file @file{etc/MORE.STUFF} for more information about |
3268 | external packages. | |
3269 | ||
f0bf7708 | 3270 | @node Current GNU distributions |
4009494e GM |
3271 | @section Where can I get other up-to-date GNU stuff? |
3272 | @cindex Current GNU distributions | |
3273 | @cindex Sources for current GNU distributions | |
3274 | @cindex Stuff, current GNU | |
3275 | @cindex Up-to-date GNU stuff | |
3276 | @cindex Finding current GNU software | |
3277 | @cindex Official GNU software sites | |
3278 | ||
3279 | The most up-to-date official GNU software is normally kept at | |
3280 | ||
3281 | @uref{ftp://ftp.gnu.org/pub/gnu} | |
3282 | ||
4009494e GM |
3283 | A list of sites mirroring @samp{ftp.gnu.org} can be found at |
3284 | ||
3285 | @uref{http://www.gnu.org/order/ftp.html} | |
3286 | ||
f0bf7708 | 3287 | @node Difference between Emacs and XEmacs |
4009494e GM |
3288 | @section What is the difference between Emacs and XEmacs (formerly Lucid Emacs)? |
3289 | @cindex XEmacs | |
3290 | @cindex Difference Emacs and XEmacs | |
3291 | @cindex Lucid Emacs | |
3292 | @cindex Epoch | |
3293 | ||
3294 | XEmacs is a branch version of Emacs. It was first called Lucid Emacs, | |
3295 | and was initially derived from a prerelease version of Emacs 19. In | |
3296 | this FAQ, we use the name ``Emacs'' only for the official version. | |
3297 | ||
3298 | Emacs and XEmacs each come with Lisp packages that are lacking in the | |
3299 | other. The two versions have some significant differences at the Lisp | |
3300 | programming level. Their current features are roughly comparable, | |
3301 | though the support for some operating systems, character sets and | |
3302 | specific packages might be quite different. | |
3303 | ||
3304 | Some XEmacs code has been contributed to Emacs, and we would like to | |
3305 | use other parts, but the earlier XEmacs maintainers did not always | |
3306 | keep track of the authors of contributed code, which makes it | |
3307 | impossible for the FSF to get copyright papers signed for that code. | |
3308 | (The FSF requires these papers for all the code included in the Emacs | |
3309 | release, aside from generic C support packages that retain their | |
3310 | separate identity and are not integrated into the code of Emacs | |
3311 | proper.) | |
3312 | ||
3313 | If you want to talk about these two versions and distinguish them, | |
3314 | please call them ``Emacs'' and ``XEmacs.'' To contrast ``XEmacs'' | |
3315 | with ``GNU Emacs'' would be misleading, since XEmacs too has its | |
3316 | origin in the work of the GNU Project. Terms such as ``Emacsen'' and | |
3317 | ``(X)Emacs'' are not wrong, but they are not very clear, so it | |
3318 | is better to write ``Emacs and XEmacs.'' | |
3319 | ||
f0bf7708 | 3320 | @node Emacs for minimalists |
8a76755b GM |
3321 | @section I don't have enough disk space to install Emacs |
3322 | @cindex Zile | |
3323 | @cindex Not enough disk space to install Emacs | |
3324 | ||
3325 | GNU Zile is a lightweight Emacs clone. Zile is short for @samp{Zile Is | |
3326 | Lossy Emacs}. It has all of Emacs's basic editing features. The Zile | |
3327 | binary typically has a size of about 130 kbytes, so this can be useful | |
3328 | if you are in an extremely space-restricted environment. More | |
3329 | information is available from | |
3330 | ||
3331 | @uref{http://www.gnu.org/software/zile/} | |
3332 | ||
3333 | ||
f0bf7708 | 3334 | @node Emacs for MS-DOS |
b59a8457 | 3335 | @section Where can I get Emacs for MS-DOS? |
4009494e GM |
3336 | @cindex MS-DOS, Emacs for |
3337 | @cindex DOS, Emacs for | |
3338 | @cindex Compiling Emacs for DOS | |
3339 | @cindex Emacs for MS-DOS | |
4009494e | 3340 | |
b59a8457 GM |
3341 | To build Emacs from source for MS-DOS, see the instructions in the file |
3342 | @file{msdos/INSTALL} in the distribution. The DOS port builds and runs | |
3343 | on plain DOS, and also on all versions of MS-Windows from version 3.X | |
3344 | onwards, including Windows XP and Vista. | |
4009494e | 3345 | |
b59a8457 GM |
3346 | The file @file{etc/PROBLEMS} contains some additional information |
3347 | regarding Emacs under MS-DOS. | |
4009494e | 3348 | |
b59a8457 GM |
3349 | A pre-built binary distribution of the old Emacs 20 is available, as |
3350 | described at | |
4009494e | 3351 | |
b59a8457 | 3352 | @uref{ftp://ftp.delorie.com/pub/djgpp/current/v2gnu/emacs.README} |
4009494e GM |
3353 | |
3354 | For a list of other MS-DOS implementations of Emacs (and Emacs | |
3355 | look-alikes), consult the list of ``Emacs implementations and literature,'' | |
3356 | available at | |
3357 | ||
b59a8457 | 3358 | @uref{http://www.finseth.com/emacs.html} |
4009494e GM |
3359 | |
3360 | Note that while many of these programs look similar to Emacs, they often | |
3361 | lack certain features, such as the Emacs Lisp extension language. | |
3362 | ||
b59a8457 | 3363 | @node Emacs for MS-Windows |
4009494e | 3364 | @section Where can I get Emacs for Microsoft Windows? |
b59a8457 | 3365 | @cindex FAQ for Emacs on MS-Windows |
4009494e GM |
3366 | @cindex Emacs for MS-Windows |
3367 | @cindex Microsoft Windows, Emacs for | |
4009494e | 3368 | |
b59a8457 GM |
3369 | There is a @uref{http://www.gnu.org/software/emacs/windows/ntemacs.html, |
3370 | separate FAQ} for Emacs on MS-Windows. For MS-DOS, @pxref{Emacs for MS-DOS}. | |
4009494e | 3371 | |
4009494e | 3372 | |
f0bf7708 | 3373 | @node Emacs for GNUstep |
93e2d996 | 3374 | @section Where can I get Emacs for GNUstep? |
b59a8457 | 3375 | @cindex GNUstep, Emacs for |
4009494e | 3376 | |
93e2d996 | 3377 | Beginning with version 23.1, Emacs supports GNUstep natively. |
b59a8457 | 3378 | See the file @file{nextstep/INSTALL} in the distribution. |
4009494e | 3379 | |
b59a8457 GM |
3380 | @node Emacs for Mac OS X |
3381 | @section Where can I get Emacs for Mac OS X? | |
4009494e GM |
3382 | @cindex Apple computers, Emacs for |
3383 | @cindex Macintosh, Emacs for | |
b59a8457 | 3384 | @cindex Mac OS X, Emacs for |
4009494e | 3385 | |
4009494e | 3386 | Beginning with version 22.1, Emacs supports Mac OS X natively. |
b59a8457 | 3387 | See the file @file{nextstep/INSTALL} in the distribution. |
4009494e GM |
3388 | |
3389 | @c ------------------------------------------------------------ | |
f0bf7708 | 3390 | @node Major packages and programs |
4009494e GM |
3391 | @chapter Major packages and programs |
3392 | @cindex Major packages and programs | |
3393 | ||
3394 | @menu | |
3395 | * VM:: | |
4009494e GM |
3396 | * AUCTeX:: |
3397 | * BBDB:: | |
85b438b7 | 3398 | * Spell-checkers:: |
4009494e GM |
3399 | * Emacs/W3:: |
3400 | * EDB:: | |
b59a8457 | 3401 | * JDEE:: |
4009494e GM |
3402 | @end menu |
3403 | ||
f0bf7708 | 3404 | @node VM |
4009494e GM |
3405 | @section VM (View Mail) --- another mail reader within Emacs, with MIME support |
3406 | @cindex VM | |
3407 | @cindex Alternative mail software | |
3408 | @cindex View Mail | |
3409 | @cindex E-mail reader, VM | |
3410 | ||
3411 | @table @b | |
3412 | ||
091f8bc1 | 3413 | @item Web site |
16f6287e GM |
3414 | @uref{http://launchpad.net/vm} |
3415 | (was @uref{http://www.nongnu.org/viewmail/}) | |
4009494e GM |
3416 | |
3417 | @item Informational newsgroup | |
3418 | @uref{news:gnu.emacs.vm.info}@* | |
3419 | ||
3420 | @item Bug reports newsgroup | |
3421 | @uref{news:gnu.emacs.vm.bug}@* | |
4009494e GM |
3422 | @end table |
3423 | ||
091f8bc1 GM |
3424 | VM was originally written by @uref{http://www.wonderworks.com/vm/,Kyle Jones}. |
3425 | @uref{ftp://ftp.wonderworks.com/pub/vm/,Older versions} of VM remain | |
3426 | available. | |
4009494e | 3427 | |
4009494e | 3428 | |
f0bf7708 | 3429 | @node AUCTeX |
4009494e GM |
3430 | @section AUC@TeX{} --- enhanced @TeX{} modes with debugging facilities |
3431 | @cindex Mode for @TeX{} | |
3432 | @cindex @TeX{} mode | |
3433 | @cindex AUC@TeX{} mode for editing @TeX{} | |
3434 | @cindex Writing and debugging @TeX{} | |
3435 | ||
3436 | AUC@TeX{} is a set of sophisticated major modes for @TeX{}, LaTeX, | |
3437 | ConTeXt, and Texinfo offering context-sensitive syntax highlighting, | |
3438 | indentation, formatting and folding, macro completion, @TeX{} shell | |
3439 | functionality, and debugging. Be also sure to check out | |
3440 | @ref{Introduction, RefTeX, Introduction, reftex, Ref@TeX{} User Manual}. | |
3441 | Current versions of AUC@TeX{} include the | |
091f8bc1 | 3442 | @uref{http://www.gnu.org/software/auctex/preview-latex.html,preview-latex} |
4009494e GM |
3443 | package for WYSIWYG previews of various LaTeX constructs in the Emacs |
3444 | source buffer. | |
3445 | ||
85b438b7 | 3446 | @uref{http://www.gnu.org/software/auctex/, AUCTeX} |
4009494e | 3447 | |
f0bf7708 | 3448 | @node BBDB |
4009494e GM |
3449 | @section BBDB --- personal Info Rolodex integrated with mail/news readers |
3450 | @cindex BBDB | |
3451 | @cindex Rolodex-like functionality | |
3452 | @cindex Integrated contact database | |
3453 | @cindex Contact database | |
3454 | @cindex Big Brother Database | |
3455 | @cindex Address book | |
3456 | ||
85b438b7 | 3457 | @uref{http://bbdb.sourceforge.net/, The Insidious Big Brother Database} |
4009494e | 3458 | |
85b438b7 GM |
3459 | @node Spell-checkers |
3460 | @section Spell-checkers | |
4009494e GM |
3461 | @cindex Spell-checker |
3462 | @cindex Checking spelling | |
3463 | @cindex Ispell | |
85b438b7 GM |
3464 | @cindex Aspell |
3465 | @cindex Hunspell | |
4009494e | 3466 | |
85b438b7 | 3467 | Various spell-checkers are compatible with Emacs, including: |
4009494e | 3468 | |
85b438b7 | 3469 | @table @b |
4009494e | 3470 | |
85b438b7 GM |
3471 | @item GNU Aspell |
3472 | @uref{http://aspell.net/} | |
4009494e | 3473 | |
85b438b7 | 3474 | @item Ispell |
4009494e GM |
3475 | @uref{http://fmg-www.cs.ucla.edu/geoff/ispell.html} |
3476 | ||
85b438b7 GM |
3477 | @item Hunspell |
3478 | @uref{http://hunspell.sourceforge.net/} | |
4009494e | 3479 | |
85b438b7 | 3480 | @end table |
4009494e | 3481 | |
f0bf7708 | 3482 | @node Emacs/W3 |
4009494e GM |
3483 | @section Emacs/W3 --- A World Wide Web browser inside of Emacs |
3484 | @cindex WWW browser | |
3485 | @cindex Web browser | |
3486 | @cindex HTML browser in Emacs | |
3487 | @cindex @code{w3-mode} | |
3488 | ||
85b438b7 | 3489 | @uref{http://www.gnu.org/software/w3/, Emacs/W3} |
4009494e | 3490 | |
f0bf7708 | 3491 | @node EDB |
4009494e GM |
3492 | @section EDB --- Database program for Emacs; replaces forms editing modes |
3493 | @cindex EDB | |
3494 | @cindex Database | |
3495 | @cindex Forms mode | |
3496 | ||
e126f4f1 | 3497 | @uref{http://gnuvola.org/software/edb/, The Emacs Database} |
4009494e | 3498 | |
b59a8457 GM |
3499 | @node JDEE |
3500 | @section JDEE --- Integrated development environment for Java | |
4009494e GM |
3501 | @cindex Java development environment |
3502 | @cindex Integrated Java development environment | |
b59a8457 | 3503 | @cindex JDEE |
4009494e | 3504 | |
e126f4f1 | 3505 | @uref{http://jdee.sourceforge.net/, A Java Development Environment for Emacs} |
4009494e GM |
3506 | |
3507 | @c ------------------------------------------------------------ | |
f0bf7708 | 3508 | @node Key bindings |
4009494e GM |
3509 | @chapter Key bindings |
3510 | @cindex Key bindings | |
3511 | ||
3512 | @menu | |
3513 | * Binding keys to commands:: | |
3514 | * Invalid prefix characters:: | |
3515 | * Terminal setup code works after Emacs has begun:: | |
4009494e GM |
3516 | * Working with function and arrow keys:: |
3517 | * X key translations for Emacs:: | |
4009494e | 3518 | * Backspace invokes help:: |
4009494e GM |
3519 | * Swapping keys:: |
3520 | * Producing C-XXX with the keyboard:: | |
3521 | * No Meta key:: | |
3522 | * No Escape key:: | |
3523 | * Compose Character:: | |
3524 | * Binding combinations of modifiers and function keys:: | |
3525 | * Meta key does not work in xterm:: | |
3526 | * ExtendChar key does not work as Meta:: | |
3527 | * SPC no longer completes file names:: | |
3528 | @end menu | |
3529 | ||
f0bf7708 | 3530 | @node Binding keys to commands |
4009494e GM |
3531 | @section How do I bind keys (including function keys) to commands? |
3532 | @cindex Binding keys to commands | |
3533 | @cindex Keys, binding to commands | |
3534 | @cindex Commands, binding keys to | |
3535 | ||
3536 | Keys can be bound to commands either interactively or in your | |
3537 | @file{.emacs} file. To interactively bind keys for all modes, type | |
3538 | @kbd{M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}}. | |
3539 | ||
3540 | To bind a key just in the current major mode, type @kbd{M-x | |
3541 | local-set-key @key{RET} @var{key} @var{cmd} @key{RET}}. | |
3542 | ||
3543 | @inforef{Key Bindings, Key Bindings, emacs}, for further details. | |
3544 | ||
3545 | To make the process of binding keys interactively easier, use the | |
3546 | following ``trick'': First bind the key interactively, then immediately | |
3547 | type @kbd{C-x @key{ESC} @key{ESC} C-a C-k C-g}. Now, the command needed | |
3548 | to bind the key is in the kill ring, and can be yanked into your | |
3549 | @file{.emacs} file. If the key binding is global, no changes to the | |
3550 | command are required. For example, | |
3551 | ||
3552 | @lisp | |
3553 | (global-set-key (quote [f1]) (quote help-for-help)) | |
3554 | @end lisp | |
3555 | ||
3556 | @noindent | |
3557 | can be placed directly into the @file{.emacs} file. If the key binding is | |
3558 | local, the command is used in conjunction with the @samp{add-hook} function. | |
3559 | For example, in TeX mode, a local binding might be | |
3560 | ||
3561 | @lisp | |
3562 | (add-hook 'tex-mode-hook | |
3563 | (lambda () | |
3564 | (local-set-key (quote [f1]) (quote help-for-help)))) | |
3565 | @end lisp | |
3566 | ||
3567 | ||
3568 | @itemize @bullet | |
3569 | ||
3570 | @item | |
3571 | Control characters in key sequences, in the form yanked from the kill | |
3572 | ring are given in their graphic form---i.e., @key{CTRL} is shown as | |
3573 | @samp{^}, @key{TAB} as a set of spaces (usually 8), etc. You may want | |
3574 | to convert these into their vector or string forms. | |
3575 | ||
3576 | @item | |
3577 | If a prefix key of the character sequence to be bound is already | |
3578 | bound as a complete key, then you must unbind it before the new | |
3579 | binding. For example, if @kbd{ESC @{} is previously bound: | |
3580 | ||
3581 | @lisp | |
3582 | (global-unset-key [?\e ?@{]) ;; or | |
3583 | (local-unset-key [?\e ?@{]) | |
3584 | @end lisp | |
3585 | ||
3586 | @item | |
3587 | Aside from commands and ``lambda lists,'' a vector or string also | |
3588 | can be bound to a key and thus treated as a macro. For example: | |
3589 | ||
3590 | @lisp | |
3591 | (global-set-key [f10] [?\C-x?\e?\e?\C-a?\C-k?\C-g]) ;; or | |
3592 | (global-set-key [f10] "\C-x\e\e\C-a\C-k\C-g") | |
3593 | @end lisp | |
3594 | ||
3595 | @end itemize | |
3596 | ||
f0bf7708 | 3597 | @node Invalid prefix characters |
4009494e GM |
3598 | @section Why does Emacs say @samp{Key sequence XXX uses invalid prefix characters}? |
3599 | @cindex Prefix characters, invalid | |
3600 | @cindex Invalid prefix characters | |
3601 | @cindex Misspecified key sequences | |
3602 | ||
3603 | Usually, one of two things has happened. In one case, the control | |
3604 | character in the key sequence has been misspecified (e.g. @samp{C-f} | |
3605 | used instead of @samp{\C-f} within a Lisp expression). In the other | |
3606 | case, a @dfn{prefix key} in the keystroke sequence you were trying to bind | |
3607 | was already bound as a @dfn{complete key}. Historically, the @samp{ESC [} | |
3608 | prefix was usually the problem, in which case you should evaluate either | |
3609 | of these forms before attempting to bind the key sequence: | |
3610 | ||
3611 | @lisp | |
3612 | (global-unset-key [?\e ?[]) ;; or | |
3613 | (global-unset-key "\e[") | |
3614 | @end lisp | |
3615 | ||
f0bf7708 | 3616 | @node Terminal setup code works after Emacs has begun |
4009494e GM |
3617 | @section Why doesn't this [terminal or window-system setup] code work in my @file{.emacs} file, but it works just fine after Emacs starts up? |
3618 | @cindex Terminal setup code in @file{.emacs} | |
3619 | ||
3620 | During startup, Emacs initializes itself according to a given code/file | |
3621 | order. If some of the code executed in your @file{.emacs} file needs to | |
3622 | be postponed until the initial terminal or window-system setup code has | |
3623 | been executed but is not, then you will experience this problem (this | |
3624 | code/file execution order is not enforced after startup). | |
3625 | ||
3626 | To postpone the execution of Emacs Lisp code until after terminal or | |
3627 | window-system setup, treat the code as a @dfn{lambda list} and set the | |
3628 | value of either the @code{term-setup-hook} or @code{window-setup-hook} | |
3629 | variable to this lambda function. For example, | |
3630 | ||
3631 | @lisp | |
3632 | (add-hook 'term-setup-hook | |
3633 | (lambda () | |
3634 | (when (string-match "\\`vt220" (or (getenv "TERM") "")) | |
3635 | ;; Make vt220's "Do" key behave like M-x: | |
3636 | (global-set-key [do] 'execute-extended-command)))) | |
3637 | @end lisp | |
3638 | ||
3639 | For information on what Emacs does every time it is started, see the | |
3640 | @file{lisp/startup.el} file. | |
3641 | ||
f0bf7708 | 3642 | @node Working with function and arrow keys |
4009494e GM |
3643 | @section How do I tell what characters or symbols my function or arrow keys emit? |
3644 | @cindex Working with arrow keys | |
3645 | @cindex Arrow keys, symbols generated by | |
3646 | @cindex Working with function keys | |
3647 | @cindex Function keys, symbols generated by | |
3648 | @cindex Symbols generated by function keys | |
3649 | ||
3650 | Type @kbd{C-h c} then the function or arrow keys. The command will | |
3651 | return either a function key symbol or character sequence (see the | |
85b438b7 | 3652 | Emacs documentation for an explanation). This works for other |
4009494e GM |
3653 | keys as well. |
3654 | ||
f0bf7708 | 3655 | @node X key translations for Emacs |
4009494e GM |
3656 | @section How do I set the X key ``translations'' for Emacs? |
3657 | @cindex X key translations | |
3658 | @cindex Key translations under X | |
3659 | @cindex Translations for keys under X | |
3660 | ||
3661 | Emacs is not written using the Xt library by default, so there are no | |
3662 | ``translations'' to be set. (We aren't sure how to set such translations | |
3663 | if you do build Emacs with Xt; please let us know if you've done this!) | |
3664 | ||
3665 | The only way to affect the behavior of keys within Emacs is through | |
3666 | @code{xmodmap} (outside Emacs) or @code{define-key} (inside Emacs). The | |
3667 | @code{define-key} command should be used in conjunction with the | |
3668 | @code{function-key-map} map. For instance, | |
3669 | ||
3670 | @lisp | |
3671 | (define-key function-key-map [M-@key{TAB}] [?\M-\t]) | |
3672 | @end lisp | |
3673 | ||
3674 | @noindent | |
3675 | defines the @kbd{M-@key{TAB}} key sequence. | |
3676 | ||
f0bf7708 | 3677 | @node Backspace invokes help |
4009494e GM |
3678 | @section Why does the @key{Backspace} key invoke help? |
3679 | @cindex Backspace key invokes help | |
3680 | @cindex Help invoked by Backspace | |
3681 | @cindex DEL key does not delete | |
3682 | ||
3683 | The @key{Backspace} key (on most keyboards) generates @acronym{ASCII} code 8. | |
3684 | @kbd{C-h} sends the same code. In Emacs by default @kbd{C-h} invokes | |
3685 | help-command. This is intended to be easy to remember since the first | |
3686 | letter of @samp{help} is @samp{h}. The easiest solution to this problem | |
3687 | is to use @kbd{C-h} (and @key{Backspace}) for help and @key{DEL} (the | |
3688 | @key{Delete} key) for deleting the previous character. | |
3689 | ||
3690 | For many people this solution may be problematic: | |
3691 | ||
3692 | @itemize @bullet | |
3693 | ||
3694 | @item | |
3695 | They normally use @key{Backspace} outside of Emacs for deleting the | |
3696 | previous character. This can be solved by making @key{DEL} the command | |
3697 | for deleting the previous character outside of Emacs. On many Unix | |
3698 | systems, this command will remap @key{DEL}: | |
3699 | ||
3700 | @example | |
3701 | stty erase `^?' | |
3702 | @end example | |
3703 | ||
3704 | @item | |
3705 | The user may prefer the @key{Backspace} key for deleting the | |
3706 | previous character because it is more conveniently located on their | |
3707 | keyboard or because they don't even have a separate @key{Delete} key. | |
3708 | In this case, the @key{Backspace} key should be made to behave like | |
3709 | @key{Delete}. There are several methods. | |
3710 | ||
3711 | @itemize @minus | |
3712 | @item | |
3713 | Some terminals (e.g., VT3## terminals) and terminal emulators (e.g., | |
3714 | TeraTerm) allow the character generated by the @key{Backspace} key to be | |
3715 | changed from a setup menu. | |
3716 | ||
3717 | @item | |
3718 | You may be able to get a keyboard that is completely programmable, or a | |
3719 | terminal emulator that supports remapping of any key to any other key. | |
3720 | ||
3721 | @item | |
3722 | With Emacs 21.1 and later, you can control the effect of the | |
3723 | @key{Backspace} and @key{Delete} keys, on both dumb terminals and a | |
3724 | windowed displays, by customizing the option | |
3725 | @code{normal-erase-is-backspace-mode}, or by invoking @kbd{M-x | |
3726 | normal-erase-is-backspace}. See the documentation of these symbols | |
3727 | (@pxref{Emacs Lisp documentation}) for more info. | |
3728 | ||
3729 | @item | |
3730 | It is possible to swap the @key{Backspace} and @key{DEL} keys inside | |
3731 | Emacs: | |
3732 | ||
3733 | @lisp | |
3734 | (keyboard-translate ?\C-h ?\C-?) | |
3735 | @end lisp | |
3736 | ||
3737 | @noindent | |
3738 | This is the recommended method of forcing @key{Backspace} to act as | |
3739 | @key{DEL}, because it works even in modes which bind @key{DEL} to | |
3740 | something other than @code{delete-backward-char}. | |
3741 | ||
3742 | Similarly, you could remap @key{DEL} to act as @kbd{C-d}, which by | |
3743 | default deletes forward: | |
3744 | ||
3745 | @lisp | |
3746 | (keyboard-translate ?\C-? ?\C-d) | |
3747 | @end lisp | |
3748 | ||
3749 | @xref{Swapping keys}, for further details about @code{keyboard-translate}. | |
3750 | ||
3751 | @item | |
3752 | Another approach is to switch key bindings and put help on @kbd{C-x h} | |
3753 | instead: | |
3754 | ||
3755 | @lisp | |
3756 | (global-set-key "\C-h" 'delete-backward-char) | |
3757 | ||
3758 | ;; overrides mark-whole-buffer | |
3759 | (global-set-key "\C-xh" 'help-command) | |
3760 | @end lisp | |
3761 | ||
3762 | @noindent | |
3763 | This method is not recommended, though: it only solves the problem for | |
3764 | those modes which bind @key{DEL} to @code{delete-backward-char}. Modes | |
3765 | which bind @key{DEL} to something else, such as @code{view-mode}, will | |
3766 | not work as you expect when you press the @key{Backspace} key. For this | |
3767 | reason, we recommend the @code{keyboard-translate} method, shown | |
3768 | above. | |
3769 | ||
3770 | Other popular key bindings for help are @kbd{M-?} and @kbd{C-x ?}. | |
3771 | @end itemize | |
3772 | ||
3773 | Don't try to bind @key{DEL} to @code{help-command}, because there are | |
3774 | many modes that have local bindings of @key{DEL} that will interfere. | |
3775 | ||
3776 | @end itemize | |
3777 | ||
3778 | When Emacs 21 or later runs on a windowed display, it binds the | |
3779 | @key{Delete} key to a command which deletes the character at point, to | |
3780 | make Emacs more consistent with keyboard operation on these systems. | |
3781 | ||
3782 | For more information about troubleshooting this problem, see @ref{DEL | |
3783 | Does Not Delete, , If @key{DEL} Fails to Delete, emacs, The GNU Emacs | |
3784 | Manual}. | |
3785 | ||
f0bf7708 | 3786 | @node Swapping keys |
4009494e GM |
3787 | @section How do I swap two keys? |
3788 | @cindex Swapping keys | |
3789 | @cindex Keys, swapping | |
3790 | @cindex @code{keyboard-translate} | |
3791 | ||
3792 | You can swap two keys (or key sequences) by using the | |
3793 | @code{keyboard-translate} function. For example, to turn @kbd{C-h} | |
3794 | into @key{DEL} and @key{DEL} to @kbd{C-h}, use | |
3795 | ||
3796 | @lisp | |
3797 | (keyboard-translate ?\C-h ?\C-?) ; translate `C-h' to DEL | |
3798 | (keyboard-translate ?\C-? ?\C-h) ; translate DEL to `C-h'. | |
3799 | @end lisp | |
3800 | ||
3801 | @noindent | |
3802 | The first key sequence of the pair after the function identifies what is | |
3803 | produced by the keyboard; the second, what is matched for in the | |
3804 | keymaps. | |
3805 | ||
3806 | However, in the specific case of @kbd{C-h} and @key{DEL}, you should | |
3807 | toggle @code{normal-erase-is-backspace-mode} instead of calling | |
3808 | @code{keyboard-translate}. @inforef{DEL Does Not Delete, DEL Does Not Delete, | |
3809 | emacs}. | |
3810 | ||
3811 | Keyboard translations are not the same as key bindings in keymaps. | |
3812 | Emacs contains numerous keymaps that apply in different situations, but | |
3813 | there is only one set of keyboard translations, and it applies to every | |
3814 | character that Emacs reads from the terminal. Keyboard translations | |
3815 | take place at the lowest level of input processing; the keys that are | |
3816 | looked up in keymaps contain the characters that result from keyboard | |
3817 | translation. | |
3818 | ||
f0bf7708 | 3819 | @node Producing C-XXX with the keyboard |
4009494e GM |
3820 | @section How do I produce C-XXX with my keyboard? |
3821 | @cindex Producing control characters | |
3822 | @cindex Generating control characters | |
3823 | @cindex Control characters, generating | |
3824 | ||
3825 | On terminals (but not under X), some common ``aliases'' are: | |
3826 | ||
3827 | @table @asis | |
3828 | ||
3829 | @item @kbd{C-2} or @kbd{C-@key{SPC}} | |
3830 | @kbd{C-@@} | |
3831 | ||
3832 | @item @kbd{C-6} | |
3833 | @kbd{C-^} | |
3834 | ||
3835 | @item @kbd{C-7} or @kbd{C-S--} | |
3836 | @kbd{C-_} | |
3837 | ||
3838 | @item @kbd{C-4} | |
3839 | @kbd{C-\} | |
3840 | ||
3841 | @item @kbd{C-5} | |
3842 | @kbd{C-]} | |
3843 | ||
3844 | @item @kbd{C-/} | |
3845 | @kbd{C-?} | |
3846 | ||
3847 | @end table | |
3848 | ||
3849 | Often other aliases exist; use the @kbd{C-h c} command and try | |
3850 | @key{CTRL} with all of the digits on your keyboard to see what gets | |
3851 | generated. You can also try the @kbd{C-h w} command if you know the | |
3852 | name of the command. | |
3853 | ||
f0bf7708 | 3854 | @node No Meta key |
4009494e GM |
3855 | @section What if I don't have a @key{Meta} key? |
3856 | @cindex No @key{Meta} key | |
3857 | @cindex @key{Meta} key, what to do if you lack it | |
3858 | ||
3859 | On many keyboards, the @key{Alt} key acts as @key{Meta}, so try it. | |
3860 | ||
3861 | Instead of typing @kbd{M-a}, you can type @kbd{@key{ESC} a}. In fact, | |
3862 | Emacs converts @kbd{M-a} internally into @kbd{@key{ESC} a} anyway | |
3863 | (depending on the value of @code{meta-prefix-char}). Note that you | |
3864 | press @key{Meta} and @key{a} together, but with @key{ESC}, you press | |
3865 | @key{ESC}, release it, and then press @key{a}. | |
3866 | ||
f0bf7708 | 3867 | @node No Escape key |
4009494e GM |
3868 | @section What if I don't have an @key{Escape} key? |
3869 | @cindex No Escape key | |
3870 | @cindex Lacking an Escape key | |
3871 | @cindex Escape key, lacking | |
3872 | ||
3873 | Type @kbd{C-[} instead. This should send @acronym{ASCII} code 27 just like an | |
3874 | Escape key would. @kbd{C-3} may also work on some terminal (but not | |
3875 | under X). For many terminals (notably DEC terminals) @key{F11} | |
3876 | generates @key{ESC}. If not, the following form can be used to bind it: | |
3877 | ||
3878 | @lisp | |
3879 | ;; F11 is the documented ESC replacement on DEC terminals. | |
3880 | (define-key function-key-map [f11] [?\e]) | |
3881 | @end lisp | |
3882 | ||
f0bf7708 | 3883 | @node Compose Character |
4009494e GM |
3884 | @section Can I make my @key{Compose Character} key behave like a @key{Meta} key? |
3885 | @cindex @key{Compose Character} key, using as @key{Meta} | |
3886 | @cindex @key{Meta}, using @key{Compose Character} for | |
3887 | ||
3888 | On a dumb terminal such as a VT220, no. It is rumored that certain | |
3889 | VT220 clones could have their @key{Compose} key configured this way. If | |
3890 | you're using X, you might be able to do this with the @code{xmodmap} | |
3891 | command. | |
3892 | ||
f0bf7708 | 3893 | @node Binding combinations of modifiers and function keys |
4009494e GM |
3894 | @section How do I bind a combination of modifier key and function key? |
3895 | @cindex Modifiers and function keys | |
3896 | @cindex Function keys and modifiers | |
3897 | @cindex Binding modifiers and function keys | |
3898 | ||
3899 | With Emacs 19 and later, you can represent modified function keys in | |
3900 | vector format by adding prefixes to the function key symbol. For | |
85b438b7 | 3901 | example (from the Emacs documentation): |
4009494e GM |
3902 | |
3903 | @lisp | |
3904 | (global-set-key [?\C-x right] 'forward-page) | |
3905 | @end lisp | |
3906 | ||
3907 | @noindent | |
3908 | where @samp{?\C-x} is the Lisp character constant for the character @kbd{C-x}. | |
3909 | ||
3910 | You can use the modifier keys @key{Control}, @key{Meta}, @key{Hyper}, | |
3911 | @key{Super}, @key{Alt}, and @key{Shift} with function keys. To | |
3912 | represent these modifiers, prepend the strings @samp{C-}, @samp{M-}, | |
3913 | @samp{H-}, @samp{s-}, @samp{A-}, and @samp{S-} to the symbol name. Here | |
3914 | is how to make @kbd{H-M-RIGHT} move forward a word: | |
3915 | ||
3916 | @lisp | |
3917 | (global-set-key [H-M-right] 'forward-word) | |
3918 | @end lisp | |
3919 | ||
3920 | @itemize @bullet | |
3921 | ||
3922 | @item | |
3923 | Not all modifiers are permitted in all situations. @key{Hyper}, | |
3924 | @key{Super}, and @key{Alt} are not available on Unix character | |
3925 | terminals. Non-@acronym{ASCII} keys and mouse events (e.g. @kbd{C-=} and | |
3926 | @kbd{Mouse-1}) also fall under this category. | |
3927 | ||
3928 | @end itemize | |
3929 | ||
3930 | @xref{Binding keys to commands}, for general key binding instructions. | |
3931 | ||
f0bf7708 | 3932 | @node Meta key does not work in xterm |
4009494e GM |
3933 | @section Why doesn't my @key{Meta} key work in an @code{xterm} window? |
3934 | @cindex @key{Meta} key and @code{xterm} | |
3935 | @cindex Xterm and @key{Meta} key | |
3936 | ||
3937 | @inforef{Unibyte Mode, Single-Byte Character Set Support, emacs}. | |
3938 | ||
3939 | If the advice in the Emacs manual fails, try all of these methods before | |
3940 | asking for further help: | |
3941 | ||
3942 | @itemize @bullet | |
3943 | ||
3944 | @item | |
3945 | You may have big problems using @code{mwm} as your window manager. | |
3946 | (Does anyone know a good generic solution to allow the use of the | |
3947 | @key{Meta} key in Emacs with @file{mwm}?) | |
3948 | ||
3949 | @item | |
3950 | For X11: Make sure it really is a @key{Meta} key. Use @code{xev} to | |
3951 | find out what keysym your @key{Meta} key generates. It should be either | |
3952 | @code{Meta_L} or @code{Meta_R}. If it isn't, use @file{xmodmap} to fix | |
3953 | the situation. If @key{Meta} does generate @code{Meta_L} or | |
3954 | @code{Meta_R}, but @kbd{M-x} produces a non-@acronym{ASCII} character, put this in | |
3955 | your @file{~/.Xdefaults} file: | |
3956 | ||
3957 | @example | |
3958 | XTerm*eightBitInput: false | |
3959 | XTerm*eightBitOutput: true | |
3960 | @end example | |
3961 | ||
3962 | @item | |
3963 | Make sure the @code{pty} the @code{xterm} is using is passing 8 bit | |
3964 | characters. @samp{stty -a} (or @samp{stty everything}) should show | |
3965 | @samp{cs8} somewhere. If it shows @samp{cs7} instead, use @samp{stty | |
3966 | cs8 -istrip} (or @samp{stty pass8}) to fix it. | |
3967 | ||
3968 | @item | |
3969 | If there is an @code{rlogin} connection between @code{xterm} and Emacs, the | |
3970 | @samp{-8} argument may need to be given to rlogin to make it pass all 8 bits | |
3971 | of every character. | |
3972 | ||
3973 | @item | |
3974 | If Emacs is running on Ultrix, it is reported that evaluating | |
3975 | @code{(set-input-mode t nil)} helps. | |
3976 | ||
3977 | @item | |
3978 | If all else fails, you can make @code{xterm} generate @kbd{@key{ESC} W} when | |
3979 | you type @kbd{M-W}, which is the same conversion Emacs would make if it | |
3980 | got the @kbd{M-W} anyway. In X11R4, the following resource | |
3981 | specification will do this: | |
3982 | ||
3983 | @example | |
3984 | XTerm.VT100.EightBitInput: false | |
3985 | @end example | |
3986 | ||
3987 | @noindent | |
3988 | (This changes the behavior of the @code{insert-eight-bit} action.) | |
3989 | ||
3990 | With older @code{xterm}s, you can specify this behavior with a translation: | |
3991 | ||
3992 | @example | |
3993 | XTerm.VT100.Translations: #override \ | |
3994 | Meta<KeyPress>: string(0x1b) insert() | |
3995 | @end example | |
3996 | ||
3997 | @noindent | |
3998 | You might have to replace @samp{Meta} with @samp{Alt}. | |
3999 | ||
4000 | @end itemize | |
4001 | ||
f0bf7708 | 4002 | @node ExtendChar key does not work as Meta |
4009494e GM |
4003 | @section Why doesn't my @key{ExtendChar} key work as a @key{Meta} key under HP-UX 8.0 and 9.x? |
4004 | @cindex @key{ExtendChar} key as @key{Meta} | |
4005 | @cindex @key{Meta}, using @key{ExtendChar} for | |
4006 | @cindex HP-UX, the @key{ExtendChar} key | |
4007 | ||
4008 | This is a result of an internationalization extension in X11R4 and the | |
4009 | fact that HP is now using this extension. Emacs assumes that the | |
4010 | @code{XLookupString} function returns the same result regardless of the | |
4011 | @key{Meta} key state which is no longer necessarily true. Until Emacs | |
4012 | is fixed, the temporary kludge is to run this command after each time | |
4013 | the X server is started but preferably before any xterm clients are: | |
4014 | ||
4015 | @example | |
4016 | xmodmap -e 'remove mod1 = Mode_switch' | |
4017 | @end example | |
4018 | ||
4019 | @c FIXME: Emacs 21 supports I18N in X11; does that mean that this bug is | |
4020 | @c solved? | |
4021 | ||
4022 | This will disable the use of the extra keysyms systemwide, which may be | |
4023 | undesirable if you actually intend to use them. | |
4024 | ||
f0bf7708 | 4025 | @node SPC no longer completes file names |
4009494e GM |
4026 | @section Why doesn't SPC complete file names anymore? |
4027 | @cindex @kbd{SPC} file name completion | |
4028 | ||
4029 | Starting with Emacs 22.1, @kbd{SPC} no longer completes file names in | |
4030 | the minibuffer, so that file names with embedded spaces could be typed | |
4031 | without the need to quote the spaces. | |
4032 | ||
4033 | You can get the old behavior by binding @kbd{SPC} to | |
4034 | @code{minibuffer-complete-word} in the minibuffer, as follows: | |
4035 | ||
4036 | @lisp | |
4037 | (define-key minibuffer-local-filename-completion-map (kbd "SPC") | |
4038 | 'minibuffer-complete-word) | |
4039 | ||
4040 | (define-key minibuffer-local-must-match-filename-map (kbd "SPC") | |
4041 | 'minibuffer-complete-word) | |
4042 | @end lisp | |
4043 | ||
4044 | @c ------------------------------------------------------------ | |
f0bf7708 | 4045 | @node Alternate character sets |
4009494e GM |
4046 | @chapter Alternate character sets |
4047 | @cindex Alternate character sets | |
4048 | ||
4049 | @menu | |
4050 | * Emacs does not display 8-bit characters:: | |
4051 | * Inputting eight-bit characters:: | |
4009494e GM |
4052 | * Right-to-left alphabets:: |
4053 | * How to add fonts:: | |
4054 | @end menu | |
4055 | ||
f0bf7708 | 4056 | @node Emacs does not display 8-bit characters |
4009494e GM |
4057 | @section How do I make Emacs display 8-bit characters? |
4058 | @cindex Displaying eight-bit characters | |
4059 | @cindex Eight-bit characters, displaying | |
4060 | ||
4061 | @inforef{Unibyte Mode, Single-byte Character Set | |
4062 | Support, emacs}. On a Unix, when Emacs runs on a text-only terminal | |
4063 | display or is invoked with @samp{emacs -nw}, you typically need to use | |
4064 | @code{set-terminal-coding-system} to tell Emacs what the terminal can | |
4065 | display, even after setting the language environment; otherwise | |
4066 | non-@acronym{ASCII} characters will display as @samp{?}. On other operating | |
4067 | systems, such as MS-DOS and MS-Windows, Emacs queries the OS about the | |
4068 | character set supported by the display, and sets up the required | |
4069 | terminal coding system automatically. | |
4070 | ||
f0bf7708 | 4071 | @node Inputting eight-bit characters |
4009494e GM |
4072 | @section How do I input eight-bit characters? |
4073 | @cindex Entering eight-bit characters | |
4074 | @cindex Eight-bit characters, entering | |
4075 | @cindex Input, 8-bit characters | |
4076 | ||
4077 | Various methods are available for input of eight-bit characters. See | |
4078 | @inforef{Unibyte Mode, Single-byte Character Set | |
4079 | Support, emacs}. For more sophisticated methods, @inforef{Input | |
4080 | Methods, Input Methods, emacs}. | |
4081 | ||
f0bf7708 | 4082 | @node Right-to-left alphabets |
4009494e GM |
4083 | @section Where is an Emacs that can handle Semitic (right-to-left) alphabets? |
4084 | @cindex Right-to-left alphabets | |
4085 | @cindex Hebrew, handling with Emacs | |
4086 | @cindex Semitic alphabets | |
4087 | @cindex Arabic alphabets | |
b59a8457 | 4088 | @cindex Bidirectional text |
4009494e | 4089 | |
b59a8457 GM |
4090 | Emacs supports Hebrew characters (ISO 8859-8) since version 20, but does |
4091 | not yet support right-to-left character entry and display. The | |
4092 | @uref{http://lists.gnu.org/mailman/listinfo/emacs-bidi, emacs-bidi | |
4093 | mailing list} discusses development of support for this feature. | |
4009494e | 4094 | |
4009494e | 4095 | |
f0bf7708 | 4096 | @node How to add fonts |
4009494e GM |
4097 | @section How do I add fonts for use with Emacs? |
4098 | @cindex add fonts for use with Emacs | |
4099 | @cindex intlfonts | |
4100 | ||
4101 | First, download and install the BDF font files and any auxiliary | |
4102 | packages they need. The GNU Intlfonts distribution can be found on | |
4103 | @uref{http://directory.fsf.org/localization/intlfonts.html, the GNU | |
4104 | Software Directory Web site}. | |
4105 | ||
4106 | Next, if you are on X Window system, issue the following two commands | |
4107 | from the shell's prompt: | |
4108 | ||
4109 | @example | |
4110 | xset +fp /usr/local/share/emacs/fonts | |
4111 | xset fp rehash | |
4112 | @end example | |
4113 | ||
4114 | @noindent | |
4115 | (Modify the first command if you installed the fonts in a directory | |
4116 | that is not @file{/usr/local/share/emacs/fonts}.) You also need to | |
4117 | arrange for these two commands to run whenever you log in, e.g., by | |
4118 | adding them to your window-system startup file, such as | |
4119 | @file{~/.xsessionrc} or @file{~/.gnomerc}. | |
4120 | ||
4121 | Now, add the following line to your @file{~/.emacs} init file: | |
4122 | ||
4123 | @lisp | |
4124 | (add-to-list 'bdf-directory-list "/usr/share/emacs/fonts/bdf") | |
4125 | @end lisp | |
4126 | ||
4127 | @noindent | |
4128 | (Again, modify the file name if you installed the fonts elsewhere.) | |
4129 | ||
4130 | Finally, if you wish to use the installed fonts with @code{ps-print}, | |
4131 | add the following line to your @file{~/.emacs}: | |
4132 | ||
4133 | @lisp | |
4134 | (setq ps-multibyte-buffer 'bdf-font-except-latin) | |
4135 | @end lisp | |
4136 | ||
4137 | A few additional steps are necessary for MS-Windows; they are listed | |
4138 | below. | |
4139 | ||
4140 | First, make sure @emph{all} the directories with BDF font files are | |
4141 | mentioned in @code{bdf-directory-list}. On Unix and GNU/Linux | |
4142 | systems, one normally runs @kbd{make install} to install the BDF fonts | |
4143 | in the same directory. By contrast, Windows users typically don't run | |
4144 | the Intlfonts installation command, but unpack the distribution in | |
4145 | some directory, which leaves the BDF fonts in its subdirectories. For | |
4146 | example, assume that you unpacked Intlfonts in @file{C:/Intlfonts}; | |
4147 | then you should set @code{bdf-directory-list} as follows: | |
4148 | ||
4149 | @lisp | |
4150 | (setq bdf-directory-list | |
4151 | '("C:/Intlfonts/Asian" | |
4152 | "C:/Intlfonts/Chinese" "C:/Intlfonts/Chinese.X" | |
4153 | "C:/Intlfonts/Chinese.BIG" "C:/Intlfonts/Ethiopic" | |
4154 | "C:/Intlfonts/European" "C:/Intlfonts/European.BIG" | |
4155 | "C:/Intlfonts/Japanese" "C:/Intlfonts/Japanese.X" | |
4156 | "C:/Intlfonts/Japanese.BIG" "C:/Intlfonts/Korean.X" | |
4157 | "C:/Intlfonts/Misc")) | |
4158 | @end lisp | |
4159 | ||
4160 | @cindex @code{w32-bdf-filename-alist} | |
4161 | @cindex @code{w32-find-bdf-fonts} | |
4162 | Next, you need to set up the variable @code{w32-bdf-filename-alist} to | |
4163 | an alist of the BDF fonts and their corresponding file names. | |
4164 | Assuming you have set @code{bdf-directory-list} to name all the | |
4165 | directories with the BDF font files, the following Lisp snippet will | |
4166 | set up @code{w32-bdf-filename-alist}: | |
4167 | ||
4168 | @lisp | |
4169 | (setq w32-bdf-filename-alist | |
4170 | (w32-find-bdf-fonts bdf-directory-list)) | |
4171 | @end lisp | |
4172 | ||
4173 | Now, create fontsets for the BDF fonts: | |
4174 | ||
4175 | @lisp | |
4176 | (create-fontset-from-fontset-spec | |
4177 | "-*-fixed-medium-r-normal-*-16-*-*-*-c-*-fontset-bdf, | |
4178 | japanese-jisx0208:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1983-*, | |
4179 | katakana-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*, | |
4180 | latin-jisx0201:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0201*-*, | |
4181 | japanese-jisx0208-1978:-*-*-medium-r-normal-*-16-*-*-*-c-*-jisx0208.1978-*, | |
4182 | thai-tis620:-misc-fixed-medium-r-normal--16-160-72-72-m-80-tis620.2529-1, | |
4183 | lao:-misc-fixed-medium-r-normal--16-160-72-72-m-80-MuleLao-1, | |
4184 | tibetan-1-column:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-80-MuleTibetan-1, | |
4185 | ethiopic:-Admas-Ethiomx16f-Medium-R-Normal--16-150-100-100-M-160-Ethiopic-Unicode, | |
4186 | tibetan:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-160-MuleTibetan-0") | |
4187 | @end lisp | |
4188 | ||
4189 | Many of the international bdf fonts from Intlfonts are type 0, and | |
4190 | therefore need to be added to font-encoding-alist: | |
4191 | ||
4192 | @lisp | |
4193 | (setq font-encoding-alist | |
4194 | (append '(("MuleTibetan-0" (tibetan . 0)) | |
4195 | ("GB2312" (chinese-gb2312 . 0)) | |
4196 | ("JISX0208" (japanese-jisx0208 . 0)) | |
4197 | ("JISX0212" (japanese-jisx0212 . 0)) | |
4198 | ("VISCII" (vietnamese-viscii-lower . 0)) | |
4199 | ("KSC5601" (korean-ksc5601 . 0)) | |
4200 | ("MuleArabic-0" (arabic-digit . 0)) | |
4201 | ("MuleArabic-1" (arabic-1-column . 0)) | |
4202 | ("MuleArabic-2" (arabic-2-column . 0))) | |
4203 | font-encoding-alist)) | |
4204 | @end lisp | |
4205 | ||
4206 | You can now use the Emacs font menu to select the @samp{bdf: 16-dot medium} | |
4207 | fontset, or you can select it by setting the default font in your | |
4208 | @file{~/.emacs}: | |
4209 | ||
4210 | @lisp | |
4211 | (set-default-font "fontset-bdf") | |
4212 | @end lisp | |
4213 | ||
4214 | ||
4215 | @c ------------------------------------------------------------ | |
f0bf7708 | 4216 | @node Mail and news |
4009494e GM |
4217 | @chapter Mail and news |
4218 | @cindex Mail and news | |
4219 | ||
4220 | @menu | |
4221 | * Changing the included text prefix:: | |
4222 | * Saving a copy of outgoing mail:: | |
4223 | * Expanding aliases when sending mail:: | |
4009494e | 4224 | * Sorting the messages in an Rmail folder:: |
b59a8457 | 4225 | * Rmail writes to /var/spool/mail:: |
4009494e | 4226 | * Replying to the sender of a message:: |
4009494e GM |
4227 | * Automatically starting a mail or news reader:: |
4228 | * Reading news with Emacs:: | |
4229 | * Gnus does not work with NNTP:: | |
b59a8457 | 4230 | * Making Gnus faster:: |
4009494e | 4231 | * Catching up in all newsgroups:: |
4009494e GM |
4232 | @end menu |
4233 | ||
f0bf7708 | 4234 | @node Changing the included text prefix |
4009494e GM |
4235 | @section How do I change the included text prefix in mail/news followups? |
4236 | @cindex Prefix in mail/news followups, changing | |
4237 | @cindex Included text prefix, changing | |
4238 | @cindex Setting the included text character | |
4239 | @cindex Quoting in mail messages | |
4240 | ||
b59a8457 GM |
4241 | If you read mail with Rmail, set the variable @code{mail-yank-prefix}. |
4242 | For Gnus, set @code{message-yank-prefix}. For VM, set | |
4243 | @code{vm-included-text-prefix}. For mh-e, set @code{mh-ins-buf-prefix}. | |
4009494e | 4244 | |
b59a8457 GM |
4245 | For fancier control of citations, use Supercite (@pxref{Top,, the Supercite |
4246 | Manual, sc, The Supercite Manual}). | |
4009494e GM |
4247 | |
4248 | To prevent Emacs from including various headers of the replied-to | |
4249 | message, set the value of @code{mail-yank-ignored-headers} to an | |
4250 | appropriate regexp. | |
4251 | ||
f0bf7708 | 4252 | @node Saving a copy of outgoing mail |
4009494e GM |
4253 | @section How do I save a copy of outgoing mail? |
4254 | @cindex Saving a copy of outgoing mail | |
4255 | @cindex Copying outgoing mail to a file | |
4256 | @cindex Filing outgoing mail | |
4257 | @cindex Automatic filing of outgoing mail | |
4258 | @cindex Mail, saving outgoing automatically | |
4259 | ||
4260 | You can either mail yourself a copy by including a @samp{BCC} header in the | |
4261 | mail message, or store a copy of the message directly to a file by | |
4262 | including an @samp{FCC} header. | |
4263 | ||
4264 | If you use standard mail, you can automatically create a @samp{BCC} to | |
4265 | yourself by putting | |
4266 | ||
4267 | @lisp | |
4268 | (setq mail-self-blind t) | |
4269 | @end lisp | |
4270 | ||
4271 | @noindent | |
4272 | in your @file{.emacs} file. You can automatically include an @samp{FCC} | |
4273 | field by putting something like the following in your @file{.emacs} | |
4274 | file: | |
4275 | ||
4276 | @lisp | |
4277 | (setq mail-archive-file-name (expand-file-name "~/outgoing")) | |
4278 | @end lisp | |
4279 | ||
b59a8457 | 4280 | The output file will be in Unix mail format. |
4009494e GM |
4281 | |
4282 | If you use @code{mh-e}, add an @samp{FCC} or @samp{BCC} field to your | |
4283 | components file. | |
4284 | ||
4285 | It does not work to put @samp{set record filename} in the @file{.mailrc} | |
4286 | file. | |
4287 | ||
f0bf7708 | 4288 | @node Expanding aliases when sending mail |
4009494e GM |
4289 | @section Why doesn't Emacs expand my aliases when sending mail? |
4290 | @cindex Expanding aliases when sending mail | |
4291 | @cindex Mail alias expansion | |
4292 | @cindex Sending mail with aliases | |
4293 | ||
b59a8457 GM |
4294 | @xref{Mail Aliases,, The Emacs Manual, emacs, The Emacs Manual}. |
4295 | ||
4009494e GM |
4296 | @itemize @bullet |
4297 | ||
4298 | @item | |
b59a8457 GM |
4299 | Normally, Emacs expands aliases when you send the message. |
4300 | To expand them before this, use @kbd{M-x expand-mail-aliases}. | |
4009494e GM |
4301 | |
4302 | @item | |
53aff12a GM |
4303 | Emacs normally only reads the @file{.mailrc} file once per session, when |
4304 | you start to compose your first mail message. If you edit the file | |
4305 | after this, you can use @kbd{M-x build-mail-aliases} to make Emacs | |
4306 | reread it. Prior to Emacs 24.1, this is not an interactive command, so | |
4307 | you must instead type @kbd{M-: (build-mail-aliases) @key{RET}}. | |
4009494e GM |
4308 | |
4309 | @item | |
4310 | If you like, you can expand mail aliases as abbrevs, as soon as you | |
4311 | type them in. To enable this feature, execute the following: | |
4312 | ||
4313 | @lisp | |
4314 | (add-hook 'mail-mode-hook 'mail-abbrevs-setup) | |
4315 | @end lisp | |
4316 | ||
4317 | Note that the aliases are expanded automatically only after you type | |
b59a8457 | 4318 | a word-separator character (e.g. @key{RET} or @kbd{,}). You can force their |
4009494e GM |
4319 | expansion by moving point to the end of the alias and typing @kbd{C-x a e} |
4320 | (@kbd{M-x expand-abbrev}). | |
4321 | @end itemize | |
4322 | ||
f0bf7708 | 4323 | @node Sorting the messages in an Rmail folder |
4009494e GM |
4324 | @section How can I sort the messages in my Rmail folder? |
4325 | @cindex Rmail, sorting messages in | |
4326 | @cindex Folder, sorting messages in an Rmail | |
4327 | @cindex Sorting messages in an Rmail folder | |
4328 | ||
4329 | In Rmail, type @kbd{C-c C-s C-h} to get a list of sorting functions | |
4330 | and their key bindings. | |
4331 | ||
b59a8457 GM |
4332 | @node Rmail writes to /var/spool/mail |
4333 | @section Why does Rmail need to write to @file{/var/spool/mail}? | |
4334 | @cindex Rmail and @file{/var/spool/mail} | |
4335 | @cindex @file{/var/spool/mail} and Rmail | |
4009494e GM |
4336 | |
4337 | This is the behavior of the @code{movemail} program which Rmail uses. | |
4338 | This indicates that @code{movemail} is configured to use lock files. | |
4339 | ||
4340 | RMS writes: | |
4341 | ||
4342 | @quotation | |
4343 | Certain systems require lock files to interlock access to mail files. | |
4344 | On these systems, @code{movemail} must write lock files, or you risk losing | |
4345 | mail. You simply must arrange to let @code{movemail} write them. | |
4346 | ||
4347 | Other systems use the @code{flock} system call to interlock access. On | |
4348 | these systems, you should configure @code{movemail} to use @code{flock}. | |
4349 | @end quotation | |
4350 | ||
f0bf7708 | 4351 | @node Replying to the sender of a message |
4009494e GM |
4352 | @section How can I force Rmail to reply to the sender of a message, but not the other recipients? |
4353 | @cindex Replying only to the sender of a message | |
4354 | @cindex Sender, replying only to | |
4355 | @cindex Rmail, replying to the sender of a message in | |
4356 | ||
4357 | @email{isaacson@@seas.upenn.edu, Ron Isaacson} says: When you hit | |
4358 | @key{r} to reply in Rmail, by default it CCs all of the original | |
4359 | recipients (everyone on the original @samp{To} and @samp{CC} | |
4360 | lists). With a prefix argument (i.e., typing @kbd{C-u} before @key{r}), | |
4361 | it replies only to the sender. However, going through the whole | |
4362 | @kbd{C-u} business every time you want to reply is a pain. This is the | |
4363 | best fix I've been able to come up with: | |
4364 | ||
4365 | @lisp | |
4366 | (defun rmail-reply-t () | |
4367 | "Reply only to the sender of the current message. (See rmail-reply.)" | |
4368 | (interactive) | |
4369 | (rmail-reply t)) | |
4370 | ||
4371 | (add-hook 'rmail-mode-hook | |
4372 | (lambda () | |
4373 | (define-key rmail-mode-map "r" 'rmail-reply-t) | |
4374 | (define-key rmail-mode-map "R" 'rmail-reply))) | |
4375 | @end lisp | |
4376 | ||
f0bf7708 | 4377 | @node Automatically starting a mail or news reader |
4009494e GM |
4378 | @section How do I make Emacs automatically start my mail/news reader? |
4379 | @cindex Mail reader, starting automatically | |
4380 | @cindex News reader, starting automatically | |
4381 | @cindex Starting mail/news reader automatically | |
4382 | ||
4383 | To start Emacs in Gnus: | |
4384 | ||
4385 | @example | |
4386 | emacs -f gnus | |
4387 | @end example | |
4388 | ||
4389 | @noindent | |
4390 | in Rmail: | |
4391 | ||
4392 | @example | |
4393 | emacs -f rmail | |
4394 | @end example | |
4395 | ||
4396 | A more convenient way to start with Gnus: | |
4397 | ||
4398 | @example | |
4399 | alias gnus 'emacs -f gnus' | |
4400 | gnus | |
4401 | @end example | |
4402 | ||
4403 | It is probably unwise to automatically start your mail or news reader | |
4404 | from your @file{.emacs} file. This would cause problems if you needed to run | |
4405 | two copies of Emacs at the same time. Also, this would make it difficult for | |
4406 | you to start Emacs quickly when you needed to. | |
4407 | ||
f0bf7708 | 4408 | @node Reading news with Emacs |
4009494e GM |
4409 | @section How do I read news under Emacs? |
4410 | @cindex Reading news under Emacs | |
4411 | @cindex Usenet reader in Emacs | |
4412 | @cindex Gnus newsreader | |
b59a8457 GM |
4413 | @cindex FAQ for Gnus |
4414 | @cindex Gnus FAQ | |
4415 | @cindex Learning more about Gnus | |
4416 | ||
4417 | Use @kbd{M-x gnus}. For more information on Gnus, @pxref{Top,, the Gnus | |
4418 | Manual, gnus, The Gnus Manual}, which includes @ref{Frequently Asked | |
4419 | Questions,, the Gnus FAQ, gnus}. | |
4009494e | 4420 | |
4009494e | 4421 | |
f0bf7708 | 4422 | @node Gnus does not work with NNTP |
4009494e GM |
4423 | @section Why doesn't Gnus work via NNTP? |
4424 | @cindex Gnus and NNTP | |
4425 | @cindex NNTP, Gnus fails to work with | |
4426 | ||
4427 | There is a bug in NNTP version 1.5.10, such that when multiple requests | |
4428 | are sent to the NNTP server, the server only handles the first one | |
4429 | before blocking waiting for more input which never comes. NNTP version | |
4430 | 1.5.11 claims to fix this. | |
4431 | ||
4432 | You can work around the bug inside Emacs like this: | |
4433 | ||
4434 | @lisp | |
4435 | (setq nntp-maximum-request 1) | |
4436 | @end lisp | |
4437 | ||
4438 | You can find out what version of NNTP your news server is running by | |
4439 | telnetting to the NNTP port (usually 119) on the news server machine | |
4440 | (i.e., @kbd{telnet server-machine 119}). The server should give its | |
4441 | version number in the welcome message. Type @kbd{quit} to get out. | |
4442 | ||
b59a8457 GM |
4443 | @node Making Gnus faster |
4444 | @section How do I make Gnus faster? | |
4009494e GM |
4445 | @cindex Faster, starting Gnus |
4446 | @cindex Starting Gnus faster | |
4447 | @cindex Gnus, starting faster | |
b59a8457 GM |
4448 | @cindex Slow catch up in Gnus |
4449 | @cindex Gnus is slow when catching up | |
4450 | @cindex Crosspostings make Gnus catching up slow | |
4009494e | 4451 | |
b59a8457 | 4452 | From the Gnus FAQ (@pxref{Reading news with Emacs}): |
4009494e GM |
4453 | |
4454 | @quotation | |
b59a8457 GM |
4455 | If you have a slow machine, or are just really impatient, there are a |
4456 | few things you can do to make Gnus run faster. | |
4009494e | 4457 | |
b59a8457 GM |
4458 | Set @code{gnus-check-new-newsgroups} and |
4459 | @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster. | |
4460 | ||
4461 | Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and | |
4462 | @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the | |
4463 | summary buffer faster. | |
4009494e GM |
4464 | @end quotation |
4465 | ||
f0bf7708 | 4466 | @node Catching up in all newsgroups |
4009494e GM |
4467 | @section How do I catch up all newsgroups in Gnus? |
4468 | @cindex Catching up all newsgroups in Gnus | |
4469 | @cindex Gnus, Catching up all newsgroups in | |
4470 | ||
4471 | In the @file{*Newsgroup*} buffer, type @kbd{M-< C-x ( c y C-x ) M-0 C-x e} | |
4472 | ||
4473 | Leave off the initial @kbd{M-<} if you only want to catch up from point | |
4474 | to the end of the @file{*Newsgroup*} buffer. | |
4475 | ||
f0bf7708 | 4476 | @node Concept index |
4009494e GM |
4477 | @unnumbered Concept Index |
4478 | @printindex cp | |
4479 | ||
4009494e | 4480 | @bye |