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