[Emacs-diffs] Changes to emacs/man/idlwave.texi

[John-David T. Smith]

Index: emacs/man/idlwave.texi
diff -c emacs/man/idlwave.texi:1.20 emacs/man/idlwave.texi:1.21
*** emacs/man/idlwave.texi:1.20 Thu Jul 18 21:33:34 2002
--- emacs/man/idlwave.texi      Fri Jul 19 03:01:33 2002
***************
*** 2,8 ****
  @c %**start of header
  @setfilename ../info/idlwave
  @settitle IDLWAVE User Manual
! @dircategory Editors
  @direntry
  * IDLWAVE: (idlwave). Major mode and shell for IDL files.
  @end direntry
--- 2,8 ----
  @c %**start of header
  @setfilename ../info/idlwave
  @settitle IDLWAVE User Manual
! @dircategory Emacs
  @direntry
  * IDLWAVE: (idlwave). Major mode and shell for IDL files.
  @end direntry
***************
*** 33,60 ****
  Copyright @copyright{} 1999, 2000, 2001, 2002 Free Software Foundation,
  Inc.
  
! Permission is granted to make and distribute verbatim
! copies of this manual provided the copyright notice and
! this permission notice are preserved on all copies.
!      
! @ignore
! Permission is granted to process this file through TeX and print the
! results, provided the printed document carries a copying permission
! notice identical to this one except for the removal of this paragraph
! (this paragraph not being relevant to the printed manual).
!      
! @end ignore
! Permission is granted to copy and distribute modified
! versions of this manual under the conditions for
! verbatim copying, provided that the entire resulting
! derived work is distributed under the terms of a permission
! notice identical to this one.
!      
! Permission is granted to copy and distribute
! translations of this manual into another language,
! under the above conditions for modified versions,
! except that this permission notice may be stated in a
! translation approved by the Free Software Foundation.
  @end ifinfo
  
  @titlepage
--- 33,54 ----
  Copyright @copyright{} 1999, 2000, 2001, 2002 Free Software Foundation,
  Inc.
  
