comparison man/xemacs/xemacs.texi @ 0:376386a54a3c r19-14

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