|
100
|
1 # See "br-vers.el" for the OO-Browser lisp code directory entry.
|
|
0
|
2 #
|
|
|
3 # SUMMARY: OO-Browser overview and installation notes
|
|
|
4 #
|
|
|
5 # AUTHOR: Bob Weiner
|
|
|
6 #
|
|
100
|
7 # ORG: InfoDock Associates. We sell corporate support and development
|
|
|
8 # contracts for InfoDock, Emacs and XEmacs.
|
|
|
9 # E-mail: <info@infodock.com> Web: http://www.infodock.com
|
|
|
10 # Tel: +1 408-243-3300
|
|
|
11 #
|
|
70
|
12 # ORIG-DATE: 16-Jun-90
|
|
100
|
13 # LAST-MOD: 21-Feb-97 at 17:05:39 by Bob Weiner
|
|
24
|
14 #
|
|
100
|
15 # Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
|
|
0
|
16 # See the file BR-COPY for license information.
|
|
|
17 #
|
|
|
18 # This file is part of the OO-Browser.
|
|
|
19
|
|
|
20 ===========================================================================
|
|
|
21 * Table of Contents
|
|
|
22 ===========================================================================
|
|
|
23 * Files
|
|
|
24 * Mail Lists
|
|
|
25 * Installation / Configuration
|
|
|
26 * Invocation
|
|
|
27
|
|
|
28
|
|
|
29 ===========================================================================
|
|
|
30 * Files
|
|
|
31 ===========================================================================
|
|
|
32
|
|
|
33 See the "BR-COPY" file for copying and distribution information.
|
|
|
34
|
|
|
35 See the "BR-OBTAIN" file for information on obtaining the OO-Browser.
|
|
|
36
|
|
|
37 See the "MANIFEST" file for summaries of the OO-Browser files.
|
|
|
38
|
|
|
39 See the "BR-RELEASE" file for a summary of new features in this release.
|
|
|
40
|
|
|
41 See the "BR-FEATURES" file for a summary of OO-Browser features.
|
|
|
42
|
|
|
43 "man/oo-browser.info" and "man/oo-browser.texi" contain the Info and Texinfo
|
|
|
44 source versions of the OO-Browser User Manual.
|
|
|
45
|
|
|
46
|
|
|
47 ===========================================================================
|
|
|
48 * Mail Lists
|
|
|
49 ===========================================================================
|
|
|
50
|
|
100
|
51 <oo-browser@infodock.com> - mail list
|
|
|
52 <oo-browser-request@infodock.com> - add/change/delete requests
|
|
0
|
53
|
|
100
|
54 The oo-browser mail list is for public discussion, bug reports and feature
|
|
|
55 ideas concerning the OO-Browser multi-language code browser. If your
|
|
|
56 Emacs version supports menubars and popup menus, you can use the
|
|
|
57 Compose-Mail-to-List and Mail-List-Request menu items to access the mail
|
|
|
58 list and request address, respectively, when in the OO-Browser.
|
|
|
59
|
|
|
60 If you ask questions, you should consider adding to the discussion by
|
|
|
61 telling people the kinds of work you are doing or contemplating doing
|
|
|
62 with the OO-Browser. In this way, the list will not be overwhelmed by
|
|
|
63 messages that ask for, but provide no information.
|
|
0
|
64
|
|
|
65 ALL mail concerning administration of the OO-Browser mailing list should
|
|
|
66 be sent to the -request address. That includes addition, change, or
|
|
|
67 deletion requests. Don't EVER consider sending such a request to the
|
|
|
68 oo-browser mail list.
|
|
|
69
|
|
100
|
70 Use the following formats in the *body* of your message to execute requests,
|
|
|
71 where you substitute your own values for the <> delimited items and items
|
|
|
72 enclosed in [] are optional.
|
|
0
|
73
|
|
100
|
74 subscribe oo-browser [<your-email-address>]
|
|
|
75 or
|
|
|
76 unsubscribe oo-browser [<your-email-address>]
|
|
0
|
77
|
|
|
78 For example:
|
|
|
79
|
|
100
|
80 To: oo-browser-request@infodock.com
|
|
|
81 Subject: Used if a human happens to read your mail.
|
|
0
|
82
|
|
100
|
83 subscribe oo-browser joe@nowhere.gov
|
|
0
|
84
|
|
100
|
85 To change your address, you must unsubscribe your old address with
|
|
|
86 once command and subscribe your new address with another command, though
|
|
|
87 you can embed multiple commands on separate lines within a single message.
|
|
0
|
88
|
|
|
89
|
|
|
90 ===========================================================================
|
|
|
91 * Installation / Configuration
|
|
|
92 ===========================================================================
|
|
|
93
|
|
|
94 To install the OO-Browser:
|
|
|
95
|
|
|
96 If you have the Hyperbole system installed, you must be using
|
|
|
97 V3.18.4 or greater. Otherwise, you must upgrade. Get Hyperbole
|
|
100
|
98 from: "ftp://ftp.xemacs.org/pub/infodock". Get the h*
|
|
0
|
99 files in that directory. Once you have this version installed,
|
|
|
100 you can safely delete the oobr/hypb/ directory, which duplicates a
|
|
|
101 subset of the Hyperbole files to provide the OO-Browser with
|
|
|
102 context-sensitive keyboard and mouse keys. But then you must
|
|
|
103 make a symbolic link from your hyperbole directory to oobr/hypb,
|
|
|
104 so that the OO-Browser Makefile can see the Hyperbole files it needs.
|
|
|
105
|
|
|
106 Add the full path of either the Hyperbole code directory or the
|
|
100
|
107 "oobr/hypb/" subdirectory to your `load-path' variable.
|
|
0
|
108
|
|
100
|
109 You may want to change the settings of `c++-cpp-include-dirs'
|
|
|
110 and `c++-include-dirs' at the bottom of "br-site.el".
|
|
0
|
111
|
|
|
112 If you prefer to use some non-GNU Emacs editor such
|
|
|
113 as vi to view and edit your code, then modify to your taste the
|
|
|
114 settings in the br-setup-external function in "br-site.el" and add
|
|
|
115 the following line to your personal Emacs initialization file:
|
|
|
116 (add-hook 'br-mode-hook 'br-setup-external)
|
|
|
117
|
|
|
118 Add the following lines to your site autoload configuration, substituting
|
|
|
119 the correct full path for <OO-BROWSER-DIR>:
|
|
|
120
|
|
|
121 (defvar br-directory "<OO-BROWSER-DIR>/")
|
|
|
122 "Directory where the OO-Browser executable code is kept.
|
|
|
123 It must end with a directory separator character.")
|
|
|
124
|
|
|
125 (autoload 'oo-browser (expand-file-name "br-start" br-directory)
|
|
|
126 "Invoke the OO-Browser" t)
|
|
|
127 (autoload 'br-env-browse (expand-file-name "br-start" br-directory)
|
|
|
128 "Browse an existing OO-Browser Environment" t)
|
|
|
129
|
|
|
130 Add the following key binding to your site keys configuration:
|
|
|
131
|
|
|
132 (global-set-key "\C-c\C-o" 'oo-browser)
|
|
|
133
|
|
|
134
|
|
|
135 The OO-Browser's Emacs Lisp files are pre-byte-compiled for InfoDock,
|
|
|
136 Emacs 19 and XEmacs, so if you run one of these versions, when you use
|
|
|
137 make to build the OO-Browser, very few files will need to be built, so
|
|
|
138 your make will finish quickly.
|
|
|
139
|
|
|
140 Before doing your first make, edit the CONFIGURABLE SECTION in the
|
|
|
141 "Makefile". You must set the EMACS variable to point to the Emacs
|
|
|
142 executable that you want to use to byte-compile the OO-Browser Lisp
|
|
|
143 files. You may also have to set SITE-PRELOADS; follow the instructions
|
|
100
|
144 that precede the `SITE-PRELOADS =' line. Make these changes now and save
|
|
0
|
145 the Makefile.
|
|
|
146
|
|
|
147 If you are running Emacs V18 or Epoch, you must first rebuild all
|
|
|
148 byte-compiled Lisp files. Move to the oobr directory and use:
|
|
|
149 make all-elc
|
|
|
150
|
|
|
151 Then, whatever Emacs version you use, move to the oobr directory
|
|
|
152 and use:
|
|
|
153 make
|
|
|
154
|
|
|
155 Use these commands if you want to build graphical interfaces to
|
|
|
156 the OO-Browser:
|
|
|
157
|
|
|
158 If you want to build the X OO-Browser, you have to change some
|
|
|
159 of the variable settings at the top of the "tree-x/Makefile",
|
|
|
160 such as the BINDIR directory.
|
|
|
161
|
|
|
162 Once you have done that, use:
|
|
|
163 make xoobr
|
|
|
164 to build the X OO-Browser and then use:
|
|
|
165 make install
|
|
|
166 to install the executable for use.
|
|
|
167
|
|
|
168 If you want to rebuild the NEXTSTEP OO-Browser below the
|
|
|
169 "tree-nx" directory, you must use NeXT's ProjectBuilder. The
|
|
|
170 browser is pre-built for NEXTSTEP 3.0 on 68k NeXT machines.
|
|
|
171
|
|
|
172 To produce the Postscript version of the Hyperbole manual:
|
|
|
173 make ps
|
|
|
174
|
|
|
175 If you ever want to just rebuild out of data Lisp files, use:
|
|
|
176 make elc
|
|
|
177
|
|
|
178 The OO-Browser is now ready for use.
|
|
|
179
|
|
|
180
|
|
|
181 ===========================================================================
|
|
|
182 * Invocation
|
|
|
183 ===========================================================================
|
|
|
184
|
|
|
185 To invoke the OO-Browser, use:
|
|
|
186
|
|
|
187 {C-c C-o} or {M-x oo-browser RET}
|
