home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 5 Edit
/
05-Edit.zip
/
browser2.zip
/
INSTALL.DOS
< prev
next >
Wrap
Text File
|
1995-02-17
|
6KB
|
193 lines
Copyright (c) 1993-1995 Gerd Moellmann
$Id: INSTALL.DOS,v 3.1 1995/02/17 18:21:38 mmann Exp $
C++ SOURCE CODE BROWSER v3.0
INSTALLATION INSTRUCTIONS
Non MS-DOS users, please read INSTALL instead
Introduction
------------
Welcome to the C++ source code browser v3.0, an Emacs package for
browsing C++ source code.
To use the source code browser you need at least:
- Emacs 18 installed on your system,
- a C compiler to compile the C part of the browser (GCC is
fine of course, Borland C++ can be used),
- `gzip' unpacker to decompress the source archive,
- a `tar' to unpack the files in the archive.
Installation
------------
It is recommended to install the package outside of the Emacs
directory tree to make upgrading both Emacs or the browser easier.
Choose a place where the browser package should go, make a directory
with a name of your choice, e.g. `browser'
cd xy
mkdir browser
cd browser
Copy the C++ browser archive to this directory and unpack it:
copy wherever/cppbrwsr.gz
gzip -d cppbrwsr.gz
ren cppbrwsr cppbrwsr.tar
tar xvf cppbrwsr.tar
del *.tar
This will create the following files in the `browser' directory:
br-*.el Lisp source files for the Lisp part of the
browser.
cl*.el Lisp source files for the Emacs Common Lisp
compatibility package (this is only needed
if you are Emacs 18, since you should already
have it if you're using Emacs 19).
by*.el Lisp source files for a modified version of the
Emacs 19 optimizing byte compiler. This is only
needed for Emacs 18).
*.c, *.h C source files for the C part of the browser
makefile A makefile for DMAKE 3.8 (you can compile the
C sources without using this).
README A readme file.
INSTALL The file you are currently reading.
INSTALL.DOS Installation instructions for MS-DOS users.
COPYING A copy of the GNU General Public License.
Compiling under MS-DOS
----------------------
The C part of the browser has been compiled with GNU C (EMX 0.9a under
OS/2) and Borland C++ 3.1 and 4.0.
Borland C++ -> bcc -ml -DMSDOS=1 -DPROTOTYPE -eebrowse.exe \
lex.c parse.c sym.c wildargs.obj
GCC -> gcc -O2 -DOS2=1 -DPROTOTYPES \
lex.c parse.c sym.c -o ebrowse.exe
Copy `ebrowse.exe' to a directory in your PATH, e.g. to the `bin'
directory of your Emacs installation.
Installing the Optimizing Byte Compiler
---------------------------------------
The standard Emacs 18 byte compiler, located in `bytecomp.el', has
problems compiling some forms generated by the `CL-19' package.
`CL-19' already applies one patch to the byte compiler (related to
macro expansion of top-level forms), but this is not sufficient as I
had to find out.
This package therefore includes the new optimizing byte compiler
written by Jamie Zawinski and Hallvard Furuseth which in its original
form ran both under Emacs 18 and 19. Since I only had access to a
modified source that was part of the Emacs 19.19 distribution I had
partly to port it back to Emacs 18. If you have the original source of
the optimizing byte compiler running under Emacs 18, do not install
the files in the browser package.
To install the compiler, save your original `bytecomp.el' (usually
located in some directory like `emacs/lisp' in some backup directory,
copy the new files `byte-opt.el', `byte-run.el' and `bytecomp.el' to
where it was located, start your Emacs and compile the files with `M-x
byte-compile-file'. Do that again after loading `bytecomp.elc' with
`M-x load-library' to ensure that the optimizing compiler has
generated optimized code for itself.
Installing the CL-19 package
----------------------------
The `CL-19' package included in the distribution package is the one
that was part of Emacs 19.19. This package has a bug in the function
`add-hook' that is fixed in `br-fixes.el' without modifying the
original source. (The `CL-19' package defines this function for the
benefit of Emacs 18 users that want to use the convenient Emacs 19
`add-hook'.
Save the original `cl.el' in some backup directory. Then copy the Lisp
source files `cl.el', `cl-extra.el', `cl-macros.el', `cl-compat.el',
and `cl-seq.el' to your Emacs lisp directory and compile the files via
`M-x byte-compile-file'.
Compiling the Lisp Part (Emacs 19)
----------------------------------
Make sure that your Emacs has the Lisp compatibility package
installed. If necessary, add the compile the files with the prefix
`cl' in your Emacs Lisp directory and add the line
(require 'cl-19 "cl")
to your Emacs startup file `.emacs' (located in your `$HOME'
directory).
To compile the Lisp part of the browser, compile and load the files
br-macro.el
br-struc.el
from inside Emacs (the easiest way to do this in Emacs 19 is to open a
dired buffer and use the command `B'). After loading the compiled
files `br-macro.elc' and `br-struc.elc', compile the rest of the Lisp
files that start with the `br-' prefix.
The optimizing compiler of Emacs 19 will display a number of warnings
during the compilation process, which can be ignored (it warns about
the usage of buffer-local variables, and I didn't find a way to turn
this useless warning off).
Modifying your Emacs Startup File `.emacs'
------------------------------------------
After compiling, modify the Emacs Lisp load path to include the
directory the browser was installed in:
(setq emacs-load-path
(append '("xyz/browser") emacs-load-path))
and add the following lines, following the `require' of the CL-19
package:
(require 'browse "br-brows")
(require 'br-utils)
Installing the Documentation
----------------------------
Compile the Texinfo file `browser.texi' using the command line
makeinfo browser.texi
and modify the info search path to include the browser directory:
(setq Info-directory-list
(append '("xyz/browser") Info-directory-list))
Load the file `dir' located in the `info' directory of your Emacs
installation and add a line at the end of the file (omit the
quotee):
`* Browser: (br-inf). C++ Browser'
(make sure there is a newline at the end of the file). Save `dir' to
disk. You should now be able to select the browser documentation in
the Info browser of Emacs (`\C-h i).
--- end of file ---