comparison man/idlwave.texi @ 77578:4211034c233f

Minor updates for IDLWAVE 6.1.

77577:9eb9feafec58

* IDLWAVE: (idlwave).	Major mode and shell for IDL files.
@end direntry
@synindex ky cp
@syncodeindex vr cp
@syncodeindex fn cp
@set VERSION 6.0
@set EDITION 6.0
@set IDLVERSION 6.2
@set NSYSROUTINES 1966
@set DATE Feb, 2006
@set AUTHOR J.D. Smith & Carsten Dominik
@set AUTHOREMAIL jdsmith@@as.arizona.edu
@set MAINTAINER J.D. Smith
@set MAINTAINEREMAIL jdsmith@@as.arizona.edu
@set IDLWAVEHOMEPAGE http://idlwave.org/
@c %**end of header
@finalout

@ifinfo 
This file documents IDLWAVE, a major mode for editing IDL files with

@tab Re-indent all lines in the current routine.
@item @kbd{C-u @key{TAB}}
@tab Re-indent all lines in the current statement.
@item @kbd{M-@key{RET}}
@tab Start a continuation line, splitting the current line at point.
@item @kbd{M-q}
@tab Fill the current comment paragraph.
@item @kbd{C-c ?}
@tab Display calling sequence and keywords for the procedure or function call
at point.

@tab Cycle forward.
@item @kbd{@key{TAB}}
@tab Complete a procedure name, function name or keyword in the shell buffer.
@item @kbd{C-c C-d C-c}
@tab Save and compile the source file in the current buffer.
@item @kbd{C-c C-d C-x}
@tab Go to next syntax error.
@item @kbd{C-c C-d C-v}
@tab Switch to electric debug mode.
@item @kbd{C-c C-d C-b}

line, call @code{idlwave-shell-execute-default-command-line} with a
prefix argument: @kbd{C-u C-c C-d C-y}.  If no default command line has
been set (or you give two prefix arguments), the last command on the
@code{comint} input history is sent.

@node Walking the Calling Stack, Electric Debug Mode, Compiling Programs, Debugging IDL Programs
@subsection Walking the Calling Stack
@cindex Calling stack, walking

While debugging a program, it can be very useful to check the context in

@enumerate

@item
It has a @emph{builtin list} with information about the routines IDL
ships with.  IDLWAVE @value{VERSION} is distributed with a list of
@value{NSYSROUTINES} routines, reflecting IDL version
@value{IDLVERSION}.  As of IDL v6.2, the routine info is distributed
directly with IDL in the form of an XML catalog which IDLWAVE scans.
Formerly, this list was created by scanning the IDL manuals to produce
the file @file{idlw-rinfo.el}.

talking to the IDL program.

Here is an example of the additional configuration needed for a Windows
system.  I am assuming that IDLWAVE has been installed in
@w{@samp{C:\Program Files\IDLWAVE}} and that IDL is installed in
@w{@samp{C:\RSI\IDL62}}.

@lisp
;; location of the lisp files (only needed if IDLWAVE is not part of
;; your default X/Emacs installation)
(setq load-path (cons "c:/program files/IDLWAVE" load-path))

;; The location of the IDL library directories, both standard,  and your own.
;; note that the initial "+" expands the path recursively
(setq idlwave-library-path
        '("+c:/RSI/IDL55/lib/" "+c:/path/to/my/idllibs" ))

;; location of the IDL system directory (try "print,!DIR")
(setq idlwave-system-directory "c:/RSI/IDL62/")

@end lisp

@noindent Furthermore, Windows sometimes tries to outsmart you --- make
sure you check the following things:

77578:4211034c233f

* IDLWAVE: (idlwave).	Major mode and shell for IDL files.
@end direntry
@synindex ky cp
@syncodeindex vr cp
@syncodeindex fn cp
@set VERSION 6.1
@set EDITION 6.1
@set IDLVERSION 6.3
@set NSYSROUTINES 4346
@set DATE April, 2007
@set AUTHOR J.D. Smith & Carsten Dominik
@set MAINTAINER J.D. Smith
@c %**end of header
@finalout

@ifinfo 
This file documents IDLWAVE, a major mode for editing IDL files with

@tab Re-indent all lines in the current routine.
@item @kbd{C-u @key{TAB}}
@tab Re-indent all lines in the current statement.
@item @kbd{M-@key{RET}}
@tab Start a continuation line, splitting the current line at point.
@item @kbd{M-;}
@tab Start new comment at line beginning or after code, or (un)comment
highlighted region.
@item @kbd{M-q}
@tab Fill the current comment paragraph.
@item @kbd{C-c ?}
@tab Display calling sequence and keywords for the procedure or function call
at point.

@tab Cycle forward.
@item @kbd{@key{TAB}}
@tab Complete a procedure name, function name or keyword in the shell buffer.
@item @kbd{C-c C-d C-c}
@tab Save and compile the source file in the current buffer.
@item @kbd{C-c C-d C-e}
@tab Compile and run the current region.
@item @kbd{C-c C-d C-x}
@tab Go to next syntax error.
@item @kbd{C-c C-d C-v}
@tab Switch to electric debug mode.
@item @kbd{C-c C-d C-b}

line, call @code{idlwave-shell-execute-default-command-line} with a
prefix argument: @kbd{C-u C-c C-d C-y}.  If no default command line has
been set (or you give two prefix arguments), the last command on the
@code{comint} input history is sent.

@kindex C-c C-d C-e
@cindex Compiling regions
For quickly compiling and running the currently marked region as a main
level program @kbd{C-c C-d C-e} (@code{idlwave-shell-run-region}) is
very useful.  A temporary file is created holding the contents of the
current region (with @code{END} appended), and run from the shell.

@node Walking the Calling Stack, Electric Debug Mode, Compiling Programs, Debugging IDL Programs
@subsection Walking the Calling Stack
@cindex Calling stack, walking

While debugging a program, it can be very useful to check the context in

@enumerate

@item
It has a @emph{builtin list} with information about the routines IDL
ships with.  IDLWAVE @value{VERSION} is distributed with a list of
@value{NSYSROUTINES} routines and object methods, reflecting IDL version
@value{IDLVERSION}.  As of IDL v6.2, the routine info is distributed
directly with IDL in the form of an XML catalog which IDLWAVE scans.
Formerly, this list was created by scanning the IDL manuals to produce
the file @file{idlw-rinfo.el}.

talking to the IDL program.

Here is an example of the additional configuration needed for a Windows
system.  I am assuming that IDLWAVE has been installed in
@w{@samp{C:\Program Files\IDLWAVE}} and that IDL is installed in
@w{@samp{C:\RSI\IDL63}}.

@lisp
;; location of the lisp files (only needed if IDLWAVE is not part of
;; your default X/Emacs installation)
(setq load-path (cons "c:/program files/IDLWAVE" load-path))

;; The location of the IDL library directories, both standard,  and your own.
;; note that the initial "+" expands the path recursively
(setq idlwave-library-path
        '("+c:/RSI/IDL63/lib/" "+c:/path/to/my/idllibs" ))

;; location of the IDL system directory (try "print,!DIR")
(setq idlwave-system-directory "c:/RSI/IDL63/")

@end lisp

@noindent Furthermore, Windows sometimes tries to outsmart you --- make
sure you check the following things: