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