home *** CD-ROM | disk | FTP | other *** search
/ Sams Teach Yourself C in 21 Days (6th Edition) / STYC216E.ISO / pc / DJGPP / v2gnu / emacs.README < prev    next >
Text File  |  2000-02-05  |  19KB  |  400 lines
  1. 1. Introduction
  2.    ------------
  3.  
  4. GNU Emacs 20 compiled with DJGPP v2.x is hereby available as part of
  5. the DJGPP archives.
  6.  
  7. Emacs is an extremely powerful, extensible, customizable editor.  It
  8. serves as a programmer's editor, a programming environment, and much
  9. more.  Some say it's an operating system in disguise.  Others say it's
  10. a way of life...
  11.  
  12. Apart of usual features you'd expect to find in an editor, Emacs
  13. offers many advanced editing features, and also many features that
  14. most editors usually don't have at all.
  15.  
  16. Here are some of the advanced editing features that you should try
  17. (the names of relevant commands and optional packages are in
  18. parentheses):
  19.  
  20.  - support for every imaginable programming language on Earth (Ada,
  21.    Assembly, Awk, C, C++, Java, Perl, Fortran, Pascal, Prolog, Simula,
  22.    Scheme, SQL, Tcl, VHDL, Texinfo, TeX, Nroff, SGML/HTML)
  23.  - compilation from within the editor (`M-x compile')
  24.  - invoking Grep and Diff from within the editor (M-x grep, M-x diff)
  25.  - user-extensible syntax highlighting (font-lock)
  26.  - automatic highlighting of matching parentheses (paren)
  27.  - finding function/macro definitions (M-.)
  28.  - reading Info docs (info) and man pages (man)
  29.  - interface to version control software (RCS, CVS) (vc)
  30.  - automatic expansion of partially-typed words (by pressing M-/)
  31.  - passing part of a buffer to an external program, and inserting its
  32.    output into the buffer (M-|, M-!)
  33.  - saving and restoring of Emacs state between sessions (desktop)
  34.  - color-enhanced comparison of files and directories (ediff)
  35.  - you can use Emacs as a word processor (enriched)
  36.  - you can use Emacs as a hex editor of binary files (hexl)
  37.  - integrated spell-checking (ispell)
  38.  - printing (`M-x lpr-buffer' and `M-x ps-print-buffer')
  39.  - built-in sorting of files, buffers, or parts thereof (sort)
  40.  - emulation of other editors (EDT, TPU, vi, Brief, even WordStar)
  41.  
  42. Here are some of the features you probably won't expect to find in an
  43. editor:
  44.  
  45.  - editing compressed archives--zip, zoo, lzh, tar, etc.--(arc-mode)
  46.  - ``editing'' a directory: use Emacs as a file manager (dired)
  47.  - display of calendar (calendar) and holydays (holyday), and
  48.    management of appointment diary (diary)
  49.  - computation of lunar phases (lunar) and sunrise/sunset (solar)
  50.  - packages for reading email (RMAIL) and news groups (Gnus)
  51.  - games (tetris, gomoku, life, solitaire)
  52.  - invoking arbitrary commands at certain time: you can use Emacs as
  53.    your system manager or a cron daemon (midnight)
  54.  
  55. Emacs 20 has several significant improvements and enhancements as
  56. compared to version 19; it is also significantly larger (run-time
  57. memory footprint grows by about 1MB, the disk storage now needs about
  58. 10MB more space) and somewhat slower.  (On the other hand, typical
  59. desktop machines got much faster and memory-adbundant.)
  60.  
  61. Emacs can be compiled with DJGPP out of the box, and you are
  62. encouraged to get the latest version from the GNU ftp sites and build
  63. it by yourself.  But if you don't have the time, necessary tools or
  64. disk storage required to unpack the full source distribution and build
  65. Emacs, you can get the pre-built binaries and only those parts of the
  66. package that you need from the DJGPP sites.
  67.  
  68. The single most important new feature in Emacs 20 is support for
  69. multilingual editing.  You can now edit files in many different
  70. languages, and type text in any supported language, even if your
  71. version of the OS doesn't have a built-in support for that language.
  72. You can mix several languages in the same buffer, read and write files
  73. in many different encodings for non-ASCII characters, and print
  74. non-ASCII text to a PostScript printer.
  75.  
  76. The DJGPP version of Emacs includes full support for all these
  77. features.  The only multilingual feature whose support is somewhat
  78. limited is the display of non-ASCII characters.  Emacs can directly
  79. display a single non-ASCII character set--the one supported by the
  80. installed DOS codepage.  It can also display all single-byte character
  81. sets, such as Latin-1, Cyrillic, Greek, Hebrew, and other ISO 8859
  82. character sets; however, where these scripts don't have corresponding
  83. glyphs in the current codepage, Emacs _simulates_ those glyphs with
  84. ASCII strings.  For example, the Latin letter ``c with cedilla'' is
  85. displayed as "{,c}" if the codepage doesn't support that letter.  This
  86. looks somewhat awkward, but the text is still readable by a person who
  87. knows the language.  Characters from Far-Eastern scripts, such as
  88. Chinese, Japanese, or Korean, can only be displayed when Emacs runs on
  89. versions of DOS/Windows localized for those countries.  For more
  90. details, see the section "MS-DOS and MULE" in the on-line manual.
  91.  
  92. Another significant new feature is Customize: an interactive package
  93. for customizing every feature and option in Emacs without knowing any
  94. of Emacs Lisp, the language used to extend and customize the editor.
  95.  
  96. There are lost and lots of other new features, too many to list here.
  97. See the file NEWS in the distribution for a full list.
  98.  
  99. You will want to install this version instead of Emacs 19, if: (1) you
  100. need the multilingual support, or some of the other major new
  101. features; (2) you don't care about the slow-down of Emacs operation,
  102. or have a fast machine with enough RAM where that slow-down and the
  103. larger memory footprint aren't noticeable; or (3) you are an Emacs
  104. addict and absolutely must have the latest and the greatest...
  105.  
  106. You will want to stick to Emacs 19 if: (1) you want non-ASCII files to
  107. be displayed as literal bytes; (2) you have a slow and memory-starved
  108. machine; or (3) you need the leanest, meanest Emacs possible.
  109.  
  110. The binaries here were produced from the official version 20.5 of GNU
  111. Emacs, with the following changes:
  112.  
  113.     * Built-in spelling works.  You need to download and install the
  114.       DJGPP port of Ispell, v2gnu/ispNNNb.zip, to be able to take
  115.       advantage of this feature.
  116.  
  117.     * Texinfo mode knows about the new commands (like @env) introduced
  118.       in the latest release 4.0 of the GNU Texinfo package.
  119.  
  120.     * Arguments passed to subsidiary commands are quoted in accordance
  121.       to the quoting style supported by all DJGPP programs.
  122.  
  123.     * A few Y2K-related problems in the Version Control support are
  124.       corrected.  These corrections were lifted from Emacs 20.6
  125.       pretest distribution.
  126.  
  127.  
  128. 2. Files
  129.    -----
  130.  
  131. Emacs is a very large package.  To make downloading it easier, the
  132. archive here is divided into several zip files.  Some files are
  133. *required* for running Emacs, others are needed if you want to use
  134. specific optional features, still others are only needed if you want
  135. to rebuild Emacs (e.g., if you discover a bug).  Here is the list of
  136. the files:
  137.  
  138.   em2005b.zip   Binaries and runtime support, required.
  139.   em2005li.zip  Lisp sources of Emacs packages, recommended.
  140.   lei2005b.zip  Library of Emacs Input methods, required for typing
  141.         non-ASCII text.
  142.   ifonts12.zip  Intlfonts 1.2, fonts for printing all non-ASCII
  143.         scripts except Chinese, Japanese, and Korean.
  144.   ifnt12cn.zip  Intlfonts 1.2 for Chinese scripts.
  145.   ifnt12jk.zip  Intlfonts 1.2 for Japanese and Korean scripts.
  146.   em2005s1.zip  Emacs sources required for building Emacs with DJGPP.
  147.   em2005s2.zip  Emacs sources not required for the DJGPP version.
  148.   lei2005s.zip  Sources for Leim, Library of Emacs Input methods.
  149.  
  150. The approximate disk storage that you will need for the package is as
  151. follows:
  152.  
  153.   Binaries and runtime support (em2005b.zip)....................39MB
  154.   Additional storage for Elisp sources (em2005li.zip)...........34MB
  155.   Additional storage for Leim (lei2005b.zip).....................4MB
  156.   Additional storage for Intlfonts (ifonts12.zip)................2MB
  157.   Additional storage for Chinese fonts (ifnt12cn.zip)...........31MB
  158.   Additional storage for Japanese/Korean fonts (ifnt12jk.zip)....6MB
  159.   Additional storage for DJGPP sources (em2005s1.zip)...........15MB
  160.   Additional storage for the full sources........................3MB
  161.   Additional storage for Leim sources (lei2005s.zip)............10MB
  162.  
  163. (These numbers may vary depending on the cluster size of your disk.)
  164.  
  165. If you can afford the disk space, downloading and installing the Elisp
  166. sources (em2005li.zip) is *highly* recommended, because the best docs
  167. for each Elisp package can be always found at the beginning of its .el
  168. file; if you can't figure out something by reading the on-line manual,
  169. always read the comments at the beginning of the .el package that
  170. defines the function(s) you are after.  (The GNU Emacs Lisp Manual,
  171. available from GNU FTP sites, is highly recommended if you seek deep
  172. understanding of how the Elisp code works.)
  173.  
  174. The em2005li.zip package is also required if you want to dump Emacs
  175. with some non-standard features.  To this end, the pure undumped Emacs
  176. executable, temacs.exe, is included in em2005li.zip.  The TAGS files,
  177. required to quickly find any function in the Emacs sources, are also
  178. included.
  179.  
  180. The Leim package, lei2005b.zip, is only required if you need to *type*
  181. non-ASCII text at the keyboard; reading, writing, and displaying
  182. non-ASCII text do *not* require Leim.
  183.  
  184. The various Intlfonts zip files are only used for printing non-ASCII
  185. text to PostScript printers, when the characters of that text are not
  186. directly supported by the printer's internal fonts.  If you don't care
  187. about printing foreign text, or don't have a PostScript printer in the
  188. first place, don't bother downloading these files (they are rather
  189. big).
  190.  
  191. The rest of the package is only required if you want to recompile
  192. Emacs or debug it.  Note that if you want to rebuild Emacs with DJGPP,
  193. you will only need em2005s1.zip; building Emacs with Leim support
  194. requires lei2005s.zip as well.  The rest of the source distribution
  195. (in em2005s2.zip) isn't used to compile Emacs with DJGPP and is here
  196. only for completeness' sake.  The file `INSTALL' in the main Emacs
  197. directory describes (at its end) how to build Emacs with DJGPP.  The
  198. distribution has already been configured for DJGPP v2.x, so you don't
  199. need to run config.bat if you use DJGPP v2.
  200.  
  201.  
  202. 3. Getting started
  203.    ---------------
  204.  
  205. To install the pre-built distribution of Emacs, follow these steps:
  206.  
  207.    * Go to your main DJGPP installation directory.  If you don't have
  208.      DJGPP installed, you can install Emacs in any directory you want.
  209.  
  210.    * Unzip all the files that you want to install:
  211.  
  212.           unzip32 em2005b.zip
  213.           unzip32 em2005li.zip
  214.           unzip32 lei2005b.zip
  215.  
  216.      etc.  The above example uses the unzip32.exe program, available
  217.      from the same place where you downloaded Emacs.  If you use
  218.      PKUNZIP, don't forget the -d switch, like so:
  219.  
  220.           pkunzip -d em2005b.zip
  221.  
  222.      If you unzip the files on Windows 9X or Windows 2000, make sure
  223.      you use an unzip program that supports long file names in zip
  224.      archives.  Unzip32.exe, available from the DJGPP archives, and
  225.      djtar.exe, distributed as part of the basic DJGPP development
  226.      environment djdevNNN.zip, both support long file names on those
  227.      operating systems, so I recommend to use one of these programs to
  228.      unzip the package.
  229.  
  230.      If you install Emacs on Windows NT, you must use an unzip program
  231.      that truncates long file names to the DOS 8+3 limits.  Again,
  232.      unzip32 and djtar will do the right thing for you.
  233.  
  234.    * When you unzip the archives, a directory called `emacs' is created
  235.      in the `gnu' subdirectory of the DJGPP tree, with several
  236.      subdirectories.  Add the `gnu/emacs/bin' directory to your PATH.
  237.      If you don't have DJGPP installed, and you have Info files from
  238.      other packages on your system, add the `gnu/emacs/info' directory
  239.      to your INFOPATH environment variable.
  240.  
  241.    * On Windows 9X/2K, you should set LFN=y in the environment, or the
  242.      long file names might not work for you.  (Long file names are NOT
  243.      supported on Windows NT.)  Also, I advise to set the "DPMI
  244.      Memory" property of the DOS box to 65535KB (unless you have more
  245.      than 64MB physical memory installed), so that Emacs could use
  246.      lots of memory.
  247.  
  248.    * If you are a new user of Emacs, be sure to begin by reading the
  249.      Emacs tutorial.  To this end, invoke Emacs and choose the
  250.      "Emacs Tutorial" item from the "Help" submenu (on the menu bar).
  251.      Emacs should automatically choose the tutorial in your native
  252.      language, if such a tutorial is available; if not, the tutorial
  253.      in English shall be displayed.
  254.  
  255.    * An example start-up file is included under the name
  256.      `_emacs.xmpl'; you can use it as a starting point for your
  257.      customizations by renaming it to `_emacs'.  (Emacs automatically
  258.      searches for and loads a file named `_emacs' at start-up.)
  259.      Please don't complain if you don't like the settings of
  260.      `_emacs.xmpl', as they are my own preferences.  Emacs is about
  261.      total freedom of tailoring a program to your liking, so just
  262.      change them as you see fit and move on.
  263.  
  264.      New users are advised to avoid using the example start-up file
  265.      until they get hold of the Emacs basics, because that example
  266.      disables the message about most important commands printed at
  267.      startup.  If you ever get stuck inside Emacs and need a quick way
  268.      of bailing out, you will need those instructions.
  269.  
  270.    * The file `gnu/emacs/etc/refcard.ps' can be printed on a
  271.      PostScript printer to produce a handy reference card for most
  272.      frequently used Emacs commands and features.
  273.  
  274.    * If you run Emacs under Windows 9X/2K, you might find the icon
  275.      files in the `gnu/emacs/nt/icons' directory useful for placing an
  276.      Emacs shortcut on your desktop.  Users of Windows 3.X should use
  277.      the files `gnu/emacs/msdos/emacs.pif' and
  278.      `gnu/emacs/msdos/emacs.ico' instead.
  279.  
  280.    * To make full use of several optional Emacs features, consider
  281.      installing additional packages:
  282.  
  283.       - The man clone (v2apps/manNNb.zip), Less (v2gnu/lssNNNb.zip),
  284.         Gawk (v2gnu/gwkNNNb.zip), and Sed (v2gnu/sedNNNb.zip) for
  285.         reading man pages inside Emacs.
  286.  
  287.       - Grep (v2gnu/grepNNb.zip) and Findutils (v2gnu/findNNb.zip) for
  288.         using the `M-x grep' and `M-x grep-find' commands.
  289.  
  290.       - Diffutils (v2gnu/difNNNb.zip) for the `M-x diff' command and
  291.         the commands provided by the Ediff package.
  292.  
  293.       - RCS (v2gnu/rcsNNNb.zip) or CVS (v2gnu/cvsNNNb.zip) for the
  294.         Emacs built-in Version Control support.
  295.  
  296.       - Ispell (v2gnu/ispNNNb.zip) for spell-checking commands.
  297.  
  298. The zip files are LFN-clean, which means they can be unzipped on
  299. Windows 9X (or any other system that supports long filenames); in that
  300. case all the files will get their original long names, including the
  301. letter-case (e.g., `ChangeLog', `FAQ', etc.).  Note that if you want
  302. LFN support within Emacs (i.e., you set LFN=y in the environment), you
  303. *must* unzip the archives with an unzip program that supports long
  304. filenames, or else Emacs won't be able to find some of its files.  If
  305. you want to be able to run Emacs from both Windows 9X and plain DOS,
  306. you need to set the NameNumericTail property in the Registry to 0
  307. before you unzip the package (you may return the setting to 1 after you
  308. finish unzipping).  The DJGPP FAQ list explains the details of how to
  309. change this setting.
  310.  
  311.  
  312. 4. Building Emacs from sources
  313.    ---------------------------
  314.  
  315. To rebuild Emacs from sources, follow these steps:
  316.  
  317.    * Unzip em2005b.zip as described above.  If you want to build Emacs
  318.      with Leim, unzip lei2005b.zip as well.
  319.  
  320.    * Unzip the source distribution from the same directory:
  321.  
  322.           unzip32 em2005s1.zip
  323.           unzip32 lei2005s.zip
  324.  
  325.      (lei2005s.zip is only needed if you want to rebuild Emacs with
  326.      Leim.)
  327.  
  328.      The above example uses the unzip32.exe program, available from
  329.      the same place where you downloaded Emacs.  If you use PKUNZIP,
  330.      don't forget the -d switch, like so:
  331.  
  332.           pkunzip -d em2005b.zip
  333.  
  334.      If you unzip the files on Windows 9X or Windows 2000, make sure
  335.      you use an unzip program that supports long file names in zip
  336.      archives.  Unzip32.exe, available from the DJGPP archives, and
  337.      djtar.exe, distributed as part of the basic DJGPP development
  338.      environment djdevNNN.zip, both support long file names on those
  339.      operating systems, so I recommend to use one of these programs to
  340.      unzip the package.
  341.  
  342.      If you install Emacs on Windows NT, you must use an unzip program
  343.      that truncates long file names to the DOS 8+3 limits.  Again,
  344.      unzip32 and djtar will do the right thing for you.
  345.  
  346.      Note: you *must* unzip the source distributions on top of the
  347.      binary distributions, since the build process relies on some of
  348.      the files that come with the binary zips.
  349.  
  350.    * In the `gnu/emacs' directory, type "make install" and press
  351.      [Enter] to build the package.  This puts the compiled executables
  352.      in the `gnu/emacs/bin' subdirectory.
  353.  
  354.    * If you change some of the configuration scripts (in the
  355.      `gnu/emacs/msdos' subdirectory) or the `config.bat' batch file,
  356.      you will need to run "config msdos" before "make install".
  357.  
  358.  
  359.  
  360. 5. Troubleshooting
  361.    ---------------
  362.  
  363. If you invoke Emacs on Windows 9X or Windows NT, and it doesn't find
  364. some of its files, you have a problem related to long file names.  On
  365. Windows 9X/2000, try setting LFN=y in the environment before running
  366. Emacs; if that doesn't help, set LFN=n and try again.  If it only
  367. works with LFN=n on Windows 9X, you need to unzip the distribution
  368. again using a program which supports long file names in zip archives.
  369. I recommend unzip32.exe, available from the DJGPP sites.
  370.  
  371. If Emacs doesn't find some of its files on Windows NT, make sure you
  372. unzip the distribution with a program which truncates the long file
  373. names to DOS 8+3 limits.  Again, unzip32.exe will do the right thing.
  374.  
  375. If you have any other trouble with using Emacs, it is recommended to
  376. perform the following steps in order:
  377.  
  378.    * Read the on-line docs which describe the command you use.
  379.  
  380.    * Look up your problem in the Emacs FAQ list (choose
  381.      "Help->Manuals->Emacs FAQ" from the menu bar).
  382.  
  383.    * Consult the file `PROBLEMS' in the main Emacs directory for
  384.      solutions to known problems.
  385.  
  386.    * Read the chapter about reporting bugs in the on-line manual.  The
  387.      file `BUGS' in the main Emacs directory describes how to find
  388.      that chapter, if you have trouble with that.
  389.  
  390. You can post questions and requests for help to the gnu.emacs.help
  391. news group if none of the above seems to help. (Problems that seem to
  392. be DOS- or DJGPP-related can be reported to the comp.os.msdos.djgpp
  393. news group first.)
  394.  
  395.  
  396.  
  397.                    Enjoy.
  398.  
  399.                                     Eli Zaretskii <eliz@is.elta.co.il>
  400.