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