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