1 This is ../info/xemacs.info, produced by makeinfo version 4.0b 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.
74 * Packages:: How XEmacs organizes its high-level functionality.
76 Fundamental Editing Commands
77 * Basic:: The most basic editing commands.
78 * Undo:: Undoing recently made changes in the text.
79 * Minibuffer:: Entering arguments that are prompted for.
80 * M-x:: Invoking commands by their names.
81 * Help:: Commands for asking XEmacs about its commands.
83 Important Text-Changing Commands
84 * Mark:: The mark: how to delimit a ``region'' of text.
86 Selecting text with the mouse.
87 * Additional Mouse Operations::
88 Other operations available from the mouse.
89 * Killing:: Killing text.
90 * Yanking:: Recovering killed text. Moving text.
91 * Using X Selections::
92 Using primary selection, cut buffers, and highlighted regions.
94 Other ways of copying text.
95 * Rectangles:: Operating on the text inside a rectangle on the screen.
96 * Registers:: Saving a text string or a location in the buffer.
97 * Display:: Controlling what text is displayed.
98 * Search:: Finding or replacing occurrences of a string.
99 * Fixit:: Commands especially useful for fixing typos.
102 * Files:: All about handling files.
103 * Buffers:: Multiple buffers; editing several files at once.
104 * Windows:: Viewing two pieces of text at once.
105 * Mule:: Using world scripts.
108 * Major Modes:: Text mode vs. Lisp mode vs. C mode ...
109 * Indentation:: Editing the white space at the beginnings of lines.
110 * Text:: Commands and modes for editing English.
111 * Programs:: Commands and modes for editing programs.
112 * Running:: Compiling, running and debugging programs.
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
180 * Packages:: Introduction to XEmacs Packages.
181 * Package Terminology:: Understanding different kinds of packages.
182 * Using Packages:: How to install and use packages.
183 * Building Packages:: Building packages from sources.
185 Basic Editing Commands
187 * Blank Lines:: Commands to make or delete blank lines.
188 * Continuation Lines:: Lines too wide for the frame.
189 * Position Info:: What page, line, row, or column is point on?
190 * Arguments:: Numeric arguments for repeating a command.
194 * File: Minibuffer File. Entering file names with the minibuffer.
195 * Edit: Minibuffer Edit. How to edit in the minibuffer.
196 * Completion:: An abbreviation facility for minibuffer input.
197 * Repetition:: Re-executing commands that used the minibuffer.
199 The Mark and the Region
201 * Setting Mark:: Commands to set the mark.
202 * Using Region:: Summary of ways to operate on contents of the region.
203 * Marking Objects:: Commands to put region around textual units.
204 * Mark Ring:: Previous mark positions saved so you can go back there.
208 * Kill Ring:: Where killed text is stored. Basic yanking.
209 * Appending Kills:: Several kills in a row all yank together.
210 * Earlier Kills:: Yanking something killed some time ago.
214 * X Clipboard Selection:: Pasting to the X clipboard.
215 * X Selection Commands:: Other operations on the selection.
216 * X Cut Buffers:: X cut buffers are available for compatibility.
217 * Active Regions:: Using zmacs-style highlighting of the
222 * Position: RegPos. Saving positions in registers.
223 * Text: RegText. Saving text in registers.
224 * Rectangle: RegRect. Saving rectangles in registers.
225 * Configurations: RegConfig. Saving window configurations in registers.
226 * Files: RegFiles. File names in registers.
227 * Numbers: RegNumbers. Numbers in registers.
228 * Bookmarks:: Bookmarks are like registers, but persistent.
230 Controlling the Display
232 * Scrolling:: Moving text up and down in a window.
233 * Horizontal Scrolling:: Moving text left and right in a window.
234 * Selective Display:: Hiding lines with lots of indentation.
235 * Display Vars:: Information on variables for customizing display.
237 Searching and Replacement
239 * Incremental Search:: Search happens as you type the string.
240 * Non-Incremental Search:: Specify entire string and then search.
241 * Word Search:: Search for sequence of words.
242 * Regexp Search:: Search for match for a regexp.
243 * Regexps:: Syntax of regular expressions.
244 * Search Case:: To ignore case while searching, or not.
245 * Replace:: Search, and replace some or all matches.
246 * Other Repeating Search:: Operating on all matches for some regexp.
250 * Unconditional Replace:: Replacing all matches for a string.
251 * Regexp Replace:: Replacing all matches for a regexp.
252 * Replacement and Case:: How replacements preserve case of letters.
253 * Query Replace:: How to use querying.
255 Commands for Fixing Typos
257 * Kill Errors:: Commands to kill a batch of recently entered text.
258 * Transpose:: Exchanging two characters, words, lines, lists...
259 * Fixing Case:: Correcting case of last word entered.
260 * Spelling:: Apply spelling checker to a word, or a whole file.
264 * File Names:: How to type and edit file name arguments.
265 * Visiting:: Visiting a file prepares XEmacs to edit the file.
266 * Saving:: Saving makes your changes permanent.
267 * Reverting:: Reverting cancels all the changes not saved.
268 * Auto Save:: Auto Save periodically protects against loss of data.
269 * Version Control:: Version control systems (RCS and SCCS).
270 * ListDir:: Listing the contents of a file directory.
271 * Comparing Files:: Finding where two files differ.
272 * Dired:: ``Editing'' a directory to delete, rename, etc.
274 * Misc File Ops:: Other things you can do on files.
278 * Backup:: How XEmacs saves the old version of your file.
279 * Interlocking:: How XEmacs protects against simultaneous editing
280 of one file by two users.
284 * Names: Backup Names. How backup files are named;
285 Choosing single or numbered backup files.
286 * Deletion: Backup Deletion. XEmacs deletes excess numbered backups.
287 * Copying: Backup Copying. Backups can be made by copying or renaming.
289 Auto-Saving: Protection Against Disasters
291 * Files: Auto Save Files.
292 * Control: Auto Save Control.
293 * Recover:: Recovering text from auto-save files.
297 * Concepts of VC:: Basic version control information;
298 checking files in and out.
299 * Editing with VC:: Commands for editing a file maintained
300 with version control.
301 * Variables for Check-in/out:: Variables that affect the commands used
302 to check files in or out.
303 * Log Entries:: Logging your changes.
304 * Change Logs and VC:: Generating a change log file from log
306 * Old Versions:: Examining and comparing old versions.
307 * VC Status:: Commands to view the VC status of files and
309 * Renaming and VC:: A command to rename both the source and
310 master file correctly.
311 * Snapshots:: How to make and use snapshots, a set of
312 file versions that can be treated as a unit.
313 * Version Headers:: Inserting version control headers into
318 * Making Snapshots:: The snapshot facilities.
319 * Snapshot Caveats:: Things to be careful of when using snapshots.
321 Dired, the Directory Editor
323 * Enter: Dired Enter. How to invoke Dired.
324 * Edit: Dired Edit. Editing the Dired buffer.
325 * Deletion: Dired Deletion. Deleting files with Dired.
326 * Immed: Dired Immed. Other file operations through Dired.
328 Using Multiple Buffers
330 * Select Buffer:: Creating a new buffer or reselecting an old one.
331 * List Buffers:: Getting a list of buffers that exist.
332 * Misc Buffer:: Renaming; changing read-onliness; copying text.
333 * Kill Buffer:: Killing buffers you no longer need.
334 * Several Buffers:: How to go through the list of all buffers
335 and operate variously on several of them.
339 * Basic Window:: Introduction to XEmacs windows.
340 * Split Window:: New windows are made by splitting existing windows.
341 * Other Window:: Moving to another window or doing something to it.
342 * Pop Up Window:: Finding a file or buffer in another window.
343 * Change Window:: Deleting windows and changing their sizes.
347 * Choosing Modes:: How major modes are specified or chosen.
351 * Indentation Commands:: Various commands and techniques for indentation.
352 * Tab Stops:: You can set arbitrary "tab stops" and then
353 indent to the next tab stop when you want to.
354 * Just Spaces:: You can request indentation using just spaces.
356 Commands for Human Languages
358 * Text Mode:: The major modes for editing text files.
359 * Nroff Mode:: The major mode for editing input to the formatter nroff.
360 * TeX Mode:: The major modes for editing input to the formatter TeX.
361 * Outline Mode:: The major mode for editing outlines.
362 * Words:: Moving over and killing words.
363 * Sentences:: Moving over and killing sentences.
364 * Paragraphs:: Moving over paragraphs.
365 * Pages:: Moving over pages.
366 * Filling:: Filling or justifying text
367 * Case:: Changing the case of text
371 * Editing: TeX Editing. Special commands for editing in TeX mode.
372 * Printing: TeX Print. Commands for printing part of a file with TeX.
376 * Format: Outline Format. What the text of an outline looks like.
377 * Motion: Outline Motion. Special commands for moving through outlines.
378 * Visibility: Outline Visibility. Commands to control what is visible.
382 * Auto Fill:: Auto Fill mode breaks long lines automatically.
383 * Fill Commands:: Commands to refill paragraphs and center lines.
384 * Fill Prefix:: Filling when every line is indented or in a comment, etc.
388 * Program Modes:: Major modes for editing programs.
389 * Lists:: Expressions with balanced parentheses.
390 There are editing commands to operate on them.
391 * Defuns:: Each program is made up of separate functions.
392 There are editing commands to operate on them.
393 * Grinding:: Adjusting indentation to show the nesting.
394 * Matching:: Insertion of a close-delimiter flashes matching open.
395 * Comments:: Inserting, filling and aligning comments.
396 * Balanced Editing:: Inserting two matching parentheses at once, etc.
397 * Lisp Completion:: Completion on symbol names in Lisp code.
398 * Documentation:: Getting documentation of functions you plan to call.
399 * Change Log:: Maintaining a change history for your program.
400 * Tags:: Go directly to any function in your program in one
401 command. Tags remembers which file it is in.
402 * Fortran:: Fortran mode and its special features.
403 * Asm Mode:: Asm mode and its special features.
405 Indentation for Programs
408 * Multi-line Indent:: Commands to reindent many lines at once.
409 * Lisp Indent:: Specifying how each Lisp function should be indented.
410 * C Indent:: Choosing an indentation style for C code.
414 * Tag Syntax:: Tag syntax for various types of code and text files.
415 * Create Tags Table:: Creating a tags table with `etags'.
416 * Select Tags Table:: How to visit a tags table.
417 * Find Tag:: Commands to find the definition of a specific tag.
418 * Tags Search:: Using a tags table for searching and replacing.
419 * List Tags:: Listing and finding tags defined in a file.
423 * Motion: Fortran Motion. Moving point by statements or subprograms.
424 * Indent: Fortran Indent. Indentation commands for Fortran.
425 * Comments: Fortran Comments. Inserting and aligning comments.
426 * Columns: Fortran Columns. Measuring columns for valid Fortran.
427 * Abbrev: Fortran Abbrev. Built-in abbrevs for Fortran keywords.
431 * Commands: ForIndent Commands. Commands for indenting Fortran.
432 * Numbers: ForIndent Num. How line numbers auto-indent.
433 * Conv: ForIndent Conv. Conventions you must obey to avoid trouble.
434 * Vars: ForIndent Vars. Variables controlling Fortran indent style.
436 Compiling and Testing Programs
438 * Compilation:: Compiling programs in languages other than Lisp
440 * Modes: Lisp Modes. Various modes for editing Lisp programs, with
441 different facilities for running the Lisp programs.
442 * Libraries: Lisp Libraries. Creating Lisp programs to run in XEmacs.
443 * Eval: Lisp Eval. Executing a single Lisp expression in XEmacs.
444 * Debug: Lisp Debug. Debugging Lisp programs running in XEmacs.
445 * Interaction: Lisp Interaction. Executing Lisp in an XEmacs buffer.
446 * External Lisp:: Communicating through XEmacs with a separate Lisp.
450 * Loading:: Loading libraries of Lisp code into XEmacs for use.
451 * Compiling Libraries:: Compiling a library makes it load and run faster.
452 * Mocklisp:: Converting Mocklisp to Lisp so XEmacs can run it.
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 init file.
496 * Audible Bell:: Changing how XEmacs sounds the bell.
497 * Faces:: Changing the fonts and colors of a region of text.
498 * X Resources:: X resources controlling various aspects of the
503 * Examining:: Examining or setting one variable's value.
504 * Easy Customization:: Convenient and easy customization of variables.
505 * Edit Options:: Examining or editing list of all variables' values.
506 * Locals:: Per-buffer values of variables.
507 * File Variables:: How files can specify variable values.
511 * Basic Kbd Macro:: Defining and running keyboard macros.
512 * Save Kbd Macro:: Giving keyboard macros names; saving them in files.
513 * Kbd Macro Query:: Keyboard macros that do different things each use.
515 Customizing Key Bindings
517 * Keymaps:: Definition of the keymap data structure.
518 Names of XEmacs's standard keymaps.
519 * Rebinding:: How to redefine one key's meaning conveniently.
520 * Disabling:: Disabling a command means confirmation is required
521 before it can be executed. This is done to protect
522 beginners from surprises.
526 * Entry: Syntax Entry. What the syntax table records for each character.
527 * Change: Syntax Change. How to change the information.
531 * Init Syntax:: Syntax of constants in Emacs Lisp.
532 * Init Examples:: How to do some things with an init file.
533 * Terminal Init:: Each terminal type can have an init file.
535 Dealing with XEmacs Trouble
537 * Stuck Recursive:: `[...]' in mode line around the parentheses.
538 * Screen Garbled:: Garbage on the screen.
539 * Text Garbled:: Garbage in the text.
540 * Unasked-for Search:: Spontaneous entry to incremental search.
541 * Emergency Escape:: Emergency escape---
542 What to do if XEmacs stops responding.
543 * Total Frustration:: When you are at your wits' end.
546 File: xemacs.info, Node: License, Next: Distrib, Prev: Top, Up: Top
548 GNU GENERAL PUBLIC LICENSE
549 **************************
551 Version 1, February 1989
553 Copyright (C) 1989 Free Software Foundation, Inc.
554 675 Mass Ave, Cambridge, MA 02139, USA
556 Everyone is permitted to copy and distribute verbatim copies
557 of this license document, but changing it is not allowed.
562 The license agreements of most software companies try to keep users
563 at the mercy of those companies. By contrast, our General Public
564 License is intended to guarantee your freedom to share and change free
565 software--to make sure the software is free for all its users. The
566 General Public License applies to the Free Software Foundation's
567 software and to any other program whose authors commit to using it.
568 You can use it for your programs, too.
570 When we speak of free software, we are referring to freedom, not
571 price. Specifically, the General Public License is designed to make
572 sure that you have the freedom to give away or sell copies of free
573 software, that you receive source code or can get it if you want it,
574 that you can change the software or use pieces of it in new free
575 programs; and that you know you can do these things.
577 To protect your rights, we need to make restrictions that forbid
578 anyone to deny you these rights or to ask you to surrender the rights.
579 These restrictions translate to certain responsibilities for you if you
580 distribute copies of the software, or if you modify it.
582 For example, if you distribute copies of a such a program, whether
583 gratis or for a fee, you must give the recipients all the rights that
584 you have. You must make sure that they, too, receive or can get the
585 source code. And you must tell them their rights.
587 We protect your rights with two steps: (1) copyright the software,
588 and (2) offer you this license which gives you legal permission to copy,
589 distribute and/or modify the software.
591 Also, for each author's protection and ours, we want to make certain
592 that everyone understands that there is no warranty for this free
593 software. If the software is modified by someone else and passed on, we
594 want its recipients to know that what they have is not the original, so
595 that any problems introduced by others will not reflect on the original
596 authors' reputations.
598 The precise terms and conditions for copying, distribution and
602 1. This License Agreement applies to any program or other work which
603 contains a notice placed by the copyright holder saying it may be
604 distributed under the terms of this General Public License. The
605 "Program", below, refers to any such program or work, and a "work
606 based on the Program" means either the Program or any work
607 containing the Program or a portion of it, either verbatim or with
608 modifications. Each licensee is addressed as "you".
610 2. You may copy and distribute verbatim copies of the Program's source
611 code as you receive it, in any medium, provided that you
612 conspicuously and appropriately publish on each copy an
613 appropriate copyright notice and disclaimer of warranty; keep
614 intact all the notices that refer to this General Public License
615 and to the absence of any warranty; and give any other recipients
616 of the Program a copy of this General Public License along with
617 the Program. You may charge a fee for the physical act of
620 3. You may modify your copy or copies of the Program or any portion of
621 it, and copy and distribute such modifications under the terms of
622 Paragraph 1 above, provided that you also do the following:
624 * cause the modified files to carry prominent notices stating
625 that you changed the files and the date of any change; and
627 * cause the whole of any work that you distribute or publish,
628 that in whole or in part contains the Program or any part
629 thereof, either with or without modifications, to be licensed
630 at no charge to all third parties under the terms of this
631 General Public License (except that you may choose to grant
632 warranty protection to some or all third parties, at your
635 * If the modified program normally reads commands interactively
636 when run, you must cause it, when started running for such
637 interactive use in the simplest and most usual way, to print
638 or display an announcement including an appropriate copyright
639 notice and a notice that there is no warranty (or else,
640 saying that you provide a warranty) and that users may
641 redistribute the program under these conditions, and telling
642 the user how to view a copy of this General Public License.
644 * You may charge a fee for the physical act of transferring a
645 copy, and you may at your option offer warranty protection in
648 Mere aggregation of another independent work with the Program (or
649 its derivative) on a volume of a storage or distribution medium
650 does not bring the other work under the scope of these terms.
652 4. You may copy and distribute the Program (or a portion or
653 derivative of it, under Paragraph 2) in object code or executable
654 form under the terms of Paragraphs 1 and 2 above provided that you
655 also do one of the following:
657 * accompany it with the complete corresponding machine-readable
658 source code, which must be distributed under the terms of
659 Paragraphs 1 and 2 above; or,
661 * accompany it with a written offer, valid for at least three
662 years, to give any third party free (except for a nominal
663 charge for the cost of distribution) a complete
664 machine-readable copy of the corresponding source code, to be
665 distributed under the terms of Paragraphs 1 and 2 above; or,
667 * accompany it with the information you received as to where the
668 corresponding source code may be obtained. (This alternative
669 is allowed only for noncommercial distribution and only if you
670 received the program in object code or executable form alone.)
672 Source code for a work means the preferred form of the work for
673 making modifications to it. For an executable file, complete
674 source code means all the source code for all modules it contains;
675 but, as a special exception, it need not include source code for
676 modules which are standard libraries that accompany the operating
677 system on which the executable file runs, or for standard header
678 files or definitions files that accompany that operating system.
680 5. You may not copy, modify, sublicense, distribute or transfer the
681 Program except as expressly provided under this General Public
682 License. Any attempt otherwise to copy, modify, sublicense,
683 distribute or transfer the Program is void, and will automatically
684 terminate your rights to use the Program under this License.
685 However, parties who have received copies, or rights to use
686 copies, from you under this General Public License will not have
687 their licenses terminated so long as such parties remain in full
690 6. By copying, distributing or modifying the Program (or any work
691 based on the Program) you indicate your acceptance of this license
692 to do so, and all its terms and conditions.
694 7. Each time you redistribute the Program (or any work based on the
695 Program), the recipient automatically receives a license from the
696 original licensor to copy, distribute or modify the Program
697 subject to these terms and conditions. You may not impose any
698 further restrictions on the recipients' exercise of the rights
701 8. The Free Software Foundation may publish revised and/or new
702 versions of the General Public License from time to time. Such
703 new versions will be similar in spirit to the present version, but
704 may differ in detail to address new problems or concerns.
706 Each version is given a distinguishing version number. If the
707 Program specifies a version number of the license which applies to
708 it and "any later version", you have the option of following the
709 terms and conditions either of that version or of any later
710 version published by the Free Software Foundation. If the Program
711 does not specify a version number of the license, you may choose
712 any version ever published by the Free Software Foundation.
714 9. If you wish to incorporate parts of the Program into other free
715 programs whose distribution conditions are different, write to the
716 author to ask for permission. For software which is copyrighted
717 by the Free Software Foundation, write to the Free Software
718 Foundation; we sometimes make exceptions for this. Our decision
719 will be guided by the two goals of preserving the free status of
720 all derivatives of our free software and of promoting the sharing
721 and reuse of software generally.
725 10. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
726 WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
727 LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
728 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
729 WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT
730 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
731 FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE
732 QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
733 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
734 SERVICING, REPAIR OR CORRECTION.
736 11. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
737 WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
738 MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE
739 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
740 INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
741 INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
742 DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU
743 OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY
744 OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
745 ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
747 END OF TERMS AND CONDITIONS
749 Appendix: How to Apply These Terms to Your New Programs
750 =======================================================
752 If you develop a new program, and you want it to be of the greatest
753 possible use to humanity, the best way to achieve this is to make it
754 free software which everyone can redistribute and change under these
757 To do so, attach the following notices to the program. It is safest
758 to attach them to the start of each source file to most effectively
759 convey the exclusion of warranty; and each file should have at least the
760 "copyright" line and a pointer to where the full notice is found.
762 ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES.
763 Copyright (C) 19YY NAME OF AUTHOR
765 This program is free software; you can redistribute it and/or modify
766 it under the terms of the GNU General Public License as published by
767 the Free Software Foundation; either version 1, or (at your option)
770 This program is distributed in the hope that it will be useful,
771 but WITHOUT ANY WARRANTY; without even the implied warranty of
772 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
773 GNU General Public License for more details.
775 You should have received a copy of the GNU General Public License
776 along with this program; if not, write to the Free Software
777 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
779 Also add information on how to contact you by electronic and paper
782 If the program is interactive, make it output a short notice like
783 this when it starts in an interactive mode:
785 Gnomovision version 69, Copyright (C) 19YY NAME OF AUTHOR
786 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
787 This is free software, and you are welcome to redistribute it
788 under certain conditions; type `show c' for details.
790 The hypothetical commands `show w' and `show c' should show the
791 appropriate parts of the General Public License. Of course, the
792 commands you use may be called something other than `show w' and `show
793 c'; they could even be mouse-clicks or menu items--whatever suits your
796 You should also get your employer (if you work as a programmer) or
797 your school, if any, to sign a "copyright disclaimer" for the program,
798 if necessary. Here a sample; alter the names:
800 Yoyodyne, Inc., hereby disclaims all copyright interest in the
801 program `Gnomovision' (a program to direct compilers to make passes
802 at assemblers) written by James Hacker.
804 SIGNATURE OF TY COON, 1 April 1989
805 Ty Coon, President of Vice
807 That's all there is to it!
810 File: xemacs.info, Node: Distrib, Next: Intro, Prev: License, Up: Top
815 XEmacs is "free"; this means that everyone is free to use it and
816 free to redistribute it on a free basis. XEmacs is not in the public
817 domain; it is copyrighted and there are restrictions on its
818 distribution, but these restrictions are designed to permit everything
819 that a good cooperating citizen would want to do. What is not allowed
820 is to try to prevent others from further sharing any version of XEmacs
821 that they might get from you. The precise conditions are found in the
822 GNU General Public License that comes with XEmacs and also appears
823 following this section.
825 The easiest way to get a copy of XEmacs is from someone else who has
826 it. You need not ask for permission to do so, or tell any one else;
829 If you have access to the Internet, you can get the latest version of
830 XEmacs from the anonymous FTP server `ftp.xemacs.org' in the directory
831 `/pub/xemacs'. It can also be found at numerous other archive sites
832 around the world; check the file `etc/DISTRIB' in an XEmacs
833 distribution for the latest known list.
835 Getting Other Versions of Emacs
836 ===============================
838 The Free Software Foundation's version of Emacs (called "FSF Emacs"
839 in this manual and often referred to as "GNU Emacs") is available by
840 anonymous FTP from `prep.ai.mit.edu'.
842 Win-Emacs, an older version of XEmacs that runs on Microsoft Windows
843 and Windows NT, is available by anonymous FTP from `ftp.netcom.com' in
844 the directory `/pub/pe/pearl', or from `ftp.cica.indiana.edu' as the
845 files `wemdemo*.zip' in the directory `/pub/pc/win3/demo'.
848 File: xemacs.info, Node: Intro, Next: Glossary, Prev: Distrib, Up: Top
853 You are reading about XEmacs, an incarnation of the advanced,
854 self-documenting, customizable, extensible real-time display editor
855 Emacs. XEmacs provides many powerful display and user-interface
856 capabilities not found in other Emacsen and is mostly upwardly
857 compatible with GNU Emacs from the Free Software Foundation (referred
858 to as "FSF Emacs" in this manual). XEmacs also comes standard with a
859 great number of useful packages.
861 We say that XEmacs is a "display" editor because normally the text
862 being edited is visible on the screen and is updated automatically as
863 you type. *Note Display: Frame.
865 We call XEmacs a "real-time" editor because the display is updated
866 very frequently, usually after each character or pair of characters you
867 type. This minimizes the amount of information you must keep in your
868 head as you edit. *Note Real-time: Basic.
870 We call XEmacs advanced because it provides facilities that go beyond
871 simple insertion and deletion: filling of text; automatic indentation of
872 programs; viewing two or more files at once; and dealing in terms of
873 characters, words, lines, sentences, paragraphs, and pages, as well as
874 expressions and comments in several different programming languages.
875 It is much easier to type one command meaning "go to the end of the
876 paragraph" than to find that spot with simple cursor keys.
878 "Self-documenting" means that at any time you can type a special
879 character, `Control-h', to find out what your options are. You can
880 also use `C-h' to find out what a command does, or to find all the
881 commands relevant to a topic. *Note Help::.
883 "Customizable" means you can change the definitions of XEmacs
884 commands. For example, if you use a programming language in which
885 comments start with `<**' and end with `**>', you can tell the XEmacs
886 comment manipulation commands to use those strings (*note Comments::).
887 Another sort of customization is rearrangement of the command set. For
888 example, you can set up the four basic cursor motion commands (up,
889 down, left and right) on keys in a diamond pattern on the keyboard if
890 you prefer. *Note Customization::.
892 "Extensible" means you can go beyond simple customization and write
893 entirely new commands, programs in the Lisp language to be run by
894 XEmacs's own Lisp interpreter. XEmacs is an "on-line extensible"
895 system: it is divided into many functions that call each other. You can
896 redefine any function in the middle of an editing session and replace
897 any part of XEmacs without making a separate copy of all of XEmacs.
898 Most of the editing commands of XEmacs are written in Lisp; the few
899 exceptions could have been written in Lisp but are written in C for
900 efficiency. Only a programmer can write an extension to XEmacs, but
901 anybody can use it afterward.
904 File: xemacs.info, Node: Frame, Next: Keystrokes, Prev: Concept Index, Up: Top
910 In many environments, such as a tty terminal, an XEmacs frame
911 literally takes up the whole screen. If you are running XEmacs in
912 a multi-window system like the X Window System, the XEmacs frame
913 takes up one X window. *Note XEmacs under X::, for more
917 No matter what environment you are running in, XEmacs allows you
918 to look at several buffers at the same time by having several
919 windows be part of the frame. Often, the whole frame is taken up
920 by just one window, but you can split the frame into two or more
921 subwindows. If you are running XEmacs under the X window system,
922 that means you can have several "XEmacs windows" inside the X
923 window that contains the XEmacs frame. You can even have multiple
924 frames in different X windows, each with their own set of
927 Each XEmacs frame displays a variety of information:
928 * The biggest area usually displays the text you are editing. It may
929 consist of one window or of two or more windows if you need to
930 look at two buffers a the same time.
932 * Below each text window's last line is a "mode line" (*note Mode
933 Line::), which describes what is going on in that window. The
934 mode line is in inverse video if the terminal supports that. If
935 there are several XEmacs windows in one frame, each window has its
938 * At the bottom of each XEmacs frame is the "echo area" or
939 "minibuffer window"(*note Echo Area::). It is used by XEmacs to
940 exchange information with the user. There is only one echo area
943 * If you are running XEmacs under a graphical windowing system, a
944 menu bar at the top of the frame makes shortcuts to several of the
945 commands available (*note Pull-down Menus::).
947 * Under a graphical windowing system, a toolbar at the top of the
948 frame, just under the menu bar if it exists, provides "one-touch"
949 shortcuts to several commands. (Not yet documented.)
951 * Under a graphical windowing system, a gutter at the top (under the
952 toolbar) and/or bottom of the frame provides advanced GUI
953 facilities like tab controls for rapid switching among related
954 windows and progress bars for time-consuming operations like
955 downloads across the Internet. Gutters are an experimental feature
956 introduced in XEmacs version 21.2. (Not yet documented.)
958 You can subdivide the XEmacs frame into multiple text windows, and
959 use each window for a different file (*note Windows::). Multiple XEmacs
960 windows are tiled vertically on the XEmacs frame. The upper XEmacs
961 window is separated from the lower window by its mode line.
963 When there are multiple, tiled XEmacs windows on a single XEmacs
964 frame, the XEmacs window receiving input from the keyboard has the
965 "keyboard focus" and is called the "selected window". The selected
966 window contains the cursor, which indicates the insertion point. If
967 you are working in an environment that permits multiple XEmacs frames,
968 and you move the focus from one XEmacs frame into another, the selected
969 window is the one that was last selected in that frame.
971 The same text can be displayed simultaneously in several XEmacs
972 windows, which can be in different XEmacs frames. If you alter the text
973 in an XEmacs buffer by editing it in one XEmacs window, the changes are
974 visible in all XEmacs windows containing that buffer.
978 * Point:: The place in the text where editing commands operate.
979 * Echo Area:: Short messages appear at the bottom of the frame.
980 * Mode Line:: Interpreting the mode line.
981 * GUI Components:: Menubar, toolbars, gutters.
982 * XEmacs under X:: Some information on using XEmacs under the X
984 * XEmacs under MS Windows:: Some information on using XEmacs under
988 File: xemacs.info, Node: Point, Next: Echo Area, Prev: Frame, Up: Frame
993 When XEmacs is running, the cursor shows the location at which
994 editing commands will take effect. This location is called "point".
995 You can use keystrokes or the mouse cursor to move point through the
996 text and edit the text at different places.
998 While the cursor appears to point AT a character, you should think
999 of point as BETWEEN two characters: it points BEFORE the character on
1000 which the cursor appears. The exception is at the end of the line,
1001 where the cursor appears after the last character of the line. Where
1002 the display is capable, the cursor at the end of the line will appear
1003 differently from a cursor over whitespace at the end of the line. (In
1004 an X Windows frame, the end-of-line cursor is half the width of a
1005 within-line cursor.) Sometimes people speak of "the cursor" when they
1006 mean "point," or speak of commands that move point as "cursor motion"
1009 Each XEmacs frame has only one cursor. When output is in progress,
1010 the cursor must appear where the typing is being done. This does not
1011 mean that point is moving. It is only that XEmacs has no way to show
1012 you the location of point except when the terminal is idle.
1014 If you are editing several files in XEmacs, each file has its own
1015 point location. A file that is not being displayed remembers where
1016 point is. Point becomes visible at the correct location when you look
1019 When there are multiple text windows, each window has its own point
1020 location. The cursor shows the location of point in the selected
1021 window. The visible cursor also shows you which window is selected. If
1022 the same buffer appears in more than one window, point can be moved in
1023 each window independently.
1025 The term `point' comes from the character `.', which was the command
1026 in TECO (the language in which the original Emacs was written) for
1027 accessing the value now called `point'.
1030 File: xemacs.info, Node: Echo Area, Next: Mode Line, Prev: Point, Up: Frame
1035 The line at the bottom of the frame (below the mode line) is the
1036 "echo area". XEmacs uses this area to communicate with the user:
1038 * "Echoing" means printing out the characters that the user types.
1039 XEmacs never echoes single-character commands. Multi-character
1040 commands are echoed only if you pause while typing them: As soon
1041 as you pause for more than one second in the middle of a command,
1042 all the characters of the command so far are echoed. This is
1043 intended to "prompt" you for the rest of the command. Once
1044 echoing has started, the rest of the command is echoed immediately
1045 as you type it. This behavior is designed to give confident users
1046 fast response, while giving hesitant users maximum feedback. You
1047 can change this behavior by setting a variable (*note Display
1050 * If you issue a command that cannot be executed, XEmacs may print
1051 an "error message" in the echo area. Error messages are
1052 accompanied by a beep or by flashing the frame. Any input you
1053 have typed ahead is thrown away when an error happens.
1055 * Some commands print informative messages in the echo area. These
1056 messages look similar to error messages, but are not announced
1057 with a beep and do not throw away input. Sometimes a message
1058 tells you what the command has done, when this is not obvious from
1059 looking at the text being edited. Sometimes the sole purpose of a
1060 command is to print a message giving you specific information.
1061 For example, the command `C-x =' is used to print a message
1062 describing the character position of point in the text and its
1063 current column in the window. Commands that take a long time
1064 often display messages ending in `...' while they are working, and
1065 add `done' at the end when they are finished.
1067 * The echo area is also used to display the "minibuffer", a window
1068 that is used for reading arguments to commands, such as the name
1069 of a file to be edited. When the minibuffer is in use, the echo
1070 area displays with a prompt string that usually ends with a colon.
1071 The cursor appears after the prompt. You can always get out of
1072 the minibuffer by typing `C-g'. *Note Minibuffer::.
projects / chise / xemacs-chise.git / blob