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