xemacs-beta: man/hyperbole.texi comparison

comparison man/hyperbole.texi @ 24:4103f0995bd7 r19-15b95

Import from CVS: tag r19-15b95

author	cvs
date	Mon, 13 Aug 2007 08:51:03 +0200
parents	49a24b4fd526
children	c53a95d3c46d

comparison

equal deleted inserted replaced

-:0edd3412f124
+:4103f0995bd7
 \input texinfo
 @c
-@c FILE:         hypb.texi
+@c FILE:         hyperbole.texi
-@c SUMMARY:      The Hyperbole User Manual for V3
+@c SUMMARY:      The Hyperbole User Manual for V4
-@c USAGE:        Hardcopy man from TeX; Info man from 'texinfo-format-buffer'.
+@c USAGE:        Hardcopy man from TeX; Info man from `texinfo-format-buffer'.
 @c
 @c AUTHOR:       Bob Weiner
-@c ORG:          Brown U.
+@c
+@c ORG:          InfoDock Associates.  We sell corporate support and
+@c               development contracts for InfoDock, Emacs and XEmacs.
+@c               E-mail: <info@infodock.com>  Web: http://www.infodock.com
+@c               Tel: +1 408-243-3300
 @c
 @c ORIG-DATE:     6-Nov-91 at 11:18:03
-@c LAST-MOD:      3-Nov-95 at 23:55:27 by Bob Weiner
+@c LAST-MOD:     20-Feb-97 at 12:36:16 by Bob Weiner
 @c %**start of header (This is for running Texinfo on a region.)
 @setfilename ../info/hyperbole.info
 @settitle Hyperbole User Manual
 @c %**end of header (This is for running Texinfo on a region.)
 @center @titlefont{Hyperbole Manual}
 @sp 1
 @center Everyday Information Management
 @sp 5
 @center Bob Weiner
+@center InfoDock Associates
 @sp 1
-@center E-mail: <hyperbole@@hub.ucsb.edu>  (This is a mail list.)
+@center E-mail: <hyperbole@@infodock.com>  (This is a mailing list.)
 @sp 2
-@center Edition 4.01
+@center Edition 4.02
 @sp 2
-@center November 3, 1995
+@center February 19, 1997
 @page
 @vskip 0pt plus 1filll
-Copyright @copyright{} 1991, 1992, 1993, 1994, 1995  Free Software Foundation, Inc.
+Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997  Free Software Foundation, Inc.
 All trademarks referenced herein are trademarks of their respective
 holders.
+InfoDock Associates, the developer of Hyperbole and InfoDock (an industrial
+quality turn-key version of XEmacs), donates its work on Hyperbole to the
+Free Software Foundation and makes it freely available for worldwide
+distribution.
+InfoDock Associates is a commercial firm dedicated to radical productivity
+improvement in technical environments, whether in software development or
+other knowledge intensive disciplines.  Our initial offerings include high
+quality commercial support, training, books and custom package development
+for InfoDock, XEmacs or GNU Emacs on a variety of platforms.
+@example
+E-mail: <info@@infodock.com>
+Web:    http://www.infodock.com
+Tel:    +1 408-243-3300
+@end example
 @setchapternewpage odd
 @end titlepage
 @page
 @node Top, Introduction, (dir), (dir)
 @c  node-name,  next,  previous,  up
 @unnumbered Preface
 @ifinfo
 @noindent
-Copyright @copyright{} 1991, 1992, 1993, 1994, 1995  Free Software Foundation, Inc.
+Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997  Free Software Foundation, Inc.
 All trademarks referenced herein are trademarks of their respective holders.
+InfoDock Associates, the developer of Hyperbole and InfoDock (an industrial
+quality turn-key version of XEmacs), donates its work on Hyperbole to the
+Free Software Foundation and makes it freely available for worldwide
+distribution.
+InfoDock Associates is a commercial firm dedicated to radical productivity
+improvement in technical environments, whether in software development or
+other knowledge intensive disciplines.  Our initial offerings include high
+quality commercial support, training, books and custom package development
+for InfoDock, XEmacs or GNU Emacs on a variety of platforms.
+@example
+E-mail: <info@@infodock.com>
+Web:    http://www.infodock.com
+Tel:    +1 408-243-3300
+@end example
 @end ifinfo
 This edition of the Hyperbole User Manual is for use with any version
-4.01 or greater of Hyperbole.
+4.02 or greater of Hyperbole.
 Hyperbole is free software; you can use it, redistribute it and/or modify it
 without fee under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2, or (at your option) any later
 version.
 @cindex credits
 @cindex InfoDock, obtaining
 @cindex Hyperbole, obtaining
 @cindex anonymous ftp
-Hyperbole was designed and written by Bob Weiner.  Motorola,
+Hyperbole was designed and written by Bob Weiner of InfoDock Associates.
-Inc@. funded and donated this work for free redistribution as part of
+Motorola, Inc@. helped fund early work.  For information on how to
-the InfoDock integrated software engineering and productivity toolset.
+obtain Hyperbole, @ref{Obtaining}.
-For information on how to obtain Hyperbole, @ref{Obtaining}.  InfoDock
-can be found at the same location.
 This manual explains user operation and summarizes basic developer
 facilities of Hyperbole.  This major release of Hyperbole concentrates
 on providing convenient access to information and control over its
 display.  The Hyperbole outliner emphasizes flexible views and structure
 @cindex hypertext
 @cindex Emacs Lisp
 @cindex Emacs 19
 @cindex Epoch
 @cindex XEmacs
-@cindex Lucid Emacs
+Hyperbole (pronounced Hi-per-bo-lee) is an open, efficient, programmable
-Hyperbole (pronounced Hi-purr-boe-lee) is an open, efficient,
+information management and hypertext system.  It is intended for
-programmable information management and hypertext system.  It is
+everyday work on any UNIX platform supported by GNU Emacs.  It works
-intended for everyday work on any UNIX platform supported by GNU Emacs.
+well with the versions of Emacs that support multiple X or NEXTSTEP
-It works well with the versions of Emacs that support multiple X or
+windows: Emacs 19, XEmacs and Epoch.  Hyperbole allows hypertext buttons
-NEXTSTEP windows: Emacs 19, XEmacs (formerly called Lucid Emacs) and
+to be embedded within unstructured and structured files, mail messages
-Epoch.  Hyperbole allows hypertext buttons to be embedded within
+and news articles.  It offers intuitive mouse-based control of
-unstructured and structured files, mail messages and news articles.  It
+information display within multiple windows.  It also provides
-offers intuitive mouse-based control of information display within
+point-and-click access to Info manuals, ftp archives, Wide-Area
-multiple windows.  It also provides point-and-click access to Info
+Information Servers (WAIS), and the World-Wide Web (WWW) hypertext
-manuals, ftp archives, Wide-Area Information Servers (WAIS), and the
+system through encapsulations of software that support these protocols.
-World-Wide Web (WWW) hypertext system through encapsulations of software
-that support these protocols.
 @noindent
 Hyperbole consists of four parts:
 @table @bullet
 @node Mail Lists, Manual Overview, Hyperbole Overview, Introduction
 @section   Mail Lists
 If you maintain or use Hyperbole, you should consider joining one of the
-two Hyperbole interest mailing lists.  @xref{Menus}, and the description
+two Hyperbole mailing lists.  @xref{Menus}, and the description
-of the Msg/ menu item, for a convenient means of joining and mailing
+of the the Msg/ menu item, for a convenient means of joining and mailing
 to these lists.
 @cindex mail lists
 @cindex e-mail
 There are several Hyperbole-related mail addresses.  Learn what each is
 @cindex mail list requests
 @cindex joining a mail list
 @cindex subscribing to a mail list
 @cindex unsubscribing from a mail list
 @format
-<hyperbole-request@@hub.ucsb.edu>
+<hyperbole-request@@infodock.com>
-<hyperbole-announce-request@@hub.ucsb.edu>
+<hyperbole-announce-request@@infodock.com>
 @end format
 @display
 @strong{All} mail concerning administration of the Hyperbole mailing
 lists should be sent to the appropriate one of these addresses.  That
 includes addition, change, or deletion requests.  Don't consider sending
 such a request to a Hyperbole mail list or people will wonder why you
 don't know that all Internet mail lists have a -request address for
 administrative requests.@refill
-Use the following formats on your subject line to execute requests,
+Use the following formats in the @emph{body} of your message to execute requests,
-where you substitute your own values for the <> delimited items.@refill
+where you substitute your own values for the <> delimited items and items
+enclosed in [] are optional.
-Subject: Subscribe '<' <user@@domain> '>' (<your name>).
-Subject: Unsubscribe '<' <user@@domain> '>'.
+subscribe <mail-list-name> [<your-email-address>]
+or
-To change your address, you must unsubscribe your old address in one
+unsubscribe <mail-list-name> [<your-email-address>]
-message and then subscribe your new address in another message.@refill
 For example:
-To: hyperbole-announce-request@@hub.ucsb.edu
+To: hyperbole-request@@infodock.com
-Subject: Unsubscribe <joe@@any.com>.
+Subject: Used if a human happens to read your mail.
-To: hyperbole-announce-request@@hub.ucsb.edu
+subscribe hyperbole joe@@nowhere.gov
-Subject: Subscribe <joe@@any.com> (Joe Williams).
+To change your address, you must unsubscribe your old address with
+once command and subscribe your new address with another command, though
+you can embed multiple commands on separate lines within a single message.
 @end display
 @noindent
 There are two Hyperbole-related mail lists.  Subscribe to one or the other,
 not to both.
 @cindex hyperbole mail list
 @format
-<hyperbole@@hub.ucsb.edu>
+<hyperbole@@infodock.com>
 @end format
 @display
 Mail list for discussion of all Hyperbole issues.  Bug reports and
 suggestions may also be sent here.@refill
-@end display
 @cindex e-mail, effective communication
 @cindex effective communication
-@display
 Always use your Subject and/or Summary: lines to state the position that
 your message takes on the topic that it addresses.
 For example, send:
 Statements end with periods, questions with question marks (typically),
 and high energy, high impact declarations with exclamation points.  This
 simple rule makes all e-mail communication much easier for recipients to
 handle appropriately.@refill
-@end display
 @cindex Hyperbole version
 @cindex Emacs version
 @vindex emacs-version
-@display
 If you ask a question, your subject line should end with a ?,
 e.g@. "Subject: How can man page SEE ALSOs be made implicit buttons?"  A
 "Subject: Re: How can ..." then indicates an answer to the question.
 Question messages should normally include your Hyperbole and Emacs
 version numbers and clearly explain your problem and surrounding issues.
 messages that ask for, but provide no information.@refill
 @end display
 @cindex hyperbole-announce mail list
 @format
-<hyperbole-announce@@hub.ucsb.edu>
+<hyperbole-announce@@infodock.com>
 @end format
 @display
 Those who don't want to participate in the discussion but want to hear
 about bug fixes and new releases of Hyperbole should subscribe to this
 @end menu
 @node Obtaining, Building, Installation, Installation
 @section   Obtaining
-@cindex InfoDock
 @cindex ftp
 @cindex anonymous ftp
-Hyperbole is actually part of an integrated tool framework that we have
+Hyperbole can be obtained via anonymous ftp on the Internet from:
-developed called InfoDock.  InfoDock provides a modern user interface on top
-of Emacs, information management, and powerful software development tools,
-all in one package.  Hyperbole or InfoDock can be obtained via anonymous
-ftp on the Internet from:
 @file{ftp://ftp.xemacs.org/pub/infodock}.
 @cindex downloading Hyperbole
 @cindex obtaining Hyperbole
 @noindent
 Ftp to ftp.xemacs.org  (Internet Host ID = 128.174.252.16):
 @example
-prompt> ftp ftp.xemacs.org
+prompt> ftp ftp.xemacs.org  (If this doesn't work, try `ftp xemacs.org'.)
 @end example
 @noindent
 Login as @emph{anonymous} with your own @emph{<user-id>@@<site-name>} as
 a password.
 @noindent
 Move to the Hyperbole directory:
 @example
