NAME

emacs − GNU project Emacs

SYNOPSIS

emacs [file ...]

DESCRIPTION

GNU Emacs was written by the author of the original (PDP-10) Emacs, Richard Stallman.  Its functionality encompasses everything other Emacs editors do, and it’s easily extensible since its editing commands are written in Lisp. 

Emacs has an extensive interactive help facility, but the facility assumes that you know how to manipulate Emacs windows and buffers.  Control-h (backspace or Control-h) enters the Help facility.  Help Tutorial (Control-h t) requests an interactive tutorial that can teach beginners the fundamentals of Emacs in a few minutes.  Help Apropos (Control-h a) helps you find a command given its functionality; Help Character (Control-h c) yes describes a given character’s effect; and Help Function (Control-h f) describes a given Lisp function specified by name. 

The Emacs Undo command can undo several steps of modification to your buffers, so it’s easy to recover from editing mistakes. 

Special packages in GNU Emacs handle mail reading (RMail) and sending (Mail), outline editing (Outline), compiling (Compile), running subshells within Emacs windows (Shell), running a Lisp read-eval-print loop (Lisp-Interaction-Mode), and automated psychotherapy (Doctor). 

There is an extensive reference manual, but users of other versions of Emacs should have little trouble adapting even without a copy.  Users new to Emacs will be able to use basic features fairly rapidly by studying the tutorial and using the self-documentation features. 

OPTIONS

The following options are of general interest:

file Edit file. 

+number
Go to the line specified by number (don’t insert a space between the "+" sign and the number). 

-d displayname
Create the Emacs window on the display specified by displayname.  This must be the first argument listed in the command line. 

−q Don’t load an init file. 

-u user Load user’s init file. 

-t file Use specified file as the terminal instead of using stdin/stdout.  This must be the first argument specified in the command line. 

The following options are lisp-oriented (these options are processed in the order encountered):

-f function
Execute the lisp function function. 

-l file Load the lisp code in the file file. 

The following options are useful when running Emacs as a batch editor:

-batch commandfile
Edit in batch mode using the commands found in commandfile.  The editor will send messages to stdout.  This option must be the first in the argument list. 

−kill Exit Emacs while in batch mode. 

MANUALS

You can order printed copies of the GNU Emacs Manual from the Free Software Foundation, which develops GNU software.  Their address is:
 

    Free Software Foundation
    675 Mass Ave.
    Cambridge, MA 02139

 
As with all software and publications from FSF, everyone is permitted to make and distribute copies of the Emacs manual.  The TeX source to the manual is also included in the Emacs source distribution.

FILES

/usr/local/emacs/src - C source files and object files. 
 
/usr/local/emacs/lisp - Lisp source files and compiled files that define most editing commands.  Some are preloaded; others are autoloaded from this directory when used.
  /usr/local/emacs/man - sources for the Emacs reference manual.
 
/usr/local/emacs/etc - various programs that are used with GNU Emacs, and some files of information.
 
/usr/local/emacs/etc/DOC.∗ - contains the documentation strings for the Lisp primitives and preloaded Lisp functions of GNU Emacs.  They are stored here to reduce the size of Emacs proper.
 
/usr/local/emacs/etc/DIFF discusses GNU Emacs vs. Twenex Emacs;
/usr/local/emacs/etc/CCADIFF discusses GNU Emacs vs. CCA Emacs;
/usr/local/emacs/etc/GOSDIFF discusses GNU Emacs vs. Gosling Emacs.
/usr/local/emacs/etc/SERVICE lists people offering various services to assist users of GNU Emacs, including education, troubleshooting, porting and customization.
These files also have information useful to anyone wishing to write programs in the Emacs Lisp extension language, which has not yet been fully documented.
 
/usr/local/emacs/info - files for the Info documentation browser (a subsystem of Emacs) to refer to.  Currently not much of Unix is documented here, but the complete text of the Emacs reference manual is included in a convenient tree structured form.
 
/usr/local/emacs/lock - holds lock files that are made for all files being modified in Emacs, to prevent simultaneous modification of one file by two users.
 
/usr/local/emacs/cpp - the GNU cpp, needed for building Emacs on certain versions of Unix where the standard cpp cannot handle long names for macros.
 
/usr/local/emacs/shortnames - facilities for translating long names to short names in C code, needed for building Emacs on certain versions of Unix where the C compiler cannot handle long names for functions or variables.

BUGS

There is a mailing list, bug-gnu-emacs@prep.ai.mit.edu on the internet (ucbvax!prep.ai.mit.edu!bug-gnu-emacs on UUCPnet), for reporting Emacs bugs and fixes.  But before reporting something as a bug, please try to be sure that it really is a bug, not a misunderstanding or a deliberate feature.  We ask you to read the section “Reporting Emacs Bugs” near the end of the reference manual (or Info system) for hints on how and when to report bugs.  Also, include the version number of the Emacs you are running in every bug report that you send in. 
 
Do not expect a personal answer to a bug report.  The purpose of reporting bugs is to get them fixed for everyone in the next release, if possible. For personal assistance, look in the SERVICE file (see above) for a list of people who offer it.
 
Please do not send anything but bug reports to this mailing list. Send requests to be added to mailing lists to the special list info-gnu-emacs-request@prep.ai.mit.edu (or the corresponding UUCP address).  For more information about Emacs mailing lists, see the file /usr/local/emacs/etc/MAILINGLISTS.  Bugs tend actually to be fixed if they can be isolated, so it’s in your interest to report them in such a way that they can be easily reproduced.

Bugs that I know about are: shell will not work with programs running in Raw mode on some Unix versions. 

UNRESTRICTIONS

Emacs is free; anyone may redistribute copies of Emacs to anyone under the terms stated in the Emacs General Public License, a copy of which accompanies each copy of Emacs and which also appears in the reference manual. 

Copies of Emacs may sometimes be received packaged with distributions of Unix systems, but it is never included in the scope of any license covering those systems.  Such inclusion violates the terms on which distribution is permitted.  In fact, the primary purpose of the General Public License is to prohibit anyone from attaching any other restrictions to redistribution of Emacs. 

Richard Stallman encourages you to improve and extend Emacs, and urges that you contribute your extensions to the GNU library.  Eventually GNU (Gnu’s Not Unix) will be a complete replacement for Berkeley Unix.  Everyone will be able to use the GNU system for free. 

AUTHORS

Emacs was written by Richard Stallman and the Free Software Foundation. 
 

4th Berkeley Distribution  —  January 17, 1989