


EMACS(1)                                                 EMACS(1)


NNAAMMEE
       emacs - GNU project Emacs

SSYYNNOOPPSSIISS
       eemmaaccss [ _c_o_m_m_a_n_d_-_l_i_n_e _s_w_i_t_c_h_e_s ] [ _f_i_l_e _._._.  ]

DDEESSCCRRIIPPTTIIOONN
       _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 edi-
       tors 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
       windows  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 funda-
       mentals of _E_m_a_c_s in a few minutes.  Help  Apropos  (CTRL-h
       a)  helps you find a command given its functionality, Help
       Character (CTRL-h c) describes a given character's effect,
       and  Help Function (CTRL-h f) describes a given Lisp func-
       tion 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 mis-
       takes.

       _G_N_U _E_m_a_c_s_'_s many  special  packages  handle  mail  reading
       (RMail)  and  sending  (Mail),  outline editing (Outline),
       compiling (Compile), running subshells within  _E_m_a_c_s  win-
       dows  (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  fea-
       tures  fairly  rapidly  by studying the tutorial and using
       the self-documentation features.

       Emacs Options

       The following options are of general interest:

       _f_i_l_e    Edit _f_i_l_e_.

       ++_n_u_m_b_e_r Go to the line specified by _n_u_m_b_e_r (do not  insert
               a space between the "+" sign and the number).

       --qq      Do not load an init file.

       --uu _u_s_e_r Load _u_s_e_r_'_s init file.

       --tt _f_i_l_e Use  specified  _f_i_l_e  as  the  terminal instead of



                         1990 November 13                       1





EMACS(1)                                                 EMACS(1)


               using stdin/stdout.  This must be the first  argu-
               ment specified in the command line.

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

       --ff _f_u_n_c_t_i_o_n
               Execute the lisp function _f_u_n_c_t_i_o_n_.

       --ll _f_i_l_e Load 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:

       --bbaattcchh _c_o_m_m_a_n_d_f_i_l_e
               Edit  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.

       --kkiillll   Exit _E_m_a_c_s while in batch mode.

       Using Emacs with X

       _E_m_a_c_s has been tailored to work well  with  the  X  window
       system.   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:

       --rrnn _n_a_m_e
               Specifies the program name which  should  be  used
               when   looking   up   defaults  in  the  user's  X
               resources.  This must be the first  option  speci-
               fied in the command line.

       --wwnn _n_a_m_e
               Specifies the name which should be assigned to the
               _E_m_a_c_s window.

       --rr      Display the _E_m_a_c_s window in reverse video.

       --ii      Use the "kitchen sink" bitmap icon when iconifying
               the _E_m_a_c_s window.

       --ffoonntt _f_o_n_t_, --ffnn _f_o_n_t
               Set  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  directory.   Note  that  _E_m_a_c_s
               will only accept fixed width fonts.  Under the X11
               Release  4  font-naming conventions, any font with
               the value "m" or "c" in the eleventh field of  the



                         1990 November 13                       2





EMACS(1)                                                 EMACS(1)


               font  name  is  a  fixed width font.  Furthermore,
               fonts whose name are of the form _w_i_d_t_hx_h_e_i_g_h_t  are
               generally  fixed width, as is the font _f_i_x_e_d.  See
               _x_l_s_f_o_n_t_s(1) for more information.

               When you specify a font, be sure to  put  a  space
               between the switch and the font name.

       --bb _p_i_x_e_l_s
               Set  the _E_m_a_c_s window's border width to the number
               of pixels specified by _p_i_x_e_l_s_.   Defaults  to  one
               pixel on each side of the window.

       --iibb _p_i_x_e_l_s
               Set the window's internal border width to the num-
               ber of pixels specified by  _p_i_x_e_l_s_.   Defaults  to
               one pixel of padding on each side of the window.


       --ww _g_e_o_m_e_t_r_y_, --ggeeoommeettrryy _g_e_o_m_e_t_r_y
               Set the _E_m_a_c_s window's width, height, and position
               as specified.  The geometry  specification  is  in
               the  standard X format; see _X(1) for more informa-
               tion.  The width and height are specified in char-
               acters; the default is 80 by 24.


       --ffgg _c_o_l_o_r
               On color displays, sets the color of the text.

               See  the  file  _/_u_s_r_/_l_i_b_/_X_1_1_/_r_g_b_._t_x_t for a list of
               valid color names.

       --bbgg _c_o_l_o_r
               On color displays, sets the color of the  window's
               background.

       --bbdd _c_o_l_o_r
               On  color displays, sets the color of the window's
               border.

       --ccrr _c_o_l_o_r
               On color displays, sets the color of the  window's
               text cursor.

       --mmss _c_o_l_o_r
               On  color displays, sets the color of the window's
               mouse cursor.

       --dd _d_i_s_p_l_a_y_n_a_m_e_, --ddiissppllaayy _d_i_s_p_l_a_y_n_a_m_e
               Create the _E_m_a_c_s window on the  display  specified
               by  _d_i_s_p_l_a_y_n_a_m_e.   Must be the first option speci-
               fied in the command line.




                         1990 November 13                       3





EMACS(1)                                                 EMACS(1)


       --nnww     Tells _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(1) window, display is done in  that  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_r_e_s_o_u_r_c_e_s  file  (see _x_r_d_b(1)).  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:

       ffoonntt ((class FFoonntt))
               Sets the window's text font.

       rreevveerrsseeVViiddeeoo ((class RReevveerrsseeVViiddeeoo))
               If  _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 reverse video.

       bbiittmmaappIIccoonn ((class BBiittmmaappIIccoonn))
               If _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."

       bboorrddeerrWWiiddtthh ((class BBoorrddeerrWWiiddtthh))
               Sets the window's border width in pixels.

       iinntteerrnnaallBBoorrddeerr ((class BBoorrddeerrWWiiddtthh))
               Sets the window's internal border width in pixels.

       ffoorreeggrroouunndd ((class FFoorreeggrroouunndd))
               For color displays, sets the window's text  color.

       bbaacckkggrroouunndd ((class BBaacckkggrroouunndd))
               For  color  displays, sets the window's background
               color.

       bboorrddeerrCCoolloorr ((class BBoorrddeerrCCoolloorr))
               For color displays, sets the color of the window's
               border.

       ccuurrssoorrCCoolloorr ((class FFoorreeggrroouunndd))
               For color displays, sets the color of the window's
               text cursor.

       ppooiinntteerrCCoolloorr ((class FFoorreeggrroouunndd))
               For color displays, sets the color of the window's
               mouse cursor.

       ggeeoommeettrryy ((class GGeeoommeettrryy))
               Sets   the   geometry  of  the  _E_m_a_c_s  window  (as
               described above).



                         1990 November 13                       4





EMACS(1)                                                 EMACS(1)


       ttiittllee ((class TTiittllee))
               Sets the title of the _E_m_a_c_s window.

       iiccoonnNNaammee ((class TTiittllee))
               Sets the icon name for the _E_m_a_c_s window icon.

       If you try to set color values while  using  a  black  and
       white  display,  the window's characteristics will default
       as follows: the foreground color will be set to black, the
       background  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.

       Using the Mouse

       The  following  lists  the  mouse  button bindings for the
       _E_m_a_c_s window under X11.

       MOUSE BUTTON         FUNCTION
       left                 Set point.
       middle               Paste text.
       right                Cut text into X cut buffer.
       SHIFT-middle         Cut text into X cut buffer.
       SHIFT-right          Paste text.
       CTRL-middle          Cut text into X cut buffer  and  kill
                            it.
       CTRL-right           Select  this  window,  then  split it
                            into two  windows.   Same  as  typing
                            CTRL-x 2.
       CTRL-SHIFT-left      X  buffer  menu--hold the buttons and
                            keys down, wait for menu  to  appear,
                            select  buffer,  and  release.   Move
                            mouse out of menu and release to can-
                            cel.
       CTRL-SHIFT-middle    X  help  menu--pop up index card menu
                            for Emacs help.
       CTRL-SHIFT-right     Select window with mouse, and  delete
                            all  other  windows.   Same as typing
                            CTRL-x 1.


MMAANNUUAALLSS
       You 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.



                         1990 November 13                       5





EMACS(1)                                                 EMACS(1)


FFIILLEESS
       /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 func-
       tions 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 educa-
       tion, 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.

       /usr/lib/X11/rgb.txt - list of valid X color names.





                         1990 November 13                       6





EMACS(1)                                                 EMACS(1)


BBUUGGSS
       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 sys-
       tem) 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  assis-
       tance,  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  mail-
       ing  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 is in your  inter-
       est  to  report them in such a way that they can be easily
       reproduced.

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

UUNNRREESSTTRRIICCTTIIOONNSS
       _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
       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 per-
       mitted.  In fact, the primary purpose of the General  Pub-
       lic 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.

SSEEEE AALLSSOO
       X(1), xlsfonts(1), xterm(1), xrdb(1)




                         1990 November 13                       7





EMACS(1)                                                 EMACS(1)


AAUUTTHHOORRSS
       _E_m_a_c_s was written by Richard Stallman and the  Free  Soft-
       ware  Foundation.   Joachim  Martillo  and  Robert Krawitz
       added the X features.





















































                         1990 November 13                       8