-ftp> cd pub/infodock
+ftp> cd pub/xemacs/infodock
 @end example
 @noindent
 Set your transfer mode to binary:
 @node Configuring,  , Installing, Installation
 @section   Configuring
+@cindex menu, Cust
+@cindex customization
+Major Hyperbole user options can be set from the window-system-based
+Customization submenu below the Hyperbole menu.  Alternatively, the
+minibuffer-based menu, Cust/ may be used.
 @cindex configuration
 @vindex file, hyperbole.el
 @vindex file, hsite.el
-There are many Hyperbole configuration options that may be changed by
+There are many additional Hyperbole configuration options that may be
-editing the @file{hyperbole.el} and @file{hsite.el} files in the
+changed by editing the @file{hyperbole.el} and @file{hsite.el} files in
-@file{hyperbole/} directory.  The following sections discuss the
+the @file{hyperbole/} directory.  The following sections discuss the
 configuration options most likely to be of interest to users.
 @menu
 * Internal Viewers::
 * External Viewers::
 in response to simple mouse clicks.
 @cindex ibtypes, list of
 @noindent
 See @file{hibtypes.el} for complete examples.  Standard implicit button
-types include (in alphabetical order):
+types are listed below in the order in which Hyperbole tries to match
+to the types when looking for an implicit button.
 @table @code
