Commit | Line | Data |
---|---|---|
3f973d9b AI |
1 | \input texinfo |
2 | ||
3f973d9b | 3 | @setfilename ../info/emacs |
18f952d5 | 4 | @settitle GNU Emacs Manual |
3f973d9b | 5 | |
3f973d9b | 6 | @c The edition number appears in several places in this file |
a59d905d | 7 | @set EDITION Sixteenth |
3efe9e56 | 8 | @set EMACSVER 22.0.92 |
98c4a074 | 9 | |
18f952d5 | 10 | @copying |
98c4a074 EZ |
11 | This is the @value{EDITION} edition of the @cite{GNU Emacs Manual}, |
12 | updated for Emacs version @value{EMACSVER}. | |
3f973d9b | 13 | |
b223e22d | 14 | Copyright @copyright{} 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, |
4e6835db | 15 | 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software |
b223e22d | 16 | Foundation, Inc. |
3f973d9b | 17 | |
18f952d5 | 18 | @quotation |
7a258cfb | 19 | Permission is granted to copy, distribute and/or modify this document |
678e7c71 | 20 | under the terms of the GNU Free Documentation License, Version 1.2 or |
7a258cfb | 21 | any later version published by the Free Software Foundation; with the |
5a7f4c1b RS |
22 | Invariant Sections being ``The GNU Manifesto,'' ``Distribution'' and |
23 | ``GNU GENERAL PUBLIC LICENSE,'' with the Front-Cover texts being ``A GNU | |
80df2fce | 24 | Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the |
7a258cfb | 25 | license is included in the section entitled ``GNU Free Documentation |
80df2fce | 26 | License.'' |
7a258cfb DL |
27 | |
28 | (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify | |
29 | this GNU Manual, like GNU software. Copies published by the Free | |
30 | Software Foundation raise funds for GNU development.'' | |
18f952d5 KB |
31 | @end quotation |
32 | @end copying | |
33 | ||
34 | @dircategory Emacs | |
35 | @direntry | |
36 | * Emacs: (emacs). The extensible self-documenting text editor. | |
37 | @end direntry | |
3f973d9b AI |
38 | |
39 | @c in general, keep the following line commented out, unless doing a | |
40 | @c copy of this manual that will be published. the manual should go | |
177c0ea7 | 41 | @c onto the distribution in the full, 8.5 x 11" size. |
3f973d9b | 42 | |
d7fb7d7f | 43 | @smallbook |
3f973d9b | 44 | |
dfe1fb06 KB |
45 | @c per rms and peterb, use 10pt fonts for the main text, mostly to |
46 | @c save on paper cost. Also do not declare @setchapternewpage odd. | |
47 | @c Do this inside @tex for now, so current makeinfo does not complain. | |
48 | @tex | |
49 | @fonttextsize 10 | |
444246ca | 50 | \global\hbadness=6000 % don't worry about not-too-underfull boxes |
dfe1fb06 KB |
51 | @end tex |
52 | ||
18f952d5 KB |
53 | @defcodeindex op |
54 | @synindex pg cp | |
55 | ||
3f973d9b AI |
56 | @iftex |
57 | @kbdinputstyle code | |
58 | ||
59 | @shorttitlepage GNU Emacs Manual | |
60 | @end iftex | |
18f952d5 | 61 | |
3f973d9b AI |
62 | @titlepage |
63 | @sp 6 | |
64 | @center @titlefont{GNU Emacs Manual} | |
65 | @sp 4 | |
98c4a074 | 66 | @center @value{EDITION} Edition, Updated for Emacs Version @value{EMACSVER}. |
3f973d9b AI |
67 | @sp 5 |
68 | @center Richard Stallman | |
69 | @page | |
70 | @vskip 0pt plus 1filll | |
18f952d5 | 71 | @insertcopying |
3f973d9b | 72 | |
18f952d5 | 73 | @sp 2 |
3bd25af1 | 74 | ISBN 1-882114-86-8* |
3f973d9b | 75 | Published by the Free Software Foundation @* |
a7e3b4ef LK |
76 | 51 Franklin Street, Fifth Floor @* |
77 | Boston, MA 02110-1301 USA | |
3f973d9b AI |
78 | |
79 | @sp 2 | |
80 | Cover art by Etienne Suvasa. | |
81 | ||
82 | @end titlepage | |
af26e673 KB |
83 | |
84 | ||
85 | @summarycontents | |
86 | @contents | |
87 | ||
88 | ||
4f00b8c1 | 89 | @ifnottex |
3f973d9b AI |
90 | @node Top, Distrib, (dir), (dir) |
91 | @top The Emacs Editor | |
92 | ||
93 | Emacs is the extensible, customizable, self-documenting real-time | |
94 | display editor. This Info file describes how to edit with Emacs and | |
98c4a074 EZ |
95 | some of how to customize it; it corresponds to GNU Emacs version |
96 | @value{EMACSVER}. | |
a9278633 EZ |
97 | |
98 | @ifinfo | |
350287ef RS |
99 | To learn more about the Info documentation system, type @kbd{h}, and |
100 | Emacs will take you to a programmed instruction sequence for the Info | |
101 | commands. | |
a9278633 EZ |
102 | @end ifinfo |
103 | ||
b5f1c9fa | 104 | For information on extending Emacs, see @ref{Top, Emacs Lisp,, elisp, The |
3f973d9b | 105 | Emacs Lisp Reference Manual}. |
4f00b8c1 | 106 | @end ifnottex |
3f973d9b AI |
107 | |
108 | @ignore | |
109 | These subcategories have been deleted for simplicity | |
110 | and to avoid conflicts. | |
111 | Completion | |
112 | Backup Files | |
113 | Auto-Saving: Protection Against Disasters | |
114 | Snapshots | |
115 | Text Mode | |
116 | Outline Mode | |
117 | @TeX{} Mode | |
118 | Formatted Text | |
3f973d9b AI |
119 | Shell Command History |
120 | ||
121 | The ones for Dired and Rmail have had the items turned into :: items | |
122 | to avoid conflicts. | |
123 | Also Running Shell Commands from Emacs | |
124 | and Sending Mail and Registers and Minibuffer. | |
125 | @end ignore | |
126 | ||
127 | @menu | |
128 | * Distrib:: How to get the latest Emacs distribution. | |
129 | * Copying:: The GNU General Public License gives you permission | |
130 | to redistribute GNU Emacs on certain terms; | |
131 | it also explains that there is no warranty. | |
7a258cfb | 132 | * GNU Free Documentation License:: The license for this documentation. |
3f973d9b AI |
133 | * Intro:: An introduction to Emacs concepts. |
134 | * Glossary:: The glossary. | |
08d01386 | 135 | * Antinews:: Information about Emacs version 21. |
2f920ca8 | 136 | * Mac OS:: Using Emacs in the Mac. |
53c1041b | 137 | * Microsoft Windows:: Using Emacs on Microsoft Windows and MS-DOS. |
3f973d9b | 138 | * Manifesto:: What's GNU? Gnu's Not Unix! |
607bd994 | 139 | * Acknowledgments:: Major contributors to GNU Emacs. |
3f973d9b | 140 | |
9f4e54c8 | 141 | Indexes (each index contains a large menu) |
3f973d9b | 142 | * Key Index:: An item for each standard Emacs key sequence. |
07d65d5e | 143 | * Option Index:: An item for every command-line option. |
3f973d9b AI |
144 | * Command Index:: An item for each command name. |
145 | * Variable Index:: An item for each documented variable. | |
146 | * Concept Index:: An item for each concept. | |
147 | ||
148 | Important General Concepts | |
149 | * Screen:: How to interpret what you see on the screen. | |
150 | * User Input:: Kinds of input events (characters, buttons, | |
151 | function keys). | |
152 | * Keys:: Key sequences: what you type to request one | |
153 | editing action. | |
154 | * Commands:: Named functions run by key sequences to do editing. | |
177c0ea7 | 155 | * Text Characters:: Character set for text (the contents of buffers |
3f973d9b AI |
156 | and strings). |
157 | * Entering Emacs:: Starting Emacs from the shell. | |
158 | * Exiting:: Stopping or killing Emacs. | |
b4e112e7 | 159 | * Emacs Invocation:: Hairy startup options. |
3f973d9b AI |
160 | |
161 | Fundamental Editing Commands | |
162 | * Basic:: The most basic editing commands. | |
163 | * Minibuffer:: Entering arguments that are prompted for. | |
164 | * M-x:: Invoking commands by their names. | |
165 | * Help:: Commands for asking Emacs about its commands. | |
166 | ||
167 | Important Text-Changing Commands | |
168 | * Mark:: The mark: how to delimit a ``region'' of text. | |
6326f9e5 LT |
169 | * Killing:: Killing (cutting) text. |
170 | * Yanking:: Recovering killed text. Moving text. (Pasting.) | |
3f973d9b AI |
171 | * Accumulating Text:: Other ways of copying text. |
172 | * Rectangles:: Operating on the text inside a rectangle on the screen. | |
173 | * Registers:: Saving a text string or a location in the buffer. | |
174 | * Display:: Controlling what text is displayed. | |
175 | * Search:: Finding or replacing occurrences of a string. | |
176 | * Fixit:: Commands especially useful for fixing typos. | |
4244e880 LT |
177 | * Keyboard Macros:: A keyboard macro records a sequence of |
178 | keystrokes to be replayed with a single command. | |
3f973d9b AI |
179 | |
180 | Major Structures of Emacs | |
181 | * Files:: All about handling files. | |
182 | * Buffers:: Multiple buffers; editing several files at once. | |
183 | * Windows:: Viewing two pieces of text at once. | |
184 | * Frames:: Running the same Emacs session in multiple X windows. | |
76dd3692 | 185 | * International:: Using non-@acronym{ASCII} character sets (the MULE features). |
3f973d9b AI |
186 | |
187 | Advanced Features | |
188 | * Major Modes:: Text mode vs. Lisp mode vs. C mode ... | |
189 | * Indentation:: Editing the white space at the beginnings of lines. | |
190 | * Text:: Commands and modes for editing English. | |
191 | * Programs:: Commands and modes for editing programs. | |
192 | * Building:: Compiling, running and debugging programs. | |
4b827f5d | 193 | * Maintaining:: Features for maintaining large programs. |
3f973d9b AI |
194 | * Abbrevs:: How to define text abbreviations to reduce |
195 | the number of characters you must type. | |
0701f901 EZ |
196 | @ifnottex |
197 | * Picture Mode:: Editing pictures made up of characters using | |
198 | the quarter-plane screen model. | |
199 | @end ifnottex | |
3f973d9b AI |
200 | * Sending Mail:: Sending mail in Emacs. |
201 | * Rmail:: Reading mail in Emacs. | |
202 | * Dired:: You can ``edit'' a directory to manage files in it. | |
203 | * Calendar/Diary:: The calendar and diary facilities. | |
204 | * Gnus:: How to read netnews with Emacs. | |
205 | * Shell:: Executing shell commands from Emacs. | |
206 | * Emacs Server:: Using Emacs as an editing server for @code{mail}, etc. | |
c1d84701 | 207 | * Printing:: Printing hardcopies of buffers or regions. |
3f973d9b AI |
208 | * Sorting:: Sorting lines, paragraphs or pages within Emacs. |
209 | * Narrowing:: Restricting display and editing to a portion | |
210 | of the buffer. | |
211 | * Two-Column:: Splitting apart columns to edit them | |
212 | in side-by-side windows. | |
07d65d5e LK |
213 | * Editing Binary Files::Using Hexl mode to edit binary files. |
214 | * Saving Emacs Sessions:: Saving Emacs state from one session to the next. | |
3f973d9b AI |
215 | * Recursive Edit:: A command can allow you to do editing |
216 | "within the command". This is called a | |
5892cf49 | 217 | "recursive editing level". |
3f973d9b | 218 | * Emulation:: Emulating some other editors with Emacs. |
4f00b8c1 | 219 | * Hyperlinking:: Following links in buffers. |
356dfa97 | 220 | * Thumbnails:: Browsing images using thumbnails. |
3f973d9b AI |
221 | * Dissociated Press:: Dissociating text for fun. |
222 | * Amusements:: Various games and hacks. | |
223 | * Customization:: Modifying the behavior of Emacs. | |
74576486 | 224 | * X Resources:: X resources for customizing Emacs. |
3f973d9b AI |
225 | |
226 | Recovery from Problems | |
227 | * Quitting:: Quitting and aborting. | |
228 | * Lossage:: What to do if Emacs is hung or malfunctioning. | |
229 | * Bugs:: How and when to report a bug. | |
230 | * Contributing:: How to contribute improvements to Emacs. | |
231 | * Service:: How to get help for your own Emacs needs. | |
232 | ||
f1308a07 RS |
233 | Detailed Node Listing |
234 | --------------------- | |
488cacbd | 235 | |
f1308a07 RS |
236 | Here are some other nodes which are really inferiors of the ones |
237 | already listed, mentioned here so you can get to them in one step: | |
3f973d9b AI |
238 | |
239 | The Organization of the Screen | |
240 | ||
241 | * Point:: The place in the text where editing commands operate. | |
242 | * Echo Area:: Short messages appear at the bottom of the screen. | |
243 | * Mode Line:: Interpreting the mode line. | |
244 | * Menu Bar:: How to use the menu bar. | |
245 | ||
246 | Basic Editing Commands | |
247 | ||
248 | * Inserting Text:: Inserting text by simply typing it. | |
249 | * Moving Point:: How to move the cursor to the place where you want to | |
250 | change something. | |
251 | * Erasing:: Deleting and killing text. | |
63c5dbcf | 252 | * Basic Undo:: Undoing recent changes in the text. |
07d65d5e LK |
253 | * Basic Files:: Visiting, creating, and saving files. |
254 | * Basic Help:: Asking what a character does. | |
3f973d9b AI |
255 | * Blank Lines:: Commands to make or delete blank lines. |
256 | * Continuation Lines:: Lines too wide for the screen. | |
257 | * Position Info:: What page, line, row, or column is point on? | |
258 | * Arguments:: Numeric arguments for repeating a command. | |
07d65d5e | 259 | * Repeating:: A short-cut for repeating the previous command. |
3f973d9b AI |
260 | |
261 | The Minibuffer | |
262 | ||
263 | * Minibuffer File:: Entering file names with the minibuffer. | |
264 | * Minibuffer Edit:: How to edit in the minibuffer. | |
265 | * Completion:: An abbreviation facility for minibuffer input. | |
266 | * Minibuffer History:: Reusing recent minibuffer arguments. | |
267 | * Repetition:: Re-executing commands that used the minibuffer. | |
268 | ||
269 | Help | |
270 | ||
271 | * Help Summary:: Brief list of all Help commands. | |
272 | * Key Help:: Asking what a key does in Emacs. | |
273 | * Name Help:: Asking about a command, variable or function name. | |
274 | * Apropos:: Asking what pertains to a given topic. | |
ef043ba0 | 275 | * Help Mode:: Special features of Help mode and Help buffers. |
3f973d9b AI |
276 | * Library Keywords:: Finding Lisp libraries by keywords (topics). |
277 | * Language Help:: Help relating to international language support. | |
278 | * Misc Help:: Other help commands. | |
07d65d5e LK |
279 | * Help Files:: Commands to display pre-written help files. |
280 | * Help Echo:: Help on active text and tooltips (`balloon help') | |
3f973d9b AI |
281 | |
282 | The Mark and the Region | |
283 | ||
284 | * Setting Mark:: Commands to set the mark. | |
285 | * Transient Mark:: How to make Emacs highlight the region-- | |
286 | when there is one. | |
07d65d5e | 287 | * Momentary Mark:: Enabling Transient Mark mode momentarily. |
3f973d9b AI |
288 | * Using Region:: Summary of ways to operate on contents of the region. |
289 | * Marking Objects:: Commands to put region around textual units. | |
290 | * Mark Ring:: Previous mark positions saved so you can go back there. | |
291 | * Global Mark Ring:: Previous mark positions in various buffers. | |
292 | ||
07d65d5e | 293 | Killing and Moving Text |
3f973d9b AI |
294 | |
295 | * Deletion:: Commands for deleting small amounts of text and | |
296 | blank areas. | |
297 | * Killing by Lines:: How to kill entire lines of text at one time. | |
298 | * Other Kill Commands:: Commands to kill large regions of text and | |
177c0ea7 | 299 | syntactic units such as words and sentences. |
318aa7ba KS |
300 | * CUA Bindings:: Using @kbd{C-x}, @kbd{C-c}, @kbd{C-v} for copy |
301 | and paste, with enhanced rectangle support. | |
3f973d9b AI |
302 | |
303 | Yanking | |
304 | ||
305 | * Kill Ring:: Where killed text is stored. Basic yanking. | |
306 | * Appending Kills:: Several kills in a row all yank together. | |
307 | * Earlier Kills:: Yanking something killed some time ago. | |
308 | ||
309 | Registers | |
310 | ||
311 | * RegPos:: Saving positions in registers. | |
312 | * RegText:: Saving text in registers. | |
313 | * RegRect:: Saving rectangles in registers. | |
314 | * RegConfig:: Saving window configurations in registers. | |
07d65d5e | 315 | * RegNumbers:: Numbers in registers. |
3f973d9b AI |
316 | * RegFiles:: File names in registers. |
317 | * Bookmarks:: Bookmarks are like registers, but persistent. | |
318 | ||
319 | Controlling the Display | |
320 | ||
63c5dbcf | 321 | * Scrolling:: Moving text up and down in a window. |
9f4e54c8 | 322 | * Auto Scrolling:: Redisplay scrolls text automatically when needed. |
63c5dbcf RS |
323 | * Horizontal Scrolling:: Moving text left and right in a window. |
324 | * Follow Mode:: Follow mode lets two windows scroll as one. | |
3f6cafd9 | 325 | * Faces:: How to change the display style using faces. |
258158c0 | 326 | * Standard Faces:: Emacs' predefined faces. |
3f6cafd9 | 327 | * Font Lock:: Minor mode for syntactic highlighting using faces. |
3f6cafd9 | 328 | * Highlight Interactively:: Tell Emacs what text to highlight. |
3f6cafd9 | 329 | * Fringes:: Enabling or disabling window fringes. |
cfade67d | 330 | * Displaying Boundaries:: Displaying top and bottom of the buffer. |
3f6cafd9 | 331 | * Useless Whitespace:: Showing possibly-spurious trailing whitespace. |
3f973d9b AI |
332 | * Selective Display:: Hiding lines with lots of indentation. |
333 | * Optional Mode Line:: Optional mode line display features. | |
3f6cafd9 RS |
334 | * Text Display:: How text characters are normally displayed. |
335 | * Cursor Display:: Features for displaying the cursor. | |
cfade67d RS |
336 | * Line Truncation:: Truncating lines to fit the screen width instead |
337 | of continuing them to multiple screen lines. | |
5892cf49 | 338 | * Display Custom:: Information on variables for customizing display. |
3f973d9b AI |
339 | |
340 | Searching and Replacement | |
341 | ||
342 | * Incremental Search:: Search happens as you type the string. | |
343 | * Nonincremental Search:: Specify entire string and then search. | |
344 | * Word Search:: Search for sequence of words. | |
345 | * Regexp Search:: Search for match for a regexp. | |
346 | * Regexps:: Syntax of regular expressions. | |
347 | * Search Case:: To ignore case while searching, or not. | |
348 | * Replace:: Search, and replace some or all matches. | |
349 | * Other Repeating Search:: Operating on all matches for some regexp. | |
350 | ||
351 | Replacement Commands | |
352 | ||
353 | * Unconditional Replace:: Replacing all matches for a string. | |
354 | * Regexp Replace:: Replacing all matches for a regexp. | |
355 | * Replacement and Case:: How replacements preserve case of letters. | |
356 | * Query Replace:: How to use querying. | |
357 | ||
358 | Commands for Fixing Typos | |
359 | ||
63c5dbcf | 360 | * Undo:: Full details of Emacs undo commands. |
3f973d9b AI |
361 | * Kill Errors:: Commands to kill a batch of recently entered text. |
362 | * Transpose:: Exchanging two characters, words, lines, lists... | |
363 | * Fixing Case:: Correcting case of last word entered. | |
364 | * Spelling:: Apply spelling checker to a word or a whole buffer. | |
365 | ||
4244e880 LT |
366 | Keyboard Macros |
367 | ||
368 | * Basic Keyboard Macro:: Defining and running keyboard macros. | |
369 | * Keyboard Macro Ring:: Where previous keyboard macros are saved. | |
370 | * Keyboard Macro Counter:: Inserting incrementing numbers in macros. | |
371 | * Keyboard Macro Query:: Making keyboard macros do different things each time. | |
372 | * Save Keyboard Macro:: Giving keyboard macros names; saving them in files. | |
373 | * Edit Keyboard Macro:: Editing keyboard macros. | |
07d65d5e LK |
374 | * Keyboard Macro Step-Edit:: Interactively executing and editing a keyboard |
375 | macro. | |
4244e880 | 376 | |
3f973d9b AI |
377 | File Handling |
378 | ||
379 | * File Names:: How to type and edit file-name arguments. | |
380 | * Visiting:: Visiting a file prepares Emacs to edit the file. | |
381 | * Saving:: Saving makes your changes permanent. | |
382 | * Reverting:: Reverting cancels all the changes not saved. | |
383 | * Auto Save:: Auto Save periodically protects against loss of data. | |
384 | * File Aliases:: Handling multiple names for one file. | |
385 | * Version Control:: Version control systems (RCS, CVS and SCCS). | |
386 | * Directories:: Creating, deleting, and listing file directories. | |
387 | * Comparing Files:: Finding where two files differ. | |
53727721 | 388 | * Diff Mode:: Editing diff output. |
3f973d9b AI |
389 | * Misc File Ops:: Other things you can do on files. |
390 | * Compressed Files:: Accessing compressed files. | |
ff9705de | 391 | * File Archives:: Operating on tar, zip, jar etc. archive files. |
3f973d9b AI |
392 | * Remote Files:: Accessing files on other sites. |
393 | * Quoted File Names:: Quoting special characters in file names. | |
ff9705de RS |
394 | * File Name Cache:: Completion against a list of files you often use. |
395 | * File Conveniences:: Convenience Features for Finding Files. | |
396 | * Filesets:: Handling sets of files. | |
3f973d9b AI |
397 | |
398 | Saving Files | |
399 | ||
c638ec8a | 400 | * Save Commands:: Commands for saving files. |
3f973d9b | 401 | * Backup:: How Emacs saves the old version of your file. |
c638ec8a | 402 | * Customize Save:: Customizing the saving of files. |
3f973d9b AI |
403 | * Interlocking:: How Emacs protects against simultaneous editing |
404 | of one file by two users. | |
07d65d5e | 405 | * File Shadowing:: Copying files to "shadows" automatically. |
ff9705de | 406 | * Time Stamps:: Emacs can update time stamps on saved files. |
3f973d9b AI |
407 | |
408 | Version Control | |
409 | ||
410 | * Introduction to VC:: How version control works in general. | |
ff9705de | 411 | * VC Mode Line:: How the mode line shows version control status. |
3f973d9b AI |
412 | * Basic VC Editing:: How to edit a file under version control. |
413 | * Old Versions:: Examining and comparing old versions. | |
07d65d5e | 414 | * Secondary VC Commands:: The commands used a little less frequently. |
3f973d9b | 415 | * Branches:: Multiple lines of development. |
3f973d9b AI |
416 | |
417 | Using Multiple Buffers | |
418 | ||
419 | * Select Buffer:: Creating a new buffer or reselecting an old one. | |
420 | * List Buffers:: Getting a list of buffers that exist. | |
47d7776c | 421 | * Misc Buffer:: Renaming; changing read-onliness; copying text. |
3f973d9b AI |
422 | * Kill Buffer:: Killing buffers you no longer need. |
423 | * Several Buffers:: How to go through the list of all buffers | |
424 | and operate variously on several of them. | |
177c0ea7 | 425 | * Indirect Buffers:: An indirect buffer shares the text of another buffer. |
07d65d5e LK |
426 | * Buffer Convenience:: Convenience and customization features for |
427 | buffer handling. | |
3f973d9b AI |
428 | |
429 | Multiple Windows | |
430 | ||
431 | * Basic Window:: Introduction to Emacs windows. | |
432 | * Split Window:: New windows are made by splitting existing windows. | |
433 | * Other Window:: Moving to another window or doing something to it. | |
434 | * Pop Up Window:: Finding a file or buffer in another window. | |
435 | * Force Same Window:: Forcing certain buffers to appear in the selected | |
436 | window rather than in another window. | |
437 | * Change Window:: Deleting windows and changing their sizes. | |
07d65d5e | 438 | * Window Convenience:: Convenience functions for window handling. |
3f973d9b AI |
439 | |
440 | Frames and X Windows | |
441 | ||
9e6728e3 | 442 | * Cut and Paste:: Mouse commands for cut and paste. |
3f973d9b AI |
443 | * Mouse References:: Using the mouse to select an item from a list. |
444 | * Menu Mouse Clicks:: Mouse clicks that bring up menus. | |
445 | * Mode Line Mouse:: Mouse clicks on the mode line. | |
446 | * Creating Frames:: Creating additional Emacs frames with various contents. | |
5892cf49 RS |
447 | * Frame Commands:: Iconifying, deleting, and switching frames. |
448 | * Speedbar:: How to make and use a speedbar frame. | |
3f973d9b AI |
449 | * Multiple Displays:: How one Emacs job can talk to several displays. |
450 | * Special Buffer Frames:: You can make certain buffers have their own frames. | |
451 | * Frame Parameters:: Changing the colors and other modes of frames. | |
452 | * Scroll Bars:: How to enable and disable scroll bars; how to use them. | |
5892cf49 | 453 | * Wheeled Mice:: Using mouse wheels for scrolling. |
3f6cafd9 | 454 | * Drag and Drop:: Using drag and drop to open files and insert text. |
3f973d9b | 455 | * Menu Bars:: Enabling and disabling the menu bar. |
5892cf49 RS |
456 | * Tool Bars:: Enabling and disabling the tool bar. |
457 | * Dialog Boxes:: Controlling use of dialog boxes. | |
3f6cafd9 | 458 | * Tooltips:: Showing "tooltips", AKA "balloon help" for active text. |
5892cf49 | 459 | * Mouse Avoidance:: Moving the mouse pointer out of the way. |
3f973d9b | 460 | * Non-Window Terminals:: Multiple frames on terminals that show only one. |
abc8be34 | 461 | * Text-Only Mouse:: Using the mouse in text-only terminals. |
3f973d9b AI |
462 | |
463 | International Character Set Support | |
464 | ||
9c9cbe8b | 465 | * International Chars:: Basic concepts of multibyte characters. |
3f973d9b AI |
466 | * Enabling Multibyte:: Controlling whether to use multibyte characters. |
467 | * Language Environments:: Setting things up for the language you use. | |
468 | * Input Methods:: Entering text characters not on your keyboard. | |
469 | * Select Input Method:: Specifying your choice of input methods. | |
07d65d5e | 470 | * Multibyte Conversion:: How single-byte characters convert to multibyte. |
3f973d9b AI |
471 | * Coding Systems:: Character set conversion when you read and |
472 | write files, and so on. | |
473 | * Recognize Coding:: How Emacs figures out which conversion to use. | |
9f4e54c8 RS |
474 | * Specify Coding:: Specifying a file's coding system explicitly. |
475 | * Output Coding:: Choosing coding systems for output. | |
91af4758 | 476 | * Text Coding:: Choosing conversion to use for file text. |
c79fccd6 | 477 | * Communication Coding:: Coding systems for interprocess communication. |
91af4758 RS |
478 | * File Name Coding:: Coding systems for file @emph{names}. |
479 | * Terminal Coding:: Specifying coding systems for converting | |
480 | terminal input and output. | |
3f973d9b AI |
481 | * Fontsets:: Fontsets are collections of fonts |
482 | that cover the whole spectrum of characters. | |
483 | * Defining Fontsets:: Defining a new fontset. | |
07d65d5e | 484 | * Undisplayable Characters::When characters don't display. |
5a579270 | 485 | * Unibyte Mode:: You can pick one European character set |
07d65d5e LK |
486 | to use without multibyte characters. |
487 | * Charsets:: How Emacs groups its internal character codes. | |
3f973d9b AI |
488 | |
489 | Major Modes | |
490 | ||
491 | * Choosing Modes:: How major modes are specified or chosen. | |
492 | ||
493 | Indentation | |
494 | ||
495 | * Indentation Commands:: Various commands and techniques for indentation. | |
496 | * Tab Stops:: You can set arbitrary "tab stops" and then | |
497 | indent to the next tab stop when you want to. | |
498 | * Just Spaces:: You can request indentation using just spaces. | |
499 | ||
500 | Commands for Human Languages | |
501 | ||
502 | * Words:: Moving over and killing words. | |
503 | * Sentences:: Moving over and killing sentences. | |
504 | * Paragraphs:: Moving over paragraphs. | |
505 | * Pages:: Moving over pages. | |
506 | * Filling:: Filling or justifying text. | |
507 | * Case:: Changing the case of text. | |
508 | * Text Mode:: The major modes for editing text files. | |
509 | * Outline Mode:: Editing outlines. | |
510 | * TeX Mode:: Editing input to the formatter TeX. | |
07d65d5e | 511 | * HTML Mode:: Editing HTML, SGML, and XML files. |
3f973d9b AI |
512 | * Nroff Mode:: Editing input to the formatter nroff. |
513 | * Formatted Text:: Editing formatted text directly in WYSIWYG fashion. | |
07d65d5e | 514 | * Text Based Tables:: Editing text-based tables in WYSIWYG fashion. |
3f973d9b AI |
515 | |
516 | Filling Text | |
517 | ||
518 | * Auto Fill:: Auto Fill mode breaks long lines automatically. | |
07d65d5e | 519 | * Refill:: Keeping paragraphs filled. |
3f973d9b AI |
520 | * Fill Commands:: Commands to refill paragraphs and center lines. |
521 | * Fill Prefix:: Filling paragraphs that are indented | |
522 | or in a comment, etc. | |
523 | * Adaptive Fill:: How Emacs can determine the fill prefix automatically. | |
07d65d5e | 524 | * Longlines:: Editing text with very long lines. |
3f973d9b AI |
525 | |
526 | Editing Programs | |
527 | ||
528 | * Program Modes:: Major modes for editing programs. | |
4b827f5d RS |
529 | * Defuns:: Commands to operate on major top-level parts |
530 | of a program. | |
3f973d9b | 531 | * Program Indent:: Adjusting indentation to show the nesting. |
4b827f5d | 532 | * Parentheses:: Commands that operate on parentheses. |
07d65d5e | 533 | * Comments:: Inserting, killing, and aligning comments. |
3f973d9b | 534 | * Documentation:: Getting documentation of functions you plan to call. |
4b827f5d RS |
535 | * Hideshow:: Displaying blocks selectively. |
536 | * Symbol Completion:: Completion on symbol names of your program or language. | |
537 | * Glasses:: Making identifiersLikeThis more readable. | |
538 | * Misc for Programs:: Other Emacs features useful for editing programs. | |
539 | * C Modes:: Special commands of C, C++, Objective-C, | |
540 | Java, and Pike modes. | |
4b827f5d RS |
541 | * Asm Mode:: Asm mode and its special features. |
542 | ||
543 | Top-Level Definitions, or Defuns | |
544 | ||
545 | * Left Margin Paren:: An open-paren or similar opening delimiter | |
546 | starts a defun if it is at the left margin. | |
547 | * Moving by Defuns:: Commands to move over or mark a major definition. | |
548 | * Imenu:: Making buffer indexes as menus. | |
549 | * Which Function:: Which Function mode shows which function you are in. | |
3f973d9b AI |
550 | |
551 | Indentation for Programs | |
552 | ||
553 | * Basic Indent:: Indenting a single line. | |
4b827f5d | 554 | * Multi-line Indent:: Commands to reindent many lines at once. |
3f973d9b | 555 | * Lisp Indent:: Specifying how each Lisp function should be indented. |
4b827f5d RS |
556 | * C Indent:: Extra features for indenting C and related modes. |
557 | * Custom C Indent:: Controlling indentation style for C and related modes. | |
3f973d9b | 558 | |
4b827f5d | 559 | Commands for Editing with Parentheses |
3f973d9b | 560 | |
4b827f5d RS |
561 | * Expressions:: Expressions with balanced parentheses. |
562 | * Moving by Parens:: Commands for moving up, down and across | |
563 | in the structure of parentheses. | |
564 | * Matching:: Insertion of a close-delimiter flashes matching open. | |
3f973d9b | 565 | |
4b827f5d | 566 | Manipulating Comments |
3f973d9b | 567 | |
4b827f5d RS |
568 | * Comment Commands:: Inserting, killing, and indenting comments. |
569 | * Multi-Line Comments:: Commands for adding and editing multi-line comments. | |
570 | * Options for Comments::Customizing the comment features. | |
571 | ||
572 | Documentation Lookup | |
573 | ||
574 | * Info Lookup:: Looking up library functions and commands | |
575 | in Info files. | |
576 | * Man Page:: Looking up man pages of library functions and commands. | |
577 | * Lisp Doc:: Looking up Emacs Lisp functions, etc. | |
578 | ||
579 | C and Related Modes | |
580 | ||
581 | * Motion in C:: Commands to move by C statements, etc. | |
582 | * Electric C:: Colon and other chars can automatically reindent. | |
583 | * Hungry Delete:: A more powerful DEL command. | |
584 | * Other C Commands:: Filling comments, viewing expansion of macros, | |
585 | and other neat features. | |
4b827f5d | 586 | |
3f973d9b AI |
587 | Compiling and Testing Programs |
588 | ||
589 | * Compilation:: Compiling programs in languages other | |
590 | than Lisp (C, Pascal, etc.). | |
591 | * Compilation Mode:: The mode for visiting compiler errors. | |
592 | * Compilation Shell:: Customizing your shell properly | |
593 | for use in the compilation buffer. | |
05ff843e RS |
594 | * Grep Searching:: Searching with grep. |
595 | * Flymake:: Finding syntax errors on the fly. | |
177c0ea7 JB |
596 | * Debuggers:: Running symbolic debuggers for non-Lisp programs. |
597 | * Executing Lisp:: Various modes for editing Lisp programs, | |
3f973d9b | 598 | with different facilities for running |
177c0ea7 | 599 | the Lisp programs. |
3f973d9b | 600 | * Lisp Libraries:: Creating Lisp programs to run in Emacs. |
3f973d9b | 601 | * Lisp Eval:: Executing a single Lisp expression in Emacs. |
07d65d5e | 602 | * Lisp Interaction:: Executing Lisp in an Emacs buffer. |
177c0ea7 | 603 | * External Lisp:: Communicating through Emacs with a separate Lisp. |
3f973d9b AI |
604 | |
605 | Running Debuggers Under Emacs | |
606 | ||
607 | * Starting GUD:: How to start a debugger subprocess. | |
608 | * Debugger Operation:: Connection between the debugger and source buffers. | |
609 | * Commands of GUD:: Key bindings for common commands. | |
610 | * GUD Customization:: Defining your own commands for GUD. | |
07d65d5e LK |
611 | * GDB Graphical Interface:: An enhanced mode that uses GDB features to |
612 | implement a graphical debugging environment through | |
613 | Emacs. | |
3f973d9b | 614 | |
d7fb7d7f | 615 | Maintaining Large Programs |
4b827f5d RS |
616 | |
617 | * Change Log:: Maintaining a change history for your program. | |
5a579270 | 618 | * Format of ChangeLog:: What the change log file looks like. |
4b827f5d RS |
619 | * Tags:: Go direct to any function in your program in one |
620 | command. Tags remembers which file it is in. | |
4b827f5d RS |
621 | |
622 | Tags Tables | |
623 | ||
177c0ea7 | 624 | * Tag Syntax:: Tag syntax for various types of code and text files. |
4b827f5d | 625 | * Create Tags Table:: Creating a tags table with @code{etags}. |
07d65d5e | 626 | * Etags Regexps:: Create arbitrary tags using regular expressions. |
4b827f5d | 627 | * Select Tags Table:: How to visit a tags table. |
177c0ea7 | 628 | * Find Tag:: Commands to find the definition of a specific tag. |
4b827f5d RS |
629 | * Tags Search:: Using a tags table for searching and replacing. |
630 | * List Tags:: Listing and finding tags defined in a file. | |
631 | ||
3f973d9b AI |
632 | Abbrevs |
633 | ||
634 | * Abbrev Concepts:: Fundamentals of defined abbrevs. | |
635 | * Defining Abbrevs:: Defining an abbrev, so it will expand when typed. | |
636 | * Expanding Abbrevs:: Controlling expansion: prefixes, canceling expansion. | |
637 | * Editing Abbrevs:: Viewing or editing the entire list of defined abbrevs. | |
638 | * Saving Abbrevs:: Saving the entire list of abbrevs for another session. | |
639 | * Dynamic Abbrevs:: Abbreviations for words already in the buffer. | |
07d65d5e | 640 | * Dabbrev Customization:: What is a word, for dynamic abbrevs. Case handling. |
3f973d9b | 641 | |
0701f901 EZ |
642 | @ifnottex |
643 | Editing Pictures | |
644 | ||
645 | * Basic Picture:: Basic concepts and simple commands of Picture Mode. | |
646 | * Insert in Picture:: Controlling direction of cursor motion | |
647 | after "self-inserting" characters. | |
648 | * Tabs in Picture:: Various features for tab stops and indentation. | |
649 | * Rectangles in Picture:: Clearing and superimposing rectangles. | |
650 | @end ifnottex | |
651 | ||
3f973d9b AI |
652 | Sending Mail |
653 | ||
654 | * Mail Format:: Format of the mail being composed. | |
655 | * Mail Headers:: Details of permitted mail header fields. | |
656 | * Mail Aliases:: Abbreviating and grouping mail addresses. | |
657 | * Mail Mode:: Special commands for editing mail being composed. | |
8a792d55 | 658 | * Mail Amusements:: Distract the NSA's attention; add a fortune to a msg. |
3f973d9b AI |
659 | * Mail Methods:: Using alternative mail-composition methods. |
660 | ||
661 | Reading Mail with Rmail | |
662 | ||
663 | * Rmail Basics:: Basic concepts of Rmail, and simple use. | |
664 | * Rmail Scrolling:: Scrolling through a message. | |
665 | * Rmail Motion:: Moving to another message. | |
666 | * Rmail Deletion:: Deleting and expunging messages. | |
667 | * Rmail Inbox:: How mail gets into the Rmail file. | |
668 | * Rmail Files:: Using multiple Rmail files. | |
669 | * Rmail Output:: Copying message out to files. | |
670 | * Rmail Labels:: Classifying messages by labeling them. | |
671 | * Rmail Attributes:: Certain standard labels, called attributes. | |
672 | * Rmail Reply:: Sending replies to messages you are viewing. | |
673 | * Rmail Summary:: Summaries show brief info on many messages. | |
674 | * Rmail Sorting:: Sorting messages in Rmail. | |
675 | * Rmail Display:: How Rmail displays a message; customization. | |
07d65d5e | 676 | * Rmail Coding:: How Rmail handles decoding character sets. |
3f973d9b AI |
677 | * Rmail Editing:: Editing message text and headers in Rmail. |
678 | * Rmail Digest:: Extracting the messages from a digest message. | |
679 | * Out of Rmail:: Converting an Rmail file to mailbox format. | |
680 | * Rmail Rot13:: Reading messages encoded in the rot13 code. | |
681 | * Movemail:: More details of fetching new mail. | |
07d65d5e LK |
682 | * Remote Mailboxes:: Retrieving Mail from Remote Mailboxes. |
683 | * Other Mailbox Formats:: Retrieving Mail from Local Mailboxes in | |
684 | Various Formats | |
3f973d9b AI |
685 | |
686 | Dired, the Directory Editor | |
687 | ||
688 | * Dired Enter:: How to invoke Dired. | |
c3149267 | 689 | * Dired Navigation:: How to move in the Dired buffer. |
3f973d9b AI |
690 | * Dired Deletion:: Deleting files with Dired. |
691 | * Flagging Many Files:: Flagging files based on their names. | |
692 | * Dired Visiting:: Other file operations through Dired. | |
693 | * Marks vs Flags:: Flagging for deletion vs marking. | |
694 | * Operating on Files:: How to copy, rename, print, compress, etc. | |
695 | either one file or several files. | |
696 | * Shell Commands in Dired:: Running a shell command on the marked files. | |
697 | * Transforming File Names:: Using patterns to rename multiple files. | |
698 | * Comparison in Dired:: Running `diff' by way of Dired. | |
699 | * Subdirectories in Dired:: Adding subdirectories to the Dired buffer. | |
700 | * Subdirectory Motion:: Moving across subdirectories, and up and down. | |
701 | * Hiding Subdirectories:: Making subdirectories visible or invisible. | |
702 | * Dired Updating:: Discarding lines for files of no interest. | |
703 | * Dired and Find:: Using `find' to choose the files for Dired. | |
10510ea3 RS |
704 | * Wdired:: Operating on files by editing the Dired buffer. |
705 | * Misc Dired Features:: Various other features. | |
3f973d9b AI |
706 | |
707 | The Calendar and the Diary | |
708 | ||
709 | * Calendar Motion:: Moving through the calendar; selecting a date. | |
710 | * Scroll Calendar:: Bringing earlier or later months onto the screen. | |
711 | * Counting Days:: How many days are there between two dates? | |
712 | * General Calendar:: Exiting or recomputing the calendar. | |
86ab1238 | 713 | * Writing Calendar Files:: Writing calendars to files of various formats. |
3f973d9b AI |
714 | * Holidays:: Displaying dates of holidays. |
715 | * Sunrise/Sunset:: Displaying local times of sunrise and sunset. | |
716 | * Lunar Phases:: Displaying phases of the moon. | |
717 | * Other Calendars:: Converting dates to other calendar systems. | |
718 | * Diary:: Displaying events from your diary. | |
719 | * Appointments:: Reminders when it's time to do something. | |
07d65d5e | 720 | * Importing Diary:: Converting diary events to/from other formats. |
3f973d9b | 721 | * Daylight Savings:: How to specify when daylight savings time is active. |
07d65d5e | 722 | * Time Intervals:: Keeping track of time intervals. |
3f973d9b AI |
723 | |
724 | Movement in the Calendar | |
725 | ||
726 | * Calendar Unit Motion:: Moving by days, weeks, months, and years. | |
727 | * Move to Beginning or End:: Moving to start/end of weeks, months, and years. | |
728 | * Specified Dates:: Moving to the current date or another | |
729 | specific date. | |
730 | ||
731 | Conversion To and From Other Calendars | |
732 | ||
733 | * Calendar Systems:: The calendars Emacs understands | |
734 | (aside from Gregorian). | |
735 | * To Other Calendar:: Converting the selected date to various calendars. | |
736 | * From Other Calendar:: Moving to a date specified in another calendar. | |
737 | * Mayan Calendar:: Moving to a date specified in a Mayan calendar. | |
738 | ||
739 | The Diary | |
740 | ||
a72bfb87 | 741 | * Displaying the Diary:: Viewing diary entries and associated calendar dates. |
3f973d9b AI |
742 | * Format of Diary File:: Entering events in your diary. |
743 | * Date Formats:: Various ways you can specify dates. | |
744 | * Adding to Diary:: Commands to create diary entries. | |
745 | * Special Diary Entries:: Anniversaries, blocks of dates, cyclic entries, etc. | |
746 | ||
76dd3692 | 747 | Gnus |
3f973d9b AI |
748 | |
749 | * Buffers of Gnus:: The group, summary, and article buffers. | |
750 | * Gnus Startup:: What you should know about starting Gnus. | |
751 | * Summary of Gnus:: A short description of the basic Gnus commands. | |
752 | ||
753 | Running Shell Commands from Emacs | |
754 | ||
755 | * Single Shell:: How to run one shell command and return. | |
756 | * Interactive Shell:: Permanent shell taking input via Emacs. | |
757 | * Shell Mode:: Special Emacs commands used with permanent shell. | |
07d65d5e | 758 | * Shell Prompts:: Two ways to recognize shell prompts. |
3f973d9b | 759 | * Shell History:: Repeating previous commands in a shell buffer. |
07d65d5e | 760 | * Directory Tracking:: Keeping track when the subshell changes directory. |
3f973d9b | 761 | * Shell Options:: Options for customizing Shell mode. |
07d65d5e LK |
762 | * Terminal emulator:: An Emacs window as a terminal emulator. |
763 | * Term Mode:: Special Emacs commands used in Term mode. | |
764 | * Paging in Term:: Paging in the terminal emulator. | |
3f973d9b AI |
765 | * Remote Host:: Connecting to another computer. |
766 | ||
07d65d5e LK |
767 | Using Emacs as a Server |
768 | ||
769 | * Invoking emacsclient:: Emacs client startup options. | |
770 | ||
771 | Hyperlinking and Navigation Features | |
772 | ||
773 | * Browse-URL:: Following URLs. | |
774 | * Goto-address:: Activating URLs. | |
775 | * FFAP:: Finding files etc. at point. | |
776 | ||
3f973d9b AI |
777 | Customization |
778 | ||
779 | * Minor Modes:: Each minor mode is one feature you can turn on | |
780 | independently of any others. | |
07d65d5e | 781 | * Easy Customization:: Convenient way to browse and change user options. |
3f973d9b AI |
782 | * Variables:: Many Emacs commands examine Emacs variables |
783 | to decide what to do; by setting variables, | |
784 | you can control their functioning. | |
3f973d9b AI |
785 | * Key Bindings:: The keymaps say what command each key runs. |
786 | By changing them, you can "redefine keys". | |
3f973d9b | 787 | * Syntax:: The syntax table controls how words and |
07d65d5e | 788 | expressions are parsed. |
3f973d9b | 789 | * Init File:: How to write common customizations in the |
177c0ea7 | 790 | @file{.emacs} file. |
3f973d9b AI |
791 | |
792 | Variables | |
793 | ||
794 | * Examining:: Examining or setting one variable's value. | |
3f973d9b AI |
795 | * Hooks:: Hook variables let you specify programs for parts |
796 | of Emacs to run on particular occasions. | |
797 | * Locals:: Per-buffer values of variables. | |
798 | * File Variables:: How files can specify variable values. | |
799 | ||
3f973d9b AI |
800 | Customizing Key Bindings |
801 | ||
802 | * Keymaps:: Generalities. The global keymap. | |
803 | * Prefix Keymaps:: Keymaps for prefix keys. | |
804 | * Local Keymaps:: Major and minor modes have their own keymaps. | |
805 | * Minibuffer Maps:: The minibuffer uses its own local keymaps. | |
806 | * Rebinding:: How to redefine one key's meaning conveniently. | |
807 | * Init Rebinding:: Rebinding keys with your init file, @file{.emacs}. | |
808 | * Function Keys:: Rebinding terminal function keys. | |
809 | * Named ASCII Chars:: Distinguishing @key{TAB} from @kbd{C-i}, and so on. | |
07d65d5e | 810 | * Non-ASCII Rebinding:: Rebinding non-@acronym{ASCII} characters such as Latin-1. |
3f973d9b AI |
811 | * Mouse Buttons:: Rebinding mouse buttons in Emacs. |
812 | * Disabling:: Disabling a command means confirmation is required | |
813 | before it can be executed. This is done to protect | |
814 | beginners from surprises. | |
815 | ||
816 | The Init File, @file{~/.emacs} | |
817 | ||
818 | * Init Syntax:: Syntax of constants in Emacs Lisp. | |
819 | * Init Examples:: How to do some things with an init file. | |
820 | * Terminal Init:: Each terminal type can have an init file. | |
821 | * Find Init:: How Emacs finds the init file. | |
822 | ||
823 | Dealing with Emacs Trouble | |
824 | ||
82f6ab38 | 825 | * DEL Does Not Delete:: What to do if @key{DEL} doesn't delete. |
3f973d9b AI |
826 | * Stuck Recursive:: `[...]' in mode line around the parentheses. |
827 | * Screen Garbled:: Garbage on the screen. | |
828 | * Text Garbled:: Garbage in the text. | |
3f973d9b | 829 | * Memory Full:: How to cope when you run out of memory. |
07d65d5e | 830 | * After a Crash:: Recovering editing in an Emacs session that crashed. |
3f973d9b AI |
831 | * Emergency Escape:: Emergency escape--- |
832 | What to do if Emacs stops responding. | |
833 | * Total Frustration:: When you are at your wits' end. | |
834 | ||
835 | Reporting Bugs | |
836 | ||
07d65d5e LK |
837 | * Bug Criteria:: Have you really found a bug? |
838 | * Understanding Bug Reporting:: How to report a bug effectively. | |
839 | * Checklist:: Steps to follow for a good bug report. | |
840 | * Sending Patches:: How to send a patch for GNU Emacs. | |
3f973d9b | 841 | |
07d65d5e | 842 | Command Line Arguments for Emacs Invocation |
3f973d9b AI |
843 | |
844 | * Action Arguments:: Arguments to visit files, load libraries, | |
845 | and call functions. | |
846 | * Initial Options:: Arguments that take effect while starting Emacs. | |
847 | * Command Example:: Examples of using command line arguments. | |
848 | * Resume Arguments:: Specifying arguments when you resume a running Emacs. | |
849 | * Environment:: Environment variables that Emacs uses. | |
3f973d9b AI |
850 | * Display X:: Changing the default display and using remote login. |
851 | * Font X:: Choosing a font for text, under X. | |
ed6a2558 | 852 | * Colors:: Choosing display colors. |
3f973d9b AI |
853 | * Window Size X:: Start-up window size, under X. |
854 | * Borders X:: Internal and external borders, under X. | |
855 | * Title X:: Specifying the initial frame's title. | |
856 | * Icons X:: Choosing what sort of icon to use, under X. | |
2ca5e353 | 857 | * Misc X:: Other display options. |
306d63c4 | 858 | |
07d65d5e LK |
859 | Environment Variables |
860 | ||
861 | * General Variables:: Environment variables that all versions of Emacs use. | |
862 | * Misc Variables:: Certain system specific variables. | |
863 | * MS-Windows Registry:: An alternative to the environment on MS-Windows. | |
864 | ||
865 | X Options and Resources | |
306d63c4 RS |
866 | |
867 | * Resources:: Using X resources with Emacs (in general). | |
868 | * Table of Resources:: Table of specific X resources that affect Emacs. | |
869 | * Face Resources:: X resources for customizing faces. | |
3f973d9b | 870 | * Lucid Resources:: X resources for Lucid menus. |
f910bdeb | 871 | * LessTif Resources:: X resources for LessTif and Motif menus. |
07d65d5e | 872 | * GTK resources:: Resources for GTK widgets. |
3f973d9b | 873 | |
70dc6062 | 874 | Emacs and Mac OS |
3f973d9b | 875 | |
70dc6062 YM |
876 | * Mac Input:: Keyboard and mouse input on Mac. |
877 | * Mac International:: International character sets on Mac. | |
07d65d5e | 878 | * Mac Environment Variables:: Setting environment variables for Emacs. |
70dc6062 YM |
879 | * Mac Directories:: Volumes and directories on Mac. |
880 | * Mac Font Specs:: Specifying fonts on Mac. | |
07d65d5e | 881 | * Mac Functions:: Mac-specific Lisp functions. |
3f973d9b | 882 | |
e691d082 | 883 | Emacs and Microsoft Windows |
3f973d9b | 884 | |
4179c1d6 EZ |
885 | * Text and Binary:: Text files use CRLF to terminate lines. |
886 | * Windows Files:: File-name conventions on Windows. | |
887 | * ls in Lisp:: Emulation of @code{ls} for Dired. | |
888 | * Windows HOME:: Where Emacs looks for your @file{.emacs}. | |
889 | * Windows Keyboard:: Windows-specific keyboard features. | |
890 | * Windows Mouse:: Windows-specific mouse features. | |
3f973d9b | 891 | * Windows Processes:: Running subprocesses on Windows. |
4179c1d6 EZ |
892 | * Windows Printing:: How to specify the printer on MS-Windows. |
893 | * Windows Misc:: Miscellaneous Windows features. | |
3f973d9b AI |
894 | @end menu |
895 | ||
896 | @iftex | |
897 | @unnumbered Preface | |
898 | ||
899 | This manual documents the use and simple customization of the Emacs | |
350287ef RS |
900 | editor. Simple Emacs customizations do not require you to be a |
901 | programmer, but if you are not interested in customizing, you can | |
902 | ignore the customization hints. | |
3f973d9b AI |
903 | |
904 | This is primarily a reference manual, but can also be used as a | |
edc89fbc | 905 | primer. If you are new to Emacs, we recommend you start with |
350287ef RS |
906 | the on-line, learn-by-doing tutorial, before reading the manual. To |
907 | run the tutorial, start Emacs and type @kbd{C-h t}. The tutorial | |
908 | describes commands, tells you when to try them, and explains the | |
909 | results. | |
3f973d9b AI |
910 | |
911 | On first reading, just skim chapters 1 and 2, which describe the | |
912 | notational conventions of the manual and the general appearance of the | |
913 | Emacs display screen. Note which questions are answered in these | |
914 | chapters, so you can refer back later. After reading chapter 4, you | |
350287ef RS |
915 | should practice the commands shown there. The next few chapters |
916 | describe fundamental techniques and concepts that are used constantly. | |
917 | You need to understand them thoroughly, so experiment with them | |
918 | until you are fluent. | |
3f973d9b AI |
919 | |
920 | Chapters 14 through 19 describe intermediate-level features that are | |
350287ef RS |
921 | useful for many kinds of editing. Chapter 20 and following chapters |
922 | describe optional but useful features; read those chapters when you | |
923 | need them. | |
3f973d9b AI |
924 | |
925 | Read the Trouble chapter if Emacs does not seem to be working | |
350287ef | 926 | properly. It explains how to cope with several common problems |
3f973d9b AI |
927 | (@pxref{Lossage}), as well as when and how to report Emacs bugs |
928 | (@pxref{Bugs}). | |
177c0ea7 | 929 | |
350287ef RS |
930 | To find the documentation of a particular command, look in the index. |
931 | Keys (character commands) and command names have separate indexes. | |
932 | There is also a glossary, with a cross reference for each term. | |
3f973d9b AI |
933 | |
934 | This manual is available as a printed book and also as an Info file. | |
350287ef RS |
935 | The Info file is for on-line perusal with the Info program, which is |
936 | the principal means of accessing on-line documentation in the GNU | |
937 | system. Both the Emacs Info file and an Info reader are included with | |
938 | GNU Emacs. The Info file and the printed book contain substantially | |
939 | the same text and are generated from the same source files, which are | |
940 | also distributed with GNU Emacs. | |
3f973d9b | 941 | |
d7fb7d7f RS |
942 | GNU Emacs is a member of the Emacs editor family. There are many |
943 | Emacs editors, all sharing common principles of organization. For | |
944 | information on the underlying philosophy of Emacs and the lessons | |
945 | learned from its development, see @cite{Emacs, the Extensible, | |
946 | Customizable Self-Documenting Display Editor}, available from | |
5a579270 | 947 | @url{ftp://publications.ai.mit.edu/ai-publications/pdf/AIM-519A.pdf}. |
3f973d9b | 948 | |
713d2b54 RS |
949 | This edition of the manual is intended for use with GNU Emacs |
950 | installed on GNU and Unix systems. GNU Emacs can also be used on VMS, | |
951 | MS-DOS (also called MS-DOG), Microsoft Windows, and Macintosh systems. | |
952 | Those systems use different file name syntax; in addition, VMS and | |
53c1041b EZ |
953 | MS-DOS do not support all GNU Emacs features. @xref{Microsoft |
954 | Windows}, for information about using Emacs on Windows. | |
e691d082 KB |
955 | @xref{Mac OS}, for information about using Emacs on Macintosh. We |
956 | don't try to describe VMS usage in this manual. | |
3f973d9b AI |
957 | @end iftex |
958 | ||
0b96ec68 | 959 | @node Distrib, Intro, Top, Top |
3f973d9b AI |
960 | @unnumbered Distribution |
961 | ||
962 | GNU Emacs is @dfn{free software}; this means that everyone is free to | |
a7e3b4ef LK |
963 | use it and free to redistribute it on certain conditions. GNU Emacs |
964 | is not in the public domain; it is copyrighted and there are | |
965 | restrictions on its distribution, but these restrictions are designed | |
966 | to permit everything that a good cooperating citizen would want to do. | |
967 | What is not allowed is to try to prevent others from further sharing | |
968 | any version of GNU Emacs that they might get from you. The precise | |
969 | conditions are found in the GNU General Public License that comes with | |
970 | Emacs and also appears in this manual@footnote{This manual is itself | |
971 | covered by the GNU Free Documentation License. This license is | |
972 | similar in spirit to the General Public License, but is more suitable | |
973 | for documentation. @xref{GNU Free Documentation License}.}. | |
974 | @xref{Copying}. | |
975 | ||
976 | One way to get a copy of GNU Emacs is from someone else who has it. | |
977 | You need not ask for our permission to do so, or tell any one else; | |
978 | just copy it. If you have access to the Internet, you can get the | |
979 | latest distribution version of GNU Emacs by anonymous FTP; see | |
980 | @url{http://www.gnu.org/software/emacs} on our website for more | |
981 | information. | |
3f973d9b AI |
982 | |
983 | You may also receive GNU Emacs when you buy a computer. Computer | |
984 | manufacturers are free to distribute copies on the same terms that apply to | |
985 | everyone else. These terms require them to give you the full sources, | |
986 | including whatever changes they may have made, and to permit you to | |
987 | redistribute the GNU Emacs received from them under the usual terms of the | |
988 | General Public License. In other words, the program must be free for you | |
989 | when you get it, not just free for the manufacturer. | |
990 | ||
ad709ece | 991 | You can also order copies of GNU Emacs from the Free Software |
a7e3b4ef LK |
992 | Foundation. This is a convenient and reliable way to get a copy; it is |
993 | also a good way to help fund our work. We also sell hardcopy versions | |
994 | of this manual and @cite{An Introduction to Programming in Emacs Lisp}, | |
995 | by Robert J. Chassell. You can find an order form on our web site at | |
996 | @url{http://www.gnu.org/order/order.html}. For further information, | |
997 | write to | |
3f973d9b AI |
998 | |
999 | @display | |
1000 | Free Software Foundation | |
a7e3b4ef LK |
1001 | 51 Franklin Street, Fifth Floor |
1002 | Boston, MA 02110-1301 | |
3f973d9b AI |
1003 | USA |
1004 | @end display | |
1005 | ||
1006 | The income from distribution fees goes to support the foundation's | |
1007 | purpose: the development of new free software, and improvements to our | |
1008 | existing programs including GNU Emacs. | |
1009 | ||
1010 | If you find GNU Emacs useful, please @strong{send a donation} to the | |
1011 | Free Software Foundation to support our work. Donations to the Free | |
1012 | Software Foundation are tax deductible in the US. If you use GNU Emacs | |
1013 | at your workplace, please suggest that the company make a donation. If | |
1014 | company policy is unsympathetic to the idea of donating to charity, you | |
1015 | might instead suggest ordering a CD-ROM from the Foundation | |
1016 | occasionally, or subscribing to periodic updates. | |
1017 | ||
06d5f0ed | 1018 | @iftex |
0b96ec68 LT |
1019 | @node Acknowledgments, Intro, Distrib, Top |
1020 | @unnumberedsec Acknowledgments | |
ad709ece | 1021 | |
7db5875f KS |
1022 | Contributors to GNU Emacs include Jari Aalto, Per Abrahamsen, Tomas |
1023 | Abrahamsson, Jay K.@: Adams, Michael Albinus, Nagy Andras, Ralf | |
1024 | Angeli, Joe Arceneaux, Miles Bader, David Bakhash, Juanma Barranquero, | |
1025 | Eli Barzilay, Steven L.@: Baur, Jay Belanger, Alexander L.@: Belikoff, | |
5be76758 | 1026 | Boaz Ben-Zvi, Karl Berry, Anna M.@: Bigatti, Ray Blaak, Jim Blandy, Johan Bockg@aa{}rd, |
7db5875f KS |
1027 | Per Bothner, Terrence Brannon, Frank Bresz, Peter Breton, Emmanuel |
1028 | Briot, Kevin Broadey, Vincent Broman, David M.@: Brown, Georges | |
1029 | Brun-Cottan, Joe Buehler, W@l{}odek Bzyl, Bill Carpenter, Per | |
1030 | Cederqvist, Hans Chalupsky, Chris Chase, Bob Chassell, Andrew Choi, | |
1031 | Sacha Chua, James Clark, Mike Clarkson, Glynn Clements, Andrew | |
1032 | Csillag, Doug Cutting, Mathias Dahl, Satyaki Das, Michael DeCorte, | |
1033 | Gary Delp, Matthieu Devin, Eri Ding, Jan Dj@"{a}rv, Carsten Dominik, | |
1034 | Scott Draves, Benjamin Drieu, Viktor Dukhovni, John Eaton, Rolf Ebert, | |
1035 | Paul Eggert, Stephen Eglen, Torbj@"orn Einarsson, Tsugutomo Enami, | |
1036 | Hans Henrik Eriksen, Michael Ernst, Ata Etemadi, Frederick Farnbach, | |
1037 | Oscar Figueiredo, Fred Fish, Karl Fogel, Gary Foster, Romain | |
1038 | Francoise, Noah Friedman, Andreas Fuchs, Hallvard Furuseth, Keith | |
1039 | Gabryelski, Peter S.@: Galbraith, Kevin Gallagher, Kevin Gallo, Juan | |
90e4b32d | 1040 | Le@'{o}n Lahoz Garc@'{@dotless{i}}a, Howard Gayle, Stephen Gildea, Julien |
7db5875f KS |
1041 | Gilles, David Gillespie, Bob Glickstein, Deepak Goel, Boris Goldowsky, |
1042 | Michelangelo Grigni, Odd Gripenstam, Kai Gro@ss{}johann, Michael | |
1043 | Gschwind, Henry Guillaume, Doug Gwyn, Ken'ichi Handa, Lars Hansen, | |
1044 | Chris Hanson, K. Shane Hartman, John Heidemann, Jon K.@: Hellan, | |
1045 | Jesper Harder, Markus Heritsch, Karl Heuer, Manabu Higashida, Anders | |
1046 | Holst, Jeffrey C.@: Honig, Kurt Hornik, Tom Houlder, Joakim Hove, | |
1047 | Denis Howe, Lars Ingebrigtsen, Andrew Innes, Seiichiro Inoue, Pavel | |
1048 | Janik, Paul Jarc, Ulf Jasper, Michael K. Johnson, Kyle Jones, Terry | |
d155accf | 1049 | Jones, Simon Josefsson, Arne J@o{}rgensen, Tomoji Kagatani, Brewster |
7db5875f KS |
1050 | Kahle, Lute Kamstra, David Kastrup, David Kaufman, Henry Kautz, Taichi |
1051 | Kawabata, Howard Kaye, Michael Kifer, Richard King, Peter Kleiweg, | |
1052 | Shuhei Kobayashi, Pavel Kobiakov, Larry K.@: Kolodney, David M.@: | |
1053 | Koppelman, Koseki Yoshinori, Robert Krawitz, Sebastian Kremer, Ryszard | |
1054 | Kubiak, Geoff Kuenning, David K@aa{}gedal, Daniel LaLiberte, Mario | |
1055 | Lang, Aaron Larson, James R.@: Larus, Vinicius Jose Latorre, Werner | |
1056 | Lemberg, Frederic Lepied, Peter Liljenberg, Lars Lindberg, Chris | |
1057 | Lindblad, Anders Lindgren, Thomas Link, Juri Linkov, Francis Litterio, | |
1058 | Emilio C. Lopes, Dave Love, Sascha L@"{u}decke, Eric Ludlam,Alan | |
1059 | Mackenzie, Christopher J.@: Madsen, Neil M.@: Mager, Ken Manheimer, | |
1060 | Bill Mann, Brian Marick, Simon Marshall, Bengt Martensson, Charlie | |
1061 | Martin, Thomas May, Roland McGrath, Will Mengarini, David Megginson, | |
1062 | Ben A. Mesander, Wayne Mesard, Brad Miller, Lawrence Mitchell, Richard | |
c9f63b41 | 1063 | Mlynarik, Gerd Moellmann, Stefan Monnier, Morioka Tomohiko, Keith |
7db5875f KS |
1064 | Moore, Glenn Morris, Diane Murray, Sen Nagata, Erik Naggum, Thomas |
1065 | Neumann, Thien-Thi Nguyen, Mike Newton, Jurgen Nickelsen, Dan | |
1066 | Nicolaescu, Hrvoje Niksic, Jeff Norden, Andrew Norman, Alexandre | |
1067 | Oliva, Bob Olson, Michael Olson, Takaaki Ota, Pieter E.@: J.@: Pareit, | |
c9f63b41 | 1068 | David Pearson, Jeff Peck, Damon Anton Permezel, Tom Perrine, William |
7db5875f KS |
1069 | M.@: Perry, Per Persson, Jens Petersen, Daniel Pfeiffer, Richard L.@: |
1070 | Pieri, Fred Pierresteguy, Christian Plaunt, David Ponce, Francesco | |
1071 | A.@: Potorti, Michael D. Prange, Mukesh Prasad, Ken Raeburn, Marko | |
1072 | Rahamaa, Ashwin Ram, Eric S. Raymond, Paul Reilly, Edward M. Reingold, | |
1073 | Alex Rezinsky, Rob Riepel, David Reitter, Nick Roberts, Roland B.@: | |
1074 | Roberts, John Robinson, Danny Roozendaal, William Rosenblatt, | |
1075 | Guillermo J.@: Rozas, Martin Rudalics, Ivar Rummelhoff, Jason Rumney, | |
1076 | Wolfgang Rupprecht, Kevin Ryde, James B. Salem, Masahiko Sato, Jorgen | |
1077 | Schaefer, Holger Schauer, William Schelter, Ralph Schleicher, Gregor | |
c9f63b41 | 1078 | Schmid, Michael Schmidt, Ronald S. Schnell, Philippe Schnoebelen, Jan |
7db5875f KS |
1079 | Schormann, Alex Schroeder, Stephen Schoef, Raymond Scholz, Randal |
1080 | Schwartz, Oliver Seidel, Manuel Serrano, Hovav Shacham, Stanislav | |
5be76758 | 1081 | Shalunov, Marc Shapiro, Richard Sharman, Olin Shivers, Espen Skoglund, |
7db5875f KS |
1082 | Rick Sladkey, Lynn Slater, Chris Smith, David Smith, Paul D.@: Smith, |
1083 | Andre Spiegel, Michael Staats, William Sommerfeld, Michael Staats, | |
1084 | Reiner Steib, Sam Steingold, Ake Stenhoff, Peter Stephenson, Ken | |
1085 | Stevens, Jonathan Stigelman, Martin Stjernholm, Kim F.@: Storm, Steve | |
1086 | Strassman, Olaf Sylvester, Naoto Takahashi, Steven Tamm, Jean-Philippe | |
1087 | Theberge, Jens T.@: Berger Thielemann, Spencer Thomas, Jim Thompson, | |
1088 | Luc Teirlinck, Tom Tromey, Enami Tsugutomo, Eli Tziperman, Daiki Ueno, | |
1089 | Masanobu Umeda, Rajesh Vaidheeswarran, Neil W.@: Van Dyke, Didier | |
1090 | Verna, Ulrik Vieth, Geoffrey Voelker, Johan Vromans, Inge Wallin, John | |
1091 | Paul Wallington, Colin Walters, Barry Warsaw, Morten Welinder, Joseph | |
1092 | Brian Wells, Rodney Whitby, John Wiegley, Ed Wilkinson, Mike Williams, | |
1093 | Bill Wohler, Steven A. Wood, Dale R.@: Worley, Francis J.@: Wright, | |
1094 | Felix S. T. Wu, Tom Wurgler, Katsumi Yamaoka, Masatake Yamato, | |
1095 | Jonathan Yavner, Ryan Yeske, Chong Yidong, Ilya Zakharevich, Milan | |
1096 | Zamazal, Victor Zandy, Eli Zaretskii, Jamie Zawinski, Shenghuo Zhu, | |
1097 | Ian T.@: Zimmermann, Reto Zimmermann, Neal Ziring, Teodor Zlatanov, | |
1098 | and Detlev Zundel. | |
06d5f0ed | 1099 | @end iftex |
3f973d9b | 1100 | |
0b96ec68 LT |
1101 | @node Intro, Glossary, Distrib, Top |
1102 | @unnumbered Introduction | |
1103 | ||
350287ef RS |
1104 | You are reading about GNU Emacs, the GNU incarnation of the |
1105 | advanced, self-documenting, customizable, extensible editor Emacs. | |
0b96ec68 LT |
1106 | (The `G' in `GNU' is not silent.) |
1107 | ||
350287ef RS |
1108 | We call Emacs advanced because it provides much more than simple |
1109 | insertion and deletion. It can control subprocesses, indent programs | |
1110 | automatically, show two or more files at once, and edit formatted | |
1111 | text. Emacs editing commands operate in terms of characters, words, | |
1112 | lines, sentences, paragraphs, and pages, as well as expressions and | |
1113 | comments in various programming languages. | |
0b96ec68 LT |
1114 | |
1115 | @dfn{Self-documenting} means that at any time you can type a special | |
1116 | character, @kbd{Control-h}, to find out what your options are. You can | |
1117 | also use it to find out what any command does, or to find all the commands | |
1118 | that pertain to a topic. @xref{Help}. | |
1119 | ||
350287ef RS |
1120 | @dfn{Customizable} means that you can alter Emacs commands' behavior |
1121 | in simple ways. For example, if you use a programming language in | |
1122 | which comments start with @samp{<**} and end with @samp{**>}, you can | |
1123 | tell the Emacs comment manipulation commands to use those strings | |
1124 | (@pxref{Comments}). Another sort of customization is rearrangement of | |
1125 | the command set. For example, you can rebind the basic cursor motion | |
1126 | commands (up, down, left and right) to any keys on the keyboard that | |
1127 | you find comfortable. @xref{Customization}. | |
1128 | ||
1129 | @dfn{Extensible} means that you can go beyond simple customization | |
1130 | and write entirely new commands---programs in the Lisp language to be | |
1131 | run by Emacs's own Lisp interpreter. Emacs is an ``on-line | |
1132 | extensible'' system, which means that it is divided into many | |
1133 | functions that call each other, any of which can be redefined in the | |
1134 | middle of an editing session. Almost any part of Emacs can be | |
1135 | replaced without making a separate copy of all of Emacs. Most of the | |
1136 | editing commands of Emacs are written in Lisp; the few exceptions | |
1137 | could have been written in Lisp but use C instead for efficiency. | |
1138 | Writing an extension is programming, but non-programmers can use it | |
1139 | afterwards. @xref{Top, Emacs Lisp Intro, Preface, eintr, An | |
1140 | Introduction to Programming in Emacs Lisp}, if you want to learn Emacs | |
1141 | Lisp programming. | |
0b96ec68 | 1142 | |
5a579270 | 1143 | When running on a graphical display, Emacs provides its own menus |
350287ef RS |
1144 | and convenient handling of mouse buttons. In addition, Emacs provides |
1145 | many of the benefits of a graphical display even on a text-only | |
1146 | terminal. For instance, it can highlight parts of a file, display and | |
1147 | edit several files at once, move text between files, and edit files | |
1148 | while running shell commands. | |
0b96ec68 LT |
1149 | |
1150 | @include screen.texi | |
1151 | @include commands.texi | |
1152 | @include entering.texi | |
1153 | @include basic.texi | |
1154 | @include mini.texi | |
1155 | @include m-x.texi | |
1156 | @include help.texi | |
1157 | @include mark.texi | |
1158 | @include killing.texi | |
1159 | @include regs.texi | |
1160 | @include display.texi | |
1161 | @include search.texi | |
1162 | @include fixit.texi | |
1163 | @include kmacro.texi | |
1164 | @include files.texi | |
1165 | @include buffers.texi | |
1166 | @include windows.texi | |
1167 | @include frames.texi | |
1168 | @include mule.texi | |
1169 | @include major.texi | |
1170 | @include indent.texi | |
1171 | @include text.texi | |
1172 | @include programs.texi | |
1173 | @include building.texi | |
1174 | @include maintaining.texi | |
1175 | @include abbrevs.texi | |
0701f901 EZ |
1176 | @ifnottex |
1177 | @include picture-xtra.texi | |
1178 | @end ifnottex | |
0b96ec68 LT |
1179 | @include sending.texi |
1180 | @include rmail.texi | |
1181 | @include dired.texi | |
1182 | @include calendar.texi | |
1183 | @include misc.texi | |
1184 | @include custom.texi | |
1185 | @include trouble.texi | |
1186 | ||
1187 | @node Copying, GNU Free Documentation License, Service, Top | |
1188 | @appendix GNU GENERAL PUBLIC LICENSE | |
3f973d9b AI |
1189 | @center Version 2, June 1991 |
1190 | ||
1191 | @display | |
1192 | Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc. | |
a7e3b4ef | 1193 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA |
3f973d9b AI |
1194 | |
1195 | Everyone is permitted to copy and distribute verbatim copies | |
1196 | of this license document, but changing it is not allowed. | |
1197 | @end display | |
1198 | ||
1199 | @unnumberedsec Preamble | |
1200 | ||
1201 | The licenses for most software are designed to take away your | |
1202 | freedom to share and change it. By contrast, the GNU General Public | |
1203 | License is intended to guarantee your freedom to share and change free | |
1204 | software---to make sure the software is free for all its users. This | |
1205 | General Public License applies to most of the Free Software | |
1206 | Foundation's software and to any other program whose authors commit to | |
1207 | using it. (Some other Free Software Foundation software is covered by | |
f7e44111 | 1208 | the GNU Lesser General Public License instead.) You can apply it to |
3f973d9b AI |
1209 | your programs, too. |
1210 | ||
1211 | When we speak of free software, we are referring to freedom, not | |
1212 | price. Our General Public Licenses are designed to make sure that you | |
1213 | have the freedom to distribute copies of free software (and charge for | |
1214 | this service if you wish), that you receive source code or can get it | |
1215 | if you want it, that you can change the software or use pieces of it | |
1216 | in new free programs; and that you know you can do these things. | |
1217 | ||
1218 | To protect your rights, we need to make restrictions that forbid | |
1219 | anyone to deny you these rights or to ask you to surrender the rights. | |
1220 | These restrictions translate to certain responsibilities for you if you | |
1221 | distribute copies of the software, or if you modify it. | |
1222 | ||
1223 | For example, if you distribute copies of such a program, whether | |
1224 | gratis or for a fee, you must give the recipients all the rights that | |
1225 | you have. You must make sure that they, too, receive or can get the | |
1226 | source code. And you must show them these terms so they know their | |
1227 | rights. | |
1228 | ||
1229 | We protect your rights with two steps: (1) copyright the software, and | |
1230 | (2) offer you this license which gives you legal permission to copy, | |
1231 | distribute and/or modify the software. | |
1232 | ||
1233 | Also, for each author's protection and ours, we want to make certain | |
1234 | that everyone understands that there is no warranty for this free | |
1235 | software. If the software is modified by someone else and passed on, we | |
1236 | want its recipients to know that what they have is not the original, so | |
1237 | that any problems introduced by others will not reflect on the original | |
1238 | authors' reputations. | |
1239 | ||
1240 | Finally, any free program is threatened constantly by software | |
1241 | patents. We wish to avoid the danger that redistributors of a free | |
1242 | program will individually obtain patent licenses, in effect making the | |
1243 | program proprietary. To prevent this, we have made it clear that any | |
1244 | patent must be licensed for everyone's free use or not licensed at all. | |
1245 | ||
1246 | The precise terms and conditions for copying, distribution and | |
1247 | modification follow. | |
1248 | ||
1249 | @iftex | |
1250 | @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION | |
1251 | @end iftex | |
00ea6f3d | 1252 | @ifnottex |
3f973d9b | 1253 | @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION |
00ea6f3d | 1254 | @end ifnottex |
3f973d9b AI |
1255 | |
1256 | @enumerate 0 | |
1257 | @item | |
1258 | This License applies to any program or other work which contains | |
1259 | a notice placed by the copyright holder saying it may be distributed | |
df9d7630 | 1260 | under the terms of this General Public License. The ``Program,'' below, |
3f973d9b AI |
1261 | refers to any such program or work, and a ``work based on the Program'' |
1262 | means either the Program or any derivative work under copyright law: | |
1263 | that is to say, a work containing the Program or a portion of it, | |
1264 | either verbatim or with modifications and/or translated into another | |
1265 | language. (Hereinafter, translation is included without limitation in | |
df9d7630 | 1266 | the term ``modification.'') Each licensee is addressed as ``you.'' |
3f973d9b AI |
1267 | |
1268 | Activities other than copying, distribution and modification are not | |
1269 | covered by this License; they are outside its scope. The act of | |
1270 | running the Program is not restricted, and the output from the Program | |
1271 | is covered only if its contents constitute a work based on the | |
1272 | Program (independent of having been made by running the Program). | |
1273 | Whether that is true depends on what the Program does. | |
1274 | ||
1275 | @item | |
1276 | You may copy and distribute verbatim copies of the Program's | |
1277 | source code as you receive it, in any medium, provided that you | |
1278 | conspicuously and appropriately publish on each copy an appropriate | |
1279 | copyright notice and disclaimer of warranty; keep intact all the | |
1280 | notices that refer to this License and to the absence of any warranty; | |
1281 | and give any other recipients of the Program a copy of this License | |
1282 | along with the Program. | |
1283 | ||
1284 | You may charge a fee for the physical act of transferring a copy, and | |
1285 | you may at your option offer warranty protection in exchange for a fee. | |
1286 | ||
1287 | @item | |
1288 | You may modify your copy or copies of the Program or any portion | |
1289 | of it, thus forming a work based on the Program, and copy and | |
1290 | distribute such modifications or work under the terms of Section 1 | |
1291 | above, provided that you also meet all of these conditions: | |
1292 | ||
1293 | @enumerate a | |
1294 | @item | |
1295 | You must cause the modified files to carry prominent notices | |
1296 | stating that you changed the files and the date of any change. | |
1297 | ||
1298 | @item | |
1299 | You must cause any work that you distribute or publish, that in | |
1300 | whole or in part contains or is derived from the Program or any | |
1301 | part thereof, to be licensed as a whole at no charge to all third | |
1302 | parties under the terms of this License. | |
1303 | ||
1304 | @item | |
1305 | If the modified program normally reads commands interactively | |
1306 | when run, you must cause it, when started running for such | |
1307 | interactive use in the most ordinary way, to print or display an | |
1308 | announcement including an appropriate copyright notice and a | |
1309 | notice that there is no warranty (or else, saying that you provide | |
1310 | a warranty) and that users may redistribute the program under | |
1311 | these conditions, and telling the user how to view a copy of this | |
1312 | License. (Exception: if the Program itself is interactive but | |
1313 | does not normally print such an announcement, your work based on | |
1314 | the Program is not required to print an announcement.) | |
1315 | @end enumerate | |
1316 | ||
1317 | These requirements apply to the modified work as a whole. If | |
1318 | identifiable sections of that work are not derived from the Program, | |
1319 | and can be reasonably considered independent and separate works in | |
1320 | themselves, then this License, and its terms, do not apply to those | |
1321 | sections when you distribute them as separate works. But when you | |
1322 | distribute the same sections as part of a whole which is a work based | |
1323 | on the Program, the distribution of the whole must be on the terms of | |
1324 | this License, whose permissions for other licensees extend to the | |
1325 | entire whole, and thus to each and every part regardless of who wrote it. | |
1326 | ||
1327 | Thus, it is not the intent of this section to claim rights or contest | |
1328 | your rights to work written entirely by you; rather, the intent is to | |
1329 | exercise the right to control the distribution of derivative or | |
1330 | collective works based on the Program. | |
1331 | ||
1332 | In addition, mere aggregation of another work not based on the Program | |
1333 | with the Program (or with a work based on the Program) on a volume of | |
1334 | a storage or distribution medium does not bring the other work under | |
1335 | the scope of this License. | |
1336 | ||
1337 | @item | |
1338 | You may copy and distribute the Program (or a work based on it, | |
1339 | under Section 2) in object code or executable form under the terms of | |
1340 | Sections 1 and 2 above provided that you also do one of the following: | |
1341 | ||
1342 | @enumerate a | |
1343 | @item | |
1344 | Accompany it with the complete corresponding machine-readable | |
1345 | source code, which must be distributed under the terms of Sections | |
1346 | 1 and 2 above on a medium customarily used for software interchange; or, | |
1347 | ||
1348 | @item | |
1349 | Accompany it with a written offer, valid for at least three | |
1350 | years, to give any third party, for a charge no more than your | |
1351 | cost of physically performing source distribution, a complete | |
1352 | machine-readable copy of the corresponding source code, to be | |
1353 | distributed under the terms of Sections 1 and 2 above on a medium | |
1354 | customarily used for software interchange; or, | |
1355 | ||
1356 | @item | |
1357 | Accompany it with the information you received as to the offer | |
1358 | to distribute corresponding source code. (This alternative is | |
1359 | allowed only for noncommercial distribution and only if you | |
1360 | received the program in object code or executable form with such | |
1361 | an offer, in accord with Subsection b above.) | |
1362 | @end enumerate | |
1363 | ||
1364 | The source code for a work means the preferred form of the work for | |
1365 | making modifications to it. For an executable work, complete source | |
1366 | code means all the source code for all modules it contains, plus any | |
1367 | associated interface definition files, plus the scripts used to | |
1368 | control compilation and installation of the executable. However, as a | |
1369 | special exception, the source code distributed need not include | |
1370 | anything that is normally distributed (in either source or binary | |
1371 | form) with the major components (compiler, kernel, and so on) of the | |
1372 | operating system on which the executable runs, unless that component | |
1373 | itself accompanies the executable. | |
1374 | ||
1375 | If distribution of executable or object code is made by offering | |
1376 | access to copy from a designated place, then offering equivalent | |
1377 | access to copy the source code from the same place counts as | |
1378 | distribution of the source code, even though third parties are not | |
1379 | compelled to copy the source along with the object code. | |
1380 | ||
1381 | @item | |
1382 | You may not copy, modify, sublicense, or distribute the Program | |
1383 | except as expressly provided under this License. Any attempt | |
1384 | otherwise to copy, modify, sublicense or distribute the Program is | |
1385 | void, and will automatically terminate your rights under this License. | |
1386 | However, parties who have received copies, or rights, from you under | |
1387 | this License will not have their licenses terminated so long as such | |
1388 | parties remain in full compliance. | |
1389 | ||
1390 | @item | |
1391 | You are not required to accept this License, since you have not | |
1392 | signed it. However, nothing else grants you permission to modify or | |
1393 | distribute the Program or its derivative works. These actions are | |
1394 | prohibited by law if you do not accept this License. Therefore, by | |
1395 | modifying or distributing the Program (or any work based on the | |
1396 | Program), you indicate your acceptance of this License to do so, and | |
1397 | all its terms and conditions for copying, distributing or modifying | |
1398 | the Program or works based on it. | |
1399 | ||
1400 | @item | |
1401 | Each time you redistribute the Program (or any work based on the | |
1402 | Program), the recipient automatically receives a license from the | |
1403 | original licensor to copy, distribute or modify the Program subject to | |
1404 | these terms and conditions. You may not impose any further | |
1405 | restrictions on the recipients' exercise of the rights granted herein. | |
1406 | You are not responsible for enforcing compliance by third parties to | |
1407 | this License. | |
1408 | ||
1409 | @item | |
1410 | If, as a consequence of a court judgment or allegation of patent | |
1411 | infringement or for any other reason (not limited to patent issues), | |
1412 | conditions are imposed on you (whether by court order, agreement or | |
1413 | otherwise) that contradict the conditions of this License, they do not | |
1414 | excuse you from the conditions of this License. If you cannot | |
1415 | distribute so as to satisfy simultaneously your obligations under this | |
1416 | License and any other pertinent obligations, then as a consequence you | |
1417 | may not distribute the Program at all. For example, if a patent | |
1418 | license would not permit royalty-free redistribution of the Program by | |
1419 | all those who receive copies directly or indirectly through you, then | |
1420 | the only way you could satisfy both it and this License would be to | |
1421 | refrain entirely from distribution of the Program. | |
1422 | ||
1423 | If any portion of this section is held invalid or unenforceable under | |
1424 | any particular circumstance, the balance of the section is intended to | |
1425 | apply and the section as a whole is intended to apply in other | |
1426 | circumstances. | |
1427 | ||
1428 | It is not the purpose of this section to induce you to infringe any | |
1429 | patents or other property right claims or to contest validity of any | |
1430 | such claims; this section has the sole purpose of protecting the | |
1431 | integrity of the free software distribution system, which is | |
1432 | implemented by public license practices. Many people have made | |
1433 | generous contributions to the wide range of software distributed | |
1434 | through that system in reliance on consistent application of that | |
1435 | system; it is up to the author/donor to decide if he or she is willing | |
1436 | to distribute software through any other system and a licensee cannot | |
1437 | impose that choice. | |
1438 | ||
1439 | This section is intended to make thoroughly clear what is believed to | |
1440 | be a consequence of the rest of this License. | |
1441 | ||
1442 | @item | |
1443 | If the distribution and/or use of the Program is restricted in | |
1444 | certain countries either by patents or by copyrighted interfaces, the | |
1445 | original copyright holder who places the Program under this License | |
1446 | may add an explicit geographical distribution limitation excluding | |
1447 | those countries, so that distribution is permitted only in or among | |
1448 | countries not thus excluded. In such case, this License incorporates | |
1449 | the limitation as if written in the body of this License. | |
1450 | ||
1451 | @item | |
1452 | The Free Software Foundation may publish revised and/or new versions | |
1453 | of the General Public License from time to time. Such new versions will | |
1454 | be similar in spirit to the present version, but may differ in detail to | |
1455 | address new problems or concerns. | |
1456 | ||
1457 | Each version is given a distinguishing version number. If the Program | |
1458 | specifies a version number of this License which applies to it and ``any | |
df9d7630 | 1459 | later version,'' you have the option of following the terms and conditions |
3f973d9b AI |
1460 | either of that version or of any later version published by the Free |
1461 | Software Foundation. If the Program does not specify a version number of | |
1462 | this License, you may choose any version ever published by the Free Software | |
1463 | Foundation. | |
1464 | ||
1465 | @item | |
1466 | If you wish to incorporate parts of the Program into other free | |
1467 | programs whose distribution conditions are different, write to the author | |
1468 | to ask for permission. For software which is copyrighted by the Free | |
1469 | Software Foundation, write to the Free Software Foundation; we sometimes | |
1470 | make exceptions for this. Our decision will be guided by the two goals | |
1471 | of preserving the free status of all derivatives of our free software and | |
1472 | of promoting the sharing and reuse of software generally. | |
1473 | ||
1474 | @iftex | |
1475 | @heading NO WARRANTY | |
1476 | @end iftex | |
00ea6f3d | 1477 | @ifnottex |
3f973d9b | 1478 | @center NO WARRANTY |
00ea6f3d | 1479 | @end ifnottex |
3f973d9b AI |
1480 | |
1481 | @item | |
1482 | BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY | |
1483 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW@. EXCEPT WHEN | |
1484 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES | |
1485 | PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED | |
1486 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF | |
1487 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE@. THE ENTIRE RISK AS | |
1488 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU@. SHOULD THE | |
1489 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, | |
1490 | REPAIR OR CORRECTION. | |
1491 | ||
1492 | @item | |
1493 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING | |
1494 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR | |
1495 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, | |
1496 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING | |
1497 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED | |
1498 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY | |
1499 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER | |
1500 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE | |
1501 | POSSIBILITY OF SUCH DAMAGES. | |
1502 | @end enumerate | |
1503 | ||
1504 | @iftex | |
1505 | @heading END OF TERMS AND CONDITIONS | |
1506 | @end iftex | |
00ea6f3d | 1507 | @ifnottex |
3f973d9b | 1508 | @center END OF TERMS AND CONDITIONS |
00ea6f3d | 1509 | @end ifnottex |
3f973d9b AI |
1510 | |
1511 | @page | |
1512 | @unnumberedsec How to Apply These Terms to Your New Programs | |
1513 | ||
1514 | If you develop a new program, and you want it to be of the greatest | |
1515 | possible use to the public, the best way to achieve this is to make it | |
1516 | free software which everyone can redistribute and change under these terms. | |
1517 | ||
1518 | To do so, attach the following notices to the program. It is safest | |
1519 | to attach them to the start of each source file to most effectively | |
1520 | convey the exclusion of warranty; and each file should have at least | |
1521 | the ``copyright'' line and a pointer to where the full notice is found. | |
1522 | ||
1523 | @smallexample | |
1524 | @var{one line to give the program's name and an idea of what it does.} | |
f7e44111 | 1525 | Copyright (C) @var{yyyy} @var{name of author} |
3f973d9b AI |
1526 | |
1527 | This program is free software; you can redistribute it and/or | |
1528 | modify it under the terms of the GNU General Public License | |
1529 | as published by the Free Software Foundation; either version 2 | |
1530 | of the License, or (at your option) any later version. | |
1531 | ||
1532 | This program is distributed in the hope that it will be useful, | |
1533 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
1534 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the | |
1535 | GNU General Public License for more details. | |
1536 | ||
1537 | You should have received a copy of the GNU General Public License along | |
1538 | with this program; if not, write to the Free Software Foundation, Inc., | |
a7e3b4ef | 1539 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
3f973d9b AI |
1540 | @end smallexample |
1541 | ||
1542 | Also add information on how to contact you by electronic and paper mail. | |
1543 | ||
1544 | If the program is interactive, make it output a short notice like this | |
1545 | when it starts in an interactive mode: | |
1546 | ||
1547 | @smallexample | |
baa2a74e | 1548 | Gnomovision version 69, Copyright (C) @var{yyyy} @var{name of author} |
3f973d9b AI |
1549 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details |
1550 | type `show w'. This is free software, and you are welcome | |
177c0ea7 | 1551 | to redistribute it under certain conditions; type `show c' |
3f973d9b AI |
1552 | for details. |
1553 | @end smallexample | |
1554 | ||
1555 | The hypothetical commands @samp{show w} and @samp{show c} should show | |
1556 | the appropriate parts of the General Public License. Of course, the | |
1557 | commands you use may be called something other than @samp{show w} and | |
1558 | @samp{show c}; they could even be mouse-clicks or menu items---whatever | |
1559 | suits your program. | |
1560 | ||
1561 | You should also get your employer (if you work as a programmer) or your | |
1562 | school, if any, to sign a ``copyright disclaimer'' for the program, if | |
1563 | necessary. Here is a sample; alter the names: | |
1564 | ||
1565 | @smallexample | |
1566 | @group | |
1567 | Yoyodyne, Inc., hereby disclaims all copyright | |
1568 | interest in the program `Gnomovision' | |
177c0ea7 | 1569 | (which makes passes at compilers) written |
3f973d9b AI |
1570 | by James Hacker. |
1571 | ||
1572 | @var{signature of Ty Coon}, 1 April 1989 | |
1573 | Ty Coon, President of Vice | |
1574 | @end group | |
1575 | @end smallexample | |
1576 | ||
1577 | This General Public License does not permit incorporating your program into | |
1578 | proprietary programs. If your program is a subroutine library, you may | |
1579 | consider it more useful to permit linking proprietary applications with the | |
f7e44111 | 1580 | library. If this is what you want to do, use the GNU Lesser General |
3f973d9b AI |
1581 | Public License instead of this License. |
1582 | ||
7a258cfb | 1583 | @include doclicense.texi |
3f973d9b | 1584 | @include cmdargs.texi |
5eadaf4d | 1585 | @include xresources.texi |
3f973d9b AI |
1586 | |
1587 | @include anti.texi | |
2f920ca8 | 1588 | @include macos.texi |
3f973d9b AI |
1589 | @include msdog.texi |
1590 | @include gnu.texi | |
1591 | @include glossary.texi | |
49e71458 | 1592 | @ifnottex |
3f973d9b | 1593 | @include ack.texi |
49e71458 | 1594 | @end ifnottex |
3f973d9b | 1595 | |
010e81be EZ |
1596 | @c The Option Index is produced only in the on-line version, |
1597 | @c because the index entries related to command-line options | |
1598 | @c tend to point to the same pages and all begin with a dash. | |
1599 | @c This, and the need to keep the node links consistent, are | |
1600 | @c the reasons for the funky @iftex/@ifnottex dance below. | |
1601 | @c The Option Index is _not_ before Key Index, because that | |
1602 | @c would require changes in the glossary.texi's @node line. | |
1603 | @c It is not after Concept Index for similar reasons. | |
1604 | ||
1605 | @iftex | |
3f973d9b AI |
1606 | @node Key Index, Command Index, Glossary, Top |
1607 | @unnumbered Key (Character) Index | |
1608 | @printindex ky | |
010e81be EZ |
1609 | @end iftex |
1610 | ||
1611 | @ifnottex | |
1612 | @node Key Index, Option Index, Glossary, Top | |
1613 | @unnumbered Key (Character) Index | |
1614 | @printindex ky | |
1615 | ||
1616 | @node Option Index, Command Index, Key Index, Top | |
1617 | @unnumbered Command-Line Options Index | |
1618 | @printindex op | |
3f973d9b | 1619 | |
010e81be EZ |
1620 | @node Command Index, Variable Index, Option Index, Top |
1621 | @unnumbered Command and Function Index | |
1622 | @printindex fn | |
1623 | @end ifnottex | |
1624 | ||
1625 | @iftex | |
3f973d9b AI |
1626 | @node Command Index, Variable Index, Key Index, Top |
1627 | @unnumbered Command and Function Index | |
1628 | @printindex fn | |
010e81be | 1629 | @end iftex |
3f973d9b AI |
1630 | |
1631 | @node Variable Index, Concept Index, Command Index, Top | |
1632 | @unnumbered Variable Index | |
1633 | @printindex vr | |
1634 | ||
1635 | @node Concept Index, Acknowledgments, Variable Index, Top | |
1636 | @unnumbered Concept Index | |
1637 | @printindex cp | |
1638 | ||
3f973d9b AI |
1639 | @bye |
1640 | ||
ab5796a9 MB |
1641 | @ignore |
1642 | arch-tag: ed48740a-410b-46ea-9387-c9a9252a3392 | |
1643 | @end ignore |