! Permission is granted to copy, distribute and/or modify this document
! under the terms of the GNU Free Documentation License, Version 1.1 or
! any later version published by the Free Software Foundation; with no
! Invariant Sections, with the Front-Cover texts being ``A GNU
! Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
! license is included in the section entitled ``GNU Free Documentation
! License'' in the Emacs manual.
! 
! (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
! this GNU Manual, like GNU software.  Copies published by the Free
! Software Foundation raise funds for GNU development.''
! 
! This document is part of a collection distributed under the GNU Free
! Documentation License.  If you want to distribute this document
! separately from the collection, you can do so by adding a copy of the
! license to the document, as described in section 6 of the license.
  @end ifinfo
  
  @titlepage
***************
*** 64,94 ****
  
  @author by Carsten Dominik & J.D. Smith
  @page
- Copyright @copyright{} 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
- 
- @sp 2
  This is edition @value{EDITION} of the @cite{IDLWAVE User Manual} for
  IDLWAVE version @value{VERSION}, @value{DATE}.
- 
  @sp 2
! 
  @cindex Copyright, of IDLWAVE
! Permission is granted to make and distribute verbatim
! copies of this manual provided the copyright notice and
! this permission notice are preserved on all copies.
!      
! Permission is granted to copy and distribute modified
! versions of this manual under the conditions for
! verbatim copying, provided that the entire resulting
! derive work is distributed under the terms of a permission
! notice identical to this one.
!      
! Permission is granted to copy and distribute
! translations of this manual into another language,
! under the above conditions for modified versions,
! except that this permission notice may be stated in a
! translation approved by the Free Software Foundation.
! 
  @end titlepage
  @contents
  
--- 58,85 ----
  
  @author by Carsten Dominik & J.D. Smith
  @page
  This is edition @value{EDITION} of the @cite{IDLWAVE User Manual} for
  IDLWAVE version @value{VERSION}, @value{DATE}.
  @sp 2
! Copyright @copyright{} 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
! @sp 2
  @cindex Copyright, of IDLWAVE
! Permission is granted to copy, distribute and/or modify this document
! under the terms of the GNU Free Documentation License, Version 1.1 or
! any later version published by the Free Software Foundation; with no
! Invariant Sections, with the Front-Cover texts being ``A GNU
! Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
! license is included in the section entitled ``GNU Free Documentation
! License'' in the Emacs manual.
! 
! (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
! this GNU Manual, like GNU software.  Copies published by the Free
! Software Foundation raise funds for GNU development.''
! 
! This document is part of a collection distributed under the GNU Free
! Documentation License.  If you want to distribute this document
! separately from the collection, you can do so by adding a copy of the
! license to the document, as described in section 6 of the license.
  @end titlepage
  @contents
  
***************
*** 1258,1264 ****
  @kindex M-?
  In any IDL program (or, as with most IDLWAVE commands, in the IDL
  Shell), press @kbd{M-?} (@code{idlwave-context-help}), or click with
! @kbd{S-mouse-3} to access context sensitive online help.  The following
  locations are recognized context for help:
  
  @cindex Context, for online help
--- 1249,1255 ----
  @kindex M-?
  In any IDL program (or, as with most IDLWAVE commands, in the IDL
  Shell), press @kbd{M-?} (@code{idlwave-context-help}), or click with
! @kbd{S-Mouse-3} to access context sensitive online help.  The following
  locations are recognized context for help:
  
  @cindex Context, for online help
***************
*** 1296,1306 ****
  @itemize @bullet
  @item
  Online help for routines and keywords can be accessed through the
! Routine Info display.  Click with @kbd{mouse-3} on an item to see the
  corresponding help (@pxref{Routine Info}).
  @item
  When using completion and Emacs pops up a window with possible
! completions, clicking with @kbd{mouse-3} on a completion item invokes
  help on that item (@pxref{Completion}).
  @end itemize
  @noindent
--- 1287,1297 ----
  @itemize @bullet
  @item
  Online help for routines and keywords can be accessed through the
! Routine Info display.  Click with @kbd{Mouse-3} on an item to see the
  corresponding help (@pxref{Routine Info}).
  @item
  When using completion and Emacs pops up a window with possible
! completions, clicking with @kbd{Mouse-3} on a completion item invokes
  help on that item (@pxref{Completion}).
  @end itemize
  @noindent
***************
*** 1308,1315 ****
  IDL manual, but an attempt will be made to visit non-blue items directly
  in the originating source file.
  
! @cindex Help application, keybindings
! @cindex Keybindings, in help application
  The help window is normally displayed in a separate frame.  The
  following commands can be used to navigate inside the help system:
  
--- 1299,1306 ----
  IDL manual, but an attempt will be made to visit non-blue items directly
  in the originating source file.
  
! @cindex Help application, key bindings
! @cindex Key bindings, in help application
  The help window is normally displayed in a separate frame.  The
  following commands can be used to navigate inside the help system:
  
***************
*** 1326,1332 ****
  @tab Move back and forward through the help topic history.
  @item @kbd{c}
  @tab Clear the history.
! @item @kbd{mouse-2}
  @tab Follow a link.  Active links are displayed in a different font.
  Items under @i{See Also} are active, and classes have links to their
  methods and back.
--- 1317,1323 ----
  @tab Move back and forward through the help topic history.
  @item @kbd{c}
  @tab Clear the history.
! @item @kbd{Mouse-2}
  @tab Follow a link.  Active links are displayed in a different font.
  Items under @i{See Also} are active, and classes have links to their
  methods and back.
***************
*** 1369,1375 ****
  @end defopt
  
  @defopt idlwave-max-popup-menu-items (@code{20})
! Maximum number of items per pane in popup menus.
  @end defopt
  
  @defopt idlwave-extra-help-function
--- 1360,1366 ----
  @end defopt
  
  @defopt idlwave-max-popup-menu-items (@code{20})
! Maximum number of items per pane in pop-up menus.
  @end defopt
  
  @defopt idlwave-extra-help-function
***************
*** 1452,1458 ****
  If the list of completions is too long to fit in the
  @file{*Completions*} window, the window can be scrolled by pressing
  @address@hidden repeatedly.  Online help (if installed) for each
! possible completion is available by clicking with @kbd{mouse-3} on the
  item.  Items for which system online help (from the IDL manual) is
  available will be displayed in a different font (e.g. colored blue).
  For other items, the corresponding source code or DocLib header will be
--- 1443,1449 ----
  If the list of completions is too long to fit in the
  @file{*Completions*} window, the window can be scrolled by pressing
  @address@hidden repeatedly.  Online help (if installed) for each
! possible completion is available by clicking with @kbd{Mouse-3} on the
  item.  Items for which system online help (from the IDL manual) is
  available will be displayed in a different font (e.g. colored blue).
  For other items, the corresponding source code or DocLib header will be
***************
*** 1699,1705 ****
  @cindex Templates
  
  IDLWAVE can insert IDL code templates into the buffer.  For a few
! templates, this is done with direct keybindings:
  
  @multitable @columnfractions .15 .85
  @item @kbd{C-c C-c}
--- 1690,1696 ----
  @cindex Templates
  
  IDLWAVE can insert IDL code templates into the buffer.  For a few
! templates, this is done with direct key bindings:
  
  @multitable @columnfractions .15 .85
  @item @kbd{C-c C-c}
***************
*** 1866,1872 ****
  @end multitable
  
  @noindent You can easily add your own abbreviations or override existing
! abbrevs with @code{define-abbrev} in your mode hook using the
  convenience function @code{idlwave-define-abbrev}:
  
  @lisp
--- 1857,1863 ----
  @end multitable
  
  @noindent You can easily add your own abbreviations or override existing
! abbrevs with @code{define-abbrev} in your mode hook, using the
  convenience function @code{idlwave-define-abbrev}:
  
  @lisp
***************
*** 2181,2187 ****
  @cindex Comint, Emacs package
  @cindex Windows
  @cindex MacOS
- @cindex Unix
  
  The IDLWAVE shell is an Emacs major mode which permits running the IDL
  program as an inferior process of Emacs, and works closely with the
--- 2172,2177 ----
***************
*** 2193,2199 ****
  versions and thus do not allow the interaction with
  address@hidden inform the maintainer if you come up with a way to
  make the IDLWAVE shell work on these systems.} --- so the IDLWAVE shell
! currently only works under Unix.
  
  @menu
  * Starting the Shell::          How to launch IDL as a subprocess
--- 2183,2189 ----
  versions and thus do not allow the interaction with
  address@hidden inform the maintainer if you come up with a way to
  make the IDLWAVE shell work on these systems.} --- so the IDLWAVE shell