-@item annot-bib
-@findex ibtypes::annot-bib
-@cindex bibliography
-@cindex reference
-Displays annotated bibliography entries referenced internally, delimeters = [].
-References must be delimited by square brackets, must begin with a
-word constituent character, and must not be in buffers whose
-names begin with a ' ' or '*' character.
-@item completion
-@findex ibtypes::completion
-@cindex completion
-Inserts completion at point into minibuffer or other window.
-@item dir-summary
-@findex ibtypes::dir-summary
-@vindex file, MANIFEST
-@vindex file, DIR
-Detects filename buttons in files named "MANIFEST" or "DIR".
-Displays selected files.
-Each file name must be at the beginning of the line and must be followed
-by one or more spaces and then another non-space, non-parenthesis, non-brace
-character.
 @item doc-id
 @findex ibtypes::doc-id
 @cindex online library
 @cindex document identifier
 Displays an index entry for a site-specific document given its id.  Ids
-must be delimited by 'doc-id-start' and 'doc-id-end' and must match the
+must be delimited by `doc-id-start' and `doc-id-end' and must match the
-function given by 'doc-id-p'.  This permits creation of catalogued
+function given by `doc-id-p'.  This permits creation of catalogued
 online libraries.  See @file{$@{hyperb:dir@}/hib-doc-id.el} for more
 information.@refill
+@item completion
+@findex ibtypes::completion
+@cindex completion
+Inserts completion at point into minibuffer or other window.
+@item Info-node
+@findex ibtypes::Info-node
+@cindex Info node
+Makes "(file)node" buttons display the associated Info node.
+@item mail-address
+@findex ibtypes::mail-address
+@cindex e-mail address
+@cindex rolodex address
+@cindex address
+If on an e-mail address in a specific buffer type, mail to that address
+in another window. Applies to the rolodex match buffer, any buffer
+attached to a file in @var{rolo-file-list}, or any buffer with @file{mail}
+or @file{rolo} (case-insensitive) within its name.
+@item patch-msg
+@findex ibtypes::patch-msg
+@cindex patch output
+Jumps to source code associated with output from the @code{patch}
+program.  Patch applies diffs to source code.
 @item elisp-compiler-msg
 @findex ibtypes::elisp-compiler-msg
 @cindex byte compiler error
 @cindex Emacs Lisp compiler error
 @cindex compiler error
 Jumps to source code for definition associated with byte-compiler error
 message.  Works when activated anywhere within an error line.
+@item grep-msg
+@findex ibtypes::grep-msg
+@cindex grep
+@cindex compiler error
+Jumps to line associated with grep or compilation error msgs.
+Messages are recognized in any buffer.
 @item debugger-source
 @findex ibtypes::debugger-source
 @cindex gdb
 @cindex dbx
 @cindex stack frame
 @cindex breakpoint
 @cindex source line
 Jumps to source line associated with debugger stack frame or breakpoint lines.
 This works with gdb, dbx, and xdb.  Such lines are recognized in any buffer.
-@item grep-msg
-@findex ibtypes::grep-msg
-@cindex grep
-@cindex compiler error
-Jumps to line associated with grep or compilation error msgs.
-Messages are recognized in any buffer.
-@item hyp-address
-@findex ibtypes::hyp-address
-@cindex Hyperbole mail list
-Turns a Hyperbole e-mail list address into an implicit button which
-inserts Hyperbole environment information.
-Useful when sending mail to a Hyperbole mail list.  See also the
-documentation for @code{actypes::hyp-config}.
-@item hyp-source
-@findex ibtypes::hyp-source
-@cindex Hyperbole report
-Turns source location entries in Hyperbole reports into buttons that jump to the associated location.
-@item Info-node
-@findex ibtypes::Info-node
-@cindex Info node
-Makes "(file)node" buttons display the associated Info node.
-@item kbd-key
-@findex ibtypes::kbd-key
-@cindex key sequence
-Executes a key sequence delimited by curly braces.
-Key sequences should be in human readable form, e.g@. @{@kbd{C-b}@}.
-Forms such as @{@}, @{@}, and @{^b@} will not be recognized.
-@item klink
-@findex ibtypes::klink
-@cindex klink
-@cindex koutline link
-@cindex kcell link
-Follows a link delimited by <> to a koutline cell.
-See documentation for @code{actypes::link-to-kotl} for valid link
-specifiers.
-@item mail-address
-@findex ibtypes::mail-address
-@cindex e-mail address
-@cindex rolodex address
-@cindex address
-If on an e-mail address in a specific buffer type, mail to that address
-in another window. Applies to the rolodex match buffer, any buffer
-attached to a file in @var{rolo-file-list}, or any buffer with @file{mail}
-or @file{rolo} (case-insensitive) within its name.
-@item man-apropos
-@findex ibtypes::man-apropos
-@item UNIX manual
-@item man pages
-@item man apropos
-Makes man apropos entries display associated man pages when selected.
-@item patch-msg
-@findex ibtypes::patch-msg
-@cindex patch output
-Jumps to source code associated with output from the @code{patch}
-program.  Patch applies diffs to source code.
 @item pathname
 @findex ibtypes::pathname
 @findex hpath:at-p
 @findex hpath:find
 @cindex remote path
 @cindex filename
 @cindex link, pathname
 Makes a delimited, valid pathname display the path entry.
 Also works for delimited and non-delimited ange-ftp and efs pathnames.
+Also works for delimited and non-delimited ange-ftp and efs pathnames.
+Emacs Lisp library files (filenames that end in .el and .elc) are looked up
+using the load-path directory list.
+@noindent
 See @code{hpath:at-p} function documentation for possible delimiters.
 See @var{hpath:suffixes} variable documentation for suffixes that are
 added to or removed from pathname when searching for a valid match.
-See @code{hpath:find} function documentation and
+See @code{hpath:find} function documentation for special file
-@var{hpath:display-alist} and @var{hpath:find-alist} variable
+display options.
-documentation for special file display options.
+@item klink
+@findex ibtypes::klink
+@cindex klink
+@cindex koutline link
+@cindex kcell link
+Follows a link delimited by <> to a koutline cell.
+See documentation for @code{actypes::link-to-kotl} for valid link
+specifiers.
+@item man-apropos
+@findex ibtypes::man-apropos
+@item UNIX manual
+@item man pages
+@item man apropos
+Makes man apropos entries display associated man pages when selected.
+@item hyp-source
+@findex ibtypes::hyp-source
+@cindex Hyperbole report
+Turns source location entries in Hyperbole reports into buttons that jump to the associated location.
+@item hyp-address
+@findex ibtypes::hyp-address
+@cindex Hyperbole mail list
+Turns a Hyperbole e-mail list address into an implicit button which
+inserts Hyperbole environment information.
+Useful when sending mail to a Hyperbole mail list.  See also the
+documentation for @code{actypes::hyp-config}.
 @item rfc
 @findex ibtypes::rfc
 @cindex Internet RFC
 @cindex Request For Comment
 Requires ange-ftp or efs when needed for remote retrievals.  The
 following formats are recognized: RFC822, rfc-822, and RFC 822.  The
 @var{hpath:rfc} variable specifies the location from which to retrieve
 RFCs."
-@item rfc-toc
+@item kbd-key
-@findex ibtypes::rfc-toc
+@findex ibtypes::kbd-key
-@cindex Internet RFC
+@cindex key sequence
-@cindex Request For Comment
+Executes a key sequence delimited by curly braces.
-@cindex RFC
+Key sequences should be in human readable form, e.g@. @{@kbd{C-b}@}.
-@cindex table of contents
+Forms such as @{@}, @{@}, and @{^b@} will not be recognized.
-Summarizes contents of an Internet rfc from anywhere within rfc buffer.
-Each line in summary may be selected to jump to section.
+@item dir-summary
+@findex ibtypes::dir-summary
+@vindex file, MANIFEST
+@vindex file, DIR
+Detects filename buttons in files named "MANIFEST" or "DIR".
+Displays selected files.
+Each file name must be at the beginning of the line and must be followed
+by one or more spaces and then another non-space, non-parenthesis, non-brace
+character.
 @item text-toc
 @findex ibtypes::text-toc
 @cindex table of contents
 @cindex toc implicit button type
 begin with an asterisk), preceding the table of contents.  Each toc
 entry must begin with some whitespace followed by one or more asterisk
 characters.  Each file section name line must start with one or more
 asterisk characters at the very beginning of the line.
+@item cscope
+@findex ibtypes::cscope
+@cindex C/C++ call trees
+@cindex C/C++ cross-reference
+@cindex Cscope
+Jumps to C/C++ source line associated with Cscope C analyzer output line.
+Requires pre-loading of the cscope.el Lisp library available from the Emacs
+Lisp archives and the commercial cscope program available from UNIX System
+Laboratories.  Otherwise, does nothing.
+@item rfc-toc
+@findex ibtypes::rfc-toc
+@cindex Internet RFC
+@cindex Request For Comment
+@cindex RFC
+@cindex table of contents
+Summarizes contents of an Internet rfc from anywhere within rfc buffer.
+Each line in summary may be selected to jump to section.
+@item annot-bib
+@findex ibtypes::annot-bib
+@cindex bibliography
+@cindex reference
+Displays annotated bibliography entries referenced internally, delimeters = [].
+References must be delimited by square brackets, must begin with a
+word constituent character, and must not be in buffers whose
+names begin with a ` ' or `*' character.
 @item www-url
 @findex ibtypes::www-url
 @cindex URL
 @cindex World-wide Web
 @cindex WWW
 @kindex Action Key, web browsing
 @vindex action-key-url-function
 When not in a w3 browser buffer, follow any non-ftp url (link) at point.
 The variable, @var{action-key-url-function}, can be used to customize
 the url browser that is used.
