1 This is Info file ../../info/xemacs.info, produced by Makeinfo version
2 1.68 from the input file xemacs.texi.
4 INFO-DIR-SECTION XEmacs Editor
6 * XEmacs: (xemacs). XEmacs Editor.
9 This file documents the XEmacs editor.
11 Copyright (C) 1985, 1986, 1988 Richard M. Stallman. Copyright (C)
12 1991, 1992, 1993, 1994 Lucid, Inc. Copyright (C) 1993, 1994 Sun
13 Microsystems, Inc. Copyright (C) 1995 Amdahl Corporation.
15 Permission is granted to make and distribute verbatim copies of this
16 manual provided the copyright notice and this permission notice are
17 preserved on all copies.
19 Permission is granted to copy and distribute modified versions of
20 this manual under the conditions for verbatim copying, provided also
21 that the sections entitled "The GNU Manifesto", "Distribution" and "GNU
22 General Public License" are included exactly as in the original, and
23 provided that the entire resulting derived work is distributed under the
24 terms of a permission notice identical to this one.
26 Permission is granted to copy and distribute translations of this
27 manual into another language, under the above conditions for modified
28 versions, except that the sections entitled "The GNU Manifesto",
29 "Distribution" and "GNU General Public License" may be included in a
30 translation approved by the author instead of in the original English.
33 File: xemacs.info, Node: Top, Next: License, Up: (dir)
35 The XEmacs Editor *****************
37 XEmacs is the extensible, customizable, self-documenting real-time
38 display editor. This Info file describes how to edit with Emacs and
39 some of how to customize it, but not how to extend it. It corresponds
40 to XEmacs version 21.0.
42 This manual is intended as a detailed reference to XEmacs. If you
43 are looking for an introductory manual, see the New User's Guide.
47 * License:: The GNU General Public License gives you permission
48 to redistribute XEmacs on certain terms; and also
49 explains that there is no warranty.
50 * Distrib:: How to get XEmacs.
51 * Intro:: An introduction to XEmacs concepts.
52 * Glossary:: The glossary.
53 * Manifesto:: What's GNU? Gnu's Not Unix!
55 Indices, nodes containing large menus
56 * Key Index:: An item for each standard XEmacs key sequence.
57 * Command Index:: An item for each command name.
58 * Variable Index:: An item for each documented variable.
59 * Concept Index:: An item for each concept.
61 Important General Concepts
62 * Frame:: How to interpret what you see on the screen.
63 * Keystrokes:: Keyboard gestures XEmacs recognizes.
65 The XEmacs Pull-down Menus available under X.
67 Starting Emacs from the shell.
68 * Exiting:: Stopping or killing XEmacs.
70 Hairy startup options.
72 How XEmacs finds Directories and Files
74 Fundamental Editing Commands
75 * Basic:: The most basic editing commands.
76 * Undo:: Undoing recently made changes in the text.
77 * Minibuffer:: Entering arguments that are prompted for.
78 * M-x:: Invoking commands by their names.
79 * Help:: Commands for asking XEmacs about its commands.
81 Important Text-Changing Commands
82 * Mark:: The mark: how to delimit a "region" of text.
84 Selecting text with the mouse.
85 * Additional Mouse Operations::
86 Other operations available from the mouse.
87 * Killing:: Killing text.
88 * Yanking:: Recovering killed text. Moving text.
89 * Using X Selections::
90 Using primary selection, cut buffers, and highlighted regions.
92 Other ways of copying text.
93 * Rectangles:: Operating on the text inside a rectangle on the screen.
94 * Registers:: Saving a text string or a location in the buffer.
95 * Display:: Controlling what text is displayed.
96 * Search:: Finding or replacing occurrences of a string.
97 * Fixit:: Commands especially useful for fixing typos.
100 * Files:: All about handling files.
101 * Buffers:: Multiple buffers; editing several files at once.
102 * Windows:: Viewing two pieces of text at once.
103 * Mule:: Using world scripts.
106 * Major Modes:: Text mode vs. Lisp mode vs. C mode ...
107 * Indentation:: Editing the white space at the beginnings of lines.
108 * Text:: Commands and modes for editing English.
109 * Programs:: Commands and modes for editing programs.
110 * Running:: Compiling, running and debugging programs.
111 * Packages:: How to add new packages to XEmacs.
112 * Abbrevs:: How to define text abbreviations to reduce
113 the number of characters you must type.
114 * Picture:: Editing pictures made up of characters
115 using the quarter-plane screen model.
116 * Sending Mail:: Sending mail in XEmacs.
117 * Reading Mail:: Reading mail in XEmacs.
118 * Calendar/Diary:: A Calendar and diary facility in XEmacs.
119 * Sorting:: Sorting lines, paragraphs or pages within XEmacs.
120 * Shell:: Executing shell commands from XEmacs.
121 * Narrowing:: Restricting display and editing to a portion
123 * Hardcopy:: Printing buffers or regions.
125 A command can allow you to do editing
126 "within the command". This is called a
127 `recursive editing level'.
128 * Dissociated Press:: Dissociating text for fun.
129 * CONX:: A different kind of dissociation.
130 * Amusements:: Various games and hacks.
131 * Emulation:: Emulating some other editors with XEmacs.
132 * Customization:: Modifying the behavior of XEmacs.
134 Recovery from Problems.
135 * Quitting:: Quitting and aborting.
136 * Lossage:: What to do if XEmacs is hung or malfunctioning.
137 * Bugs:: How and when to report a bug.
139 Here are some other nodes which are really inferiors of the ones
140 already listed, mentioned here so you can get to them in one step:
142 -- The Detailed Node Listing --
144 The Organization of the Frame
146 * Point:: The place in the text where editing commands operate.
147 * Echo Area:: Short messages appear at the bottom of the frame.
148 * Mode Line:: Interpreting the mode line.
149 * XEmacs under X:: Some information on using XEmacs under the X
154 * Intro to Keystrokes:: Keystrokes as building blocks of key sequences.
155 * Representing Keystrokes:: Using lists of modifiers and keysyms to
156 represent keystrokes.
157 * Key Sequences:: Combine key strokes into key sequences you can
159 * String Key Sequences:: Available for upward compatibility.
160 * Meta Key:: Using <ESC> to represent <Meta>
161 * Super and Hyper Keys:: Adding modifier keys on certain keyboards.
162 * Character Representation:: How characters appear in XEmacs buffers.
163 * Commands:: How commands are bound to key sequences.
167 * File Menu:: Items on the File menu.
168 * Edit Menu:: Items on the Edit menu.
169 * Apps Menu:: Items on the Apps menu.
170 * Options Menu:: Items on the Options menu.
171 * Buffers Menu:: Information about the Buffers menu.
172 * Tools Menu:: Items on the Tools menu.
173 * Help Menu:: Items on the Help menu.
174 * Menu Customization:: Adding and removing menu items and related
177 Basic Editing Commands
179 * Blank Lines:: Commands to make or delete blank lines.
180 * Continuation Lines:: Lines too wide for the frame.
181 * Position Info:: What page, line, row, or column is point on?
182 * Arguments:: Numeric arguments for repeating a command.
186 * File: Minibuffer File. Entering file names with the minibuffer.
187 * Edit: Minibuffer Edit. How to edit in the minibuffer.
188 * Completion:: An abbreviation facility for minibuffer input.
189 * Repetition:: Re-executing commands that used the minibuffer.
191 The Mark and the Region
193 * Setting Mark:: Commands to set the mark.
194 * Using Region:: Summary of ways to operate on contents of the region.
195 * Marking Objects:: Commands to put region around textual units.
196 * Mark Ring:: Previous mark positions saved so you can go back there.
200 * Kill Ring:: Where killed text is stored. Basic yanking.
201 * Appending Kills:: Several kills in a row all yank together.
202 * Earlier Kills:: Yanking something killed some time ago.
206 * X Clipboard Selection:: Pasting to the X clipboard.
207 * X Selection Commands:: Other operations on the selection.
208 * X Cut Buffers:: X cut buffers are available for compatibility.
209 * Active Regions:: Using zmacs-style highlighting of the
214 * RegPos:: Saving positions in registers.
215 * RegText:: Saving text in registers.
216 * RegRect:: Saving rectangles in registers.
218 Controlling the Display
220 * Scrolling:: Moving text up and down in a window.
221 * Horizontal Scrolling:: Moving text left and right in a window.
222 * Selective Display:: Hiding lines with lots of indentation.
223 * Display Vars:: Information on variables for customizing display.
225 Searching and Replacement
227 * Incremental Search:: Search happens as you type the string.
228 * Non-Incremental Search:: Specify entire string and then search.
229 * Word Search:: Search for sequence of words.
230 * Regexp Search:: Search for match for a regexp.
231 * Regexps:: Syntax of regular expressions.
232 * Search Case:: To ignore case while searching, or not.
233 * Replace:: Search, and replace some or all matches.
234 * Other Repeating Search:: Operating on all matches for some regexp.
238 * Unconditional Replace:: Replacing all matches for a string.
239 * Regexp Replace:: Replacing all matches for a regexp.
240 * Replacement and Case:: How replacements preserve case of letters.
241 * Query Replace:: How to use querying.
243 Commands for Fixing Typos
245 * Kill Errors:: Commands to kill a batch of recently entered text.
246 * Transpose:: Exchanging two characters, words, lines, lists...
247 * Fixing Case:: Correcting case of last word entered.
248 * Spelling:: Apply spelling checker to a word, or a whole file.
252 * File Names:: How to type and edit file name arguments.
253 * Visiting:: Visiting a file prepares XEmacs to edit the file.
254 * Saving:: Saving makes your changes permanent.
255 * Reverting:: Reverting cancels all the changes not saved.
256 * Auto Save:: Auto Save periodically protects against loss of data.
257 * Version Control:: Version control systems (RCS and SCCS).
258 * ListDir:: Listing the contents of a file directory.
259 * Comparing Files:: Finding where two files differ.
260 * Dired:: "Editing" a directory to delete, rename, etc.
262 * Misc File Ops:: Other things you can do on files.
266 * Backup:: How XEmacs saves the old version of your file.
267 * Interlocking:: How XEmacs protects against simultaneous editing
268 of one file by two users.
272 * Names: Backup Names. How backup files are named;
273 Choosing single or numbered backup files.
274 * Deletion: Backup Deletion. XEmacs deletes excess numbered backups.
275 * Copying: Backup Copying. Backups can be made by copying or renaming.
277 Auto-Saving: Protection Against Disasters
279 * Files: Auto Save Files.
280 * Control: Auto Save Control.
281 * Recover:: Recovering text from auto-save files.
285 * Concepts of VC:: Basic version control information;
286 checking files in and out.
287 * Editing with VC:: Commands for editing a file maintained
288 with version control.
289 * Variables for Check-in/out:: Variables that affect the commands used
290 to check files in or out.
291 * Log Entries:: Logging your changes.
292 * Change Logs and VC:: Generating a change log file from log
294 * Old Versions:: Examining and comparing old versions.
295 * VC Status:: Commands to view the VC status of files and
297 * Renaming and VC:: A command to rename both the source and
298 master file correctly.
299 * Snapshots:: How to make and use snapshots, a set of
300 file versions that can be treated as a unit.
301 * Version Headers:: Inserting version control headers into
306 * Making Snapshots:: The snapshot facilities.
307 * Snapshot Caveats:: Things to be careful of when using snapshots.
309 Dired, the Directory Editor
311 * Enter: Dired Enter. How to invoke Dired.
312 * Edit: Dired Edit. Editing the Dired buffer.
313 * Deletion: Dired Deletion. Deleting files with Dired.
314 * Immed: Dired Immed. Other file operations through Dired.
316 Using Multiple Buffers
318 * Select Buffer:: Creating a new buffer or reselecting an old one.
319 * List Buffers:: Getting a list of buffers that exist.
320 * Misc Buffer:: Renaming; changing read-onliness; copying text.
321 * Kill Buffer:: Killing buffers you no longer need.
322 * Several Buffers:: How to go through the list of all buffers
323 and operate variously on several of them.
327 * Basic Window:: Introduction to XEmacs windows.
328 * Split Window:: New windows are made by splitting existing windows.
329 * Other Window:: Moving to another window or doing something to it.
330 * Pop Up Window:: Finding a file or buffer in another window.
331 * Change Window:: Deleting windows and changing their sizes.
335 * Choosing Modes:: How major modes are specified or chosen.
339 * Indentation Commands:: Various commands and techniques for indentation.
340 * Tab Stops:: You can set arbitrary "tab stops" and then
341 indent to the next tab stop when you want to.
342 * Just Spaces:: You can request indentation using just spaces.
344 Commands for Human Languages
346 * Text Mode:: The major modes for editing text files.
347 * Nroff Mode:: The major mode for editing input to the formatter nroff.
348 * TeX Mode:: The major modes for editing input to the formatter TeX.
349 * Outline Mode:: The major mode for editing outlines.
350 * Words:: Moving over and killing words.
351 * Sentences:: Moving over and killing sentences.
352 * Paragraphs:: Moving over paragraphs.
353 * Pages:: Moving over pages.
354 * Filling:: Filling or justifying text
355 * Case:: Changing the case of text
359 * Editing: TeX Editing. Special commands for editing in TeX mode.
360 * Printing: TeX Print. Commands for printing part of a file with TeX.
364 * Format: Outline Format. What the text of an outline looks like.
365 * Motion: Outline Motion. Special commands for moving through outlines.
366 * Visibility: Outline Visibility. Commands to control what is visible.
370 * Auto Fill:: Auto Fill mode breaks long lines automatically.
371 * Fill Commands:: Commands to refill paragraphs and center lines.
372 * Fill Prefix:: Filling when every line is indented or in a comment, etc.
376 * Program Modes:: Major modes for editing programs.
377 * Lists:: Expressions with balanced parentheses.
378 There are editing commands to operate on them.
379 * Defuns:: Each program is made up of separate functions.
380 There are editing commands to operate on them.
381 * Grinding:: Adjusting indentation to show the nesting.
382 * Matching:: Insertion of a close-delimiter flashes matching open.
383 * Comments:: Inserting, filling and aligning comments.
384 * Balanced Editing:: Inserting two matching parentheses at once, etc.
385 * Lisp Completion:: Completion on symbol names in Lisp code.
386 * Documentation:: Getting documentation of functions you plan to call.
387 * Change Log:: Maintaining a change history for your program.
388 * Tags:: Go directly to any function in your program in one
389 command. Tags remembers which file it is in.
390 * Fortran:: Fortran mode and its special features.
391 * Asm Mode:: Asm mode and its special features.
393 Indentation for Programs
396 * Multi-line Indent:: Commands to reindent many lines at once.
397 * Lisp Indent:: Specifying how each Lisp function should be indented.
398 * C Indent:: Choosing an indentation style for C code.
402 * Tag Syntax:: Tag syntax for various types of code and text files.
403 * Create Tags Table:: Creating a tags table with `etags'.
404 * Select Tags Table:: How to visit a tags table.
405 * Find Tag:: Commands to find the definition of a specific tag.
406 * Tags Search:: Using a tags table for searching and replacing.
407 * List Tags:: Listing and finding tags defined in a file.
411 * Motion: Fortran Motion. Moving point by statements or subprograms.
412 * Indent: Fortran Indent. Indentation commands for Fortran.
413 * Comments: Fortran Comments. Inserting and aligning comments.
414 * Columns: Fortran Columns. Measuring columns for valid Fortran.
415 * Abbrev: Fortran Abbrev. Built-in abbrevs for Fortran keywords.
419 * Commands: ForIndent Commands. Commands for indenting Fortran.
420 * Numbers: ForIndent Num. How line numbers auto-indent.
421 * Conv: ForIndent Conv. Conventions you must obey to avoid trouble.
422 * Vars: ForIndent Vars. Variables controlling Fortran indent style.
424 Compiling and Testing Programs
426 * Compilation:: Compiling programs in languages other than Lisp
428 * Modes: Lisp Modes. Various modes for editing Lisp programs, with
429 different facilities for running the Lisp programs.
430 * Libraries: Lisp Libraries. Creating Lisp programs to run in XEmacs.
431 * Eval: Lisp Eval. Executing a single Lisp expression in XEmacs.
432 * Debug: Lisp Debug. Debugging Lisp programs running in XEmacs.
433 * Interaction: Lisp Interaction. Executing Lisp in an XEmacs buffer.
434 * External Lisp:: Communicating through XEmacs with a separate Lisp.
438 * Loading:: Loading libraries of Lisp code into XEmacs for use.
439 * Compiling Libraries:: Compiling a library makes it load and run faster.
440 * Mocklisp:: Converting Mocklisp to Lisp so XEmacs can run it.
444 * Packages:: Introduction to XEmacs Packages.
445 * Package Terminology:: Understanding different kinds of packages.
446 * Using Packages:: How to install and use packages.
447 * Building Packages:: Building packages from sources.
451 * Defining Abbrevs:: Defining an abbrev, so it will expand when typed.
452 * Expanding Abbrevs:: Controlling expansion: prefixes, canceling expansion.
453 * Editing Abbrevs:: Viewing or editing the entire list of defined abbrevs.
454 * Saving Abbrevs:: Saving the entire list of abbrevs for another session.
455 * Dynamic Abbrevs:: Abbreviations for words already in the buffer.
459 * Basic Picture:: Basic concepts and simple commands of Picture Mode.
460 * Insert in Picture:: Controlling direction of cursor motion
461 after "self-inserting" characters.
462 * Tabs in Picture:: Various features for tab stops and indentation.
463 * Rectangles in Picture:: Clearing and superimposing rectangles.
467 * Format: Mail Format. Format of the mail being composed.
468 * Headers: Mail Headers. Details of allowed mail header fields.
469 * Mode: Mail Mode. Special commands for editing mail being composed.
471 Running Shell Commands from XEmacs
473 * Single Shell:: How to run one shell command and return.
474 * Interactive Shell:: Permanent shell taking input via XEmacs.
475 * Shell Mode:: Special XEmacs commands used with permanent shell.
479 * Minor Modes:: Each minor mode is one feature you can turn on
480 independently of any others.
481 * Variables:: Many XEmacs commands examine XEmacs variables
482 to decide what to do; by setting variables,
483 you can control their functioning.
484 * Keyboard Macros:: A keyboard macro records a sequence of keystrokes
485 to be replayed with a single command.
486 * Key Bindings:: The keymaps say what command each key runs.
487 By changing them, you can "redefine keys".
488 * Syntax:: The syntax table controls how words and expressions
490 * Init File:: How to write common customizations in the `.emacs'
492 * Audible Bell:: Changing how XEmacs sounds the bell.
493 * Faces:: Changing the fonts and colors of a region of text.
494 * X Resources:: X resources controlling various aspects of the
499 * Examining:: Examining or setting one variable's value.
500 * Easy Customization:: Convenient and easy customization of variables.
501 * Edit Options:: Examining or editing list of all variables' values.
502 * Locals:: Per-buffer values of variables.
503 * File Variables:: How files can specify variable values.
507 * Basic Kbd Macro:: Defining and running keyboard macros.
508 * Save Kbd Macro:: Giving keyboard macros names; saving them in files.
509 * Kbd Macro Query:: Keyboard macros that do different things each use.
511 Customizing Key Bindings
513 * Keymaps:: Definition of the keymap data structure.
514 Names of XEmacs's standard keymaps.
515 * Rebinding:: How to redefine one key's meaning conveniently.
516 * Disabling:: Disabling a command means confirmation is required
517 before it can be executed. This is done to protect
518 beginners from surprises.
522 * Entry: Syntax Entry. What the syntax table records for each character.
523 * Change: Syntax Change. How to change the information.
525 The Init File, `~/.emacs'
527 * Init Syntax:: Syntax of constants in Emacs Lisp.
528 * Init Examples:: How to do some things with an init file.
529 * Terminal Init:: Each terminal type can have an init file.
531 Dealing with XEmacs Trouble
533 * Stuck Recursive:: `[...]' in mode line around the parentheses.
534 * Screen Garbled:: Garbage on the screen.
535 * Text Garbled:: Garbage in the text.
536 * Unasked-for Search:: Spontaneous entry to incremental search.
537 * Emergency Escape:: Emergency escape--
538 What to do if XEmacs stops responding.
539 * Total Frustration:: When you are at your wits' end.
542 File: xemacs.info, Node: License, Next: Distrib, Prev: Top, Up: Top
544 GNU GENERAL PUBLIC LICENSE
545 **************************
547 Version 1, February 1989
549 Copyright (C) 1989 Free Software Foundation, Inc.
550 675 Mass Ave, Cambridge, MA 02139, USA
552 Everyone is permitted to copy and distribute verbatim copies
553 of this license document, but changing it is not allowed.
558 The license agreements of most software companies try to keep users
559 at the mercy of those companies. By contrast, our General Public
560 License is intended to guarantee your freedom to share and change free
561 software--to make sure the software is free for all its users. The
562 General Public License applies to the Free Software Foundation's
563 software and to any other program whose authors commit to using it.
564 You can use it for your programs, too.
566 When we speak of free software, we are referring to freedom, not
567 price. Specifically, the General Public License is designed to make
568 sure that you have the freedom to give away or sell copies of free
569 software, that you receive source code or can get it if you want it,
570 that you can change the software or use pieces of it in new free
571 programs; and that you know you can do these things.
573 To protect your rights, we need to make restrictions that forbid
574 anyone to deny you these rights or to ask you to surrender the rights.
575 These restrictions translate to certain responsibilities for you if you
576 distribute copies of the software, or if you modify it.
578 For example, if you distribute copies of a such a program, whether
579 gratis or for a fee, you must give the recipients all the rights that
580 you have. You must make sure that they, too, receive or can get the
581 source code. And you must tell them their rights.
583 We protect your rights with two steps: (1) copyright the software,
584 and (2) offer you this license which gives you legal permission to copy,
585 distribute and/or modify the software.
587 Also, for each author's protection and ours, we want to make certain
588 that everyone understands that there is no warranty for this free
589 software. If the software is modified by someone else and passed on, we
590 want its recipients to know that what they have is not the original, so
591 that any problems introduced by others will not reflect on the original
592 authors' reputations.
594 The precise terms and conditions for copying, distribution and
599 1. This License Agreement applies to any program or other work which
600 contains a notice placed by the copyright holder saying it may be
601 distributed under the terms of this General Public License. The
602 "Program", below, refers to any such program or work, and a "work
603 based on the Program" means either the Program or any work
604 containing the Program or a portion of it, either verbatim or with
605 modifications. Each licensee is addressed as "you".
607 2. You may copy and distribute verbatim copies of the Program's source
608 code as you receive it, in any medium, provided that you
609 conspicuously and appropriately publish on each copy an
610 appropriate copyright notice and disclaimer of warranty; keep
611 intact all the notices that refer to this General Public License
612 and to the absence of any warranty; and give any other recipients
613 of the Program a copy of this General Public License along with
614 the Program. You may charge a fee for the physical act of
617 3. You may modify your copy or copies of the Program or any portion of
618 it, and copy and distribute such modifications under the terms of
619 Paragraph 1 above, provided that you also do the following:
621 * cause the modified files to carry prominent notices stating
622 that you changed the files and the date of any change; and
624 * cause the whole of any work that you distribute or publish,
625 that in whole or in part contains the Program or any part
626 thereof, either with or without modifications, to be licensed
627 at no charge to all third parties under the terms of this
628 General Public License (except that you may choose to grant
629 warranty protection to some or all third parties, at your
632 * If the modified program normally reads commands interactively
633 when run, you must cause it, when started running for such
634 interactive use in the simplest and most usual way, to print
635 or display an announcement including an appropriate copyright
636 notice and a notice that there is no warranty (or else,
637 saying that you provide a warranty) and that users may
638 redistribute the program under these conditions, and telling
639 the user how to view a copy of this General Public License.
641 * You may charge a fee for the physical act of transferring a
642 copy, and you may at your option offer warranty protection in
645 Mere aggregation of another independent work with the Program (or
646 its derivative) on a volume of a storage or distribution medium
647 does not bring the other work under the scope of these terms.
649 4. You may copy and distribute the Program (or a portion or
650 derivative of it, under Paragraph 2) in object code or executable
651 form under the terms of Paragraphs 1 and 2 above provided that you
652 also do one of the following:
654 * accompany it with the complete corresponding machine-readable
655 source code, which must be distributed under the terms of
656 Paragraphs 1 and 2 above; or,
658 * accompany it with a written offer, valid for at least three
659 years, to give any third party free (except for a nominal
660 charge for the cost of distribution) a complete
661 machine-readable copy of the corresponding source code, to be
662 distributed under the terms of Paragraphs 1 and 2 above; or,
664 * accompany it with the information you received as to where the
665 corresponding source code may be obtained. (This alternative
666 is allowed only for noncommercial distribution and only if you
667 received the program in object code or executable form alone.)
669 Source code for a work means the preferred form of the work for
670 making modifications to it. For an executable file, complete
671 source code means all the source code for all modules it contains;
672 but, as a special exception, it need not include source code for
673 modules which are standard libraries that accompany the operating
674 system on which the executable file runs, or for standard header
675 files or definitions files that accompany that operating system.
677 5. You may not copy, modify, sublicense, distribute or transfer the
678 Program except as expressly provided under this General Public
679 License. Any attempt otherwise to copy, modify, sublicense,
680 distribute or transfer the Program is void, and will automatically
681 terminate your rights to use the Program under this License.
682 However, parties who have received copies, or rights to use
683 copies, from you under this General Public License will not have
684 their licenses terminated so long as such parties remain in full
687 6. By copying, distributing or modifying the Program (or any work
688 based on the Program) you indicate your acceptance of this license
689 to do so, and all its terms and conditions.
691 7. Each time you redistribute the Program (or any work based on the
692 Program), the recipient automatically receives a license from the
693 original licensor to copy, distribute or modify the Program
694 subject to these terms and conditions. You may not impose any
695 further restrictions on the recipients' exercise of the rights
698 8. The Free Software Foundation may publish revised and/or new
699 versions of the General Public License from time to time. Such
700 new versions will be similar in spirit to the present version, but
701 may differ in detail to address new problems or concerns.
703 Each version is given a distinguishing version number. If the
704 Program specifies a version number of the license which applies to
705 it and "any later version", you have the option of following the
706 terms and conditions either of that version or of any later
707 version published by the Free Software Foundation. If the Program
708 does not specify a version number of the license, you may choose
709 any version ever published by the Free Software Foundation.
711 9. If you wish to incorporate parts of the Program into other free
712 programs whose distribution conditions are different, write to the
713 author to ask for permission. For software which is copyrighted
714 by the Free Software Foundation, write to the Free Software
715 Foundation; we sometimes make exceptions for this. Our decision
716 will be guided by the two goals of preserving the free status of
717 all derivatives of our free software and of promoting the sharing
718 and reuse of software generally.
722 10. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
723 WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
724 LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
725 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
726 WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT
727 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
728 FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE
729 QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
730 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
731 SERVICING, REPAIR OR CORRECTION.
733 11. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
734 WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
735 MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE
736 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
737 INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
738 INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
739 DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU
740 OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY
741 OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
742 ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
744 END OF TERMS AND CONDITIONS
746 Appendix: How to Apply These Terms to Your New Programs
747 =======================================================
749 If you develop a new program, and you want it to be of the greatest
750 possible use to humanity, the best way to achieve this is to make it
751 free software which everyone can redistribute and change under these
754 To do so, attach the following notices to the program. It is safest
755 to attach them to the start of each source file to most effectively
756 convey the exclusion of warranty; and each file should have at least the
757 "copyright" line and a pointer to where the full notice is found.
759 ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES.
760 Copyright (C) 19YY NAME OF AUTHOR
762 This program is free software; you can redistribute it and/or modify
763 it under the terms of the GNU General Public License as published by
764 the Free Software Foundation; either version 1, or (at your option)
767 This program is distributed in the hope that it will be useful,
768 but WITHOUT ANY WARRANTY; without even the implied warranty of
769 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
770 GNU General Public License for more details.
772 You should have received a copy of the GNU General Public License
773 along with this program; if not, write to the Free Software
774 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
776 Also add information on how to contact you by electronic and paper
779 If the program is interactive, make it output a short notice like
780 this when it starts in an interactive mode:
782 Gnomovision version 69, Copyright (C) 19YY NAME OF AUTHOR
783 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
784 This is free software, and you are welcome to redistribute it
785 under certain conditions; type `show c' for details.
787 The hypothetical commands `show w' and `show c' should show the
788 appropriate parts of the General Public License. Of course, the
789 commands you use may be called something other than `show w' and `show
790 c'; they could even be mouse-clicks or menu items--whatever suits your
793 You should also get your employer (if you work as a programmer) or
794 your school, if any, to sign a "copyright disclaimer" for the program,
795 if necessary. Here a sample; alter the names:
797 Yoyodyne, Inc., hereby disclaims all copyright interest in the
798 program `Gnomovision' (a program to direct compilers to make passes
799 at assemblers) written by James Hacker.
801 SIGNATURE OF TY COON, 1 April 1989
802 Ty Coon, President of Vice
804 That's all there is to it!
807 File: xemacs.info, Node: Distrib, Next: Intro, Prev: License, Up: Top
812 XEmacs is "free"; this means that everyone is free to use it and
813 free to redistribute it on a free basis. XEmacs is not in the public
814 domain; it is copyrighted and there are restrictions on its
815 distribution, but these restrictions are designed to permit everything
816 that a good cooperating citizen would want to do. What is not allowed
817 is to try to prevent others from further sharing any version of XEmacs
818 that they might get from you. The precise conditions are found in the
819 GNU General Public License that comes with XEmacs and also appears
820 following this section.
822 The easiest way to get a copy of XEmacs is from someone else who has
823 it. You need not ask for permission to do so, or tell any one else;
826 If you have access to the Internet, you can get the latest version of
827 XEmacs from the anonymous FTP server `ftp.xemacs.org' in the directory
828 `/pub/xemacs'. It can also be found at numerous other archive sites
829 around the world; check the file `etc/DISTRIB' in an XEmacs
830 distribution for the latest known list.
832 Getting Other Versions of Emacs
833 ===============================
835 The Free Software Foundation's version of Emacs (called "FSF Emacs"
836 in this manual and often referred to as "GNU Emacs") is available by
837 anonymous FTP from `prep.ai.mit.edu'.
839 Win-Emacs, an older version of XEmacs that runs on Microsoft Windows
840 and Windows NT, is available by anonymous FTP from `ftp.netcom.com' in
841 the directory `/pub/pe/pearl', or from `ftp.cica.indiana.edu' as the
842 files `wemdemo*.zip' in the directory `/pub/pc/win3/demo'.
845 File: xemacs.info, Node: Intro, Next: Glossary, Prev: Distrib, Up: Top
850 You are reading about XEmacs, an incarnation of the advanced,
851 self-documenting, customizable, extensible real-time display editor
852 Emacs. XEmacs provides many powerful display and user-interface
853 capabilities not found in other Emacsen and is mostly upwardly
854 compatible with GNU Emacs from the Free Software Foundation (referred
855 to as "FSF Emacs" in this manual). XEmacs also comes standard with a
856 great number of useful packages.
858 We say that XEmacs is a "display" editor because normally the text
859 being edited is visible on the screen and is updated automatically as
860 you type. *Note Display: Frame.
862 We call XEmacs a "real-time" editor because the display is updated
863 very frequently, usually after each character or pair of characters you
864 type. This minimizes the amount of information you must keep in your
865 head as you edit. *Note Real-time: Basic.
867 We call XEmacs advanced because it provides facilities that go beyond
868 simple insertion and deletion: filling of text; automatic indentation of
869 programs; viewing two or more files at once; and dealing in terms of
870 characters, words, lines, sentences, paragraphs, and pages, as well as
871 expressions and comments in several different programming languages.
872 It is much easier to type one command meaning "go to the end of the
873 paragraph" than to find that spot with simple cursor keys.
875 "Self-documenting" means that at any time you can type a special
876 character, `Control-h', to find out what your options are. You can
877 also use `C-h' to find out what a command does, or to find all the
878 commands relevant to a topic. *Note Help::.
880 "Customizable" means you can change the definitions of XEmacs
881 commands. For example, if you use a programming language in which
882 comments start with `<**' and end with `**>', you can tell the XEmacs
883 comment manipulation commands to use those strings (*note Comments::.).
884 Another sort of customization is rearrangement of the command set.
885 For example, you can set up the four basic cursor motion commands (up,
886 down, left and right) on keys in a diamond pattern on the keyboard if
887 you prefer. *Note Customization::.
889 "Extensible" means you can go beyond simple customization and write
890 entirely new commands, programs in the Lisp language to be run by
891 XEmacs's own Lisp interpreter. XEmacs is an "on-line extensible"
892 system: it is divided into many functions that call each other. You can
893 redefine any function in the middle of an editing session and replace
894 any part of XEmacs without making a separate copy of all of XEmacs.
895 Most of the editing commands of XEmacs are written in Lisp; the few
896 exceptions could have been written in Lisp but are written in C for
897 efficiency. Only a programmer can write an extension to XEmacs, but
898 anybody can use it afterward.
901 File: xemacs.info, Node: Frame, Next: Keystrokes, Prev: Concept Index, Up: Top
907 In many environments, such as a tty terminal, an XEmacs frame
908 literally takes up the whole screen. If you are running XEmacs in
909 a multi-window system like the X Window System, the XEmacs frame
910 takes up one X window. *Note XEmacs under X::, for more
914 No matter what environment you are running in, XEmacs allows you
915 to look at several buffers at the same time by having several
916 windows be part of the frame. Often, the whole frame is taken up
917 by just one window, but you can split the frame into two or more
918 subwindows. If you are running XEmacs under the X window system,
919 that means you can have several "XEmacs windows" inside the X
920 window that contains the XEmacs frame. You can even have multiple
921 frames in different X windows, each with their own set of
924 Each XEmacs frame displays a variety of information:
925 * The biggest area usually displays the text you are editing. It may
926 consist of one window or of two or more windows if you need to
927 look at two buffers a the same time.
929 * Below each text window's last line is a "mode line" (*note Mode
930 Line::.), which describes what is going on in that window. The
931 mode line is in inverse video if the terminal supports that. If
932 there are several XEmacs windows in one frame, each window has its
935 * At the bottom of each XEmacs frame is the "echo area" or
936 "minibuffer window"(*note Echo Area::.). It is used by XEmacs to
937 exchange information with the user. There is only one echo area
940 * If you are running XEmacs under the X Window System, a menu bar at
941 the top of the frame makes shortcuts to several of the commands
942 available (*note Pull-down Menus::.).
944 You can subdivide the XEmacs frame into multiple text windows, and
945 use each window for a different file (*note Windows::.). Multiple
946 XEmacs windows are tiled vertically on the XEmacs frame. The upper
947 XEmacs window is separated from the lower window by its mode line.
949 When there are multiple, tiled XEmacs windows on a single XEmacs
950 frame, the XEmacs window receiving input from the keyboard has the
951 "keyboard focus" and is called the "selected window". The selected
952 window contains the cursor, which indicates the insertion point. If
953 you are working in an environment that permits multiple XEmacs frames,
954 and you move the focus from one XEmacs frame into another, the selected
955 window is the one that was last selected in that frame.
957 The same text can be displayed simultaneously in several XEmacs
958 windows, which can be in different XEmacs frames. If you alter the text
959 in an XEmacs buffer by editing it in one XEmacs window, the changes are
960 visible in all XEmacs windows containing that buffer.
964 * Point:: The place in the text where editing commands operate.
965 * Echo Area:: Short messages appear at the bottom of the frame.
966 * Mode Line:: Interpreting the mode line.
967 * XEmacs under X:: Some information on using XEmacs under the X
971 File: xemacs.info, Node: Point, Next: Echo Area, Prev: Frame, Up: Frame
976 When XEmacs is running, the cursor shows the location at which
977 editing commands will take effect. This location is called "point".
978 You can use keystrokes or the mouse cursor to move point through the
979 text and edit the text at different places.
981 While the cursor appears to point AT a character, you should think
982 of point as BETWEEN two characters: it points BEFORE the character on
983 which the cursor appears. The exception is at the end of the line,
984 where the cursor appears after the last character of the line. Where
985 the display is capable, the cursor at the end of the line will appear
986 differently from a cursor over whitespace at the end of the line. (In
987 an X Windows frame, the end-of-line cursor is half the width of a
988 within-line cursor.) Sometimes people speak of "the cursor" when they
989 mean "point," or speak of commands that move point as "cursor motion"
992 Each XEmacs frame has only one cursor. When output is in progress,
993 the cursor must appear where the typing is being done. This does not
994 mean that point is moving. It is only that XEmacs has no way to show
995 you the location of point except when the terminal is idle.
997 If you are editing several files in XEmacs, each file has its own
998 point location. A file that is not being displayed remembers where
999 point is. Point becomes visible at the correct location when you look
1002 When there are multiple text windows, each window has its own point
1003 location. The cursor shows the location of point in the selected
1004 window. The visible cursor also shows you which window is selected. If
1005 the same buffer appears in more than one window, point can be moved in
1006 each window independently.
1008 The term `point' comes from the character `.', which was the command
1009 in TECO (the language in which the original Emacs was written) for
1010 accessing the value now called `point'.
1013 File: xemacs.info, Node: Echo Area, Next: Mode Line, Prev: Point, Up: Frame
1018 The line at the bottom of the frame (below the mode line) is the
1019 "echo area". XEmacs uses this area to communicate with the user:
1021 * "Echoing" means printing out the characters that the user types.
1022 XEmacs never echoes single-character commands. Multi-character
1023 commands are echoed only if you pause while typing them: As soon
1024 as you pause for more than one second in the middle of a command,
1025 all the characters of the command so far are echoed. This is
1026 intended to "prompt" you for the rest of the command. Once
1027 echoing has started, the rest of the command is echoed immediately
1028 as you type it. This behavior is designed to give confident users
1029 fast response, while giving hesitant users maximum feedback. You
1030 can change this behavior by setting a variable (*note Display
1033 * If you issue a command that cannot be executed, XEmacs may print
1034 an "error message" in the echo area. Error messages are
1035 accompanied by a beep or by flashing the frame. Any input you
1036 have typed ahead is thrown away when an error happens.
1038 * Some commands print informative messages in the echo area. These
1039 messages look similar to error messages, but are not announced
1040 with a beep and do not throw away input. Sometimes a message
1041 tells you what the command has done, when this is not obvious from
1042 looking at the text being edited. Sometimes the sole purpose of a
1043 command is to print a message giving you specific information.
1044 For example, the command `C-x =' is used to print a message
1045 describing the character position of point in the text and its
1046 current column in the window. Commands that take a long time
1047 often display messages ending in `...' while they are working, and
1048 add `done' at the end when they are finished.
1050 * The echo area is also used to display the "minibuffer", a window
1051 that is used for reading arguments to commands, such as the name
1052 of a file to be edited. When the minibuffer is in use, the echo
1053 area displays with a prompt string that usually ends with a colon.
1054 The cursor appears after the prompt. You can always get out of
1055 the minibuffer by typing `C-g'. *Note Minibuffer::.