aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman2005-03-24 14:00:41 +0000
committerRichard M. Stallman2005-03-24 14:00:41 +0000
commit215a5cd026c15226ac2f00b123b6776feb1521dd (patch)
tree89b6ca575a7efeb8a3c7cf3234be733a92782088
parent5e2b0a66e90341e31f3d7aa78ef429e4128e303b (diff)
downloademacs-215a5cd026c15226ac2f00b123b6776feb1521dd.tar.gz
emacs-215a5cd026c15226ac2f00b123b6776feb1521dd.zip
Don't say where to get IDL or its non-free manual.
(Installation): Node deleted.
-rw-r--r--man/idlwave.texi172
1 files changed, 48 insertions, 124 deletions
diff --git a/man/idlwave.texi b/man/idlwave.texi
index 42b3bea4034..4082c42e970 100644
--- a/man/idlwave.texi
+++ b/man/idlwave.texi
@@ -19,7 +19,6 @@
19@set AUTHOR-EMAIL jdsmith@@as.arizona.edu 19@set AUTHOR-EMAIL jdsmith@@as.arizona.edu
20@set MAINTAINER J.D. Smith 20@set MAINTAINER J.D. Smith
21@set MAINTAINER-EMAIL jdsmith@@as.arizona.edu 21@set MAINTAINER-EMAIL jdsmith@@as.arizona.edu
22@set IDLWAVE-HOMEPAGE http://idlwave.org/
23@c %**end of header 22@c %**end of header
24@finalout 23@finalout
25 24
@@ -101,7 +100,6 @@ Interactive Data Language (IDL), and running IDL as an inferior shell.
101* Getting Started:: Tutorial 100* Getting Started:: Tutorial
102* The IDLWAVE Major Mode:: The mode for editing IDL programs 101* The IDLWAVE Major Mode:: The mode for editing IDL programs
103* The IDLWAVE Shell:: The mode for running IDL as an inferior program 102* The IDLWAVE Shell:: The mode for running IDL as an inferior program
104* Installation:: How to Install or Upgrade
105* Acknowledgements:: Who did what 103* Acknowledgements:: Who did what
106* Sources of Routine Info:: How does IDLWAVE know about routine XYZ 104* Sources of Routine Info:: How does IDLWAVE know about routine XYZ
107* HTML Help Browser Tips:: 105* HTML Help Browser Tips::
@@ -180,11 +178,6 @@ Debugging IDL Programs
180* Walking the Calling Stack:: 178* Walking the Calling Stack::
181* Electric Debug Mode:: 179* Electric Debug Mode::
182 180
183Installation
184
185* Installing IDLWAVE:: How to install the distribution
186* Installing Online Help:: Where to get the additional files needed
187
188Sources of Routine Info 181Sources of Routine Info
189 182
190* Routine Definitions:: Where IDL Routines are defined. 183* Routine Definitions:: Where IDL Routines are defined.
@@ -204,8 +197,6 @@ Catalogs
204@node Introduction, IDLWAVE in a Nutshell, Top, Top 197@node Introduction, IDLWAVE in a Nutshell, Top, Top
205@chapter Introduction 198@chapter Introduction
206@cindex Introduction 199@cindex Introduction
207@cindex CORBA (Common Object Request Broker Architecture)
208@cindex Interface Definition Language
209@cindex Interactive Data Language 200@cindex Interactive Data Language
210@cindex cc-mode.el 201@cindex cc-mode.el
211@cindex @file{idl.el} 202@cindex @file{idl.el}
@@ -213,14 +204,13 @@ Catalogs
213@cindex Feature overview 204@cindex Feature overview
214 205
215IDLWAVE is a package which supports editing source files written in 206IDLWAVE is a package which supports editing source files written in
216the Interactive Data Language (IDL@footnote{IDL is a registered 207the Interactive Data Language, and running
217trademark of Research Systems, Inc., a Kodak Company}), and running
218IDL as an inferior shell@footnote{Note that this package has nothing 208IDL as an inferior shell@footnote{Note that this package has nothing
219to do with the Interface Definition Language, part of the Common 209to do with the Interface Definition Language, part of the Common
220Object Request Broker Architecture (CORBA)}@footnote{IDLWAVE can also 210Object Request Broker Architecture (CORBA)}@footnote{IDLWAVE can also
221be used for editing source files for the related WAVE/CL language, but 211be used for editing source files for the related WAVE/CL language, but
222with only limited support.}. It is a feature-rich replacement for the 212with only limited support.}. It is a feature-rich replacement for the
223IDLDE development environment bundled with IDL, and uses the full 213IDLDE development environment included with IDL, and uses the full
224power of Emacs to make editing and running IDL programs easier, 214power of Emacs to make editing and running IDL programs easier,
225quicker, and more structured. 215quicker, and more structured.
226 216
@@ -421,11 +411,10 @@ be discovered by reading the entire manual, or hovering over the
421shoulder of your nearest IDLWAVE guru for a few days. 411shoulder of your nearest IDLWAVE guru for a few days.
422 412
423It is assumed that you have access to Emacs or XEmacs with the full 413It is assumed that you have access to Emacs or XEmacs with the full
424IDLWAVE package including online help (@pxref{Installation}). We also 414IDLWAVE package including online help. We also assume that you are
425assume that you are familiar with Emacs and can read the nomenclature of 415familiar with Emacs and can read the nomenclature of key presses in
426key presses in Emacs (in particular, @kbd{C} stands for @key{CONTROL} 416Emacs (in particular, @kbd{C} stands for @key{CONTROL} and @kbd{M} for
427and @kbd{M} for @key{META} (often the @key{ALT} key carries this 417@key{META} (often the @key{ALT} key carries this functionality)).
428functionality)).
429 418
430Open a new source file by typing: 419Open a new source file by typing:
431 420
@@ -612,9 +601,8 @@ restart Emacs.
612 601
613You likely have your own indentation preferences for IDL code. For 602You likely have your own indentation preferences for IDL code. For
614example, some like to indent the main block of an IDL program from the 603example, some like to indent the main block of an IDL program from the
615margin, different from the conventions used by RSI, and use only 3 604margin and use only 3 spaces as indentation between @code{BEGIN} and
616spaces as indentation between @code{BEGIN} and @code{END}. Try the 605@code{END}. Try the following lines in @file{.emacs}:
617following lines in @file{.emacs}:
618 606
619@lisp 607@lisp
620(setq idlwave-main-block-indent 2) 608(setq idlwave-main-block-indent 2)
@@ -1279,19 +1267,18 @@ Maximum number of source files displayed in the Routine Info window.
1279@cindex Online Help, Installation 1267@cindex Online Help, Installation
1280@cindex Speed, of online help 1268@cindex Speed, of online help
1281 1269
1282For IDL system routines, RSI provides extensive documentation. 1270IDLWAVE can display help from an HTML version of the IDL documentation
1283IDLWAVE can access an HTML version of this documentation very quickly 1271if it is available. This is @emph{much} faster than using the IDL
1284and accurately. This is @emph{much} faster than using the IDL online 1272online help application, because IDLWAVE usually gets you to the right
1285help application, because IDLWAVE usually gets you to the right place 1273place in the documentation directly --- e.g. a specific keyword of a
1286in the documentation directly --- e.g. a specific keyword of a routine 1274routine --- without any additional browsing and scrolling. There are
1287--- without any additional browsing and scrolling. For this online 1275a variety of options for displaying the HTML help: see below. Help
1288help to work, an HTML version of the IDL documentation, which is not 1276for routines without HTML documentation is also available, using the
1289part of the standalone IDLWAVE distribution, is required. The 1277routine documentation header and/or source.
1290necessary files can be downloaded from @uref{@value{IDLWAVE-HOMEPAGE}, 1278
1291the maintainers webpage}. There are a variety of options for 1279To make this feature work, you should set
1292displaying the HTML help: see below. Help for routines without HTML 1280@code{idlwave-html-help-location} to the directory name of the
1293documentation is also available, using the routine documentation 1281directory where the IDL help files are installed.
1294header and/or source.
1295 1282
1296@kindex M-? 1283@kindex M-?
1297In any IDL program (or, as with most IDLWAVE commands, in the IDL 1284In any IDL program (or, as with most IDLWAVE commands, in the IDL
@@ -1376,19 +1363,19 @@ sent to. This function is used to set the variable
1376Customize this variable to see what choices of browsers your system 1363Customize this variable to see what choices of browsers your system
1377offers. 1364offers.
1378 1365
1379Certain browsers like @code{w3} (bundled with many versions of Emacs) 1366Certain browsers like @code{w3} and @code{w3m}
1380and @code{w3m} (@uref{http://emacs-w3m.namazu.org/}, the author's help 1367(@uref{http://emacs-w3m.namazu.org/}, the author's help browser of
1381browser of choice) are run within Emacs, and use Emacs buffers to 1368choice) are run within Emacs, and use Emacs buffers to display the
1382display the HTML help. This can be convenient, especially on small 1369HTML help. This can be convenient, especially on small displays, and
1383displays, and images can even be displayed in-line on new Emacs 1370images can even be displayed in-line on new Emacs versions. However,
1384versions. However, better formatting results are often achieved with 1371better formatting results are often achieved with external browsers,
1385external browsers, like Mozilla. IDLWAVE assumes any browser function 1372like Mozilla. IDLWAVE assumes any browser function containing "w3" is
1386containing "w3" is displayed in a local buffer. If you are using 1373displayed in a local buffer. If you are using another Emacs-local
1387another Emacs-local browser for which this is not true, set the 1374browser for which this is not true, set the variable
1388variable @code{idlwave-help-browser-is-local}. 1375@code{idlwave-help-browser-is-local}.
1389 1376
1390@emph{N.B. For Windows users}: IDLWAVE can bring up RSI help directly 1377@emph{N.B. For Windows users}: IDLWAVE can bring up help directly
1391in the Microsoft HTMLHelp documentation supplied with IDL: no 1378from the Microsoft HTMLHelp documentation supplied with IDL: no
1392additional help files are needed. Be sure to set 1379additional help files are needed. Be sure to set
1393@code{idlwave-system-directory} and the help file will be found 1380@code{idlwave-system-directory} and the help file will be found
1394automatically (or, alternatively, specify its location directly with 1381automatically (or, alternatively, specify its location directly with
@@ -2343,7 +2330,7 @@ Normal hook. Executed when @file{idlwave.el} is loaded.
2343 2330
2344 2331
2345 2332
2346@node The IDLWAVE Shell, Installation, The IDLWAVE Major Mode, Top 2333@node The IDLWAVE Shell, Acknowledgements, The IDLWAVE Major Mode, Top
2347@chapter The IDLWAVE Shell 2334@chapter The IDLWAVE Shell
2348@cindex IDLWAVE shell 2335@cindex IDLWAVE shell
2349@cindex Major mode, @code{idlwave-shell-mode} 2336@cindex Major mode, @code{idlwave-shell-mode}
@@ -3209,59 +3196,7 @@ examine command strings to send, after all instances of @code{___}
3209@end defopt 3196@end defopt
3210 3197
3211 3198
3212@node Installation, Acknowledgements, The IDLWAVE Shell, Top 3199@node Acknowledgements, Sources of Routine Info, The IDLWAVE Shell, Top
3213@chapter Installation
3214@cindex Installation
3215
3216@menu
3217* Installing IDLWAVE:: How to install the distribution
3218* Installing Online Help:: Where to get the additional files needed
3219@end menu
3220
3221@node Installing IDLWAVE, Installing Online Help, Installation, Installation
3222@section Installing IDLWAVE
3223
3224@cindex FTP site
3225@cindex URL, homepage for IDLWAVE
3226@cindex Homepage for IDLWAVE
3227@cindex IDLWAVE, homepage
3228@cindex XEmacs package IDLWAVE
3229@cindex Emacs, distributed with IDLWAVE
3230@cindex Copyright, of IDL manual
3231IDLWAVE is part of Emacs 21.1 and later. It is also an XEmacs package
3232and can be installed from
3233@uref{ftp://ftp.xemacs.org/pub/xemacs/packages/,the XEmacs ftp site}
3234with the normal package management system on XEmacs 21. These
3235pre-installed versions should work out-of-the-box. However, the HTML
3236files required for online HTML help are not distributed with
3237XEmacs/Emacs and have to be installed separately@footnote{Due to
3238copyright reasons, the HTML version of the IDL manual cannot be
3239distributed under the GPL.} (@pxref{Installing Online Help}).
3240
3241You can also download IDLWAVE and install it yourself from
3242@uref{@value{IDLWAVE-HOMEPAGE}, the maintainers webpage}. Follow the
3243instructions in the INSTALL file.
3244
3245@node Installing Online Help, , Installing IDLWAVE, Installation
3246@section Installing Online Help
3247@cindex Installing online help
3248@cindex Online Help, Installation
3249
3250If you want to use the online help display, an additional set of files
3251(HTML versions of the IDL documentation) must be installed. These
3252files can also be downloaded from @uref{@value{IDLWAVE-HOMEPAGE}, the
3253maintainers webpage}. You need to place the files somewhere on your
3254system and tell IDLWAVE where they are with
3255
3256@lisp
3257(setq idlwave-html-help-location "/path/to/help/dir/") ;e.g. /usr/local/etc
3258@end lisp
3259
3260Note that the help package only changes with new versions of the IDL
3261documentation, and need not be updated unless your version of IDL
3262changes.
3263
3264@node Acknowledgements, Sources of Routine Info, Installation, Top
3265@chapter Acknowledgements 3200@chapter Acknowledgements
3266@cindex Acknowledgements 3201@cindex Acknowledgements
3267@cindex Maintainer, of IDLWAVE 3202@cindex Maintainer, of IDLWAVE
@@ -3731,10 +3666,7 @@ IDLWAVE derives its knowledge about system routines from the IDL
3731manuals. The file @file{idlw-rinfo.el} contains the routine information 3666manuals. The file @file{idlw-rinfo.el} contains the routine information
3732for the IDL system routines, and links to relevant sections of the HTML 3667for the IDL system routines, and links to relevant sections of the HTML
3733documentation. The Online Help feature of IDLWAVE requires HTML 3668documentation. The Online Help feature of IDLWAVE requires HTML
3734versions of the IDL manuals to be available; the HTML documentation is 3669versions of the IDL manuals to be available.
3735not distributed with IDLWAVE by default, but must be downloaded
3736separately from the @uref{@value{IDLWAVE-HOMEPAGE}, the maintainers
3737webpage}.
3738 3670
3739The HTML files and related images can be produced from the 3671The HTML files and related images can be produced from the
3740@file{idl.chm} HTMLHelp file distributed with IDL using the free 3672@file{idl.chm} HTMLHelp file distributed with IDL using the free
@@ -3755,22 +3687,19 @@ the online HTML help available with IDLWAVE (starting with version
37555.0). Since IDLWAVE runs on a many different system types, a single 36875.0). Since IDLWAVE runs on a many different system types, a single
3756browser configuration is not possible, but choices abound. 3688browser configuration is not possible, but choices abound.
3757 3689
3758On many systems, the default browser configured in 3690Unfortunately, the HTML manuals decompiled from the original
3759@code{browse-url-browser-function}, and hence inherited by default by 3691source contain formatting structures which Netscape 4.x does not
3760@code{idlwave-help-browser-function}, is Netscape. Unfortunately, the 3692handle well, though they are still readable. A much better choice is
3761HTML manuals decompiled from the original RSI source contain 3693Mozilla, or one of the Mozilla-derived browsers such as
3762formatting structures which Netscape 4.x does not handle well, though 3694@uref{http://galeon.sourceforge.net/,Galeon} (GNU/Linux),
3763they are still readable. A much better choice is Mozilla, or one of
3764the Mozilla-derived browsers such as
3765@uref{http://galeon.sourceforge.net/,Galeon} (Linux),
3766@uref{http://www.mozilla.org/projects/camino/,Camino} (MacOSX), or 3695@uref{http://www.mozilla.org/projects/camino/,Camino} (MacOSX), or
3767@uref{http://www.mozilla.org/projects/firebird/,Firebird} (all 3696@uref{http://www.mozilla.org/projects/firebird/,Firebird} (all
3768platforms). Newer versions of Emacs provide a browser-function choice 3697platforms). Newer versions of Emacs provide a browser-function choice
3769@code{browse-url-gnome-moz} which uses the Gnome-configured browser. 3698@code{browse-url-gnome-moz} which uses the Gnome-configured browser.
3770 3699
3771Note that the HTML files decompiled from RSI Microsoft Help sources 3700Note that the HTML files decompiled from Microsoft Help sources
3772contain specific references to the @samp{Symbol} font, which by default 3701contain specific references to the @samp{Symbol} font, which by default
3773is not permitted in normal encodings (it's technically illegal). Though 3702is not permitted in normal encodings (it's invalid, technically). Though
3774it only impacts a few symbols, you can trick Mozilla-based browsers into 3703it only impacts a few symbols, you can trick Mozilla-based browsers into
3775recognizing @samp{Symbol} by following the directions 3704recognizing @samp{Symbol} by following the directions
3776@uref{http://hutchinson.belmont.ma.us/tth/Xfonts.html, here}. With this 3705@uref{http://hutchinson.belmont.ma.us/tth/Xfonts.html, here}. With this
@@ -3995,12 +3924,9 @@ IDLWAVE was developed on a UNIX system. However, thanks to the
3995portability of Emacs, much of IDLWAVE does also work under different 3924portability of Emacs, much of IDLWAVE does also work under different
3996operating systems like Windows (with NTEmacs or NTXEmacs) or MacOS. 3925operating systems like Windows (with NTEmacs or NTXEmacs) or MacOS.
3997 3926
3998The only real problem is that RSI does not provide a command-line 3927The only real problem is that there is no command-line
3999version of IDL for Windows or MacOS(<=9) with which IDLWAVE can 3928version of IDL for Windows or MacOS(<=9) with which IDLWAVE can
4000interact@footnote{Call your RSI representative and complain --- it 3929interact. As a result, the IDLWAVE Shell
4001should be trivial for them to provide one. And if enough people ask for
4002it, maybe they will. The new MacOSX version of IDL @emph{does} have a
4003shell and works well with IDLWAVE.}. As a result, the IDLWAVE Shell
4004does not work and you have to rely on IDLDE to run and debug your 3930does not work and you have to rely on IDLDE to run and debug your
4005programs. However, editing IDL source files with Emacs/IDLWAVE works 3931programs. However, editing IDL source files with Emacs/IDLWAVE works
4006with all bells and whistles, including routine info, completion and fast 3932with all bells and whistles, including routine info, completion and fast
@@ -4018,7 +3944,7 @@ system. I am assuming that IDLWAVE has been installed in
4018;; the X/Emacs installation) 3944;; the X/Emacs installation)
4019(setq load-path (cons "c:/program files/IDLWAVE" load-path)) 3945(setq load-path (cons "c:/program files/IDLWAVE" load-path))
4020 3946
4021;; The location of the IDL library files, both from RSI and your own. 3947;; The location of the IDL library files, both standard and your own.
4022;; note that the initial "+" expands the path recursively 3948;; note that the initial "+" expands the path recursively
4023(setq idlwave-library-path 3949(setq idlwave-library-path
4024 '("+c:/RSI/IDL55/lib/" "+c:/user/me/idllibs" )) 3950 '("+c:/RSI/IDL55/lib/" "+c:/user/me/idllibs" ))
@@ -4113,9 +4039,7 @@ in compiled lisp files. Presumably, you kept the original .elc files in
4113place, and this is the source of the error. If you recompile (or just 4039place, and this is the source of the error. If you recompile (or just
4114"make; make install") from source, it should resolve this problem. 4040"make; make install") from source, it should resolve this problem.
4115Another option is to recompile the @file{idlw*.el} files by hand using 4041Another option is to recompile the @file{idlw*.el} files by hand using
4116@kbd{M-x byte-compile-file}. Why not take the opportunity to grab the 4042@kbd{M-x byte-compile-file}.
4117latest IDLWAVE version at @uref{@value{IDLWAVE-HOMEPAGE}, the
4118maintainers webpage}
4119 4043
4120@item @strong{@kbd{M-@key{TAB}} doesn't complete words, it switches 4044@item @strong{@kbd{M-@key{TAB}} doesn't complete words, it switches
4121windows on my desktop.} 4045windows on my desktop.}
@@ -4214,7 +4138,7 @@ method, and the most recent information will be available to all users.
4214@item @strong{All the Greek-font characters in the HTML help are 4138@item @strong{All the Greek-font characters in the HTML help are
4215displayed as Latin characters!} 4139displayed as Latin characters!}
4216 4140
4217Unfortunately, the HTMLHelp files RSI provides attempt to switch to 4141Unfortunately, the HTMLHelp files attempt to switch to
4218@samp{Symbol} font to display Greek characters, which is not really an 4142@samp{Symbol} font to display Greek characters, which is not really an
4219permitted method for doing this in HTML. There is a "workaround" for 4143permitted method for doing this in HTML. There is a "workaround" for
4220many browsers: @xref{HTML Help Browser Tips}. 4144many browsers: @xref{HTML Help Browser Tips}.