+@item function-in-buffer
+@findex ibtypes::function-in-buffer
+@cindex functions
+@cindex func-menu
+Return function name defined within this buffer that point is within or
+after, else nil.   This triggers only when the func-menu.el package has
+been loaded and the current major mode is one handled by func-menu.
 @end table
 The Hyperbole Smart Keys offer extensive additional context-sensitive
 point-and-click type behavior beyond these standard implicit button
 types.  @xref{Smart Keys}.
 @findex actypes::exec-window-cmd
 Executes an external window-based SHELL-CMD string asynchronously.
 @item hyp-config
 @findex actypes::hyp-config
-Inserts Hyperbole configuration info at end of optional OUT-BUF or current.
+Inserts Hyperbole configuration info at end of current buffer or optional OUT-BUF.
 @item hyp-request
 @findex actypes::hyp-request
-Inserts Hyperbole mail list request help into optional OUT-BUF or current.
+Inserts Hyperbole mail list request help into current buffer or optional OUT-BUF.
 @item hyp-source
 @findex actypes::hyp-source
-Displays a buffer or file from a line beginning with 'hbut:source-prefix'.
+Displays a buffer or file from a line beginning with `hbut:source-prefix'.
 @item kbd-key
 @findex actypes::kbd-key
 Executes the function binding for KEY-SEQUENCE, delimited by @{@}.
 Returns t if a KEY-SEQUENCE has a binding, else nil.
 @item link-to-buffer-tmp
 @findex actypes::link-to-buffer-tmp
 Displays a BUFFER in another window.
 Link is generally only good for current Emacs session.
-Use 'link-to-file' instead for a permanent link.
+Use `link-to-file' instead for a permanent link.
 @item link-to-directory
 @findex actypes::link-to-directory
 Displays a DIRECTORY in Dired mode in another window.
 Displays a PATH in another window scrolled to optional POINT.
 With POINT, buffer is displayed with POINT at the top of the window.
 @item link-to-file-line
 @findex actypes::link-to-file-line
