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