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.
133 * Packages:: How XEmacs organizes its high-level functionality.
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 * 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
239 * Packages:: Introduction to XEmacs Packages.
240 * Package Terminology:: Understanding different kinds of packages.
241 * Installing Packages:: How to install packages.
242 * Building Packages:: Building packages from sources.
243 * Local.rules File:: An important part of building packages.
244 * Available Packages:: A brief directory of packaged LISP.
246 Basic Editing Commands
248 * Blank Lines:: Commands to make or delete blank lines.
249 * Continuation Lines:: Lines too wide for the frame.
250 * Position Info:: What page, line, row, or column is point on?
251 * Arguments:: Numeric arguments for repeating a command.
255 * File: Minibuffer File. Entering file names with the minibuffer.
256 * Edit: Minibuffer Edit. How to edit in the minibuffer.
257 * Completion:: An abbreviation facility for minibuffer input.
258 * Repetition:: Re-executing commands that used the minibuffer.
260 The Mark and the Region
262 * Setting Mark:: Commands to set the mark.
263 * Using Region:: Summary of ways to operate on contents of the region.
264 * Marking Objects:: Commands to put region around textual units.
265 * Mark Ring:: Previous mark positions saved so you can go back there.
269 * Kill Ring:: Where killed text is stored. Basic yanking.
270 * Appending Kills:: Several kills in a row all yank together.
271 * Earlier Kills:: Yanking something killed some time ago.
275 * X Clipboard Selection:: Pasting to the X clipboard.
276 * X Selection Commands:: Other operations on the selection.
277 * X Cut Buffers:: X cut buffers are available for compatibility.
278 * Active Regions:: Using zmacs-style highlighting of the
283 * Position: RegPos. Saving positions in registers.
284 * Text: RegText. Saving text in registers.
285 * Rectangle: RegRect. Saving rectangles in registers.
286 * Configurations: RegConfig. Saving window configurations in registers.
287 * Files: RegFiles. File names in registers.
288 * Numbers: RegNumbers. Numbers in registers.
289 * Bookmarks:: Bookmarks are like registers, but persistent.
291 Controlling the Display
293 * Scrolling:: Moving text up and down in a window.
294 * Horizontal Scrolling:: Moving text left and right in a window.
295 * Selective Display:: Hiding lines with lots of indentation.
296 * Display Vars:: Information on variables for customizing display.
298 Searching and Replacement
300 * Incremental Search:: Search happens as you type the string.
301 * Non-Incremental Search:: Specify entire string and then search.
302 * Word Search:: Search for sequence of words.
303 * Regexp Search:: Search for match for a regexp.
304 * Regexps:: Syntax of regular expressions.
305 * Search Case:: To ignore case while searching, or not.
306 * Replace:: Search, and replace some or all matches.
307 * Other Repeating Search:: Operating on all matches for some regexp.
311 * Unconditional Replace:: Replacing all matches for a string.
312 * Regexp Replace:: Replacing all matches for a regexp.
313 * Replacement and Case:: How replacements preserve case of letters.
314 * Query Replace:: How to use querying.
316 Commands for Fixing Typos
318 * Kill Errors:: Commands to kill a batch of recently entered text.
319 * Transpose:: Exchanging two characters, words, lines, lists...
320 * Fixing Case:: Correcting case of last word entered.
321 * Spelling:: Apply spelling checker to a word, or a whole file.
325 * File Names:: How to type and edit file name arguments.
326 * Visiting:: Visiting a file prepares XEmacs to edit the file.
327 * Saving:: Saving makes your changes permanent.
328 * Reverting:: Reverting cancels all the changes not saved.
329 * Auto Save:: Auto Save periodically protects against loss of data.
330 * Version Control:: Version control systems (RCS and SCCS).
331 * ListDir:: Listing the contents of a file directory.
332 * Comparing Files:: Finding where two files differ.
333 * Dired:: ``Editing'' a directory to delete, rename, etc.
335 * Misc File Ops:: Other things you can do on files.
339 * Backup:: How XEmacs saves the old version of your file.
340 * Interlocking:: How XEmacs protects against simultaneous editing
341 of one file by two users.
345 * Names: Backup Names. How backup files are named;
346 Choosing single or numbered backup files.
347 * Deletion: Backup Deletion. XEmacs deletes excess numbered backups.
348 * Copying: Backup Copying. Backups can be made by copying or renaming.
350 Auto-Saving: Protection Against Disasters
352 * Files: Auto Save Files.
353 * Control: Auto Save Control.
354 * Recover:: Recovering text from auto-save files.
358 * Concepts of VC:: Basic version control information;
359 checking files in and out.
360 * Editing with VC:: Commands for editing a file maintained
361 with version control.
362 * Variables for Check-in/out:: Variables that affect the commands used
363 to check files in or out.
364 * Log Entries:: Logging your changes.
365 * Change Logs and VC:: Generating a change log file from log
367 * Old Versions:: Examining and comparing old versions.
368 * VC Status:: Commands to view the VC status of files and
370 * Renaming and VC:: A command to rename both the source and
371 master file correctly.
372 * Snapshots:: How to make and use snapshots, a set of
373 file versions that can be treated as a unit.
374 * Version Headers:: Inserting version control headers into
379 * Making Snapshots:: The snapshot facilities.
380 * Snapshot Caveats:: Things to be careful of when using snapshots.
382 Dired, the Directory Editor
384 * Enter: Dired Enter. How to invoke Dired.
385 * Edit: Dired Edit. Editing the Dired buffer.
386 * Deletion: Dired Deletion. Deleting files with Dired.
387 * Immed: Dired Immed. Other file operations through Dired.
389 Using Multiple Buffers
391 * Select Buffer:: Creating a new buffer or reselecting an old one.
392 * List Buffers:: Getting a list of buffers that exist.
393 * Misc Buffer:: Renaming; changing read-onliness; copying text.
394 * Kill Buffer:: Killing buffers you no longer need.
395 * Several Buffers:: How to go through the list of all buffers
396 and operate variously on several of them.
400 * Basic Window:: Introduction to XEmacs windows.
401 * Split Window:: New windows are made by splitting existing windows.
402 * Other Window:: Moving to another window or doing something to it.
403 * Pop Up Window:: Finding a file or buffer in another window.
404 * Change Window:: Deleting windows and changing their sizes.
408 * Choosing Modes:: How major modes are specified or chosen.
412 * Indentation Commands:: Various commands and techniques for indentation.
413 * Tab Stops:: You can set arbitrary "tab stops" and then
414 indent to the next tab stop when you want to.
415 * Just Spaces:: You can request indentation using just spaces.
417 Commands for Human Languages
419 * Text Mode:: The major modes for editing text files.
420 * Nroff Mode:: The major mode for editing input to the formatter nroff.
421 * TeX Mode:: The major modes for editing input to the formatter TeX.
422 * Outline Mode:: The major mode for editing outlines.
423 * Words:: Moving over and killing words.
424 * Sentences:: Moving over and killing sentences.
425 * Paragraphs:: Moving over paragraphs.
426 * Pages:: Moving over pages.
427 * Filling:: Filling or justifying text
428 * Case:: Changing the case of text
432 * Editing: TeX Editing. Special commands for editing in TeX mode.
433 * Printing: TeX Print. Commands for printing part of a file with TeX.
437 * Format: Outline Format. What the text of an outline looks like.
438 * Motion: Outline Motion. Special commands for moving through outlines.
439 * Visibility: Outline Visibility. Commands to control what is visible.
443 * Auto Fill:: Auto Fill mode breaks long lines automatically.
444 * Fill Commands:: Commands to refill paragraphs and center lines.
445 * Fill Prefix:: Filling when every line is indented or in a comment, etc.
449 * Program Modes:: Major modes for editing programs.
450 * Lists:: Expressions with balanced parentheses.
451 There are editing commands to operate on them.
452 * Defuns:: Each program is made up of separate functions.
453 There are editing commands to operate on them.
454 * Grinding:: Adjusting indentation to show the nesting.
455 * Matching:: Insertion of a close-delimiter flashes matching open.
456 * Comments:: Inserting, filling and aligning comments.
457 * Balanced Editing:: Inserting two matching parentheses at once, etc.
458 * Lisp Completion:: Completion on symbol names in Lisp code.
459 * Documentation:: Getting documentation of functions you plan to call.
460 * Change Log:: Maintaining a change history for your program.
461 * Tags:: Go directly to any function in your program in one
462 command. Tags remembers which file it is in.
463 * Fortran:: Fortran mode and its special features.
464 * Asm Mode:: Asm mode and its special features.
466 Indentation for Programs
469 * Multi-line Indent:: Commands to reindent many lines at once.
470 * Lisp Indent:: Specifying how each Lisp function should be indented.
471 * C Indent:: Choosing an indentation style for C code.
475 * Tag Syntax:: Tag syntax for various types of code and text files.
476 * Create Tags Table:: Creating a tags table with @code{etags}.
477 * Select Tags Table:: How to visit a tags table.
478 * Find Tag:: Commands to find the definition of a specific tag.
479 * Tags Search:: Using a tags table for searching and replacing.
480 * List Tags:: Listing and finding tags defined in a file.
484 * Motion: Fortran Motion. Moving point by statements or subprograms.
485 * Indent: Fortran Indent. Indentation commands for Fortran.
486 * Comments: Fortran Comments. Inserting and aligning comments.
487 * Columns: Fortran Columns. Measuring columns for valid Fortran.
488 * Abbrev: Fortran Abbrev. Built-in abbrevs for Fortran keywords.
492 * Commands: ForIndent Commands. Commands for indenting Fortran.
493 * Numbers: ForIndent Num. How line numbers auto-indent.
494 * Conv: ForIndent Conv. Conventions you must obey to avoid trouble.
495 * Vars: ForIndent Vars. Variables controlling Fortran indent style.
497 Compiling and Testing Programs
499 * Compilation:: Compiling programs in languages other than Lisp
501 * Modes: Lisp Modes. Various modes for editing Lisp programs, with
502 different facilities for running the Lisp programs.
503 * Libraries: Lisp Libraries. Creating Lisp programs to run in XEmacs.
504 * Eval: Lisp Eval. Executing a single Lisp expression in XEmacs.
505 * Debug: Lisp Debug. Debugging Lisp programs running in XEmacs.
506 * Interaction: Lisp Interaction. Executing Lisp in an XEmacs buffer.
507 * External Lisp:: Communicating through XEmacs with a separate Lisp.
511 * Loading:: Loading libraries of Lisp code into XEmacs for use.
512 * Compiling Libraries:: Compiling a library makes it load and run faster.
513 * Mocklisp:: Converting Mocklisp to Lisp so XEmacs can run it.
517 * Defining Abbrevs:: Defining an abbrev, so it will expand when typed.
518 * Expanding Abbrevs:: Controlling expansion: prefixes, canceling expansion.
519 * Editing Abbrevs:: Viewing or editing the entire list of defined abbrevs.
520 * Saving Abbrevs:: Saving the entire list of abbrevs for another session.
521 * Dynamic Abbrevs:: Abbreviations for words already in the buffer.
525 * Basic Picture:: Basic concepts and simple commands of Picture Mode.
526 * Insert in Picture:: Controlling direction of cursor motion
527 after "self-inserting" characters.
528 * Tabs in Picture:: Various features for tab stops and indentation.
529 * Rectangles in Picture:: Clearing and superimposing rectangles.
533 * Format: Mail Format. Format of the mail being composed.
534 * Headers: Mail Headers. Details of allowed mail header fields.
535 * Mode: Mail Mode. Special commands for editing mail being composed.
537 Running Shell Commands from XEmacs
539 * Single Shell:: How to run one shell command and return.
540 * Interactive Shell:: Permanent shell taking input via XEmacs.
541 * Shell Mode:: Special XEmacs commands used with permanent shell.
545 * Minor Modes:: Each minor mode is one feature you can turn on
546 independently of any others.
547 * Variables:: Many XEmacs commands examine XEmacs variables
548 to decide what to do; by setting variables,
549 you can control their functioning.
550 * Keyboard Macros:: A keyboard macro records a sequence of keystrokes
551 to be replayed with a single command.
552 * Key Bindings:: The keymaps say what command each key runs.
553 By changing them, you can "redefine keys".
554 * Syntax:: The syntax table controls how words and expressions
556 * Init File:: How to write common customizations in the init file.
557 * Audible Bell:: Changing how XEmacs sounds the bell.
558 * Faces:: Changing the fonts and colors of a region of text.
559 * X Resources:: X resources controlling various aspects of the
564 * Examining:: Examining or setting one variable's value.
565 * Easy Customization:: Convenient and easy customization of variables.
566 * Edit Options:: Examining or editing list of all variables' values.
567 * Locals:: Per-buffer values of variables.
568 * File Variables:: How files can specify variable values.
572 * Basic Kbd Macro:: Defining and running keyboard macros.
573 * Save Kbd Macro:: Giving keyboard macros names; saving them in files.
574 * Kbd Macro Query:: Keyboard macros that do different things each use.
576 Customizing Key Bindings
578 * Keymaps:: Definition of the keymap data structure.
579 Names of XEmacs's standard keymaps.
580 * Rebinding:: How to redefine one key's meaning conveniently.
581 * Disabling:: Disabling a command means confirmation is required
582 before it can be executed. This is done to protect
583 beginners from surprises.
587 * Entry: Syntax Entry. What the syntax table records for each character.
588 * Change: Syntax Change. How to change the information.
592 * Init Syntax:: Syntax of constants in Emacs Lisp.
593 * Init Examples:: How to do some things with an init file.
594 * Terminal Init:: Each terminal type can have an init file.
596 Dealing with XEmacs Trouble
598 * Stuck Recursive:: `[...]' in mode line around the parentheses.
599 * Screen Garbled:: Garbage on the screen.
600 * Text Garbled:: Garbage in the text.
601 * Unasked-for Search:: Spontaneous entry to incremental search.
602 * Emergency Escape:: Emergency escape---
603 What to do if XEmacs stops responding.
604 * Total Frustration:: When you are at your wits' end.
611 This manual documents the use and simple customization of the XEmacs
612 editor. The reader is not expected to be a programmer to use this
613 editor, and simple customizations do not require programming skills either.
614 Users who are not interested in customizing XEmacs can ignore the scattered
617 This document is primarily a reference manual, but it can also be used as a
618 primer. However, if you are new to XEmacs, consider using the on-line,
619 learn-by-doing tutorial, which you get by running XEmacs and typing
620 @kbd{C-h t}. With it, you learn XEmacs by using XEmacs on a specially
621 designed file which describes commands, tells you when to try them,
622 and then explains the results you see. Using the tutorial gives a more vivid
623 introduction than the printed manual. Also consider reading the XEmacs
624 New User's Guide, which is intended specifically as an introductory
625 manual rather than as a reference guide.
627 On first reading, just skim chapters one and two, which describe the
628 notational conventions of the manual and the general appearance of the
629 XEmacs display frame. Note which questions are answered in these chapters,
630 so you can refer back later. After reading chapter four you should
631 practice the commands there. The next few chapters describe fundamental
632 techniques and concepts that are used constantly. You need to understand
633 them thoroughly, experimenting with them if necessary.
635 To find the documentation on a particular command, look in the index.
636 Keys (character commands) and command names have separate indexes. There
637 is also a glossary, with a cross reference for each term.
640 If you know vaguely what the command
641 does, look in the command summary. The command summary contains a line or
642 two about each command, and a cross reference to the section of the
643 manual that describes the command in more detail; related commands
644 are grouped together.
647 This manual comes in two forms: the published form and the Info form.
648 The Info form is for on-line perusal with the INFO program; it is
649 distributed along with XEmacs. Both forms contain substantially the
650 same text and are generated from a common source file, which is also
651 distributed along with XEmacs.
653 XEmacs is a member of the Emacs editor family. There are many Emacs
654 editors, all sharing common principles of organization. For information on
655 the underlying philosophy of Emacs and the lessons learned from its
656 development, write for a copy of AI memo 519a, ``Emacs, the Extensible,
657 Customizable Self-Documenting Display Editor'', to Publications Department,
658 Artificial Intelligence Lab, 545 Tech Square, Cambridge, MA 02139, USA. At
659 last report they charge $2.25 per copy. Another useful publication is LCS
660 TM-165, ``A Cookbook for an Emacs'', by Craig Finseth, available from
661 Publications Department, Laboratory for Computer Science, 545 Tech Square,
662 Cambridge, MA 02139, USA. The price today is $3.
664 This manual is for XEmacs installed on UNIX systems. XEmacs also
665 exists on Microsoft Windows and Windows NT as Win-Emacs (which is
666 actually based on Lucid Emacs 19.6, an older incarnation of XEmacs).
669 @comment node-name, next, previous, up
670 @node License, Distrib, Top, Top
671 @unnumbered GNU GENERAL PUBLIC LICENSE
672 @center Version 1, February 1989
673 @cindex license to copy XEmacs
674 @cindex General Public License
677 Copyright @copyright{} 1989 Free Software Foundation, Inc.
678 675 Mass Ave, Cambridge, MA 02139, USA
680 Everyone is permitted to copy and distribute verbatim copies
681 of this license document, but changing it is not allowed.
684 @unnumberedsec Preamble
686 The license agreements of most software companies try to keep users
687 at the mercy of those companies. By contrast, our General Public
688 License is intended to guarantee your freedom to share and change free
689 software---to make sure the software is free for all its users. The
690 General Public License applies to the Free Software Foundation's
691 software and to any other program whose authors commit to using it.
692 You can use it for your programs, too.
694 When we speak of free software, we are referring to freedom, not
695 price. Specifically, the General Public License is designed to make
696 sure that you have the freedom to give away or sell copies of free
697 software, that you receive source code or can get it if you want it,
698 that you can change the software or use pieces of it in new free
699 programs; and that you know you can do these things.
701 To protect your rights, we need to make restrictions that forbid
702 anyone to deny you these rights or to ask you to surrender the rights.
703 These restrictions translate to certain responsibilities for you if you
704 distribute copies of the software, or if you modify it.
706 For example, if you distribute copies of a such a program, whether
707 gratis or for a fee, you must give the recipients all the rights that
708 you have. You must make sure that they, too, receive or can get the
709 source code. And you must tell them their rights.
711 We protect your rights with two steps: (1) copyright the software, and
712 (2) offer you this license which gives you legal permission to copy,
713 distribute and/or modify the software.
715 Also, for each author's protection and ours, we want to make certain
716 that everyone understands that there is no warranty for this free
717 software. If the software is modified by someone else and passed on, we
718 want its recipients to know that what they have is not the original, so
719 that any problems introduced by others will not reflect on the original
720 authors' reputations.
722 The precise terms and conditions for copying, distribution and
726 @unnumberedsec TERMS AND CONDITIONS
729 @center TERMS AND CONDITIONS
734 This License Agreement applies to any program or other work which
735 contains a notice placed by the copyright holder saying it may be
736 distributed under the terms of this General Public License. The
737 ``Program'', below, refers to any such program or work, and a ``work based
738 on the Program'' means either the Program or any work containing the
739 Program or a portion of it, either verbatim or with modifications. Each
740 licensee is addressed as ``you''.
744 You may copy and distribute verbatim copies of the Program's source
745 code as you receive it, in any medium, provided that you conspicuously and
746 appropriately publish on each copy an appropriate copyright notice and
747 disclaimer of warranty; keep intact all the notices that refer to this
748 General Public License and to the absence of any warranty; and give any
749 other recipients of the Program a copy of this General Public License
750 along with the Program. You may charge a fee for the physical act of
754 You may modify your copy or copies of the Program or any portion of
755 it, and copy and distribute such modifications under the terms of Paragraph
756 1 above, provided that you also do the following:
760 cause the modified files to carry prominent notices stating that
761 you changed the files and the date of any change; and
764 cause the whole of any work that you distribute or publish, that
765 in whole or in part contains the Program or any part thereof, either
766 with or without modifications, to be licensed at no charge to all
767 third parties under the terms of this General Public License (except
768 that you may choose to grant warranty protection to some or all
769 third parties, at your option).
772 If the modified program normally reads commands interactively when
773 run, you must cause it, when started running for such interactive use
774 in the simplest and most usual way, to print or display an
775 announcement including an appropriate copyright notice and a notice
776 that there is no warranty (or else, saying that you provide a
777 warranty) and that users may redistribute the program under these
778 conditions, and telling the user how to view a copy of this General
782 You may charge a fee for the physical act of transferring a
783 copy, and you may at your option offer warranty protection in
787 Mere aggregation of another independent work with the Program (or its
788 derivative) on a volume of a storage or distribution medium does not bring
789 the other work under the scope of these terms.
792 You may copy and distribute the Program (or a portion or derivative of
793 it, under Paragraph 2) in object code or executable form under the terms of
794 Paragraphs 1 and 2 above provided that you also do one of the following:
798 accompany it with the complete corresponding machine-readable
799 source code, which must be distributed under the terms of
800 Paragraphs 1 and 2 above; or,
803 accompany it with a written offer, valid for at least three
804 years, to give any third party free (except for a nominal charge
805 for the cost of distribution) a complete machine-readable copy of the
806 corresponding source code, to be distributed under the terms of
807 Paragraphs 1 and 2 above; or,
810 accompany it with the information you received as to where the
811 corresponding source code may be obtained. (This alternative is
812 allowed only for noncommercial distribution and only if you
813 received the program in object code or executable form alone.)
816 Source code for a work means the preferred form of the work for making
817 modifications to it. For an executable file, complete source code means
818 all the source code for all modules it contains; but, as a special
819 exception, it need not include source code for modules which are standard
820 libraries that accompany the operating system on which the executable
821 file runs, or for standard header files or definitions files that
822 accompany that operating system.
825 You may not copy, modify, sublicense, distribute or transfer the
826 Program except as expressly provided under this General Public License.
827 Any attempt otherwise to copy, modify, sublicense, distribute or transfer
828 the Program is void, and will automatically terminate your rights to use
829 the Program under this License. However, parties who have received
830 copies, or rights to use copies, from you under this General Public
831 License will not have their licenses terminated so long as such parties
832 remain in full compliance.
835 By copying, distributing or modifying the Program (or any work based
836 on the Program) you indicate your acceptance of this license to do so,
837 and all its terms and conditions.
840 Each time you redistribute the Program (or any work based on the
841 Program), the recipient automatically receives a license from the original
842 licensor to copy, distribute or modify the Program subject to these
843 terms and conditions. You may not impose any further restrictions on the
844 recipients' exercise of the rights granted herein.
848 The Free Software Foundation may publish revised and/or new versions
849 of the General Public License from time to time. Such new versions will
850 be similar in spirit to the present version, but may differ in detail to
851 address new problems or concerns.
853 Each version is given a distinguishing version number. If the Program
854 specifies a version number of the license which applies to it and ``any
855 later version'', you have the option of following the terms and conditions
856 either of that version or of any later version published by the Free
857 Software Foundation. If the Program does not specify a version number of
858 the license, you may choose any version ever published by the Free Software
862 If you wish to incorporate parts of the Program into other free
863 programs whose distribution conditions are different, write to the author
864 to ask for permission. For software which is copyrighted by the Free
865 Software Foundation, write to the Free Software Foundation; we sometimes
866 make exceptions for this. Our decision will be guided by the two goals
867 of preserving the free status of all derivatives of our free software and
868 of promoting the sharing and reuse of software generally.
878 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
879 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
880 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
881 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
882 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
883 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
884 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
885 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
886 REPAIR OR CORRECTION.
889 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
890 ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
891 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
892 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
893 ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT
894 LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES
895 SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE
896 WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
897 ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
901 @heading END OF TERMS AND CONDITIONS
904 @center END OF TERMS AND CONDITIONS
908 @unnumberedsec Appendix: How to Apply These Terms to Your New Programs
910 If you develop a new program, and you want it to be of the greatest
911 possible use to humanity, the best way to achieve this is to make it
912 free software which everyone can redistribute and change under these
915 To do so, attach the following notices to the program. It is safest to
916 attach them to the start of each source file to most effectively convey
917 the exclusion of warranty; and each file should have at least the
918 ``copyright'' line and a pointer to where the full notice is found.
921 @var{one line to give the program's name and a brief idea of what it does.}
922 Copyright (C) 19@var{yy} @var{name of author}
924 This program is free software; you can redistribute it and/or modify
925 it under the terms of the GNU General Public License as published by
926 the Free Software Foundation; either version 1, or (at your option)
929 This program is distributed in the hope that it will be useful,
930 but WITHOUT ANY WARRANTY; without even the implied warranty of
931 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
932 GNU General Public License for more details.
934 You should have received a copy of the GNU General Public License
935 along with this program; if not, write to the Free Software
936 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
939 Also add information on how to contact you by electronic and paper mail.
941 If the program is interactive, make it output a short notice like this
942 when it starts in an interactive mode:
945 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
946 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
947 This is free software, and you are welcome to redistribute it
948 under certain conditions; type `show c' for details.
951 The hypothetical commands `show w' and `show c' should show the
952 appropriate parts of the General Public License. Of course, the
953 commands you use may be called something other than `show w' and `show
954 c'; they could even be mouse-clicks or menu items---whatever suits your
958 You should also get your employer (if you work as a programmer) or your
959 school, if any, to sign a ``copyright disclaimer'' for the program, if
960 necessary. Here a sample; alter the names:
963 Yoyodyne, Inc., hereby disclaims all copyright interest in the
964 program `Gnomovision' (a program to direct compilers to make passes
965 at assemblers) written by James Hacker.
967 @var{signature of Ty Coon}, 1 April 1989
968 Ty Coon, President of Vice
971 That's all there is to it!
973 @comment node-name, next, previous, up
974 @node Distrib, Intro, License, Top
975 @unnumbered Distribution
977 XEmacs is @dfn{free}; this means that everyone is free to use it and
978 free to redistribute it on a free basis. XEmacs is not in the public
979 domain; it is copyrighted and there are restrictions on its
980 distribution, but these restrictions are designed to permit everything
981 that a good cooperating citizen would want to do. What is not allowed
982 is to try to prevent others from further sharing any version of XEmacs
983 that they might get from you. The precise conditions are found in
984 the GNU General Public License that comes with XEmacs and also appears
985 following this section.
987 The easiest way to get a copy of XEmacs is from someone else who has it.
988 You need not ask for permission to do so, or tell any one else; just copy
991 If you have access to the Internet, you can get the latest version of
992 XEmacs from the anonymous FTP server @file{ftp.xemacs.org} in the directory
993 @file{/pub/xemacs}. It can also be found at numerous other archive
994 sites around the world; check the file @file{etc/DISTRIB} in an XEmacs
995 distribution for the latest known list.
998 @unnumberedsec Getting Other Versions of Emacs
1000 The Free Software Foundation's version of Emacs (called @dfn{FSF Emacs}
1001 in this manual and often referred to as @dfn{GNU Emacs}) is available
1002 by anonymous FTP from @file{prep.ai.mit.edu}.
1004 Win-Emacs, an older version of XEmacs that runs on Microsoft Windows
1005 and Windows NT, is available by anonymous FTP from @file{ftp.netcom.com}
1006 in the directory @file{/pub/pe/pearl}, or from @file{ftp.cica.indiana.edu}
1007 as the files @file{wemdemo*.zip} in the directory @file{/pub/pc/win3/demo}.
1009 @node Intro, Glossary, Distrib, Top
1010 @unnumbered Introduction
1012 You are reading about XEmacs, an incarnation of the advanced,
1013 self-documenting, customizable, extensible real-time display editor
1014 Emacs. XEmacs provides many powerful display and user-interface
1015 capabilities not found in other Emacsen and is mostly upwardly
1016 compatible with GNU Emacs from the Free Software Foundation
1017 (referred to as @dfn{FSF Emacs} in this manual). XEmacs also
1018 comes standard with a great number of useful packages.
1020 We say that XEmacs is a @dfn{display} editor because normally the text
1021 being edited is visible on the screen and is updated automatically as you
1022 type. @xref{Frame,Display}.
1024 We call XEmacs a @dfn{real-time} editor because the display is updated very
1025 frequently, usually after each character or pair of characters you
1026 type. This minimizes the amount of information you must keep in your
1027 head as you edit. @xref{Basic,Real-time,Basic Editing}.
1029 We call XEmacs advanced because it provides facilities that go beyond
1030 simple insertion and deletion: filling of text; automatic indentation of
1031 programs; viewing two or more files at once; and dealing in terms of
1032 characters, words, lines, sentences, paragraphs, and pages, as well as
1033 expressions and comments in several different programming languages. It is
1034 much easier to type one command meaning ``go to the end of the paragraph''
1035 than to find that spot with simple cursor keys.
1037 @dfn{Self-documenting} means that at any time you can type a special
1038 character, @kbd{Control-h}, to find out what your options are. You can
1039 also use @kbd{C-h} to find out what a command does, or to find all the
1040 commands relevant to a topic. @xref{Help}.
1042 @dfn{Customizable} means you can change the definitions of XEmacs
1043 commands. For example, if you use a programming language in
1044 which comments start with @samp{<**} and end with @samp{**>}, you can tell
1045 the XEmacs comment manipulation commands to use those strings
1046 (@pxref{Comments}). Another sort of customization is rearrangement of the
1047 command set. For example, you can set up the four basic cursor motion
1048 commands (up, down, left and right) on keys in a diamond pattern on the
1049 keyboard if you prefer. @xref{Customization}.
1051 @dfn{Extensible} means you can go beyond simple customization and
1052 write entirely new commands, programs in the Lisp language to be run by
1053 XEmacs's own Lisp interpreter. XEmacs is an ``on-line extensible''
1054 system: it is divided into many functions that call each other. You can
1055 redefine any function in the middle of an editing session and replace
1056 any part of XEmacs without making a separate copy of all of XEmacs. Most
1057 of the editing commands of XEmacs are written in Lisp; the few
1058 exceptions could have been written in Lisp but are written in C for
1059 efficiency. Only a programmer can write an extension to XEmacs, but anybody
1060 can use it afterward.
1063 @include keystrokes.texi
1065 @include entering.texi
1066 @include cmdargs.texi
1067 @include startup.texi
1075 @include killing.texi
1077 @include display.texi
1078 @include search.texi
1081 @include buffers.texi
1082 @include windows.texi
1085 @include indent.texi
1087 @include programs.texi
1088 @include building.texi
1089 @include packages.texi
1090 @include abbrevs.texi
1091 @include picture.texi
1092 @include sending.texi
1093 @include reading.texi
1094 @include calendar.texi
1096 @include custom.texi
1097 @include trouble.texi
1100 @include glossary.texi
1103 @node Key Index, Command Index, Manifesto, Top
1104 @unnumbered Key (Character) Index
1107 @node Command Index, Variable Index, Key Index, Top
1108 @unnumbered Command and Function Index
1111 @node Variable Index, Concept Index, Command Index, Top
1112 @unnumbered Variable Index
1115 @node Concept Index, Frame, Variable Index, Top
1116 @unnumbered Concept Index
1124 @c Remember to delete these lines before creating the info file.
1127 @bindingoffset = 0.5in
projects / chise / xemacs-chise.git.1 / blob