-Displays a PATH in another window scrolled to LINE-NUM.
+Displays a file given by PATH scrolled to LINE-NUM.
 @item link-to-kcell
 @findex actypes::link-to-kcell
-Displays FILE with kcell given by CELL-REF at the top of the window.
+Displays FILE with kcell given by CELL-REF at window top.
-CELL-REF may be a kcell's display label or its permanant idstamp.
+See documentation for `kcell:ref-to-id' for valid cell-ref formats.
+@noindent
 If FILE is nil, the current buffer is used.
 If CELL-REF is nil, the first cell in the view is shown.
 @item link-to-kotl
 @findex actypes::link-to-kotl
 @end example
 @noindent
 See documentation for @code{kcell:ref-to-id} for valid cell-ref formats.
 @item link-to-Info-node
 @findex actypes::link-to-Info-node
 Displays an Info NODE in another window.
-NODE must be a string of the form '(file)nodename'.
+NODE must be a string of the form `(file)nodename'.
 @item link-to-mail
 @findex actypes::link-to-mail
 Displays mail msg with MAIL-MSG-ID from MAIL-FILE in other window.
 See documentation for the variable @var{hmail:init-function} for
 @cindex Emacs 19
 @cindex menu use
 @cindex menubar, Hyperbole menu
 Under InfoDock, XEmacs, and Emacs 19, pulldown and popup menus are
 available to invoke Hyperbole commands, including those from the rolodex
-and the outliner.  These menus operate like any other X window menus.
+and the outliner.  These menus operate like any other application menus
-Use the Quit command on the Hyperbole menubar menu to get rid of the
+and are fairly self-explanatory.  Use the Quit command on the Hyperbole
-menu if you do not need it.  Invoking Hyperbole again will add the menu
+menubar menu to get rid of the menu if you do not need it.  Invoking
-back to the menubar.
+Hyperbole again will add the menu back to the menubar.
 @cindex minibuffer menus
 This section discusses only the specialized @dfn{minibuffer menus} that
-appear in the minibuffer window and that work with all Emacs versions.
+appear in the minibuffer window and that work with all Emacs versions on
-Minibuffer menu items may be selected from either the keyboard or via
+all display devices.  Minibuffer menu items may be selected from either
-mouse clicks.  When used with the keyboard, they provide rapid command
+the keyboard or via mouse clicks.  When used with the keyboard, they
-access similar to key bindings.
+provide rapid command access similar to key bindings.
 @kindex C-h h
 @vindex action-key-default-function
 @cindex menu, top level
 The top level menu is invoked from a key given in your @file{hsite.el}
 location with no other action defined.  The menu will appear in the
 minibuffer and should look mostly like so:
 @noindent
 @example
-Hy4>  Act Butfile/ Doc/ Ebut/ Gbut/ Hist Ibut/ Msg/ Otl/ Rolo/ Win/
+Hy4>  Act Butfile/ Cust/ Doc/ Ebut/ Gbut/ Hist Ibut/ Msg/ Otl/ Rolo/ Win/
 @end example
 @noindent
 The above menu items can be summarized as follows:
 @item Butfile/
 Display a local or global file of buttons, providing easy access.
 @file{HYPB} for a local button file and @file{~/.hyperb/HYPB} for your
 global file.  These are good places to start your button creation testing.
+@cindex menu, Cust
+@cindex customization
+@cindex option settings
+@item Cust/
+Customizes Hyperbole by setting major options.
+This includes where Hyperbole link referents are displayed, where URLs
+are displayed and whether to use proportional or windowful scrolling
+when a Smart Key is pressed at the end of a line.  @xref{Configuring}.
 @cindex menu, EBut
 @item Ebut/
-All explicit button commands.
+All explicit button commands.  The window-system-based Hyperbole
+menu includes a menu item that activates each explicit button found
+in the current buffer.
 @cindex menu, Doc
 @cindex menu, Types
 @item Doc/
-Hyperbole documentation quick access.  Contains Types/ submenu for
+Hyperbole documentation quick access.  Contains About item describing
-documentation on Hyperbole implicit button and action types.
+Hyperbole and a Demo item which demonstrates a number of Hyperbole
+features.  It also contains the Types/ submenu for documentation on
+Hyperbole implicit button and action types.
 @cindex menu, Global Buttons
 @item Gbut/
 All global button commands.  Global buttons are accessed by name
-rather than by direct selection.
+rather than by direct selection.  The window-system-based Hyperbole
+menu also includes a menu item that activates each global button.
 @cindex menu, History
 @cindex history
 @item Hist
 Jumps back to last position in button traversal history.
 @item Ibut/
 All implicit button commands.
 @cindex menu, Message
 @item Msg/
-Hyperbole-specific mail and news messaging support commands.
+Hyperbole-specific mail and news messaging support commands.  Use this
-Use this to send mail to the Hyperbole discussion list or to
+to send mail to a Hyperbole mail list or to add/modify/delete your entry
-add/modify your entry on a Hyperbole mail list.
+on a list.
 @cindex menu, Outliner
 @item Otl/
 Autonumbered, structured outliner and hyper-node manager commands.
 @xref{Outliner}.
 @cindex outline, view specs
 The current view spec is saved whenever the outline is saved.  The next
 time the outline is read in, this will be the initial view.
-The rest of this section documents the view spec characters that are
+The rest of this section documents the the view spec characters that are
 presently supported and explains how to invoke a view spec.  There is no
 user-level way to add your own view spec characters, so all character
 codes are reserved for future use.
 @kindex C-c C-v
 @kindex p
 @item p
 Move to the previous entry at any level.
 @kindex u
 @item u
