1 \input texinfo @c -*-texinfo-*-
2 @setfilename sxemacs.info
3 @comment node-name, next, previous, up
7 @dircategory SXEmacs Editor
9 * SXEmacs: (sxemacs). SXEmacs Editor.
12 This file documents the SXEmacs editor.
14 Copyright (C) 1985, 1986, 1988 Richard M. Stallman.
15 Copyright @copyright{} 1991, 1992, 1993, 1994 Lucid, Inc.
16 Copyright @copyright{} 1993, 1994 Sun Microsystems, Inc.
17 Copyright @copyright{} 1995 Amdahl Corporation.
18 Copyright @copyright{} 2005 - 2008 Steve Youngs.
20 Permission is granted to make and distribute verbatim copies of
21 this manual provided the copyright notice and this permission notice
22 are preserved on all copies.
25 Permission is granted to process this file through Tex and print the
26 results, provided the printed document carries copying permission
27 notice identical to this one except for the removal of this paragraph
28 (this paragraph not being relevant to the printed manual).
30 @end ignore Permission is granted to copy and distribute modified
31 versions of this manual under the conditions for verbatim copying,
32 provided also that the sections entitled ``Distribution'' and ``GNU
33 General Public License'' are included exactly as in the original, and
34 provided that the entire resulting derived work is distributed under
35 the terms of a permission notice identical to this one.
37 Permission is granted to copy and distribute translations of this
38 manual into another language, under the above conditions for modified
39 versions, except that the sections entitled ``Distribution'' and ``GNU
40 General Public License'' may be included in a translation approved by
41 the author instead of in the original English.
44 @setchapternewpage odd
45 @settitle SXEmacs User's Manual
49 @center @titlefont{SXEmacs User's Manual}
54 @center (General Public License upgraded, January 1991)
56 @center Richard Stallman
64 @vskip 0pt plus 1filll
65 Copyright @copyright{} 1985, 1986, 1988 Richard M. Stallman.
67 Copyright @copyright{} 1991, 1992, 1993, 1994 Lucid, Inc.
69 Copyright @copyright{} 1993, 1994 Sun Microsystems, Inc.
71 Copyright @copyright{} 1995 Amdahl Corporation.
73 Permission is granted to make and distribute verbatim copies of
74 this manual provided the copyright notice and this permission notice
75 are preserved on all copies.
77 Permission is granted to copy and distribute modified versions of
78 this manual under the conditions for verbatim copying, provided also
79 that the sections entitled ``Distribution'' and ``GNU General Public
80 License'' are included exactly as in the original, and provided that
81 the entire resulting derived work is distributed under the terms of a
82 permission notice identical to this one.
84 Permission is granted to copy and distribute translations of this
85 manual into another language, under the above conditions for modified
86 versions, except that the sections entitled ``Distribution'' and ``GNU
87 General Public License'' may be included in a translation approved by
88 the author instead of in the original English.
92 @node Top, License,, (dir)
93 @top The SXEmacs Editor
96 SXEmacs is the extensible, customizable, self-documenting real-time
97 display editor. This Info file describes how to edit with Emacs
98 and some of how to customize it, but not how to extend it. It
99 corresponds to: v22.1.14
101 Although, it hasn't had a complete rewrite for quite some time.
103 This manual is intended as a detailed reference to SXEmacs. If
104 you are looking for an introductory manual, see the New User's
109 * License:: The GNU General Public License gives you permission
110 to redistribute SXEmacs on certain terms; and also
111 explains that there is no warranty.
112 * Distrib:: How to get SXEmacs.
113 * Intro:: An introduction to SXEmacs concepts.
114 * Glossary:: The glossary.
116 Indices, nodes containing large menus
117 * Key Index:: An item for each standard SXEmacs key sequence.
118 * Command Index:: An item for each command name.
119 * Variable Index:: An item for each documented variable.
120 * Concept Index:: An item for each concept.
122 Important General Concepts
123 * Frame:: How to interpret what you see on the screen.
124 * Keystrokes:: Keyboard gestures SXEmacs recognizes.
126 The SXEmacs Pull-down Menus available under X.
128 Starting Emacs from the shell.
129 * Exiting:: Stopping or killing SXEmacs.
131 Hairy startup options.
133 How SXEmacs finds Directories and Files.
134 * Packages:: How SXEmacs organizes its high-level functionality.
136 Fundamental Editing Commands
137 * Basic:: The most basic editing commands.
138 * Undo:: Undoing recently made changes in the text.
139 * Minibuffer:: Entering arguments that are prompted for.
140 * M-x:: Invoking commands by their names.
141 * Help:: Commands for asking SXEmacs about its commands.
143 Important Text-Changing Commands
144 * Mark:: The mark: how to delimit a ``region'' of text.
146 Selecting text with the mouse.
147 * Additional Mouse Operations::
148 Other operations available from the mouse.
149 * Killing:: Killing text.
150 * Yanking:: Recovering killed text. Moving text.
151 * Using X Selections::
152 Using primary selection, cut buffers, and highlighted regions.
153 * Accumulating Text::
154 Other ways of copying text.
155 * Rectangles:: Operating on the text inside a rectangle on the screen.
156 * Registers:: Saving a text string or a location in the buffer.
157 * Display:: Controlling what text is displayed.
158 * Search:: Finding or replacing occurrences of a string.
159 * Fixit:: Commands especially useful for fixing typos.
162 * Files:: All about handling files.
163 * Buffers:: Multiple buffers; editing several files at once.
164 * Windows:: Viewing two pieces of text at once.
165 * Mule:: Using world scripts.
168 * Major Modes:: Text mode vs. Lisp mode vs. C mode ...
169 * Indentation:: Editing the white space at the beginnings of lines.
170 * Text:: Commands and modes for editing English.
171 * Programs:: Commands and modes for editing programs.
172 * Running:: Compiling, running and debugging programs.
173 * Abbrevs:: How to define text abbreviations to reduce
174 the number of characters you must type.
175 * Picture:: Editing pictures made up of characters
176 using the quarter-plane screen model.
177 * Sending Mail:: Sending mail in SXEmacs.
178 * Reading Mail:: Reading mail in SXEmacs.
179 * Calendar/Diary:: A Calendar and diary facility in SXEmacs.
180 * Sorting:: Sorting lines, paragraphs or pages within SXEmacs.
181 * Shell:: Executing shell commands from SXEmacs.
182 * Narrowing:: Restricting display and editing to a portion
184 * Hardcopy:: Printing buffers or regions.
186 A command can allow you to do editing
187 "within the command". This is called a
188 `recursive editing level'.
189 * Dissociated Press:: Dissociating text for fun.
190 * CONX:: A different kind of dissociation.
191 * Amusements:: Various games and hacks.
192 * Emulation:: Emulating some other editors with SXEmacs.
193 * Customization:: Modifying the behavior of SXEmacs.
195 Recovery from Problems.
196 * Quitting:: Quitting and aborting.
197 * Lossage:: What to do if SXEmacs is hung or malfunctioning.
198 * Bugs:: How and when to report a bug.
200 Here are some other nodes which are really inferiors of the ones
201 already listed, mentioned here so you can get to them in one step:
203 --- The Detailed Node Listing ---
205 The Organization of the Frame
207 * Point:: The place in the text where editing commands operate.
208 * Echo Area:: Short messages appear at the bottom of the frame.
209 * Mode Line:: Interpreting the mode line.
210 * SXEmacs under X:: Some information on using SXEmacs under the X
215 * Intro to Keystrokes:: Keystrokes as building blocks of key sequences.
216 * Representing Keystrokes:: Using lists of modifiers and keysyms to
217 represent keystrokes.
218 * Key Sequences:: Combine key strokes into key sequences you can
220 * String Key Sequences:: Available for upward compatibility.
221 * Meta Key:: Using @key{ESC} to represent @key{Meta}
222 * Super and Hyper Keys:: Adding modifier keys on certain keyboards.
223 * Character Representation:: How characters appear in SXEmacs buffers.
224 * Commands:: How commands are bound to key sequences.
228 * File Menu:: Items on the File menu.
229 * Edit Menu:: Items on the Edit menu.
230 * Apps Menu:: Items on the Apps menu.
231 * Options Menu:: Items on the Options menu.
232 * Buffers Menu:: Information about the Buffers menu.
233 * Tools Menu:: Items on the Tools menu.
234 * Help Menu:: Items on the Help menu.
235 * Menu Customization:: Adding and removing menu items and related
240 * Packages:: Introduction to SXEmacs Packages.
241 * Package Terminology:: Understanding different kinds of packages.
242 * Installing Packages:: How to install packages.
243 * Building Packages:: Building packages from sources.
244 * Local.rules File:: An important part of building packages.
245 * Available Packages:: A brief directory of packaged LISP.
247 Basic Editing Commands
249 * Blank Lines:: Commands to make or delete blank lines.
250 * Continuation Lines:: Lines too wide for the frame.
251 * Position Info:: What page, line, row, or column is point on?
252 * Arguments:: Numeric arguments for repeating a command.
256 * File: Minibuffer File. Entering file names with the minibuffer.
257 * Edit: Minibuffer Edit. How to edit in the minibuffer.
258 * Completion:: An abbreviation facility for minibuffer input.
259 * Repetition:: Re-executing commands that used the minibuffer.
261 The Mark and the Region
263 * Setting Mark:: Commands to set the mark.
264 * Using Region:: Summary of ways to operate on contents of the region.
265 * Marking Objects:: Commands to put region around textual units.
266 * Mark Ring:: Previous mark positions saved so you can go back there.
270 * Kill Ring:: Where killed text is stored. Basic yanking.
271 * Appending Kills:: Several kills in a row all yank together.
272 * Earlier Kills:: Yanking something killed some time ago.
276 * X Clipboard Selection:: Pasting to the X clipboard.
277 * X Selection Commands:: Other operations on the selection.
278 * X Cut Buffers:: X cut buffers are available for compatibility.
279 * Active Regions:: Using zmacs-style highlighting of the
284 * Position: RegPos. Saving positions in registers.
285 * Text: RegText. Saving text in registers.
286 * Rectangle: RegRect. Saving rectangles in registers.
287 * Configurations: RegConfig. Saving window configurations in registers.
288 * Files: RegFiles. File names in registers.
289 * Numbers: RegNumbers. Numbers in registers.
290 * Bookmarks:: Bookmarks are like registers, but persistent.
292 Controlling the Display
294 * Scrolling:: Moving text up and down in a window.
295 * Horizontal Scrolling:: Moving text left and right in a window.
296 * Selective Display:: Hiding lines with lots of indentation.
297 * Display Vars:: Information on variables for customizing display.
299 Searching and Replacement
301 * Incremental Search:: Search happens as you type the string.
302 * Non-Incremental Search:: Specify entire string and then search.
303 * Word Search:: Search for sequence of words.
304 * Regexp Search:: Search for match for a regexp.
305 * Regexps:: Syntax of regular expressions.
306 * Search Case:: To ignore case while searching, or not.
307 * Replace:: Search, and replace some or all matches.
308 * Other Repeating Search:: Operating on all matches for some regexp.
312 * Unconditional Replace:: Replacing all matches for a string.
313 * Regexp Replace:: Replacing all matches for a regexp.
314 * Replacement and Case:: How replacements preserve case of letters.
315 * Query Replace:: How to use querying.
317 Commands for Fixing Typos
319 * Kill Errors:: Commands to kill a batch of recently entered text.
320 * Transpose:: Exchanging two characters, words, lines, lists...
321 * Fixing Case:: Correcting case of last word entered.
322 * Spelling:: Apply spelling checker to a word, or a whole file.
326 * File Names:: How to type and edit file name arguments.
327 * Visiting:: Visiting a file prepares SXEmacs to edit the file.
328 * Saving:: Saving makes your changes permanent.
329 * Reverting:: Reverting cancels all the changes not saved.
330 * Auto Save:: Auto Save periodically protects against loss of data.
331 * Version Control:: Version control systems (RCS and SCCS).
332 * ListDir:: Listing the contents of a file directory.
333 * Comparing Files:: Finding where two files differ.
334 * Dired:: ``Editing'' a directory to delete, rename, etc.
336 * Misc File Ops:: Other things you can do on files.
340 * Backup:: How SXEmacs saves the old version of your file.
341 * Interlocking:: How SXEmacs protects against simultaneous editing
342 of one file by two users.
346 * Names: Backup Names. How backup files are named;
347 Choosing single or numbered backup files.
348 * Deletion: Backup Deletion. SXEmacs deletes excess numbered backups.
349 * Copying: Backup Copying. Backups can be made by copying or renaming.
351 Auto-Saving: Protection Against Disasters
353 * Files: Auto Save Files.
354 * Control: Auto Save Control.
355 * Recover:: Recovering text from auto-save files.
359 * Concepts of VC:: Basic version control information;
360 checking files in and out.
361 * Editing with VC:: Commands for editing a file maintained
362 with version control.
363 * Variables for Check-in/out:: Variables that affect the commands used
364 to check files in or out.
365 * Log Entries:: Logging your changes.
366 * Change Logs and VC:: Generating a change log file from log
368 * Old Versions:: Examining and comparing old versions.
369 * VC Status:: Commands to view the VC status of files and
371 * Renaming and VC:: A command to rename both the source and
372 master file correctly.
373 * Snapshots:: How to make and use snapshots, a set of
374 file versions that can be treated as a unit.
375 * Version Headers:: Inserting version control headers into
380 * Making Snapshots:: The snapshot facilities.
381 * Snapshot Caveats:: Things to be careful of when using snapshots.
383 Dired, the Directory Editor
385 * Enter: Dired Enter. How to invoke Dired.
386 * Edit: Dired Edit. Editing the Dired buffer.
387 * Deletion: Dired Deletion. Deleting files with Dired.
388 * Immed: Dired Immed. Other file operations through Dired.
390 Using Multiple Buffers
392 * Select Buffer:: Creating a new buffer or reselecting an old one.
393 * List Buffers:: Getting a list of buffers that exist.
394 * Misc Buffer:: Renaming; changing read-onliness; copying text.
395 * Kill Buffer:: Killing buffers you no longer need.
396 * Several Buffers:: How to go through the list of all buffers
397 and operate variously on several of them.
401 * Basic Window:: Introduction to SXEmacs windows.
402 * Split Window:: New windows are made by splitting existing windows.
403 * Other Window:: Moving to another window or doing something to it.
404 * Pop Up Window:: Finding a file or buffer in another window.
405 * Change Window:: Deleting windows and changing their sizes.
409 * Choosing Modes:: How major modes are specified or chosen.
413 * Indentation Commands:: Various commands and techniques for indentation.
414 * Tab Stops:: You can set arbitrary "tab stops" and then
415 indent to the next tab stop when you want to.
416 * Just Spaces:: You can request indentation using just spaces.
418 Commands for Human Languages
420 * Text Mode:: The major modes for editing text files.
421 * Nroff Mode:: The major mode for editing input to the formatter nroff.
422 * TeX Mode:: The major modes for editing input to the formatter TeX.
423 * Outline Mode:: The major mode for editing outlines.
424 * Words:: Moving over and killing words.
425 * Sentences:: Moving over and killing sentences.
426 * Paragraphs:: Moving over paragraphs.
427 * Pages:: Moving over pages.
428 * Filling:: Filling or justifying text
429 * Case:: Changing the case of text
433 * Editing: TeX Editing. Special commands for editing in TeX mode.
434 * Printing: TeX Print. Commands for printing part of a file with TeX.
438 * Format: Outline Format. What the text of an outline looks like.
439 * Motion: Outline Motion. Special commands for moving through outlines.
440 * Visibility: Outline Visibility. Commands to control what is visible.
444 * Auto Fill:: Auto Fill mode breaks long lines automatically.
445 * Fill Commands:: Commands to refill paragraphs and center lines.
446 * Fill Prefix:: Filling when every line is indented or in a comment, etc.
450 * Program Modes:: Major modes for editing programs.
451 * Lists:: Expressions with balanced parentheses.
452 There are editing commands to operate on them.
453 * Defuns:: Each program is made up of separate functions.
454 There are editing commands to operate on them.
455 * Grinding:: Adjusting indentation to show the nesting.
456 * Matching:: Insertion of a close-delimiter flashes matching open.
457 * Comments:: Inserting, filling and aligning comments.
458 * Balanced Editing:: Inserting two matching parentheses at once, etc.
459 * Lisp Completion:: Completion on symbol names in Lisp code.
460 * Documentation:: Getting documentation of functions you plan to call.
461 * Change Log:: Maintaining a change history for your program.
462 * Tags:: Go directly to any function in your program in one
463 command. Tags remembers which file it is in.
464 * CC Mode:: Modes for C, C++, Java and similar languages
465 * Fortran:: Fortran mode and its special features.
466 * Asm Mode:: Asm mode and its special features.
468 Indentation for Programs
471 * Multi-line Indent:: Commands to reindent many lines at once.
472 * Lisp Indent:: Specifying how each Lisp function should be indented.
476 * Tag Syntax:: Tag syntax for various types of code and text files.
477 * Create Tags Table:: Creating a tags table with @code{etags}.
478 * Select Tags Table:: How to visit a tags table.
479 * Find Tag:: Commands to find the definition of a specific tag.
480 * Tags Search:: Using a tags table for searching and replacing.
481 * List Tags:: Listing and finding tags defined in a file.
485 * Motion: Fortran Motion. Moving point by statements or subprograms.
486 * Indent: Fortran Indent. Indentation commands for Fortran.
487 * Comments: Fortran Comments. Inserting and aligning comments.
488 * Columns: Fortran Columns. Measuring columns for valid Fortran.
489 * Abbrev: Fortran Abbrev. Built-in abbrevs for Fortran keywords.
493 * Commands: ForIndent Commands. Commands for indenting Fortran.
494 * Numbers: ForIndent Num. How line numbers auto-indent.
495 * Conv: ForIndent Conv. Conventions you must obey to avoid trouble.
496 * Vars: ForIndent Vars. Variables controlling Fortran indent style.
498 Compiling and Testing Programs
500 * Compilation:: Compiling programs in languages other than Lisp
502 * Modes: Lisp Modes. Various modes for editing Lisp programs, with
503 different facilities for running the Lisp programs.
504 * Libraries: Lisp Libraries. Creating Lisp programs to run in SXEmacs.
505 * Eval: Lisp Eval. Executing a single Lisp expression in SXEmacs.
506 * Debug: Lisp Debug. Debugging Lisp programs running in SXEmacs.
507 * Interaction: Lisp Interaction. Executing Lisp in an SXEmacs buffer.
508 * External Lisp:: Communicating through SXEmacs with a separate Lisp.
512 * Loading:: Loading libraries of Lisp code into SXEmacs for use.
513 * Compiling Libraries:: Compiling a library makes it load and run faster.
514 * Mocklisp:: Converting Mocklisp to Lisp so SXEmacs can run it.
518 * Defining Abbrevs:: Defining an abbrev, so it will expand when typed.
519 * Expanding Abbrevs:: Controlling expansion: prefixes, canceling expansion.
520 * Editing Abbrevs:: Viewing or editing the entire list of defined abbrevs.
521 * Saving Abbrevs:: Saving the entire list of abbrevs for another session.
522 * Dynamic Abbrevs:: Abbreviations for words already in the buffer.
526 * Basic Picture:: Basic concepts and simple commands of Picture Mode.
527 * Insert in Picture:: Controlling direction of cursor motion
528 after "self-inserting" characters.
529 * Tabs in Picture:: Various features for tab stops and indentation.
530 * Rectangles in Picture:: Clearing and superimposing rectangles.
534 * Format: Mail Format. Format of the mail being composed.
535 * Headers: Mail Headers. Details of allowed mail header fields.
536 * Mode: Mail Mode. Special commands for editing mail being composed.
538 Running Shell Commands from SXEmacs
540 * Single Shell:: How to run one shell command and return.
541 * Interactive Shell:: Permanent shell taking input via SXEmacs.
542 * Shell Mode:: Special SXEmacs commands used with permanent shell.
546 * Minor Modes:: Each minor mode is one feature you can turn on
547 independently of any others.
548 * Variables:: Many SXEmacs commands examine SXEmacs variables
549 to decide what to do; by setting variables,
550 you can control their functioning.
551 * Keyboard Macros:: A keyboard macro records a sequence of keystrokes
552 to be replayed with a single command.
553 * Key Bindings:: The keymaps say what command each key runs.
554 By changing them, you can "redefine keys".
555 * Syntax:: The syntax table controls how words and expressions
557 * Init File:: How to write common customizations in the init file.
558 * Audible Bell:: Changing how SXEmacs sounds the bell.
559 * Faces:: Changing the fonts and colors of a region of text.
560 * X Resources:: X resources controlling various aspects of the
565 * Examining:: Examining or setting one variable's value.
566 * Easy Customization:: Convenient and easy customization of variables.
567 * Edit Options:: Examining or editing list of all variables' values.
568 * Locals:: Per-buffer values of variables.
569 * File Variables:: How files can specify variable values.
573 * Basic Kbd Macro:: Defining and running keyboard macros.
574 * Save Kbd Macro:: Giving keyboard macros names; saving them in files.
575 * Kbd Macro Query:: Keyboard macros that do different things each use.
577 Customizing Key Bindings
579 * Keymaps:: Definition of the keymap data structure.
580 Names of SXEmacs's standard keymaps.
581 * Rebinding:: How to redefine one key's meaning conveniently.
582 * Disabling:: Disabling a command means confirmation is required
583 before it can be executed. This is done to protect
584 beginners from surprises.
588 * Entry: Syntax Entry. What the syntax table records for each character.
589 * Change: Syntax Change. How to change the information.
593 * Init Syntax:: Syntax of constants in Emacs Lisp.
594 * Init Examples:: How to do some things with an init file.
595 * Terminal Init:: Each terminal type can have an init file.
597 Dealing with SXEmacs Trouble
599 * Stuck Recursive:: `[...]' in mode line around the parentheses.
600 * Screen Garbled:: Garbage on the screen.
601 * Text Garbled:: Garbage in the text.
602 * Unasked-for Search:: Spontaneous entry to incremental search.
603 * Emergency Escape:: Emergency escape---
604 What to do if SXEmacs stops responding.
605 * Total Frustration:: When you are at your wits' end.
612 This manual documents the use and simple customization of the SXEmacs
613 editor. The reader is not expected to be a programmer to use this
614 editor, and simple customizations do not require programming skills either.
615 Users who are not interested in customizing SXEmacs can ignore the scattered
618 This document is primarily a reference manual, but it can also be used as a
619 primer. However, if you are new to SXEmacs, consider using the on-line,
620 learn-by-doing tutorial, which you get by running SXEmacs and typing
621 @kbd{C-h t}. With it, you learn SXEmacs by using SXEmacs on a specially
622 designed file which describes commands, tells you when to try them,
623 and then explains the results you see. Using the tutorial gives a more vivid
624 introduction than the printed manual. Also consider reading the SXEmacs
625 New User's Guide, which is intended specifically as an introductory
626 manual rather than as a reference guide.
628 On first reading, just skim chapters one and two, which describe the
629 notational conventions of the manual and the general appearance of the
630 SXEmacs display frame. Note which questions are answered in these chapters,
631 so you can refer back later. After reading chapter four you should
632 practice the commands there. The next few chapters describe fundamental
633 techniques and concepts that are used constantly. You need to understand
634 them thoroughly, experimenting with them if necessary.
636 To find the documentation on a particular command, look in the index.
637 Keys (character commands) and command names have separate indexes. There
638 is also a glossary, with a cross reference for each term.
641 If you know vaguely what the command
642 does, look in the command summary. The command summary contains a line or
643 two about each command, and a cross reference to the section of the
644 manual that describes the command in more detail; related commands
645 are grouped together.
648 This manual comes in two forms: the published form and the Info form.
649 The Info form is for on-line perusal with the INFO program; it is
650 distributed along with SXEmacs. Both forms contain substantially the
651 same text and are generated from a common source file, which is also
652 distributed along with SXEmacs.
654 SXEmacs is a member of the Emacs editor family. There are many Emacs
655 editors, all sharing common principles of organization. For information on
656 the underlying philosophy of Emacs and the lessons learned from its
657 development, write for a copy of AI memo 519a, ``Emacs, the Extensible,
658 Customizable Self-Documenting Display Editor'', to Publications Department,
659 Artificial Intelligence Lab, 545 Tech Square, Cambridge, MA 02139, USA. At
660 last report they charge $2.25 per copy. Another useful publication is LCS
661 TM-165, ``A Cookbook for an Emacs'', by Craig Finseth, available from
662 Publications Department, Laboratory for Computer Science, 545 Tech Square,
663 Cambridge, MA 02139, USA. The price today is $3.
665 This manual is for SXEmacs installed on UNIX systems.
668 @comment node-name, next, previous, up
669 @node License, Distrib, Top, Top
671 @node Distrib, Intro, License, Top
672 @unnumbered Distribution
674 SXEmacs is @dfn{free}; this means that everyone is free to use it and
675 free to redistribute it on a free basis. SXEmacs is not in the public
676 domain; it is copyrighted and there are restrictions on its
677 distribution, but these restrictions are designed to permit everything
678 that a good cooperating citizen would want to do. What is not allowed
679 is to try to prevent others from further sharing any version of SXEmacs
680 that they might get from you. The precise conditions are found in
681 the GNU General Public License that comes with SXEmacs and also appears
682 following this section.
684 The easiest way to get a copy of SXEmacs is from someone else who has it.
685 You need not ask for permission to do so, or tell any one else; just copy
688 If you have access to the Internet, you can get the latest version of
689 SXEmacs from the anonymous FTP server @file{ftp.sxemacs.org} in the directory
690 @file{/pub/sxemacs}. It can also be found at numerous other archive
691 sites around the world; check the file @file{etc/DISTRIB} in an SXEmacs
692 distribution for the latest known list.
695 @unnumberedsec Getting Other Versions of Emacs
697 The Free Software Foundation's version of Emacs (called @dfn{FSF Emacs}
698 in this manual and often referred to as @dfn{GNU Emacs}) is available
699 by anonymous FTP from @file{prep.ai.mit.edu}.
701 @node Intro, Glossary, Distrib, Top
702 @unnumbered Introduction
704 You are reading about SXEmacs, an incarnation of the advanced,
705 self-documenting, customizable, extensible real-time display editor
706 Emacs. SXEmacs provides many powerful display and user-interface
707 capabilities not found in other Emacsen and is mostly upwardly
708 compatible with GNU Emacs from the Free Software Foundation
709 (referred to as @dfn{FSF Emacs} in this manual). SXEmacs also
710 comes standard with a great number of useful packages.
712 We say that SXEmacs is a @dfn{display} editor because normally the text
713 being edited is visible on the screen and is updated automatically as you
714 type. @xref{Frame,Display}.
716 We call SXEmacs a @dfn{real-time} editor because the display is updated very
717 frequently, usually after each character or pair of characters you
718 type. This minimizes the amount of information you must keep in your
719 head as you edit. @xref{Basic,Real-time,Basic Editing}.
721 We call SXEmacs advanced because it provides facilities that go beyond
722 simple insertion and deletion: filling of text; automatic indentation of
723 programs; viewing two or more files at once; and dealing in terms of
724 characters, words, lines, sentences, paragraphs, and pages, as well as
725 expressions and comments in several different programming languages. It is
726 much easier to type one command meaning ``go to the end of the paragraph''
727 than to find that spot with simple cursor keys.
729 @dfn{Self-documenting} means that at any time you can type a special
730 character, @kbd{Control-h}, to find out what your options are. You can
731 also use @kbd{C-h} to find out what a command does, or to find all the
732 commands relevant to a topic. @xref{Help}.
734 @dfn{Customizable} means you can change the definitions of SXEmacs
735 commands. For example, if you use a programming language in
736 which comments start with @samp{<**} and end with @samp{**>}, you can tell
737 the SXEmacs comment manipulation commands to use those strings
738 (@pxref{Comments}). Another sort of customization is rearrangement of the
739 command set. For example, you can set up the four basic cursor motion
740 commands (up, down, left and right) on keys in a diamond pattern on the
741 keyboard if you prefer. @xref{Customization}.
743 @dfn{Extensible} means you can go beyond simple customization and
744 write entirely new commands, programs in the Lisp language to be run by
745 SXEmacs' own Lisp interpreter. SXEmacs is an ``on-line extensible''
746 system: it is divided into many functions that call each other. You can
747 redefine any function in the middle of an editing session and replace
748 any part of SXEmacs without making a separate copy of all of SXEmacs. Most
749 of the editing commands of SXEmacs are written in Lisp; the few
750 exceptions could have been written in Lisp but are written in C for
751 efficiency. Only a programmer can write an extension to SXEmacs, but anybody
752 can use it afterward.
755 @include keystrokes.texi
757 @include entering.texi
758 @include cmdargs.texi
759 @include startup.texi
767 @include killing.texi
769 @include display.texi
773 @include buffers.texi
774 @include windows.texi
779 @include programs.texi
780 @include building.texi
781 @include packages.texi
782 @include abbrevs.texi
783 @include picture.texi
784 @include sending.texi
785 @include reading.texi
786 @include calendar.texi
789 @include trouble.texi
792 @include glossary.texi
794 @node Key Index, Command Index,, Top
795 @unnumbered Key (Character) Index
798 @node Command Index, Variable Index, Key Index, Top
799 @unnumbered Command and Function Index
802 @node Variable Index, Concept Index, Command Index, Top
803 @unnumbered Variable Index
806 @node Concept Index, Frame, Variable Index, Top
807 @unnumbered Concept Index
815 @c Remember to delete these lines before creating the info file.
818 @bindingoffset = 0.5in
projects / sxemacs / blob