[0m


EMACS(1)	    UNIX Programmer's Manual		 EMACS(1)



[1mNAME
     [0memacs - GNU project Emacs

[1mSYNOPSIS
     emacs [0m[file ...]

[1mDESCRIPTION
     [0m_G_N_U _E_m_a_c_s is a new version of _E_m_a_c_s, written by the author
     of the original (PDP-10) _E_m_a_c_s, Richard Stallman. Its user
     functionality encompasses everything other _E_m_a_c_s editors do,
     and it is easily extensible since its editing commands are
     written in Lisp.

     _E_m_a_c_s has an extensive interactive help facility, but the
     facility assumes that you know how to manipulate _E_m_a_c_s win-
     dows and buffers.	CTRL-h (backspace or CTRL-h) enters the
     Help facility.  Help Tutorial (CTRL-h t) requests an
     interactive tutorial which can teach beginners the fundamen-
     tals of _E_m_a_c_s in a few minutes.  Help Apropos (CTRL-h a)
     helps you find a command given its functionality, Help Char-
     acter (CTRL-h c) describes a given character's effect, and
     Help Function (CTRL-h f) describes a given Lisp function
     specified by name.

     _E_m_a_c_s'_s Undo can undo several steps of modification to your
     buffers, so it is easy to recover from editing mistakes.

     _G_N_U _E_m_a_c_s'_s many special packages handle mail reading
     (RMail) and sending (Mail), outline editing (Outline), com-
     piling (Compile), running subshells within _E_m_a_c_s 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
     Emacses should have little trouble adapting even without a
     copy.  Users new to _E_m_a_c_s will be able to use basic features
     fairly rapidly by studying the tutorial and using the self-
     documentation features.

     Emacs Options

     The following options are of general interest:

     [1mfile    [0mEdit _f_i_l_e.

     [1m+number [0mGo to the line specified by _n_u_m_b_e_r (do not insert a
	     space between the "+" sign and the number).

     [1m-d displayname
	     [0mCreate the _E_m_a_c_s window on the display specified by
	     _d_i_s_p_l_a_y_n_a_m_e. This must be the first argument listed
	     in the command line.



Printed 10/12/91	1987 September 1			1






EMACS(1)	    UNIX Programmer's Manual		 EMACS(1)



     [1m-q      [0mDo not load an init file.

     [1m-u user [0mLoad _u_s_e_r'_s init file.

     [1m-t file [0mUse specified _f_i_l_e 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):

     [1m-f function
	     [0mExecute the lisp function _f_u_n_c_t_i_o_n.

     [1m-l file [0mLoad the lisp code in the file _f_i_l_e.

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

     [1m-batch commandfile
	     [0mEdit in batch mode using the commands found in _c_o_m_-
	     _m_a_n_d_f_i_l_e. The editor will send messages to stdout.
	     This option must be the first in the argument list.

     [1m-kill   [0mExit _E_m_a_c_s while in batch mode.

     _U_s_i_n_g _E_m_a_c_s _w_i_t_h _X

     _E_m_a_c_s has been tailored to work well with the X window sys-
     tem.  If you run _E_m_a_c_s from under X windows, it will create
     its own X window to display in.  You will probably want to
     start the editor as a background process so that you can
     continue using your original window.  _E_m_a_c_s can be started
     with the following X switches:

     [1m-r      [0mDisplay the _E_m_a_c_s window in inverse video.

     [1m-i      [0mUse the "kitchen sink" bitmap icon when iconifying
	     the _E_m_a_c_s window.

     [1m-font font
	     [0mSet the _E_m_a_c_s window's font to that specified by
	     _f_o_n_t. You will find the various _X fonts in the
	     /_u_s_r/_l_i_b/_X_1_1/_f_o_n_t_s directories.  Note that _E_m_a_c_s
	     will only accept fixed width fonts.  xfontsel(1) is
	     useful for displaying available fonts.  When you
	     specify a font, do not include the filename exten-
	     sion.  Be sure to put a space between the -_f_o_n_t
	     switch and the font specification argument.
	     e.g. -font 9x15

     [1m-b pixels



[0mPrinted 10/12/91	1987 September 1			2






EMACS(1)	    UNIX Programmer's Manual		 EMACS(1)



	     Set the _E_m_a_c_s window's border width to the number of
	     pixels specified by _p_i_x_e_l_s.

     [1m-ib pixels
	     [0mSet the window's internal border width to the number
	     of pixels specified by _p_i_x_e_l_s. Defaults to one pixel
	     of padding on each side of the window.

     [1m-w =[WIDTH][xHEIGHT][{+-}XOFF[{+-}YOFF]]
	     [0mSet the _E_m_a_c_s window's width, height, and position
	     on the screen.  The []'s denote optional arguments,
	     the {}'s surround alternatives.  WIDTH and HEIGHT
	     are in number of characters, XOFF and YOFF are in
	     pixels.  WIDTH defaults to 80, HEIGHT to 24, XOFF
	     and YOFF to 1.  If you don't give XOFF and/or YOFF,
	     then you must use the mouse to create the window.
	     If you give XOFF and/or YOFF, then a WIDTHxHEIGHT
	     window will automatically be creating without inter-
	     vention.  XOFF and YOFF specify deltas from a corner
	     of the screen to the corresponding corner of the
	     window, as follows:

	     +XOFF+YOFF     upper left to upper left
	     -XOFF+YOFF     upper right to upper right
	     +XOFF-YOFF     lower left to lower left
	     -XOFF-YOFF     lower right to lower right

     [1m-fg color
	     [0mOn color displays, sets the color of the text.

     [1m-bg color
	     [0mOn color displays, sets the color of the window's
	     background.  See the file /_u_s_r/_l_i_b/_X_1_1/_r_g_b._t_x_t for a
	     list of valid _c_o_l_o_r names.

     [1m-bd color
	     [0mOn color displays, sets the color of the window's
	     border.See the file /_u_s_r/_l_i_b/_X_1_1/_r_g_b._t_x_t for a list
	     of valid _c_o_l_o_r names.

     [1m-cr color
	     [0mOn color displays, sets the color of the window's
	     text cursor.  See the file /_u_s_r/_l_i_b/_X_1_1/_r_g_b._t_x_t for
	     a list of valid _c_o_l_o_r names.

     [1m-ms color
	     [0mOn color displays, sets the color of the window's
	     mouse cursor.  See the file /_u_s_r/_l_i_b/_X_1_1/_r_g_b._t_x_t for
	     a list of valid _c_o_l_o_r names.

     [1m-d displayname
	     [0mCreate the _E_m_a_c_s window on the display specified by



Printed 10/12/91	1987 September 1			3






EMACS(1)	    UNIX Programmer's Manual		 EMACS(1)



	     _d_i_s_p_l_a_y_n_a_m_e. Must be the first option specified in
	     the command line.	[1m-nw [0mTells _E_m_a_c_s not to use its
	     special interface to X.  If you use this switch when
	     invoking _E_m_a_c_s from an _x_t_e_r_m window, display is done
	     in the _x_t_e_r_m window.  This must be the first option
	     specified in the command line.

     You can set _X default values for your _E_m_a_c_s windows in your
     ._X_d_e_f_a_u_l_t_s file.  Use the following format:

	  emacs.keyword:value

     where _v_a_l_u_e specifies the default value of _k_e_y_w_o_r_d. _E_m_a_c_s
     lets you set default values for the following keywords:

     [1mBodyFont
	     [0mSets the window's text font.

     [1mReverseVideo
	     [0mIf _R_e_v_e_r_s_e_V_i_d_e_o'_s value is set to _o_n, the window
	     will be displayed in inverse video.

     [1mBitMapIcon
	     [0mIf _B_i_t_M_a_p_I_c_o_n'_s value is set to _o_n, the window will
	     iconify into the "kitchen sink."

     [1mBorderWidth
	     [0mSets the window's border width in pixels.

     [1mForeground
	     [0mFor color displays, sets the window's text color.
	     See the file /_u_s_r/_l_i_b/_X_1_1/_r_g_b._t_x_t for a list of
	     valid _c_o_l_o_r names.

     [1mBackground
	     [0mFor color displays, sets the window's background
	     color.  See the file /_u_s_r/_l_i_b/_X_1_1/_r_g_b._t_x_t for a list
	     of valid _c_o_l_o_r names.

     [1mBorder  [0mFor color displays, sets the color of the window's
	     border.  See the file /_u_s_r/_l_i_b/_X_1_1/_r_g_b._t_x_t for a
	     list of valid _c_o_l_o_r names.

     [1mCursor  [0mFor color displays, sets the color of the window's
	     text cursor.  See the file /_u_s_r/_l_i_b/_X_1_1/_r_g_b._t_x_t for
	     a list of valid _c_o_l_o_r names.

     [1mMouse   [0mFor color displays, sets the color of the window's
	     mouse cursor.  See the file /_u_s_r/_l_i_b/_X_1_1/_r_g_b._t_x_t for
	     a list of valid _c_o_l_o_r names.





Printed 10/12/91	1987 September 1			4






EMACS(1)	    UNIX Programmer's Manual		 EMACS(1)



     If you try to set color values while using a black and white
     display, the window's characteristics will default as fol-
     lows: the foreground color will be set to black, the back-
     ground color will be set to white, the border color will be
     set to grey, and the text and mouse cursors will be set to
     black.

[1m
     [0m_U_s_i_n_g _t_h_e _M_o_u_s_e

     The following lists the key bindings for the mouse cursor
     when used in an _E_m_a_c_s window.


     MOUSE BUTTON	      FUNCTION
     left		      set point, selecting window if needed
     middle		      paste text from X cut buffer
     right		      put text between point and mouse pointer
			      into X cut buffer
     SHIFT-middle	      as middle
     SHIFT-right	      as right
     CTRL-left		      Select window with mouse, and delete all
			      other windows.  Same as typing
			      CTRL-x 1.
     CTRL-middle	      select this window, then split it into
			      two windows
     CTRL-right               as right, but kill the text too

[1m
MANUALS
     [0mYou can order printed copies of the  GNU  Emacs  Manual  for
     $15.00/copy  postpaid  from  the  Free  Software Foundation,
     which develops  GNU  software  (contact  them  for  quantity
     prices on the manual).  Their address is:
	 Free Software Foundation
	 675 Mass Ave.
	 Cambridge, MA 02139
     Your local Emacs maintainer might also  have  copies  avail-
     able.   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.

[1mFILES
     [0m/usr/lib/emacs/lisp - Lisp source files and  compiled  files
     that define most editing commands.  Some are preloaded; oth-
     ers are autoloaded from this directory when used.

     /usr/lib/emacs/etc - various programs that are used with GNU
     Emacs, and some files of information.

     /usr/lib/emacs/etc/DOC.*  -   contains   the   documentation



Printed 10/12/91	1987 September 1			5






EMACS(1)	    UNIX Programmer's Manual		 EMACS(1)



     strings for the Lisp primitives and preloaded Lisp functions
     of GNU Emacs.  They are stored here to reduce  the  size  of
     Emacs proper.

     /usr/lib/emacs/etc/DIFF  discusses  GNU  Emacs  vs.   Twenex
     Emacs;
     /usr/lib/emacs/etc/CCADIFF  discusses  GNU  Emacs	vs.   CCA
     Emacs;
     /usr/lib/emacs/etc/GOSDIFF discusses GNU Emacs  vs.  Gosling
     Emacs.
     /usr/lib/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/lib/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/lib/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/lib/emacs/cpp - the GNU cpp, needed for building  Emacs
     on  certain  versions  of Unix where the standard cpp cannot
     handle long names for macros.

[1mBUGS
     [0mThere 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  _e_v_e_r_y  bug
     report that you send in.

     Do not expect a personal answer to a bug report.	The  pur-
     pose  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



Printed 10/12/91	1987 September 1			6






EMACS(1)	    UNIX Programmer's Manual		 EMACS(1)



     corresponding  UUCP  address).   For  more information about
     Emacs	mailing      lists,	 see	   the	     file
     /usr/lib/emacs/etc/MAILINGLISTS.	Bugs  tend actually to be
     fixed if they can be isolated, so it is in your interest  to
     report  them  in  such  a way that they can be easily repro-
     duced.

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

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

     Copies of _E_m_a_c_s may sometimes be received packaged with dis-
     tributions  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 _E_m_a_c_s.

     Richard Stallman encourages you to improve and extend _E_m_a_c_s,
     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.

[1mAUTHORS
     [0m_E_m_a_c_s was written by Richard Stallman and the Free  Software
     Foundation.  Joachim Martillo and Robert Krawitz added the X
     features.





















Printed 10/12/91	1987 September 1			7



[0m