Mercurial > hg > xemacs-beta

comparison lisp/oobr/BR-README @ 100:4be1180a9e89 r20-1b2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r20-1b2
author cvs
date Mon, 13 Aug 2007 09:15:11 +0200
parents 131b0175ea99
children
comparison
equal deleted inserted replaced
99:2d83cbd90d8d 100:4be1180a9e89
1 # See "br-vers.el" for the OO-Browser Lisp Code Directory information. 1 # See "br-vers.el" for the OO-Browser lisp code directory entry.
2 # 2 #
3 # SUMMARY: OO-Browser overview and installation notes 3 # SUMMARY: OO-Browser overview and installation notes
4 # 4 #
5 # AUTHOR: Bob Weiner 5 # AUTHOR: Bob Weiner
6 # 6 #
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 #
7 # ORIG-DATE: 16-Jun-90 12 # ORIG-DATE: 16-Jun-90
8 # LAST-MOD: 3-May-96 at 20:45:00 by Harri Pasanen 13 # LAST-MOD: 21-Feb-97 at 17:05:39 by Bob Weiner
9 # 14 #
10 # Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996 Free Software Foundation, Inc. 15 # Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
11 # See the file BR-COPY for license information. 16 # See the file BR-COPY for license information.
12 # 17 #
13 # This file is part of the OO-Browser. 18 # This file is part of the OO-Browser.
14 19
15 =========================================================================== 20 ===========================================================================
41 46
42 =========================================================================== 47 ===========================================================================
43 * Mail Lists 48 * Mail Lists
44 =========================================================================== 49 ===========================================================================
45 50
46 <oo-browser@hub.ucsb.edu> - mail list 51 <oo-browser@infodock.com> - mail list
47 <oo-browser-request@hub.ucsb.edu> - administrative requests 52 <oo-browser-request@infodock.com> - add/change/delete requests
48 53
49 The oo-browser mail list is for discussion, bug reports and feature 54 The oo-browser mail list is for public discussion, bug reports and feature
50 requests concerning the OO-Browser multi-language code browser. 55 ideas concerning the OO-Browser multi-language code browser. If your
51 If your Emacs version supports menubars and popup menus, you can use the 56 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 57 Compose-Mail-to-List and Mail-List-Request menu items to access the mail
53 mail list and administrative address, respectively, when in the OO-Browser. 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.
54 64
55 ALL mail concerning administration of the OO-Browser mailing list should 65 ALL mail concerning administration of the OO-Browser mailing list should
56 be sent to the -request address. That includes addition, change, or 66 be sent to the -request address. That includes addition, change, or
57 deletion requests. Don't EVER consider sending such a request to the 67 deletion requests. Don't EVER consider sending such a request to the
58 oo-browser mail list. 68 oo-browser mail list.
59 69
60 Use the following formats on your subject line to execute requests, 70 Use the following formats in the *body* of your message to execute requests,
61 where you substitute your own values for the <> delimited items. 71 where you substitute your own values for the <> delimited items and items
72 enclosed in [] are optional.
62 73
63 Subject: Subscribe '<' <user@domain> '>' (<your name>). 74 subscribe oo-browser [<your-email-address>]
64 Subject: Unsubscribe '<' <user@domain> '>'. 75 or
65 76 unsubscribe oo-browser [<your-email-address>]
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 77
69 For example: 78 For example:
70 79
71 To: oo-browser-request@hub.ucsb.edu 80 To: oo-browser-request@infodock.com
72 Subject: Unsubscribe <joe@any.com>. 81 Subject: Used if a human happens to read your mail.
73 82
74 To: oo-browser-request@hub.ucsb.edu 83 subscribe oo-browser joe@nowhere.gov
75 Subject: Subscribe <joe@any.com> (Joe Williams).
76 84
77 If you ask questions, you should consider adding to the discussion by 85 To change your address, you must unsubscribe your old address with
78 telling people the kinds of work you are doing or contemplating doing 86 once command and subscribe your new address with another command, though
79 with the OO-Browser. In this way, the list will not be overwhelmed by 87 you can embed multiple commands on separate lines within a single message.
80 messages that ask for, but provide no information.
81 88
82 89
83 =========================================================================== 90 ===========================================================================
84 * Installation / Configuration 91 * Installation / Configuration
85 =========================================================================== 92 ===========================================================================
86 93
87 To install the OO-Browser: 94 To install the OO-Browser:
88 95
89 If you have the Hyperbole system installed, you must be using 96 If you have the Hyperbole system installed, you must be using
90 V3.18.4 or greater. Otherwise, you must upgrade. Get Hyperbole 97 V3.18.4 or greater. Otherwise, you must upgrade. Get Hyperbole
91 from: /anonymous@ftp.xemacs.org:/pub/infodock. Get the h* 98 from: "ftp://ftp.xemacs.org/pub/infodock". Get the h*
92 files in that directory. Once you have this version installed, 99 files in that directory. Once you have this version installed,
93 you can safely delete the oobr/hypb/ directory, which duplicates a 100 you can safely delete the oobr/hypb/ directory, which duplicates a
94 subset of the Hyperbole files to provide the OO-Browser with 101 subset of the Hyperbole files to provide the OO-Browser with
95 context-sensitive keyboard and mouse keys. But then you must 102 context-sensitive keyboard and mouse keys. But then you must
96 make a symbolic link from your hyperbole directory to oobr/hypb, 103 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. 104 so that the OO-Browser Makefile can see the Hyperbole files it needs.
98 105
99 Add the full path of either the Hyperbole code directory or the 106 Add the full path of either the Hyperbole code directory or the
100 "oobr/hypb/" subdirectory to your 'load-path' variable. 107 "oobr/hypb/" subdirectory to your `load-path' variable.
101 108
102 You may want to change the settings of 'c++-cpp-include-dirs' 109 You may want to change the settings of `c++-cpp-include-dirs'
103 and 'c++-include-dirs' at the bottom of "br-site.el". 110 and `c++-include-dirs' at the bottom of "br-site.el".
104 111
105 If you prefer to use some non-GNU Emacs editor such 112 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 113 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 114 settings in the br-setup-external function in "br-site.el" and add
108 the following line to your personal Emacs initialization file: 115 the following line to your personal Emacs initialization file:
122 129
123 Add the following key binding to your site keys configuration: 130 Add the following key binding to your site keys configuration:
124 131
125 (global-set-key "\C-c\C-o" 'oo-browser) 132 (global-set-key "\C-c\C-o" 'oo-browser)
126 133
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 134
140 The OO-Browser's Emacs Lisp files are pre-byte-compiled for InfoDock, 135 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 136 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 137 make to build the OO-Browser, very few files will need to be built, so
143 your make will finish quickly. 138 your make will finish quickly.
144 139
145 Before doing your first make, edit the CONFIGURABLE SECTION in the 140 Before doing your first make, edit the CONFIGURABLE SECTION in the
146 "Makefile". You must set the EMACS variable to point to the Emacs 141 "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 142 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 143 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 144 that precede the `SITE-PRELOADS =' line. Make these changes now and save
150 the Makefile. 145 the Makefile.
151 146
152 If you are running Emacs V18 or Epoch, you must first rebuild all 147 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: 148 byte-compiled Lisp files. Move to the oobr directory and use:
154 make all-elc 149 make all-elc