Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 270 lines (188 sloc) 9.743 kb
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
1 This is the INSTALL file of the IDLWAVE distribution, version VERSIONTAG
2
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
3 IDLWAVE has been developed and tested on Emacs >20.4 and XEmacs >21.1.
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
4
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
5 If you are using XEmacs 21, you might want to install the XEmacs
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
6 plugin package for idlwave which is available via the usual package
7 management process. You can then skip items (1)--(3) of this guide
06937cd - Note on fsf-compat.
jdsmith authored
8 and continue directly with item (4). For XEmacs, you will also need
9 to install the fsf-compat package which is often, but not always,
10 bundled with the XEmacs distribution.
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
11
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
12 If you are using Emacs 21, IDLWAVE is installed with Emacs. You could
13 then skip items (1)--(3) of this guide and continue directly with item
14 (4), but then you'd miss out on the newest features.
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
15
16
17 0. THE FAST ROAD
18 ================
19
20 On a typical UNIX system, installation goes as easy as:
21
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
22 Get these following file:
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
23
24 http://idlwave.org/download/idlwave.tar.gz
25
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
26 Standard Source Package (for either GNU Emacs or XEmacs):
27 ---------------------------------------------------------------------------
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
28 Put them in /tmp (or anywhere), then do (as root):
29
30 % tar xzvf idlwave.tar.gz
31 % cd idlwave-version
32 % make
33 % make install-all
34
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
35 where "version" is something like 5.0. This by default puts idlwave
36 in /usr/local/share/emacs/site-lisp/, which is a fine place.
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
37
7f3a88f *** empty log message ***
jdsmith authored
38 HTML Help packages
39 ---------------------------------------------------------------------------
40
f9fe124 - Minor re-wording, and adding IDL 6.2 "no help needed".
jdsmith authored
41 As of IDL 6.2 and IDLWAVE 6.0, all HTML help is provided by default
42 with your installation of IDL, and nothing further needs to be
43 installed. For systems older than IDL 6.2, HTML help can be installed
44 separately.
45
7f3a88f *** empty log message ***
jdsmith authored
46 Note that you do *not* need to update your help package with each
47 version of IDLWAVE, but only when you change IDL versions -- there is
f9fe124 - Minor re-wording, and adding IDL 6.2 "no help needed".
jdsmith authored
48 only one help package per IDL version (v5.6-v6.1).
7f3a88f *** empty log message ***
jdsmith authored
49
50 To install the HTML Help (needed for context-aware online help), get:
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
51
52 http://idlwave.org/download/idlwave-help.tar.bz2
53
54 and
55
56 % cd idlwave-version
57 % mv /path/to/idlwave-help.tar.bz2 .
58 % make install-help
59
7f3a88f *** empty log message ***
jdsmith authored
60 This simply puts the help files in /usr/local/etc (you can unpack it
61 there yourself, if you prefer).
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
62
63 N.B. Windows users do not need the help package to use online help.
64
99a8c34 *** empty log message ***
jdsmith authored
65 Setting up the package
66 ---------------------------------------------------------------------------
67
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
68 Add the following to .emacs or to a site equivalent:
69
70 ;; This is only necessary if the default install directory is not on
71 ;; your Emacs "load-path":
72 (setq load-path (cons "/usr/local/share/emacs/site-lisp" load-path))
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
73
74 (autoload 'idlwave-mode "idlwave" "IDLWAVE Mode" t)
75 (autoload 'idlwave-shell "idlw-shell" "IDLWAVE Shell" t)
76 (setq auto-mode-alist
77 (cons '("\\.pro\\'" . idlwave-mode) auto-mode-alist))
78
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
79 The rest of this file is just an extensive description of these steps,
80 with explanation of the options you have and how to change the defaults.
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
81
82
83 1. SELECTING A DIRECTORY TO INSTALL THE FILES
84 =============================================
85
86 In order to install Emacs Lisp files, you need access to a directory
87 which will be searched by Emacs for these files.
88
89 - If you are installing IDLWAVE for all users on the system, then you
90 should use the "..../emacs/site-lisp" directory.
91
92 - If you want to install the package just for yourself, make a
93 directory to contain your private lisp files, for example
94 "~/lib/emacs/lisp". Then tell Emacs to look also into this directory
95 by putting the following line into your .emacs file.
96
97 (setq load-path (cons "~/lib/emacs/lisp" load-path))
98
fd5bec6 - Discuss INFOPATH.
jdsmith authored
99 Note that, since most Emacs ship with an older copy of idlwave (and
100 its info file), you will need to use an info directory which is early
101 on the info path list (defaults to /usr/local/info). Under OSX, with
102 fink, the info path is hard coded via the environment variable
103 INFOPATH to begin with /sw/share/info, which contains the old info
104 file. Either remove it there, or do the equivalent of:
105
106 setenv INFOPATH "/usr/local/info:$INFOPATH"
107
108 in your startup scripts.
109
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
110
111 2a. INSTALLATION BY HAND
112 ========================
113
114 In order to install IDLWAVE by hand, put the files `idlwave.el',
f9fe124 - Minor re-wording, and adding IDL 6.2 "no help needed".
jdsmith authored
115 `idlw-rinfo.el' (if in the distribution), `idlw-shell.el',
116 `idlw-help.el', and `idlw-toolbar.el', and, optionally,
117 `idlw-roprompt.el' and `idlw-complete-structtag.el' into the chosen
118 load-path directory and byte-compile them (from within Emacs, execute
119 `M-x byte-compile-file' followed by the name of the Lisp files). You
120 can ignore the warnings produced by the byte compiler.
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
121
fd5bec6 - Discuss INFOPATH.
jdsmith authored
122 Copy the info file `idlwave' into the directory where Emacs info files
123 are kept and (optionally) add an entry to the `dir' file.
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
124
125 2b. INSTALLATION USING MAKE
126 ===========================
127
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
128 In order to install IDLWAVE with the make utility, examine the header
f9fe124 - Minor re-wording, and adding IDL 6.2 "no help needed".
jdsmith authored
129 of the file `Makefile', and change any default directory locations as
130 necessary. You need to specify the Lisp installation directory and
131 the directory where the Info files are installed (see note under 2a).
132 Also, check the name of the Emacs executable (usually either `emacs'
133 or `xemacs').
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
134
135 Then, type
136
137 make
138 make install
139 make install-info
f9fe124 - Minor re-wording, and adding IDL 6.2 "no help needed".
jdsmith authored
140
141 and, for manually installed HTML help (only necessary with IDL 6.1 or
142 earlier):
143
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
144 make install-help
145
146 to compile and install the code, the info files, and the HTML help (if
f9fe124 - Minor re-wording, and adding IDL 6.2 "no help needed".
jdsmith authored
147 installing or updating it). Note that the help installation requires
148 downloading the separate help package, and needs to be performed only
149 when your version of IDL changes, and is unnecessary starting with IDL
150 v6.2.
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
151
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
152
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
153 2c. PRE-BUILT XEMACS PACKAGE
154 ============================
155
156 You can also opt to install a pre-compiled XEmacs binary package (help
157 not included). Get:
158
159 http://idlwave.org/download/idlwave-xemacs.tar.gz
160
161 instead of idlwave.tar.gz, and simply execute, in an XEmacs run by a
162 user who can write to the package directories (e.g. root if it's a
163 system-wide installation):
164
165 M-x package-admin-add-binary-package [Ret] /path/to/idlwave-xemacs.tar.gz
166
f9fe124 - Minor re-wording, and adding IDL 6.2 "no help needed".
jdsmith authored
167 Note that if you install IDLWAVE by hand under XEmacs, you need to
168 ensure that the following XEmacs packages are also installed:
169
170 fsf-compat xemacs-base mail-lib
171
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
172 See INSTALLING ONLINE HELP below for information on adding the online
173 help package to your installation.
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
174
175
176 3. SETTING UP EMACS TO USE IDLWAVE
177 ==================================
178
179 Copy the following lines into your .emacs file:
180
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
181 (autoload 'idlwave-mode "idlwave" "IDLWAVE Mode" t)
182 (autoload 'idlwave-shell "idlw-shell" "IDLWAVE Shell" t)
183 (setq auto-mode-alist (cons '("\\.pro\\'" . idlwave-mode) auto-mode-alist))
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
184
185
186 4. INITIALIZING FONT-LOCK
187 =========================
188
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
189 If you are using global-font-lock-mode (with (global-font-lock-mode 1)
190 at the beginning of your .emacs) , fontification (a.k.a. chromacoding)
191 of IDLWAVE buffers will be automatic. If you'd prefer font-lock to be
192 on only for idlwave mode, add the following to .emacs:
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
193
194 (add-hook 'idlwave-mode-hook 'turn-on-font-lock)
195
196 The level of colorization can be controlled with the variable
197 `font-lock-maximum-decoration'.
198
199
7f3a88f *** empty log message ***
jdsmith authored
200 6. YOU ARE DONE WITH THE REQUIRED STEPS
201 =======================================
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
202
203 IDLWAVE has online documentation in Info format. To view this
204 information, use `M-x idlwave-info' or follow the Menu entry in the
205 IDLWAVE menu. You can also convert the documentation into Postscript
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
206 with `make ps', HTML with `make html', and PDF with "make pdf' in the
7f3a88f *** empty log message ***
jdsmith authored
207 source directory, or download the manual in one of these formats from
208 idlwave.org.
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
209
210 -------------------------------------------------------------------------
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
211 OPTIONAL STEPS
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
212
213 7. INSTALLING ONLINE HELP
214 =========================
215
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
216 N.B. THE HELP PACKAGE ONLY NEEDS TO BE UPDATED WHEN NEW VERSIONS OF
217 IDL ARE RELEASED AND THE DOCUMENTATION IS SCANNED. IDLWAVE CAN BE
f9fe124 - Minor re-wording, and adding IDL 6.2 "no help needed".
jdsmith authored
218 UPDATED SEPARATELY.
219
220 AS OF IDL v6.2, NO ADDITIONAL HELP PACKAGES NEED TO BE INSTALLED,
221 SINCE ALL NECESSARY HELP FILES ARE PROVIDED WITH IDL.
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
222
223 If you want IDLWAVE to display online help for built-in IDL routines,
224 you need the HTML version of the IDL documentation. This package is
225 only updated when new IDL releases come out. You can download the
226 package from the IDLWAVE website.
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
227
228 INSTALL BY HAND
229 ---------------
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
230 Unpack the `idlwave-help.tar.bz2' file file into an appropriate
231 directory (/usr/local/etc is the default place it's looked for).
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
232
233 INSTALL USING MAKE
234 ------------------
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
235 Move`idlwave-help.tar.bz2' into the same directory where the
236 IDLWAVE distribution is located. Edit the header of the
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
237 Makefile to make sure the variable "helpdir" is set correctly.
238 Then, type:
239
240 make install-help
241
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
242 Now all you have to do is to tell IDLWAVE where the help files are
243 located with
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
244
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
245 (setq idlwave-html-help-location "/path/to/help/files/")
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
246
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
247 in your .emacs file ("/usr/local/etc" is the default). Alternatively,
7f3a88f *** empty log message ***
jdsmith authored
248 you can just set the environment variable IDLWAVE_HELP_LOCATION.
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
249
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
250 If you have an older version of IDL than is supported by the current
251 IDLWAVE, you can install a "downgrade kit", which provides the older
252 version's routine info and HTML help files. See http://idlwave.org.
253
254 The IDL documentation is copyright by Research Systems, Inc. This
255 HTML version can be distributed for the purpose of supporting the
256 Emacs IDLWAVE mode. Please see the documentation for the copyright
257 notice by RSI.
c8115d3 Initial seed of IDLWAVE v4.10
jdsmith authored
258
259 8. SCANNING THE LOCAL IDL LIBRARY
260 =================================
261
262 If you would like to use routine information and completion for
1a1c612 - Updated to IDLWAVE v5.0, including electric-debug mode, HTML help,
jdsmith authored
263 routines in your local and private IDL libraries, they have to be
7f3a88f *** empty log message ***
jdsmith authored
264 scanned into catalogs. Some popular libraries come pre-scanned (look
265 for .idlwave_catalog files). To scan your own libraries, you have two
266 choices: use the Perl script `idlwave_catalog' to create your own
267 library catalog files (the preferred way), and/or create a user
268 catalog of your routines within Emacs. See the manual for more
269 information.
Something went wrong with that request. Please try again.