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