! currently only works under GNU and Unix.
  
  @menu
  * Starting the Shell::          How to launch IDL as a subprocess
***************
*** 2430,2442 ****
  
  @kindex C-c C-d
  Programs can be compiled, run, and debugged directly from the source
! buffer in Emacs.  The IDLWAVE shell installs keybindings both in the
  shell buffer and in all IDL code buffers of the current Emacs session.
  On Emacs versions which support this, it also installs a debugging
  toolbar.  The display of the toolbar can be toggled with @kbd{C-c C-d
  C-t} (@code{idlwave-shell-toggle-toolbar}).
  
! The debugging keybindings are by default on the prefix key @kbd{C-c
  C-d}, so for example setting a breakpoint is done with @kbd{C-c C-d
  C-b}, compiling a source file with @kbd{C-c C-d C-c}.  If you find this
  too much work, you can add bindings for one or more modifier keys which
--- 2420,2432 ----
  
  @kindex C-c C-d
  Programs can be compiled, run, and debugged directly from the source
! buffer in Emacs.  The IDLWAVE shell installs key bindings both in the
  shell buffer and in all IDL code buffers of the current Emacs session.
  On Emacs versions which support this, it also installs a debugging
  toolbar.  The display of the toolbar can be toggled with @kbd{C-c C-d
  C-t} (@code{idlwave-shell-toggle-toolbar}).
  
