home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / browser2.zip / INSTALL.DOS < prev    next >
Text File  |  1995-02-17  |  6KB  |  193 lines
  1. Copyright (c) 1993-1995 Gerd Moellmann
  2. $Id: INSTALL.DOS,v 3.1 1995/02/17 18:21:38 mmann Exp $
  3.  
  4.              C++ SOURCE CODE BROWSER v3.0
  5.               INSTALLATION INSTRUCTIONS
  6.  
  7.         Non MS-DOS users, please read INSTALL instead
  8.  
  9.  
  10.  
  11. Introduction
  12. ------------
  13.  
  14. Welcome to the C++ source code browser v3.0, an Emacs package for
  15. browsing C++ source code.
  16.  
  17. To use the source code browser you need at least:
  18.  
  19.   - Emacs 18 installed on your system,
  20.   
  21.   - a C compiler to compile the C part of the browser (GCC is
  22.     fine of course, Borland C++ can be used),
  23.  
  24.   - `gzip' unpacker to decompress the source archive,
  25.  
  26.   - a `tar' to unpack the files in the archive.
  27.  
  28.  
  29. Installation
  30. ------------
  31.  
  32. It is recommended to install the package outside of the Emacs
  33. directory tree to make upgrading both Emacs or the browser easier.
  34. Choose a place where the browser package should go, make a directory
  35. with a name of your choice, e.g. `browser'
  36.  
  37.     cd xy
  38.     mkdir browser
  39.     cd browser
  40.  
  41. Copy the C++ browser archive to this directory and unpack it:
  42.  
  43.     copy wherever/cppbrwsr.gz
  44.     gzip -d cppbrwsr.gz
  45.     ren cppbrwsr cppbrwsr.tar
  46.     tar xvf cppbrwsr.tar
  47.     del *.tar
  48.  
  49. This will create the following files in the `browser' directory:
  50.  
  51.     br-*.el        Lisp source files for the Lisp part of the
  52.             browser.
  53.     cl*.el        Lisp source files for the Emacs Common Lisp 
  54.             compatibility package (this is only needed
  55.             if you are Emacs 18, since you should already
  56.             have it if you're using Emacs 19).
  57.     by*.el        Lisp source files for a modified version of the
  58.             Emacs 19 optimizing byte compiler. This is only
  59.             needed for Emacs 18).
  60.     *.c, *.h    C source files for the C part of the browser
  61.     makefile    A makefile for DMAKE 3.8 (you can compile the
  62.             C sources without using this).
  63.     README        A readme file.
  64.     INSTALL        The file you are currently reading.
  65.     INSTALL.DOS    Installation instructions for MS-DOS users.
  66.     COPYING        A copy of the GNU General Public License.
  67.  
  68. Compiling under MS-DOS
  69. ----------------------
  70.  
  71. The C part of the browser has been compiled with GNU C (EMX 0.9a under
  72. OS/2) and Borland C++ 3.1 and 4.0. 
  73.  
  74.     Borland C++ ->    bcc -ml -DMSDOS=1 -DPROTOTYPE -eebrowse.exe \
  75.                 lex.c parse.c sym.c wildargs.obj
  76.  
  77.     GCC         ->    gcc -O2 -DOS2=1 -DPROTOTYPES \
  78.                 lex.c parse.c sym.c -o ebrowse.exe
  79.  
  80. Copy `ebrowse.exe' to a directory in your PATH, e.g. to the `bin'
  81. directory of your Emacs installation.
  82.  
  83.  
  84. Installing the Optimizing Byte Compiler
  85. ---------------------------------------
  86.  
  87. The standard Emacs 18 byte compiler, located in `bytecomp.el', has
  88. problems compiling some forms generated by the `CL-19' package.
  89. `CL-19' already applies one patch to the byte compiler (related to
  90. macro expansion of top-level forms), but this is not sufficient as I
  91. had to find out.
  92.  
  93. This package therefore includes the new optimizing byte compiler
  94. written by Jamie Zawinski and Hallvard Furuseth which in its original
  95. form ran both under Emacs 18 and 19. Since I only had access to a
  96. modified source that was part of the Emacs 19.19 distribution I had
  97. partly to port it back to Emacs 18. If you have the original source of
  98. the optimizing byte compiler running under Emacs 18, do not install
  99. the files in the browser package.
  100.  
  101. To install the compiler, save your original `bytecomp.el' (usually
  102. located in some directory like `emacs/lisp' in some backup directory,
  103. copy the new files `byte-opt.el', `byte-run.el' and `bytecomp.el' to
  104. where it was located, start your Emacs and compile the files with `M-x
  105. byte-compile-file'. Do that again after loading `bytecomp.elc' with
  106. `M-x load-library' to ensure that the optimizing compiler has
  107. generated optimized code for itself.
  108.  
  109.  
  110. Installing the CL-19 package
  111. ----------------------------
  112.  
  113. The `CL-19' package included in the distribution package is the one
  114. that was part of Emacs 19.19. This package has a bug in the function
  115. `add-hook' that is fixed in `br-fixes.el' without modifying the
  116. original source. (The `CL-19' package defines this function for the
  117. benefit of Emacs 18 users that want to use the convenient Emacs 19
  118. `add-hook'.
  119.  
  120. Save the original `cl.el' in some backup directory. Then copy the Lisp
  121. source files `cl.el', `cl-extra.el', `cl-macros.el', `cl-compat.el',
  122. and `cl-seq.el' to your Emacs lisp directory and compile the files via
  123. `M-x byte-compile-file'.
  124.  
  125.  
  126. Compiling the Lisp Part (Emacs 19)
  127. ----------------------------------
  128.  
  129. Make sure that your Emacs has the Lisp compatibility package
  130. installed. If necessary, add the compile the files with the prefix
  131. `cl' in your Emacs Lisp directory and add the line
  132.  
  133.     (require 'cl-19 "cl")
  134.  
  135. to your Emacs startup file `.emacs' (located in your `$HOME'
  136. directory). 
  137.  
  138. To compile the Lisp part of the browser, compile and load the files
  139.  
  140.     br-macro.el
  141.     br-struc.el
  142.  
  143. from inside Emacs (the easiest way to do this in Emacs 19 is to open a
  144. dired buffer and use the command `B'). After loading the compiled
  145. files `br-macro.elc' and `br-struc.elc', compile the rest of the Lisp
  146. files that start with the `br-' prefix.
  147.  
  148. The optimizing compiler of Emacs 19 will display a number of warnings
  149. during the compilation process, which can be ignored (it warns about
  150. the usage of buffer-local variables, and I didn't find a way to turn
  151. this useless warning off).
  152.  
  153.  
  154. Modifying your Emacs Startup File `.emacs'
  155. ------------------------------------------
  156.  
  157. After compiling, modify the Emacs Lisp load path to include the
  158. directory the browser was installed in:
  159.  
  160.     (setq emacs-load-path 
  161.           (append '("xyz/browser") emacs-load-path))
  162.  
  163. and add the following lines, following the `require' of the CL-19
  164.  package:
  165.  
  166.     (require 'browse "br-brows")
  167.     (require 'br-utils)
  168.  
  169.  
  170. Installing the Documentation
  171. ----------------------------
  172.  
  173. Compile the Texinfo file `browser.texi' using the command line
  174.  
  175.     makeinfo browser.texi
  176.  
  177. and modify the info search path to include the browser directory:
  178.  
  179.     (setq Info-directory-list
  180.           (append '("xyz/browser") Info-directory-list))
  181.  
  182. Load the file `dir' located in the `info' directory of your Emacs
  183. installation and add a line at the end of the file (omit the
  184. quotee): 
  185.  
  186.     `* Browser: (br-inf).        C++ Browser'
  187.  
  188. (make sure there is a newline at the end of the file). Save `dir' to
  189. disk. You should now be able to select the browser documentation in
  190. the Info browser of Emacs (`\C-h i). 
  191.     
  192.  
  193.              --- end of file ---