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