GNU Info

(idlwave)Library Catalog

---

Next: Load-Path Shadows Prev: Routine Information Sources Up: Sources of Routine Info

---

Enter node , (file) or (file)node

Library Catalog
===============

   IDLWAVE can extract routine information from library modules and
store that information in a file.  To do this, the variable
`idlwave-libinfo-file' needs to contain the path to a file in an
existing directory (the default is `"~/.idlcat.el"').  Since the file
will contain lisp code, its name should end in `.el'.  Under Windows
and MacOS, you also need to specify the search path for IDL library
files in the variable `idlwave-library-path', and the location of the
IDL directory (the value of the `!DIR' system variable) in the variable
`idlwave-system-directory'.  Under Unix and GNU, these values will be
automatically inferred from an IDLWAVE shell.

   The command `M-x idlwave-create-libinfo-file' can then be used to
scan library files.  It brings up a widget in which you can select some
or all directories on the search path.  If you only want to have routine
and completion info of some libraries, it is sufficient to scan those
directories.  However, if you want IDLWAVE to detect possible name
conflicts with routines defined in other libraries, the whole pass
should be scanned.

   After selecting directories, click on the `[Scan & Save]' button in
the widget to scan all files in the selected directories and write the
resulting routine information into the file `idlwave-libinfo-file'.  In
order to update the library information from the same directories, call
the command `idlwave-update-routine-info' with a double prefix argument:
`C-u C-u C-c C-i'.  This will rescan files in the previously selected
directories, write an updated version of the libinfo file and rebuild
IDLWAVEs internal lists.

   A note of caution:  Depending on your local installation, the IDL
library can be very large.  Parsing it for routine information will take
time and loading this information into Emacs can require a significant
amount of memory.  However, having this information available will be a
great help.

 - User Option: idlwave-libinfo-file
     File for routine information of the IDL library.

 - User Option: idlwave-library-path
     IDL library path for Windows and MacOS.  Not needed under GNU and
     Unix.

 - User Option: idlwave-system-directory
     The IDL system directory for Windows and MacOS.  Not needed under
     GNU and Unix.

 - User Option: idlwave-special-lib-alist
     Alist of regular expressions matching special library directories.