-Move to the previous entry one level up.
+Move the the previous entry one level up.
 @kindex .
 @kindex <
 @item .
 @itemx <
 Move to the beginning of the buffer.
 WinConfig>  AddName  DeleteName  RestoreName  PopRing  SaveRing  YankRing
 @end display
 @cindex wconfig commands
 @cindex window configuration commands
-@example
-@group
 @findex wconfig-add-by-name
 @findex wconfig-delete-by-name
 @findex wconfig-restore-by-name
 @findex wconfig-delete-pop
 @findex wconfig-ring-save
 @findex wconfig-yank-pop
+@example
+@group
 Menu Item       Command                   Description
 ====================================================================
 AddName         wconfig-add-by-name       Name current wconfig
 DeleteName      wconfig-delete-by-name    Delete wconfig with name
 RestoreName     wconfig-restore-by-name   Restore wconfig by name
 ACTION or ASSIST
 Resizes adjacent window sides to the point of drag release.
 @end group
 @end format
-@cindex drag, between windows
 @format
 @group
+@cindex drag, between windows
 If dragged from inside one window to another:
 ACTION
 Creates a new link button at the drag start location, linked to the
 drag end location.  If drag start position is within a button,
 modifies the button to link to drag end location.
 (2) clicked on right edge of a window's modeline,
 the Info buffer is displayed, or if already displayed and the
 modeline clicked belongs to a window displaying Info, the Info
 buffer is hidden;
 (3) clicked anywhere in the middle of a window's modeline,
-	 the functions listed in 'assist-key-modeline-hook' are
+	 the functions listed in `assist-key-modeline-hook' are
 called;
 (4) dragged vertically from modeline to within a window,
 the modeline is moved to point of key release, thereby resizing
 its window and potentially its vertical neighbors.
 ASSIST
 current minibuffer argument, otherwise, the minibuffer is erased and
 value is inserted there.
 ASSIST
 Displays Hyperbole menu item help when item is selected.
+@end group
+@end format
+@format
+@group
+If in ID-edit mode (a package from InfoDock Associates that supports
+rapid killing, copying, ynaking and display-management):
+ACTION or ASSIST
+Yanks (pastes) last selected region at point.
 @end group
 @end format
 @vindex smart-scroll-proportional
 @cindex proportional scrolling
 tries to bring current line to bottom of window.  Leaves point at end of
 line and returns t if scrolled, nil if not.
 @end group
 @end format
+@format
+@group
+When pressed on a Smart Menu item:
+ACTION
+Activates item.
+ASSIST
+Displays help for item.
+@end group
+@end format
 @cindex click, button
 @cindex button click
 @format
 @group
 When pressed on a Hyperbole button:
 ACTION
 Activates button.
 ASSIST
 Displays help for button, typically a summary of its attributes.
+@end group
+@end format
+@format
+@group
+If Smart Menu package has been loaded and `hkey-always-display-menu' is
+non-nil:
+ACTION or ASSIST
+Pops up a window with a Smart Menu of commands.
+Menu displayed is selected by (smart-menu-choose-menu).
 @end group
 @end format
 @format
 @group
 Key twice to select the tree to move and where to move it;
 (4) anywhere else, scroll down a windowful.
 @end group
 @end format
-@format
-@group
-When pressed on a Smart Menu item:
-ACTION
-Activates item.
-ASSIST
-Displays help for item.
-@end group
-@end format
 @page
 @format
 @group
 When pressed at the end of a Help buffer:
 ACTION or ASSIST
 @end group
 @end format
 @format
 @group
-When pressed within an OO-Browser listing window:
-ACTION
-(1) in a blank buffer or at the end of a buffer, browser help
-information is displayed in the viewer window;
-(2) at the beginning of a (non-single char) class name, the class'
-ancestors are listed;
-(3) at the end of an entry line, scrolls listing up;
-(4) on the '...', following a class name, point is moved to the class
-descendency expansion;
-(5) before an element name, the implementor classes of the name are
-listed;
-(6) anywhere else on an entry line, the source is displayed for editing.
-ASSIST
-(1) in a blank buffer, a selection list of buffer files is displayed;
-(2) at the beginning of a (non-single char) entry, the class'
-descendants are listed;
-(3) at the end of an entry line, scrolls listing down;
-(4) on the '...', following a class name, point is moved to the class
-expansion;
-(5) anywhere else on a class entry line, lists the class' elements;
-(6) anywhere else on an element line, lists the element's implementor
-classes;
-(7) on a blank line following all entries, the current listing buffer
-is exited.
-@end group
-@end format
-@format
-@group
-When pressed within an OO-Browser Command Help Menu buffer:
-ACTION
-Executes an OO-Browser command whose key binding is at point.
-ASSIST
-Displays help for an OO-Browser command whose key binding is at point.
-@end group
-@end format
-@format
-@group
-When pressed on an identifier within an OO-Browser source file:
-ACTION
-Tries to display identifier definition.
-ASSIST
-Not applicable.
-@end group
-@end format
-@page
-@format
-@group
 When pressed within a C source code file:
 ACTION
 Jumps to the definition of selected C construct:
-(1) on a '#include' statement, the include file is displayed;
+(1) on a `#include' statement, the include file is displayed;
 Look for include file in directory lists
-'smart-c-cpp-include-dirs' and 'smart-c-include-dirs'.
+`smart-c-cpp-include-dirs' and `smart-c-include-dirs'.
 (2) on a C identifier, the identifier definition is displayed,
-assuming the identifier is found within an 'etags' generated tag file
+assuming the identifier is found within an `etags' generated tag file
 in the current directory or any of its ancestor directories.
-(3) if 'smart-c-use-lib-man' is non-nil, the C identifier is
+(3) if `smart-c-use-lib-man' is non-nil, the C identifier is
 recognized as a library symbol, and a man page is found for the
 identifier, then the man page is displayed.
 ASSIST
 Jumps to the next tag matching an identifier at point.
 @end group
 When pressed within an assembly source code file:
 ACTION
 Jumps to the definition of selected assembly construct:
 (1) on an include statement, the include file is displayed;
 Look for include file in directory list
