home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1999 January / Simtel-MSDOS-Jan1999-CD2.iso / djgpp / v2gnu / emacs.readme < prev    next >
Text File  |  1998-12-10  |  10KB  |  212 lines
  1. 1. Introduction
  2.    ------------
  3.  
  4. GNU Emacs compiled with DJGPP v2.x is hereby available as part of the
  5. DJGPP archives.  Emacs can be compiled with DJGPP out of the box, and
  6. you are encouraged to get the latest version from the GNU ftp sites
  7. and build it by yourself; but if you don't have the time, necessary
  8. tools or disk storage required to unzip the full source distribution
  9. and build Emacs, you can get here the pre-built binaries and only
  10. those parts of the package that you need.
  11.  
  12. The binaries here were produced from the official version 19.34 of GNU
  13. Emacs, with the following changes:
  14.  
  15.     * A bug in `hexl' (found after Emacs 19.34 was already released)
  16.       was corrected whereby binary files were not read in binary mode.
  17.  
  18.     * Support for MS-Windows clipboard was added: you can copy, cut
  19.       and paste to or from other Windows applications in the same way
  20.       as on X Windows platforms.  See the `MS-DOS' chapter of the
  21.       Emacs on-line manual for more details.  The clipboard support
  22.       code was originally written by Dale P. Smith <dpsm@en.com> and
  23.       should be included in the next official Emacs release.
  24.  
  25.     * A bug was corrected whereby running sub-processes on Windows 95
  26.       with LFN enabled didn't work.
  27.  
  28.     * When Emacs doesn't have to support non-US keyboards, both left
  29.       and right Alt keys behave the same.
  30.  
  31.     * A bug with restoring the blink/bright background bit has been
  32.       corrected.  Emacs will now restore that bit to whatever it found
  33.       on startup.
  34.  
  35.     * `M-x grep' and `M-x diff' now correctly interpret the exit code
  36.       of the sub-programs they run.
  37.  
  38.     * `M-x man' now works (but you need to install a clone for the
  39.       `man' command).
  40.  
  41.     * Emacs was compiled and linked with the latest release of DJGPP
  42.       v2.01, so no library bugs should affect it (in particular, the 2
  43.       bugs related to Emacs that are described at the end of the
  44.       `INSTALL' file are no longer an issue, and it should no longer
  45.       crash on NT or when a certain number of environment variables is
  46.       defined).
  47.  
  48.  
  49.  
  50. 2. Files
  51.    -----
  52.  
  53. Emacs is a very large package.  To make downloading it easier, the
  54. archive here is divided into several zip files, each one of which
  55. should fit on a 1.4MB floppy disk.  Some files are required for running
  56. Emacs, others are recommended, still others are only needed if you want
  57. to rebuild Emacs (e.g., if you discover a bug).  Here is the list of
  58. the files:
  59.  
  60.      em1934b.zip   Binaries and minimal runtime support, required
  61.      em1934r1.zip  Full runtime support (1 of 3), required
  62.      em1934r2.zip  Full runtime support (2 of 3), required
  63.      em1934r3.zip  Full runtime support (3 of 3), required
  64.      em1934l1.zip  Elisp sources (1 of 3), recommended
  65.      em1934l2.zip  Elisp sources (2 of 3), recommended
  66.      em1934l3.zip  Elisp sources (3 of 3), recommended
  67.      em1934s1.zip  Emacs sources (1 of 3)
  68.      em1934s2.zip  Emacs sources (2 of 3)
  69.      em1934s3.zip  Emacs sources (3 of 3)
  70.  
  71. The approximate disk storage that you will need for the package is as
  72. follows:
  73.  
  74.      Binaries and minimal runtime support...................5MB
  75.      Binaries and full runtime support.....................20MB
  76.      Additional storage for Elisp sources..................15MB
  77.      Additional storage for MSDOS sources (em1934s1.zip)....6MB
  78.      Additional storage for the full sources...............12MB
  79.  
  80. (The above numbers may vary depending on the cluster size of your
  81. disk.)
  82.  
  83. If you are *exceedingly* short on disk space, you can run Emacs after
  84. installing only em1934b.zip.  However, most of the optional packages
  85. are NOT included in that archive, and neither is the on-line manual, so
  86. many commands won't work.  I tried to squeeze as many frequently-used
  87. packages as I could there, though, so `dired', `compile' and the basic
  88. help commands should work.  The rest of the runtime support
  89. (em1934r?.zip) is not organized in any particular order (actually, it's
  90. in alphabetical order), because different people use different packages
  91. for their chores, and there is no simple way to know what is best for
  92. everyone, especially since many packages require others to run.
  93.  
  94. If you can afford the disk space, downloading and installing the Elisp
  95. sources (em1934l?.zip) is *highly* recommended, because the best docs
  96. for each Elisp package can be always found at the beginning of its .el
  97. file; if you can't figure out something by reading the on-line manual,
  98. always read the comments at the beginning of the .el package that
  99. defines the function(s) you are after.  (The GNU Emacs Lisp Manual,
  100. available from GNU FTP sites, is highly recommended if you seek deep
  101. understanding of how the Elisp code works.)
  102.  
  103. The rest of the package is only required if you want to recompile Emacs
  104. or debug it.  Note that if you want to rebuild Emacs on MSDOS, you will
  105. only need em1934s1.zip; the rest of the source distribution isn't used
  106. to compile Emacs on MSDOS and is here only for completeness' sake.
  107. (However, if you need the Texinfo sources of the Emacs manual, you will
  108. need to install em1934s2.zip as well.)  The file `INSTALL' in the main
  109. Emacs directory describes (at its end) how to build Emacs on MSDOS.
  110. The distribution has already been configured for DJGPP 2.x, so you
  111. don't need to run CONFIG.BAT if you use DJGPP 2.
  112.  
  113.  
  114. 3. Getting started
  115.    ---------------
  116.  
  117. To install Emacs, follow these steps:
  118.  
  119.    * Go to your main DJGPP installation directory.
  120.  
  121.    * Unzip all the files that you want to install.  If you use PKUNZIP,
  122.      don't forget the -d switch, like so:
  123.  
  124.           pkunzip -d em1934*.zip
  125.  
  126.      If you unzip the files on Windows 95, make sure you use an unzip
  127.      program that supports long file names in zip archives.
  128.  
  129.    * When you unzip the archives, a directory called `emacs' is created
  130.      in the `gnu' subdirectory of the DJGPP tree, with several
  131.      subdirectories.  Add the `gnu/emacs/bin' directory to your PATH.
  132.  
  133.    * On Windows 95, you should set LFN=y in the environment, or the
  134.      long file names might not work for you.  (Long file names are NOT
  135.      supported on Windows NT.)
  136.  
  137.    * If you are a new user of Emacs, be sure to begin by reading the
  138.      Emacs tutorial.  To this end, invoke Emacs and choose the
  139.      "Emacs Tutorial" item from the "Help" submenu (on the menu bar).
  140.  
  141.    * An example start-up file is included under the name
  142.      `_emacs.xmpl'; you can use it as a starting point for your
  143.      customizations by renaming it to `_emacs'.  (Emacs automatically
  144.      searches for and loads a file named `_emacs' at start-up.)  Note
  145.      that some settings there need optional packages and will print an
  146.      error message if you didn't install em1934r?.zip.  And please
  147.      don't complain if you don't like the settings of `_emacs.xmpl',
  148.      as they are my own preferences.  Just change them as you see fit
  149.      and move on.
  150.  
  151.      New users are advised to avoid using the example start-up file
  152.      until they get hold of the Emacs basics, because that example
  153.      disables the message about most important commands printed at
  154.      startup.
  155.  
  156.    * If you run Emacs under MS-Windows, you might find the files
  157.      `msdos/emacs.pif' and `msdos/emacs.ico' useful.
  158.  
  159. The zip files are LFN-clean, which means they can be unzipped on
  160. Windows 95 (or any other system that supports long filenames); in that
  161. case all the files will get their original long names, including the
  162. letter-case (e.g., `ChangeLog', `FAQ', etc.).  Note that if you want
  163. LFN support within Emacs (i.e., you set LFN=y in the environment), you
  164. *must* unzip the archives with an unzip program that supports long
  165. filenames, or else Emacs won't be able to find some of its files.  If
  166. you want to be able to run Emacs from both Windows 95 and plain DOS,
  167. you need to set the NameNumericTail property in the Registry to 0
  168. before you unzip the package (you may return the setting to 1 after you
  169. finish unzipping).  The DJGPP FAQ list explains the details of how to
  170. change this setting.
  171.  
  172.  
  173. 4. Troubleshooting
  174.    ---------------
  175.  
  176. If you invoke Emacs on Windows 9X or Windows NT, and it returns to the
  177. DOS prompt immediately when invoked, you have a problem related to
  178. long file names.  On Windows 9X, try setting LFN=y in the environment
  179. before running Emacs; if that doesn't help, set LFN=n and try again.
  180. If it only works with LFN=n on Windows 9X, you need to unzip the
  181. distribution again using a program which supports long file names in
  182. zip archives.
  183.  
  184. If Emacs immediately returns to DOS prompt on Windows NT, make sure
  185. you unzip the distribution with a program which truncates the long
  186. file names to DOS 8+3 limits.
  187.  
  188. If you have any other trouble with using Emacs, it is recommended to
  189. perform the following steps in order:
  190.  
  191.    * Read the on-line docs which describe the command you use.
  192.  
  193.    * Look up your problem in the Emacs FAQ list (choose "Help|Emacs FAQ"
  194.      from the menu bar).
  195.  
  196.    * Consult the file `PROBLEMS' in the main Emacs directory for
  197.      solutions to known problems.
  198.  
  199.    * Read the chapter about reporting bugs in the on-line manual.  The
  200.      file `BUGS' in the main Emacs directory describes how to find
  201.      that chapter, if you have trouble with that.
  202.  
  203. You can post questions and requests for help to the gnu.emacs.help news
  204. group if none of the above seems to help. (Problems that seem to be
  205. DOS-related can be reported to the comp.os.msdos.djgpp news group first.)
  206.  
  207.  
  208.  
  209.                    Enjoy.
  210.  
  211.                                     Eli Zaretskii <eliz@is.elta.co.il>
  212.