! The debugging key bindings are by default on the prefix key @kbd{C-c
  C-d}, so for example setting a breakpoint is done with @kbd{C-c C-d
  C-b}, compiling a source file with @kbd{C-c C-d C-c}.  If you find this
  too much work, you can add bindings for one or more modifier keys which
***************
*** 2660,2666 ****
  
  For added speed and convenience, there are mouse bindings which allow
  you to click on expressions and examine their values.  Use
! @kbd{S-mouse-2} to print an expression and @kbd{C-M-mouse-2} to invoke
  help (i.e. you need to hold down @key{META} and @key{CONTROL} while
  clicking with the middle mouse button).  If you simply click, the
  nearest expression will be selected in the same manner as described
--- 2650,2656 ----
  
  For added speed and convenience, there are mouse bindings which allow
  you to click on expressions and examine their values.  Use
! @kbd{S-Mouse-2} to print an expression and @kbd{C-M-Mouse-2} to invoke
  help (i.e. you need to hold down @key{META} and @key{CONTROL} while
  clicking with the middle mouse button).  If you simply click, the
  nearest expression will be selected in the same manner as described
***************
*** 2722,2728 ****
  bindings.
  
  The most powerful and flexible mouse examine command is available on
! @kbd{C-S-mouse-2}.  Just as for all the other mouse examine commands, it
  permits click or drag expression selection, but instead of sending
  hard-coded commands to the shell, it pops-up a customizable selection
  list of examine functions to choose among, configured with the
--- 2712,2718 ----
  bindings.
  
  The most powerful and flexible mouse examine command is available on
! @kbd{C-S-Mouse-2}.  Just as for all the other mouse examine commands, it
  permits click or drag expression selection, but instead of sending
  hard-coded commands to the shell, it pops-up a customizable selection
  list of examine functions to choose among, configured with the
***************
*** 2732,2739 ****
  @code{___} (three underscores) will be replaced by the selected
  expression before being sent to the shell.  An example might be key
  @code{Structure Help} with value @code{help,___,/STRUCTURE}.
  
! In addition to the popup mouse command, you can easily create your own
  customized bindings to inspect expressions using the two convenience
  macros @code{idlwave-shell-inspect} and
  @code{idlwave-shell-mouse-inspect}.  These create keyboard or
--- 2722,2731 ----
  @code{___} (three underscores) will be replaced by the selected
  expression before being sent to the shell.  An example might be key
  @code{Structure Help} with value @code{help,___,/STRUCTURE}.
+ @code{idlwave-shell-examine-alist} comes by default with a large list of
+ examine commands, but can be easily customized to add more.
  
! In addition to the pop-up mouse command, you can easily create your own
  customized bindings to inspect expressions using the two convenience
  macros @code{idlwave-shell-inspect} and
  @code{idlwave-shell-mouse-inspect}.  These create keyboard or
***************
*** 2764,2770 ****
  
  @defopt idlwave-shell-examine-alist
  An alist of examine commands in which the keys name the command and are
! displayed in the selection popup, and the values are custom IDL examine
  command strings to send, after all instances of @code{___} are replaced
  by the indicated expression.
  @end defopt
--- 2756,2762 ----
  
  @defopt idlwave-shell-examine-alist
  An alist of examine commands in which the keys name the command and are
! displayed in the selection pop-up, and the values are custom IDL examine
  command strings to send, after all instances of @code{___} are replaced
  by the indicated expression.
  @end defopt
***************
*** 2848,2854 ****
  @end lisp
  @item 
  The key sequence @address@hidden no longer inserts a TAB character.
! Like in in many other Emacs modes, @address@hidden now does
  completion.  Inserting a TAB has therefore been moved to
  @address@hidden  On a character based terminal you can also use
  @kbd{C-c @key{SPC}}.
--- 2840,2846 ----
  @end lisp
  @item 
  The key sequence @address@hidden no longer inserts a TAB character.