-'smart-asm-include-dirs'.
+`smart-asm-include-dirs'.
 (2) on an identifier, the identifier definition is displayed,
-assuming the identifier is found within an 'etags' generated
+assuming the identifier is found within an `etags' generated
 	 tag file in the current directory or any of its ancestor
 	 directories.
 ASSIST
 Jumps to the next tag matching an identifier at point.
 @end group
 @end format
 @page
 @format
 @group
-When pressed within a C++ source code file:
-ACTION
-Jumps to the definition of selected C+ construct:
-(1) on a '#include' statement, the include file is displayed;
-Look for include file in directory lists
-'smart-c-cpp-include-dirs' and 'smart-c-include-dirs'.
-(2) on a C++ identifier, the identifier definition is displayed,
-assuming the identifier is found within an 'etags' generated tag file
-in the current directory or any of its ancestor directories.
-(3) if 'smart-c-use-lib-man' is non-nil, the C++ identifier is
-recognized as a library symbol, and a man page is found for the
-identifier, then the man page is displayed.
-ASSIST
-Jumps to the next tag matching an identifier at point.
-@end group
-@end format
-@format
-@group
-When pressed within a Objective-C source code file:
-ACTION
-Jumps to the definition of selected C+ construct:
-(1) on a '#include' statement, the include file is displayed;
-Look for include file in directory lists
-'smart-c-cpp-include-dirs' and 'smart-c-include-dirs'.
-(2) on an Objective-C identifier, the identifier definition is displayed,
-assuming the identifier is found within an 'etags' generated tag file
-in the current directory or any of its ancestor directories.
-(3) if 'smart-c-use-lib-man' is non-nil, the Objective-C identifier is
-recognized as a library symbol, and a man page is found for the
-identifier, then the man page is displayed.
-ASSIST
-Jumps to the next tag matching an identifier at point.
-@end group
-@end format
-@page
-@format
-@group
 When pressed on a Lisp symbol within a Lisp code buffer:
 ACTION
 Jumps to the definition of any selected Lisp construct.
-If on an Emacs Lisp require, load, or autoload clause and 'find-library'
+If on an Emacs Lisp require, load, or autoload clause and `find-library'
 from load-library package by Hallvard Furuseth <hallvard@@ifi.uio.no> has
 been loaded, jumps to library source, if possible.
 ASSIST
 Jumps to the next tag matching an identifier at point or if using the
 "wtags" package and identifier is an Emacs Lisp symbol, then displays
 documentation for the symbol.
 @end group
 @end format
+@page
+@format
+@group
+When pressed within a Java source code file:
+ACTION
+Jumps to the definition of selected Java construct:
+(1) within a commented @@see cross-reference, the referent is
+displayed;
+(2) on a `package' or `import' statement, the referent is
+displayed; Look for referent files in the directory list
+`smart-java-package-dirs'.
+(3) on an Java identifier, the identifier definition is displayed,
+assuming the identifier is found within an `etags' generated
+tag file in the current directory or any of its ancestor
+directories."
+ASSIST
+Jumps to the next tag matching an identifier at point.
+@end group
+@end format
+@format
+@group
+When pressed within a C++ source code file:
+ACTION
+Jumps to the definition of selected C++ construct:
+(1) on a `#include' statement, the include file is displayed;
+Look for include file in directory lists
+`smart-c-cpp-include-dirs' and `smart-c-include-dirs'.
+(2) on a C++ identifier, the identifier definition is displayed,
+assuming the identifier is found within an `etags' generated tag file
+in the current directory or any of its ancestor directories.
+(3) if `smart-c-use-lib-man' is non-nil, the C++ identifier is
+recognized as a library symbol, and a man page is found for the
+identifier, then the man page is displayed.
+ASSIST
+Jumps to the next tag matching an identifier at point.
+@end group
+@end format
 @format
 @group
 When the OO-Browser has been loaded and the press is within a C++ buffer:
 ACTION or ASSIST
 Jumps to the definition of selected C++ construct via OO-Browser support.
-(1) on a '#include' statement, the include file is displayed;
+(1) on a `#include' statement, the include file is displayed;
 Look for include file in directory lists
-'smart-c-cpp-include-dirs' and 'smart-c-include-dirs'.
+`smart-c-cpp-include-dirs' and `smart-c-include-dirs'.
 (2) within a method declaration, its definition is displayed;
 (3) on a class name, the class definition is shown.
+@end group
+@end format
+@format
+@group
+When pressed within a Objective-C source code file:
+ACTION
+Jumps to the definition of selected C+ construct:
+(1) on a `#include' statement, the include file is displayed;
+Look for include file in directory lists
+`smart-c-cpp-include-dirs' and `smart-c-include-dirs'.
+(2) on an Objective-C identifier, the identifier definition is displayed,
+assuming the identifier is found within an `etags' generated tag file
+in the current directory or any of its ancestor directories.
+(3) if `smart-c-use-lib-man' is non-nil, the Objective-C identifier is
+recognized as a library symbol, and a man page is found for the
+identifier, then the man page is displayed.
+ASSIST
+Jumps to the next tag matching an identifier at point.
 @end group
 @end format
 @format
 @group
 When the OO-Browser has been loaded and the press is within a
 Objective-C buffer:
 ACTION or ASSIST
 Jumps to the definition of selected Objective-C construct via
 OO-Browser support.
-(1) on a '#include' statement, the include file is displayed;
+(1) on a `#include' statement, the include file is displayed;
 Look for include file in directory lists
-'smart-c-cpp-include-dirs' and 'smart-c-include-dirs'.
+`smart-c-cpp-include-dirs' and `smart-c-include-dirs'.
 (2) within a method declaration, its definition is displayed;
 (3) on a class name, the class definition is shown.
+@end group
+@end format
+@format
+@group
+When pressed within a Fortran source code file:
+ACTION or ASSIST
+Jumps to the next tag matching an identifier at point.
 @end group
 @end format
 @format
 @group
 (2) on or after the last line, the buffer in the other window is
 scrolled down a windowful.
 @end group
 @end format
