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