! Like in many other Emacs modes, @address@hidden now does
  completion.  Inserting a TAB has therefore been moved to
  @address@hidden  On a character based terminal you can also use
  @kbd{C-c @key{SPC}}.
***************
*** 3054,3060 ****
  @cindex IDL library routine info
  @cindex Windows
  @cindex MacOS
- @cindex Unix
  @cindex IDL variable @code{!DIR}
  @cindex @code{!DIR}, IDL variable
  
--- 3046,3051 ----
***************
*** 3077,3083 ****
  (setq idlwave-system-directory "c:/RSI/IDL54/")
  @end lisp
  
! @noindent Under UNIX, these values will be automatically inferred from
  an IDLWAVE shell.
  
  The command @kbd{M-x idlwave-create-libinfo-file} can then be used to
--- 3068,3074 ----
  (setq idlwave-system-directory "c:/RSI/IDL54/")
  @end lisp
  
! @noindent Under GNU and UNIX, these values will be automatically inferred from
  an IDLWAVE shell.
  
  The command @kbd{M-x idlwave-create-libinfo-file} can then be used to
***************
*** 3098,3104 ****
  selected directories, write an updated version of the libinfo file and
  rebuild IDLWAVE's internal lists.  If you give three prefix arguments
  @address@hidden C-u C-u C-c C-i}}, updating will be done with a background
! address@hidden systems only, I think.}.  You can continue to work,
  and the library catalog will be re-read when it is ready.
  
  A note of caution:  Depending on your local installation, the IDL
--- 3089,3095 ----
  selected directories, write an updated version of the libinfo file and
  rebuild IDLWAVE's internal lists.  If you give three prefix arguments
  @address@hidden C-u C-u C-c C-i}}, updating will be done with a background
! address@hidden and Unix systems only, I think.}.  You can continue to work,
  and the library catalog will be re-read when it is ready.
  
  A note of caution:  Depending on your local installation, the IDL
***************
*** 3112,3122 ****
  @end defopt
  
  @defopt idlwave-library-path
! IDL library path for Windows and MacOS.  Not needed under Unix.
  @end defopt
  
  @defopt idlwave-system-directory
! The IDL system directory for Windows and MacOS.  Not needed under UNIX.
  @end defopt
  
  @defopt idlwave-special-lib-alist
--- 3103,3113 ----
  @end defopt
  
  @defopt idlwave-library-path
! IDL library path for Windows and MacOS.  Not needed under GNU and Unix.
  @end defopt
  
  @defopt idlwave-system-directory
! The IDL system directory for Windows and MacOS.  Not needed under GNU and 
Unix.
  @end defopt
  
  @defopt idlwave-special-lib-alist
***************
*** 3300,3306 ****
      (font-lock-mode 1)                   ; Turn on font-lock mode
      (idlwave-auto-fill-mode 0)           ; Turn off auto filling
  
!     ;; Pad with with 1 space (if -n is used then make the
      ;; padding a minimum of n spaces.)  The defaults use -1
      ;; instead of 1.
      (idlwave-action-and-binding "=" '(idlwave-expand-equal 1 1))
--- 3291,3297 ----
      (font-lock-mode 1)                   ; Turn on font-lock mode
      (idlwave-auto-fill-mode 0)           ; Turn off auto filling
  
!     ;; Pad with 1 space (if -n is used then make the
      ;; padding a minimum of n spaces.)  The defaults use -1
      ;; instead of 1.
      (idlwave-action-and-binding "=" '(idlwave-expand-equal 1 1))
***************
*** 3379,3386 ****
  editing IDL source files with Emacs/IDLWAVE works with all bells and
  whistles, including routine info, completion and fast online help.  Only
  a small amount of additional information must be specified in your
! .emacs file: You must specify path names which on a UNIX can be
! automatically gathered by 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
--- 3370,3377 ----
  editing IDL source files with Emacs/IDLWAVE works with all bells and
  whistles, including routine info, completion and fast online help.  Only
  a small amount of additional information must be specified in your
! .emacs file: you must specify path names which on a GNU or UNIX system
! are automatically gathered by 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