-@format
-@group
-If Smart Menu package has been loaded and 'hkey-always-display-menu' is
-non-nil:
-ACTION or ASSIST
-Pops up a window with a Smart Menu of commands.
-Menu displayed is selected by (smart-menu-choose-menu).
-@end group
-@end format
 @page
 @format
 @group
-If pressed within an outline-mode buffer or when 'selective-display' is
+When pressed within an OO-Browser listing window:
+ACTION
+(1) in a blank buffer or at the end of a buffer, browser help
+information is displayed in the viewer window;
+(2) at the beginning of a (non-single char) class name, the class'
+ancestors are listed;
+(3) at the end of an entry line, scrolls listing up;
+(4) on the `...', following a class name, point is moved to the class
+descendency expansion;
+(5) before an element name, the implementor classes of the name are
+listed;
+(6) anywhere else on an entry line, the source is displayed for editing.
+ASSIST
+(1) in a blank buffer, a selection list of buffer files is displayed;
+(2) at the beginning of a (non-single char) entry, the class'
+descendants are listed;
+(3) at the end of an entry line, scrolls listing down;
+(4) on the `...', following a class name, point is moved to the class
+expansion;
+(5) anywhere else on a class entry line, lists the class' elements;
+(6) anywhere else on an element line, lists the element's implementor
+classes;
+(7) on a blank line following all entries, the current listing buffer
+is exited.
+@end group
+@end format
+@format
+@group
+When pressed within an OO-Browser Command Help Menu buffer:
+ACTION
+Executes an OO-Browser command whose key binding is at point.
+ASSIST
+Displays help for an OO-Browser command whose key binding is at point.
+@end group
+@end format
+@format
+@group
+When pressed on an identifier within an OO-Browser source file:
+ACTION
+Tries to display identifier definition.
+ASSIST
+Not applicable.
+@end group
+@end format
+@page
+@format
+@group
+If pressed within an outline-mode buffer or when `selective-display' is
 non-nil:
 ACTION
 Collapses, expands, and moves outline entries.
 (1) after an outline heading has been cut via the Action Key, then paste
 the cut heading at point;
 (1) the first line of an Info Menu Entry or Cross Reference, the desired
 node is found;
 (2) the Up,Next,or Previous entries of a Node Header (first line),
 the desired node is found;
 (3) the File entry of a Node Header (first line),
-the 'Top' node within that file is found;
+the `Top' node within that file is found;
 (4) at the end of the current node, the Next node is found (this will
-descend subtrees if the function 'Info-global-next' is bound);
+descend subtrees if the function `Info-global-next' is bound);
 (5) anywhere else (e.g@. at the end of a line), the current node entry is
 scrolled up a windowful.
 ASSIST
 (1) the first line of an Info Menu Entry or Cross Reference, the desired
 node is found;
 (2) the Up,Next,or Previous entries of a Node Header (first line),
 the last node in the history list is found;
 (3) the File entry of a Node Header (first line),
-the 'DIR' root-level node is found;
+the `DIR' root-level node is found;
 (4) at the end of the current node, the Previous node is found (this will
 return from subtrees if the function 'Info-global-prev is bound);
 (5) anywhere else (e.g@. at the end of a line), the current node entry is
 scrolled down a windowful.
 @end group
 @end format
 @page
 @format
 @group
-If pressed within a Hyperbole-supported mail reader, 'hmail:reader', or mail
+If pressed within a Hyperbole-supported mail reader, `hmail:reader', or mail
-summary mode, 'hmail:lister', buffer at:
+summary mode, `hmail:lister', buffer at:
 ACTION
 (1) a msg buffer, within the first line or at the end of a message,
 the next undeleted message is displayed;
 (2) a msg buffer within the first line of an Info cross reference, the
 reference is followed;
 for editing in the other window;
 (2) on or after the last line in the buffer, if any deletes are to be
 performed, they are executed after user verification, otherwise, this
 dired invocation is quit.
 ASSIST
-(1) on a '~' character, all backup files in the directory are marked for
+(1) on a `~' character, all backup files in the directory are marked for
 deletion;
-(2) on a '#' character, all auto-save files in the directory are marked
+(2) on a `#' character, all auto-save files in the directory are marked
 for deletion;
 (3) anywhere else within an entry line, the current entry is marked for
 deletion;
 (4) on or after the last line in the buffer, all delete marks on all
 entries are undone.
 @cindex man page references
 @format
 @group
 If pressed on a cross reference within a man page entry section labeled
 NAME, SEE ALSO, or PACKAGES USED, or within a man page C routine
-specification (see 'smart-man-c-routine-ref') and man page buffer
+specification (see `smart-man-c-routine-ref') and man page buffer
 has either an attached file or else a @var{man-path} local variable
 containing its pathname:
 ACTION or ASSIST
 Displays man page or source code for cross reference.
 @end group
 @item kotl-mode:forward-word  @{@kbd{M-f}@}
 Move point forward ARG (or 1) words and return point.
 @findex kotl-mode:goto-cell
 @item kotl-mode:goto-cell  @{@kbd{C-c g}@}
-Move point to start of cell given by CELL-REF.  (See 'kcell:ref-to-id'.)
+Move point to start of cell given by CELL-REF.  (See `kcell:ref-to-id'.)
 Return point iff CELL-REF is found within current view.
 With a prefix argument, CELL-REF is assigned the argument value for use
 as an idstamp.
 Optional second arg, ERROR-P, non-nil means signal an error if CELL-REF is
 @cindex version description
 @cindex Hyperbole version
 If you find any errors in Hyperbole's operation or documentation, feel
 free to report them to the Hyperbole discussion list:
-<hyperbole@@hub.ucsb.edu>.  Be sure to use the Msg/Compose-Hypb-Mail
+<hyperbole@@infodock.com>.  Be sure to use the Msg/Compose-Hypb-Mail
 minibuffer menu item whenever you send a message to the mail list since
 it will insert important system version information for you.
 If you use Hyperbole mail or news support, @ref{Buttons in Mail}, a
 click with your Action Key on the Hyperbole mail list address

Mercurial > hg > xemacs-beta

comparison man/hyperbole.texi @ 24:4103f0995bd7 r19-15b95