XEmacs 21.2.14.
[chise/xemacs-chise.git.1] / man / xemacs / xemacs.texi
1
2 \input ../texinfo  @c -*-texinfo-*-
3 @setfilename ../../info/xemacs.info
4 @comment  node-name,  next,  previous,  up
5
6
7 @ifinfo
8 @dircategory XEmacs Editor
9 @direntry
10 * XEmacs: (xemacs).             XEmacs Editor.
11 @end direntry
12
13 This file documents the XEmacs editor.
14
15 Copyright (C) 1985, 1986, 1988 Richard M. Stallman.
16 Copyright @copyright{} 1991, 1992, 1993, 1994 Lucid, Inc.
17 Copyright @copyright{} 1993, 1994 Sun Microsystems, Inc.
18 Copyright @copyright{} 1995 Amdahl Corporation.
19
20 Permission is granted to make and distribute verbatim copies of
21 this manual provided the copyright notice and this permission notice
22 are preserved on all copies.
23
24 @ignore
25 Permission is granted to process this file through Tex and print the
26 results, provided the printed document carries copying permission
27 notice identical to this one except for the removal of this paragraph
28 (this paragraph not being relevant to the printed manual).
29
30 @end ignore
31 Permission is granted to copy and distribute modified versions of this
32 manual under the conditions for verbatim copying, provided also that the
33 sections entitled ``The GNU Manifesto'', ``Distribution'' and ``GNU
34 General Public License'' are included exactly as in the original, and
35 provided that the entire resulting derived work is distributed under the
36 terms of a permission notice identical to this one.
37
38 Permission is granted to copy and distribute translations of this manual
39 into another language, under the above conditions for modified versions,
40 except that the sections entitled ``The GNU Manifesto'',
41 ``Distribution'' and ``GNU General Public License'' may be included in a
42 translation approved by the author instead of in the original English.
43 @end ifinfo
44 @c
45 @setchapternewpage odd
46 @settitle XEmacs User's Manual
47 @c
48 @titlepage
49 @sp 6
50 @center @titlefont{XEmacs User's Manual}
51 @sp 4
52 @sp 1
53 @sp 1
54 @center July 1994
55 @center (General Public License upgraded, January 1991)
56 @sp 5
57 @center Richard Stallman
58 @sp 1
59 @center Lucid, Inc.
60 @sp 1
61 @center and
62 @sp 1
63 @center Ben Wing
64 @page
65 @vskip 0pt plus 1filll
66 Copyright @copyright{} 1985, 1986, 1988 Richard M. Stallman.
67
68 Copyright @copyright{} 1991, 1992, 1993, 1994  Lucid, Inc.
69
70 Copyright @copyright{} 1993, 1994 Sun Microsystems, Inc.
71
72 Copyright @copyright{} 1995 Amdahl Corporation.
73
74 Permission is granted to make and distribute verbatim copies of
75 this manual provided the copyright notice and this permission notice
76 are preserved on all copies.
77
78 Permission is granted to copy and distribute modified versions of this
79 manual under the conditions for verbatim copying, provided also that the
80 sections entitled ``The GNU Manifesto'', ``Distribution'' and ``GNU
81 General Public License'' are included exactly as in the original, and
82 provided that the entire resulting derived work is distributed under the
83 terms of a permission notice identical to this one.
84
85 Permission is granted to copy and distribute translations of this manual
86 into another language, under the above conditions for modified versions,
87 except that the sections entitled ``The GNU Manifesto'',
88 ``Distribution'' and ``GNU General Public License'' may be included in a
89 translation approved by the author instead of in the original English.
90 @end titlepage
91 @page
92 @ifinfo
93 @node Top, License,, (dir)
94
95 The XEmacs Editor
96 *****************
97
98 XEmacs is the extensible, customizable, self-documenting real-time
99 display editor.  This Info file describes how to edit with Emacs
100 and some of how to customize it, but not how to extend it.  It
101 corresponds to XEmacs version 21.0.
102
103 This manual is intended as a detailed reference to XEmacs.  If
104 you are looking for an introductory manual, see the New User's
105 Guide.
106
107 @end ifinfo
108 @menu
109 * License::     The GNU General Public License gives you permission
110                 to redistribute XEmacs on certain terms; and also
111                 explains that there is no warranty.
112 * Distrib::     How to get XEmacs.
113 * Intro::       An introduction to XEmacs concepts.
114 * Glossary::    The glossary.
115 * Manifesto::   What's GNU?  Gnu's Not Unix!
116
117 Indices, nodes containing large menus
118 * Key Index::      An item for each standard XEmacs key sequence.
119 * Command Index::  An item for each command name.
120 * Variable Index:: An item for each documented variable.
121 * Concept Index::  An item for each concept.
122
123 Important General Concepts
124 * Frame::      How to interpret what you see on the screen.
125 * Keystrokes::  Keyboard gestures XEmacs recognizes.
126 * Pull-down Menus:: 
127                 The XEmacs Pull-down Menus available under X.
128 * Entering Emacs::    
129                 Starting Emacs from the shell.
130 * Exiting::     Stopping or killing XEmacs.
131 * Command Switches::  
132                 Hairy startup options.
133 * Startup Paths::
134                 How XEmacs finds Directories and Files
135
136 Fundamental Editing Commands
137 * Basic::       The most basic editing commands.
138 * Undo::        Undoing recently made changes in the text.
139 * Minibuffer::  Entering arguments that are prompted for.
140 * M-x::         Invoking commands by their names.
141 * Help::        Commands for asking XEmacs about its commands.
142
143 Important Text-Changing Commands
144 * Mark::        The mark: how to delimit a ``region'' of text.
145 * Mouse Selection:: 
146                 Selecting text with the mouse.
147 * Additional Mouse Operations::
148                 Other operations available from the mouse.
149 * Killing::     Killing text.
150 * Yanking::     Recovering killed text.  Moving text.
151 * Using X Selections::
152                 Using primary selection, cut buffers, and highlighted regions.
153 * Accumulating Text::
154                 Other ways of copying text.
155 * Rectangles::  Operating on the text inside a rectangle on the screen.
156 * Registers::   Saving a text string or a location in the buffer.
157 * Display::     Controlling what text is displayed.
158 * Search::      Finding or replacing occurrences of a string.
159 * Fixit::       Commands especially useful for fixing typos.
160
161 Larger Units of Text
162 * Files::       All about handling files.
163 * Buffers::     Multiple buffers; editing several files at once.
164 * Windows::     Viewing two pieces of text at once.
165 * Mule::        Using world scripts.
166
167 Advanced Features
168 * Major Modes:: Text mode vs. Lisp mode vs. C mode ...
169 * Indentation:: Editing the white space at the beginnings of lines.
170 * Text::        Commands and modes for editing English.
171 * Programs::    Commands and modes for editing programs.
172 * Running::     Compiling, running and debugging programs.
173 * Packages::    How to add new packages to XEmacs.
174 * Abbrevs::     How to define text abbreviations to reduce
175                  the number of characters you must type.
176 * Picture::     Editing pictures made up of characters
177                  using the quarter-plane screen model.
178 * Sending Mail:: Sending mail in XEmacs.
179 * Reading Mail:: Reading mail in XEmacs.
180 * Calendar/Diary:: A Calendar and diary facility in XEmacs.
181 * Sorting::     Sorting lines, paragraphs or pages within XEmacs.
182 * Shell::       Executing shell commands from XEmacs.
183 * Narrowing::   Restricting display and editing to a portion
184                  of the buffer.
185 * Hardcopy::    Printing buffers or regions.
186 * Recursive Edit::
187                 A command can allow you to do editing
188                  "within the command".  This is called a
189                  `recursive editing level'.
190 * Dissociated Press::  Dissociating text for fun.
191 * CONX::               A different kind of dissociation.
192 * Amusements::         Various games and hacks.
193 * Emulation::          Emulating some other editors with XEmacs.
194 * Customization::      Modifying the behavior of XEmacs.
195
196 Recovery from Problems.
197 * Quitting::    Quitting and aborting.
198 * Lossage::     What to do if XEmacs is hung or malfunctioning.
199 * Bugs::        How and when to report a bug.
200
201 Here are some other nodes which are really inferiors of the ones
202 already listed, mentioned here so you can get to them in one step:
203
204  --- The Detailed Node Listing ---
205
206 The Organization of the Frame
207
208 * Point::               The place in the text where editing commands operate.  
209 * Echo Area::           Short messages appear at the bottom of the frame.  
210 * Mode Line::           Interpreting the mode line.  
211 * XEmacs under X::      Some information on using XEmacs under the X 
212                         Window System. 
213
214 Keystrokes
215
216 * Intro to Keystrokes::      Keystrokes as building blocks of key sequences.
217 * Representing Keystrokes::  Using lists of modifiers and keysyms to
218                              represent keystrokes.
219 * Key Sequences::            Combine key strokes into key sequences you can
220                              bind to commands.
221 * String Key Sequences::     Available for upward compatibility.
222 * Meta Key::                 Using @key{ESC} to represent @key{Meta}
223 * Super and Hyper Keys::     Adding modifier keys on certain keyboards.
224 * Character Representation:: How characters appear in XEmacs buffers.
225 * Commands::                 How commands are bound to key sequences.
226                     
227 Pull-down Menus
228
229 * File Menu::           Items on the File menu.
230 * Edit Menu::           Items on the Edit menu.
231 * Apps Menu::           Items on the Apps menu.
232 * Options Menu::        Items on the Options menu. 
233 * Buffers Menu::        Information about the Buffers menu.
234 * Tools Menu::          Items on the Tools menu.
235 * Help Menu::           Items on the Help menu. 
236 * Menu Customization::  Adding and removing menu items and related
237                         operations.
238
239 Basic Editing Commands
240
241 * Blank Lines::        Commands to make or delete blank lines.
242 * Continuation Lines:: Lines too wide for the frame.
243 * Position Info::      What page, line, row, or column is point on?
244 * Arguments::          Numeric arguments for repeating a command.
245
246 The Minibuffer
247
248 * File: Minibuffer File.  Entering file names with the minibuffer.
249 * Edit: Minibuffer Edit.  How to edit in the minibuffer.
250 * Completion::            An abbreviation facility for minibuffer input.
251 * Repetition::            Re-executing commands that used the minibuffer.
252
253 The Mark and the Region
254
255 * Setting Mark::        Commands to set the mark.
256 * Using Region::        Summary of ways to operate on contents of the region.
257 * Marking Objects::     Commands to put region around textual units.
258 * Mark Ring::           Previous mark positions saved so you can go back there.
259
260 Yanking
261
262 * Kill Ring::       Where killed text is stored.  Basic yanking.
263 * Appending Kills:: Several kills in a row all yank together.
264 * Earlier Kills::   Yanking something killed some time ago.
265
266 Using X Selections
267
268 * X Clipboard Selection::       Pasting to the X clipboard.
269 * X Selection Commands::        Other operations on the selection.
270 * X Cut Buffers::               X cut buffers are available for compatibility.
271 * Active Regions::              Using zmacs-style highlighting of the
272                                  selected region.
273
274 Registers
275
276 * RegPos::    Saving positions in registers.
277 * RegText::   Saving text in registers.
278 * RegRect::   Saving rectangles in registers.
279
280 Controlling the Display
281
282 * Scrolling::              Moving text up and down in a window.
283 * Horizontal Scrolling::   Moving text left and right in a window.
284 * Selective Display::      Hiding lines with lots of indentation.
285 * Display Vars::           Information on variables for customizing display.
286
287 Searching and Replacement
288
289 * Incremental Search::     Search happens as you type the string.
290 * Non-Incremental Search:: Specify entire string and then search.
291 * Word Search::            Search for sequence of words.
292 * Regexp Search::          Search for match for a regexp.
293 * Regexps::                Syntax of regular expressions.
294 * Search Case::            To ignore case while searching, or not.
295 * Replace::                Search, and replace some or all matches.
296 * Other Repeating Search:: Operating on all matches for some regexp.
297
298 Replacement Commands
299
300 * Unconditional Replace::  Replacing all matches for a string.
301 * Regexp Replace::         Replacing all matches for a regexp.
302 * Replacement and Case::   How replacements preserve case of letters.
303 * Query Replace::          How to use querying.
304
305 Commands for Fixing Typos
306
307 * Kill Errors:: Commands to kill a batch of recently entered text.
308 * Transpose::   Exchanging two characters, words, lines, lists...
309 * Fixing Case:: Correcting case of last word entered.
310 * Spelling::    Apply spelling checker to a word, or a whole file.
311
312 File Handling
313
314 * File Names::       How to type and edit file name arguments.
315 * Visiting::         Visiting a file prepares XEmacs to edit the file.
316 * Saving::           Saving makes your changes permanent.
317 * Reverting::        Reverting cancels all the changes not saved.
318 * Auto Save::        Auto Save periodically protects against loss of data.
319 * Version Control::  Version control systems (RCS and SCCS).
320 * ListDir::          Listing the contents of a file directory.
321 * Comparing Files::  Finding where two files differ.
322 * Dired::            ``Editing'' a directory to delete, rename, etc.
323                      the files in it.
324 * Misc File Ops::    Other things you can do on files.
325
326 Saving Files
327
328 * Backup::       How XEmacs saves the old version of your file.
329 * Interlocking:: How XEmacs protects against simultaneous editing
330                   of one file by two users.
331
332 Backup Files
333
334 * Names: Backup Names.          How backup files are named;
335                                 Choosing single or numbered backup files.
336 * Deletion: Backup Deletion.    XEmacs deletes excess numbered backups.
337 * Copying: Backup Copying.      Backups can be made by copying or renaming.
338
339 Auto-Saving: Protection Against Disasters
340
341 * Files: Auto Save Files.
342 * Control: Auto Save Control.
343 * Recover::             Recovering text from auto-save files.
344
345 Version Control
346
347 * Concepts of VC::              Basic version control information;
348                                   checking files in and out.
349 * Editing with VC::             Commands for editing a file maintained
350                                   with version control.
351 * Variables for Check-in/out::  Variables that affect the commands used
352                                   to check files in or out.
353 * Log Entries::                 Logging your changes.
354 * Change Logs and VC::          Generating a change log file from log
355                                   entries. 
356 * Old Versions::                Examining and comparing old versions.
357 * VC Status::                   Commands to view the VC status of files and
358                                   look at log entries.
359 * Renaming and VC::             A command to rename both the source and
360                                   master file correctly.
361 * Snapshots::                   How to make and use snapshots, a set of
362                                   file versions that can be treated as a unit.
363 * Version Headers::             Inserting version control headers into
364                                   working files.
365
366 Snapshots
367
368 * Making Snapshots::            The snapshot facilities.
369 * Snapshot Caveats::            Things to be careful of when using snapshots.
370
371 Dired, the Directory Editor
372
373 * Enter: Dired Enter.         How to invoke Dired.
374 * Edit: Dired Edit.           Editing the Dired buffer.
375 * Deletion: Dired Deletion.   Deleting files with Dired.
376 * Immed: Dired Immed.         Other file operations through Dired.
377
378 Using Multiple Buffers
379
380 * Select Buffer::   Creating a new buffer or reselecting an old one.
381 * List Buffers::    Getting a list of buffers that exist.
382 * Misc Buffer::     Renaming; changing read-onliness; copying text.
383 * Kill Buffer::     Killing buffers you no longer need.
384 * Several Buffers:: How to go through the list of all buffers
385                      and operate variously on several of them.
386
387 Multiple Windows
388
389 * Basic Window::     Introduction to XEmacs windows.
390 * Split Window::     New windows are made by splitting existing windows.
391 * Other Window::     Moving to another window or doing something to it.
392 * Pop Up Window::    Finding a file or buffer in another window.
393 * Change Window::    Deleting windows and changing their sizes.
394
395 Major Modes
396
397 * Choosing Modes::     How major modes are specified or chosen.
398
399 Indentation
400
401 * Indentation Commands:: Various commands and techniques for indentation.
402 * Tab Stops::            You can set arbitrary "tab stops" and then
403                          indent to the next tab stop when you want to.
404 * Just Spaces::          You can request indentation using just spaces.
405
406 Commands for Human Languages
407
408 * Text Mode::   The major modes for editing text files.
409 * Nroff Mode::  The major mode for editing input to the formatter nroff.
410 * TeX Mode::    The major modes for editing input to the formatter TeX.
411 * Outline Mode:: The major mode for editing outlines.
412 * Words::       Moving over and killing words.
413 * Sentences::   Moving over and killing sentences.
414 * Paragraphs::  Moving over paragraphs.
415 * Pages::       Moving over pages.
416 * Filling::     Filling or justifying text
417 * Case::        Changing the case of text
418
419 @TeX{} Mode
420
421 * Editing: TeX Editing.   Special commands for editing in TeX mode.
422 * Printing: TeX Print.    Commands for printing part of a file with TeX.
423
424 Outline Mode
425
426 * Format: Outline Format.         What the text of an outline looks like.
427 * Motion: Outline Motion.         Special commands for moving through outlines.
428 * Visibility: Outline Visibility. Commands to control what is visible.
429
430 Filling Text
431
432 * Auto Fill::     Auto Fill mode breaks long lines automatically.
433 * Fill Commands:: Commands to refill paragraphs and center lines.
434 * Fill Prefix::   Filling when every line is indented or in a comment, etc.
435
436 Editing Programs
437
438 * Program Modes::       Major modes for editing programs.
439 * Lists::               Expressions with balanced parentheses.
440                          There are editing commands to operate on them.
441 * Defuns::              Each program is made up of separate functions.
442                          There are editing commands to operate on them.
443 * Grinding::            Adjusting indentation to show the nesting.
444 * Matching::            Insertion of a close-delimiter flashes matching open.
445 * Comments::            Inserting, filling and aligning comments.
446 * Balanced Editing::    Inserting two matching parentheses at once, etc.
447 * Lisp Completion::     Completion on symbol names in Lisp code.
448 * Documentation::       Getting documentation of functions you plan to call.
449 * Change Log::          Maintaining a change history for your program.
450 * Tags::                Go directly to any function in your program in one
451                          command.  Tags remembers which file it is in.
452 * Fortran::             Fortran mode and its special features.
453 * Asm Mode::            Asm mode and its special features.
454
455 Indentation for Programs
456
457 * Basic Indent::
458 * Multi-line Indent::   Commands to reindent many lines at once.
459 * Lisp Indent::         Specifying how each Lisp function should be indented.
460 * C Indent::            Choosing an indentation style for C code.
461
462 Tags Tables
463
464 * Tag Syntax::          Tag syntax for various types of code and text files.  
465 * Create Tags Table::   Creating a tags table with @code{etags}.
466 * Select Tags Table::   How to visit a tags table.
467 * Find Tag::            Commands to find the definition of a specific tag. 
468 * Tags Search::         Using a tags table for searching and replacing.
469 * List Tags::           Listing and finding tags defined in a file.
470
471 Fortran Mode
472
473 * Motion: Fortran Motion.     Moving point by statements or subprograms.
474 * Indent: Fortran Indent.     Indentation commands for Fortran.
475 * Comments: Fortran Comments. Inserting and aligning comments.
476 * Columns: Fortran Columns.   Measuring columns for valid Fortran.
477 * Abbrev: Fortran Abbrev.     Built-in abbrevs for Fortran keywords.
478
479 Fortran Indentation
480
481 * Commands: ForIndent Commands. Commands for indenting Fortran.
482 * Numbers:  ForIndent Num.      How line numbers auto-indent.
483 * Conv:     ForIndent Conv.     Conventions you must obey to avoid trouble.
484 * Vars:     ForIndent Vars.     Variables controlling Fortran indent style.
485
486 Compiling and Testing Programs
487
488 * Compilation::        Compiling programs in languages other than Lisp
489                         (C, Pascal, etc.)
490 * Modes: Lisp Modes.   Various modes for editing Lisp programs, with
491                        different facilities for running the Lisp programs.
492 * Libraries: Lisp Libraries.      Creating Lisp programs to run in XEmacs.
493 * Eval: Lisp Eval.     Executing a single Lisp expression in XEmacs.
494 * Debug: Lisp Debug.   Debugging Lisp programs running in XEmacs.
495 * Interaction: Lisp Interaction.  Executing Lisp in an XEmacs buffer.
496 * External Lisp::      Communicating through XEmacs with a separate Lisp.
497
498 Lisp Libraries
499
500 * Loading::             Loading libraries of Lisp code into XEmacs for use.
501 * Compiling Libraries:: Compiling a library makes it load and run faster.
502 * Mocklisp::            Converting Mocklisp to Lisp so XEmacs can run it.
503
504 Packages
505
506 * Packages::            Introduction to XEmacs Packages.
507 * Package Terminology:: Understanding different kinds of packages.
508 * Using Packages::      How to install and use packages.
509 * Building Packages::   Building packages from sources.
510
511 Abbrevs
512
513 * Defining Abbrevs::  Defining an abbrev, so it will expand when typed.
514 * Expanding Abbrevs:: Controlling expansion: prefixes, canceling expansion.
515 * Editing Abbrevs::   Viewing or editing the entire list of defined abbrevs.
516 * Saving Abbrevs::    Saving the entire list of abbrevs for another session.
517 * Dynamic Abbrevs::   Abbreviations for words already in the buffer.
518
519 Editing Pictures
520
521 * Basic Picture::         Basic concepts and simple commands of Picture Mode.
522 * Insert in Picture::     Controlling direction of cursor motion
523                            after "self-inserting" characters.
524 * Tabs in Picture::       Various features for tab stops and indentation.
525 * Rectangles in Picture:: Clearing and superimposing rectangles.
526
527 Sending Mail
528
529 * Format: Mail Format.    Format of the mail being composed.
530 * Headers: Mail Headers.  Details of allowed mail header fields.
531 * Mode: Mail Mode.        Special commands for editing mail being composed.
532
533 Running Shell Commands from XEmacs
534
535 * Single Shell::         How to run one shell command and return.
536 * Interactive Shell::    Permanent shell taking input via XEmacs.
537 * Shell Mode::           Special XEmacs commands used with permanent shell.
538
539 Customization
540
541 * Minor Modes::     Each minor mode is one feature you can turn on
542                      independently of any others.
543 * Variables::       Many XEmacs commands examine XEmacs variables
544                      to decide what to do; by setting variables,
545                      you can control their functioning.
546 * Keyboard Macros:: A keyboard macro records a sequence of keystrokes
547                      to be replayed with a single command.
548 * Key Bindings::    The keymaps say what command each key runs.
549                      By changing them, you can "redefine keys".
550 * Syntax::          The syntax table controls how words and expressions
551                      are parsed.
552 * Init File::       How to write common customizations in the @file{.emacs} 
553                      file.
554 * Audible Bell::    Changing how XEmacs sounds the bell. 
555 * Faces::           Changing the fonts and colors of a region of text. 
556 * X Resources::     X resources controlling various aspects of the
557                      behavior of XEmacs.
558
559 Variables
560
561 * Examining::           Examining or setting one variable's value.
562 * Easy Customization::  Convenient and easy customization of variables.
563 * Edit Options::        Examining or editing list of all variables' values.
564 * Locals::              Per-buffer values of variables.
565 * File Variables::      How files can specify variable values.
566
567 Keyboard Macros
568
569 * Basic Kbd Macro::     Defining and running keyboard macros.
570 * Save Kbd Macro::      Giving keyboard macros names; saving them in files.
571 * Kbd Macro Query::     Keyboard macros that do different things each use.
572
573 Customizing Key Bindings
574
575 * Keymaps::    Definition of the keymap data structure.
576                Names of XEmacs's standard keymaps.
577 * Rebinding::  How to redefine one key's meaning conveniently.
578 * Disabling::  Disabling a command means confirmation is required
579                 before it can be executed.  This is done to protect
580                 beginners from surprises.
581
582 The Syntax Table
583
584 * Entry: Syntax Entry.    What the syntax table records for each character.
585 * Change: Syntax Change.  How to change the information.
586
587 The Init File, @file{~/.emacs}
588
589 * Init Syntax::     Syntax of constants in Emacs Lisp.
590 * Init Examples::   How to do some things with an init file.
591 * Terminal Init::   Each terminal type can have an init file.
592
593 Dealing with XEmacs Trouble
594
595 * Stuck Recursive::    `[...]' in mode line around the parentheses.
596 * Screen Garbled::     Garbage on the screen.
597 * Text Garbled::       Garbage in the text.
598 * Unasked-for Search:: Spontaneous entry to incremental search.
599 * Emergency Escape::   Emergency escape---
600                         What to do if XEmacs stops responding.
601 * Total Frustration::  When you are at your wits' end.
602
603 @end menu
604
605 @iftex
606 @unnumbered Preface
607
608   This manual documents the use and simple customization of the XEmacs
609 editor.  The reader is not expected to be a programmer to use this
610 editor, and simple customizations do not require programming skills either.
611 Users who are not interested in customizing XEmacs can ignore the scattered
612 customization hints.
613
614   This document is primarily a reference manual, but it can also be used as a
615 primer.  However, if you are new to XEmacs, consider using the on-line,
616 learn-by-doing tutorial, which you get by running XEmacs and typing
617 @kbd{C-h t}.  With it, you learn XEmacs by using XEmacs on a specially
618 designed file which describes commands, tells you when to try them,
619 and then explains the results you see.  Using the tutorial gives a more vivid
620 introduction than the printed manual.  Also consider reading the XEmacs
621 New User's Guide, which is intended specifically as an introductory
622 manual rather than as a reference guide.
623
624   On first reading, just skim chapters one and two, which describe the
625 notational conventions of the manual and the general appearance of the
626 XEmacs display frame.  Note which questions are answered in these chapters,
627 so you can refer back later.  After reading chapter four you should
628 practice the commands there.  The next few chapters describe fundamental
629 techniques and concepts that are used constantly.  You need to understand
630 them thoroughly, experimenting with them if necessary.
631
632   To find the documentation on a particular command, look in the index.
633 Keys (character commands) and command names have separate indexes.  There
634 is also a glossary, with a cross reference for each term.
635
636 @ignore
637   If you know vaguely what the command
638 does, look in the command summary.  The command summary contains a line or
639 two about each command, and a cross reference to the section of the
640 manual that describes the command in more detail; related commands
641 are grouped together.
642 @end ignore
643
644   This manual comes in two forms: the published form and the Info form.
645 The Info form is for on-line perusal with the INFO program; it is
646 distributed along with XEmacs.  Both forms contain substantially the
647 same text and are generated from a common source file, which is also
648 distributed along with XEmacs.
649
650   XEmacs is a member of the Emacs editor family.  There are many Emacs
651 editors, all sharing common principles of organization.  For information on
652 the underlying philosophy of Emacs and the lessons learned from its
653 development, write for a copy of AI memo 519a, ``Emacs, the Extensible,
654 Customizable Self-Documenting Display Editor'', to Publications Department,
655 Artificial Intelligence Lab, 545 Tech Square, Cambridge, MA 02139, USA.  At
656 last report they charge $2.25 per copy.  Another useful publication is LCS
657 TM-165, ``A Cookbook for an Emacs'', by Craig Finseth, available from
658 Publications Department, Laboratory for Computer Science, 545 Tech Square,
659 Cambridge, MA 02139, USA.  The price today is $3.
660
661 This manual is for XEmacs installed on UNIX systems.  XEmacs also
662 exists on Microsoft Windows and Windows NT as Win-Emacs (which is
663 actually based on Lucid Emacs 19.6, an older incarnation of XEmacs).
664 @end iftex
665
666 @comment  node-name,  next,  previous,  up
667 @node License, Distrib, Top, Top
668 @unnumbered GNU GENERAL PUBLIC LICENSE
669 @center Version 1, February 1989
670 @cindex license to copy XEmacs
671 @cindex General Public License
672
673 @display
674 Copyright @copyright{} 1989 Free Software Foundation, Inc.
675 675 Mass Ave, Cambridge, MA 02139, USA
676
677 Everyone is permitted to copy and distribute verbatim copies
678 of this license document, but changing it is not allowed.
679 @end display
680
681 @unnumberedsec Preamble
682
683   The license agreements of most software companies try to keep users
684 at the mercy of those companies.  By contrast, our General Public
685 License is intended to guarantee your freedom to share and change free
686 software---to make sure the software is free for all its users.  The
687 General Public License applies to the Free Software Foundation's
688 software and to any other program whose authors commit to using it.
689 You can use it for your programs, too.
690
691   When we speak of free software, we are referring to freedom, not
692 price.  Specifically, the General Public License is designed to make
693 sure that you have the freedom to give away or sell copies of free
694 software, that you receive source code or can get it if you want it,
695 that you can change the software or use pieces of it in new free
696 programs; and that you know you can do these things.
697
698   To protect your rights, we need to make restrictions that forbid
699 anyone to deny you these rights or to ask you to surrender the rights.
700 These restrictions translate to certain responsibilities for you if you
701 distribute copies of the software, or if you modify it.
702
703   For example, if you distribute copies of a such a program, whether
704 gratis or for a fee, you must give the recipients all the rights that
705 you have.  You must make sure that they, too, receive or can get the
706 source code.  And you must tell them their rights.
707
708   We protect your rights with two steps: (1) copyright the software, and
709 (2) offer you this license which gives you legal permission to copy,
710 distribute and/or modify the software.
711
712   Also, for each author's protection and ours, we want to make certain
713 that everyone understands that there is no warranty for this free
714 software.  If the software is modified by someone else and passed on, we
715 want its recipients to know that what they have is not the original, so
716 that any problems introduced by others will not reflect on the original
717 authors' reputations.
718
719   The precise terms and conditions for copying, distribution and
720 modification follow.
721
722 @iftex
723 @unnumberedsec TERMS AND CONDITIONS
724 @end iftex
725 @ifinfo
726 @center TERMS AND CONDITIONS
727 @end ifinfo
728
729 @enumerate
730 @item
731 This License Agreement applies to any program or other work which
732 contains a notice placed by the copyright holder saying it may be
733 distributed under the terms of this General Public License.  The
734 ``Program'', below, refers to any such program or work, and a ``work based
735 on the Program'' means either the Program or any work containing the
736 Program or a portion of it, either verbatim or with modifications.  Each
737 licensee is addressed as ``you''.
738
739 @item
740 @cindex Distribution
741 You may copy and distribute verbatim copies of the Program's source
742 code as you receive it, in any medium, provided that you conspicuously and
743 appropriately publish on each copy an appropriate copyright notice and
744 disclaimer of warranty; keep intact all the notices that refer to this
745 General Public License and to the absence of any warranty; and give any
746 other recipients of the Program a copy of this General Public License
747 along with the Program.  You may charge a fee for the physical act of
748 transferring a copy.
749
750 @item
751 You may modify your copy or copies of the Program or any portion of
752 it, and copy and distribute such modifications under the terms of Paragraph
753 1 above, provided that you also do the following:
754
755 @itemize @bullet
756 @item
757 cause the modified files to carry prominent notices stating that
758 you changed the files and the date of any change; and
759
760 @item
761 cause the whole of any work that you distribute or publish, that
762 in whole or in part contains the Program or any part thereof, either
763 with or without modifications, to be licensed at no charge to all
764 third parties under the terms of this General Public License (except
765 that you may choose to grant warranty protection to some or all
766 third parties, at your option).
767
768 @item
769 If the modified program normally reads commands interactively when
770 run, you must cause it, when started running for such interactive use
771 in the simplest and most usual way, to print or display an
772 announcement including an appropriate copyright notice and a notice
773 that there is no warranty (or else, saying that you provide a
774 warranty) and that users may redistribute the program under these
775 conditions, and telling the user how to view a copy of this General
776 Public License.
777
778 @item
779 You may charge a fee for the physical act of transferring a
780 copy, and you may at your option offer warranty protection in
781 exchange for a fee.
782 @end itemize
783
784 Mere aggregation of another independent work with the Program (or its
785 derivative) on a volume of a storage or distribution medium does not bring
786 the other work under the scope of these terms.
787
788 @item
789 You may copy and distribute the Program (or a portion or derivative of
790 it, under Paragraph 2) in object code or executable form under the terms of
791 Paragraphs 1 and 2 above provided that you also do one of the following:
792
793 @itemize @bullet
794 @item
795 accompany it with the complete corresponding machine-readable
796 source code, which must be distributed under the terms of
797 Paragraphs 1 and 2 above; or,
798
799 @item
800 accompany it with a written offer, valid for at least three
801 years, to give any third party free (except for a nominal charge
802 for the cost of distribution) a complete machine-readable copy of the
803 corresponding source code, to be distributed under the terms of
804 Paragraphs 1 and 2 above; or,
805
806 @item
807 accompany it with the information you received as to where the
808 corresponding source code may be obtained.  (This alternative is
809 allowed only for noncommercial distribution and only if you
810 received the program in object code or executable form alone.)
811 @end itemize
812
813 Source code for a work means the preferred form of the work for making
814 modifications to it.  For an executable file, complete source code means
815 all the source code for all modules it contains; but, as a special
816 exception, it need not include source code for modules which are standard
817 libraries that accompany the operating system on which the executable
818 file runs, or for standard header files or definitions files that
819 accompany that operating system.
820
821 @item
822 You may not copy, modify, sublicense, distribute or transfer the
823 Program except as expressly provided under this General Public License.
824 Any attempt otherwise to copy, modify, sublicense, distribute or transfer
825 the Program is void, and will automatically terminate your rights to use
826 the Program under this License.  However, parties who have received
827 copies, or rights to use copies, from you under this General Public
828 License will not have their licenses terminated so long as such parties
829 remain in full compliance.
830
831 @item
832 By copying, distributing or modifying the Program (or any work based
833 on the Program) you indicate your acceptance of this license to do so,
834 and all its terms and conditions.
835
836 @item
837 Each time you redistribute the Program (or any work based on the
838 Program), the recipient automatically receives a license from the original
839 licensor to copy, distribute or modify the Program subject to these
840 terms and conditions.  You may not impose any further restrictions on the
841 recipients' exercise of the rights granted herein.
842
843 @page
844 @item
845 The Free Software Foundation may publish revised and/or new versions
846 of the General Public License from time to time.  Such new versions will
847 be similar in spirit to the present version, but may differ in detail to
848 address new problems or concerns.
849
850 Each version is given a distinguishing version number.  If the Program
851 specifies a version number of the license which applies to it and ``any
852 later version'', you have the option of following the terms and conditions
853 either of that version or of any later version published by the Free
854 Software Foundation.  If the Program does not specify a version number of
855 the license, you may choose any version ever published by the Free Software
856 Foundation.
857
858 @item
859 If you wish to incorporate parts of the Program into other free
860 programs whose distribution conditions are different, write to the author
861 to ask for permission.  For software which is copyrighted by the Free
862 Software Foundation, write to the Free Software Foundation; we sometimes
863 make exceptions for this.  Our decision will be guided by the two goals
864 of preserving the free status of all derivatives of our free software and
865 of promoting the sharing and reuse of software generally.
866
867 @iftex
868 @heading NO WARRANTY
869 @end iftex
870 @ifinfo
871 @center NO WARRANTY
872 @end ifinfo
873
874 @item
875 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
876 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
877 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
878 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
879 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
880 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
881 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
882 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
883 REPAIR OR CORRECTION.
884
885 @item
886 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
887 ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
888 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
889 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
890 ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT
891 LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES
892 SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE
893 WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
894 ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
895 @end enumerate
896
897 @iftex
898 @heading END OF TERMS AND CONDITIONS
899 @end iftex
900 @ifinfo
901 @center END OF TERMS AND CONDITIONS
902 @end ifinfo
903
904 @page
905 @unnumberedsec Appendix: How to Apply These Terms to Your New Programs
906
907   If you develop a new program, and you want it to be of the greatest
908 possible use to humanity, the best way to achieve this is to make it
909 free software which everyone can redistribute and change under these
910 terms.
911
912   To do so, attach the following notices to the program.  It is safest to
913 attach them to the start of each source file to most effectively convey
914 the exclusion of warranty; and each file should have at least the
915 ``copyright'' line and a pointer to where the full notice is found.
916
917 @smallexample
918 @var{one line to give the program's name and a brief idea of what it does.}
919 Copyright (C) 19@var{yy}  @var{name of author}
920
921 This program is free software; you can redistribute it and/or modify
922 it under the terms of the GNU General Public License as published by
923 the Free Software Foundation; either version 1, or (at your option)
924 any later version.
925
926 This program is distributed in the hope that it will be useful,
927 but WITHOUT ANY WARRANTY; without even the implied warranty of
928 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
929 GNU General Public License for more details.
930
931 You should have received a copy of the GNU General Public License
932 along with this program; if not, write to the Free Software
933 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
934 @end smallexample
935
936 Also add information on how to contact you by electronic and paper mail.
937
938 If the program is interactive, make it output a short notice like this
939 when it starts in an interactive mode:
940
941 @smallexample
942 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
943 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
944 This is free software, and you are welcome to redistribute it
945 under certain conditions; type `show c' for details.
946 @end smallexample
947
948 The hypothetical commands `show w' and `show c' should show the
949 appropriate parts of the General Public License.  Of course, the
950 commands you use may be called something other than `show w' and `show
951 c'; they could even be mouse-clicks or menu items---whatever suits your
952 program.
953
954 @page
955 You should also get your employer (if you work as a programmer) or your
956 school, if any, to sign a ``copyright disclaimer'' for the program, if
957 necessary.  Here a sample; alter the names:
958
959 @example
960 Yoyodyne, Inc., hereby disclaims all copyright interest in the
961 program `Gnomovision' (a program to direct compilers to make passes
962 at assemblers) written by James Hacker.
963
964 @var{signature of Ty Coon}, 1 April 1989
965 Ty Coon, President of Vice
966 @end example
967
968 That's all there is to it!
969
970 @comment  node-name,  next,  previous,  up
971 @node Distrib, Intro, License, Top
972 @unnumbered Distribution
973
974 XEmacs is @dfn{free}; this means that everyone is free to use it and
975 free to redistribute it on a free basis.  XEmacs is not in the public
976 domain; it is copyrighted and there are restrictions on its
977 distribution, but these restrictions are designed to permit everything
978 that a good cooperating citizen would want to do.  What is not allowed
979 is to try to prevent others from further sharing any version of XEmacs
980 that they might get from you.  The precise conditions are found in
981 the GNU General Public License that comes with XEmacs and also appears
982 following this section.
983
984 The easiest way to get a copy of XEmacs is from someone else who has it.
985 You need not ask for permission to do so, or tell any one else; just copy
986 it.
987
988 If you have access to the Internet, you can get the latest version of
989 XEmacs from the anonymous FTP server @file{ftp.xemacs.org} in the directory
990 @file{/pub/xemacs}.  It can also be found at numerous other archive
991 sites around the world; check the file @file{etc/DISTRIB} in an XEmacs
992 distribution for the latest known list.
993
994
995 @unnumberedsec Getting Other Versions of Emacs
996
997 The Free Software Foundation's version of Emacs (called @dfn{FSF Emacs}
998 in this manual and often referred to as @dfn{GNU Emacs}) is available
999 by anonymous FTP from @file{prep.ai.mit.edu}.
1000
1001 Win-Emacs, an older version of XEmacs that runs on Microsoft Windows
1002 and Windows NT, is available by anonymous FTP from @file{ftp.netcom.com}
1003 in the directory @file{/pub/pe/pearl}, or from @file{ftp.cica.indiana.edu}
1004 as the files @file{wemdemo*.zip} in the directory @file{/pub/pc/win3/demo}.
1005
1006 @node Intro, Glossary, Distrib, Top
1007 @unnumbered Introduction
1008
1009   You are reading about XEmacs, an incarnation of the advanced,
1010 self-documenting, customizable, extensible real-time display editor
1011 Emacs.  XEmacs provides many powerful display and user-interface
1012 capabilities not found in other Emacsen and is mostly upwardly
1013 compatible with GNU Emacs from the Free Software Foundation
1014 (referred to as @dfn{FSF Emacs} in this manual).  XEmacs also
1015 comes standard with a great number of useful packages.
1016
1017   We say that XEmacs is a @dfn{display} editor because normally the text
1018 being edited is visible on the screen and is updated automatically as you
1019 type.  @xref{Frame,Display}.
1020
1021   We call XEmacs a @dfn{real-time} editor because the display is updated very
1022 frequently, usually after each character or pair of characters you
1023 type.  This minimizes the amount of information you must keep in your
1024 head as you edit.  @xref{Basic,Real-time,Basic Editing}.
1025
1026   We call XEmacs advanced because it provides facilities that go beyond
1027 simple insertion and deletion: filling of text; automatic indentation of
1028 programs; viewing two or more files at once; and dealing in terms of
1029 characters, words, lines, sentences, paragraphs, and pages, as well as
1030 expressions and comments in several different programming languages.  It is
1031 much easier to type one command meaning ``go to the end of the paragraph''
1032 than to find that spot with simple cursor keys.
1033
1034   @dfn{Self-documenting} means that at any time you can type a special
1035 character, @kbd{Control-h}, to find out what your options are.  You can
1036 also use @kbd{C-h} to find out what a command does, or to find all the
1037 commands relevant to a topic.  @xref{Help}.
1038
1039   @dfn{Customizable} means you can change the definitions of XEmacs
1040 commands.  For example, if you use a programming language in
1041 which comments start with @samp{<**} and end with @samp{**>}, you can tell
1042 the XEmacs comment manipulation commands to use those strings
1043 (@pxref{Comments}).  Another sort of customization is rearrangement of the
1044 command set.  For example, you can set up the four basic cursor motion
1045 commands (up, down, left and right) on keys in a diamond pattern on the
1046 keyboard if you prefer.  @xref{Customization}.
1047
1048   @dfn{Extensible} means you can go beyond simple customization and
1049 write entirely new commands, programs in the Lisp language to be run by
1050 XEmacs's own Lisp interpreter.  XEmacs is an ``on-line extensible''
1051 system: it is divided into many functions that call each other.  You can
1052 redefine any function in the middle of an editing session and replace
1053 any part of XEmacs without making a separate copy of all of XEmacs.  Most
1054 of the editing commands of XEmacs are written in Lisp; the few
1055 exceptions could have been written in Lisp but are written in C for
1056 efficiency.  Only a programmer can write an extension to XEmacs, but anybody
1057 can use it afterward.
1058
1059 @include frame.texi
1060 @include keystrokes.texi
1061 @include menus.texi
1062 @include entering.texi
1063 @include cmdargs.texi
1064 @include startup.texi
1065 @include basic.texi
1066 @include undo.texi
1067 @include mini.texi
1068 @include m-x.texi
1069 @include help.texi
1070 @include mark.texi
1071 @include mouse.texi
1072 @include killing.texi
1073 @include regs.texi
1074 @include display.texi
1075 @include search.texi
1076 @include fixit.texi
1077 @include files.texi
1078 @include buffers.texi
1079 @include windows.texi
1080 @include mule.texi
1081 @include major.texi
1082 @include indent.texi
1083 @include text.texi
1084 @include programs.texi
1085 @include building.texi
1086 @include packages.texi
1087 @include abbrevs.texi
1088 @include picture.texi
1089 @include sending.texi
1090 @include reading.texi
1091 @include calendar.texi
1092 @include misc.texi
1093 @include custom.texi
1094 @include trouble.texi
1095
1096 @include new.texi
1097 @include glossary.texi
1098 @include gnu.texi
1099
1100 @node Key Index, Command Index, Manifesto, Top
1101 @unnumbered Key (Character) Index
1102 @printindex ky
1103
1104 @node Command Index, Variable Index, Key Index, Top
1105 @unnumbered Command and Function Index
1106 @printindex fn
1107
1108 @node Variable Index, Concept Index, Command Index, Top
1109 @unnumbered Variable Index
1110 @printindex vr
1111
1112 @node Concept Index, Frame, Variable Index, Top
1113 @unnumbered Concept Index
1114 @printindex cp
1115
1116 @summarycontents
1117 @contents
1118 @bye
1119
1120
1121 @c Remember to delete these lines before creating the info file.
1122 @iftex
1123 @lucidbook
1124 @bindingoffset = 0.5in
1125 @parindent = 0pt
1126 @end iftex