www.delorie.com/gnu/docs/hyperbole/hyperbole_9.html

search

	Buy GNU books!

Hyperbole User Manual

2.3 Installing

You may want to explore the Hyperbole configuration options before installing it. See section 2.4 Configuring. If you just want to get up and running quickly, however, there is no need to configure anything, just follow these instructions to install Hyperbole.

Add the following lines to a site initialization file such as `site-start.el' to set up so that all users have Hyperbole loaded for them when they run Emacs. Otherwise, each user will have to add these lines to his own `~/.emacs' initialization file.

To autoload Hyperbole so that it loads only when needed:

(defvar hyperb:dir "<HYPERBOLE-DIR>/") "Directory where the Hyperbole executable code is kept. It must end with a directory separator character.") (load (expand-file-name "hversion" hyperb:dir)) (load (expand-file-name "hyperbole" hyperb:dir))

This establishes a few key bindings and sets up Hyperbole to automatically load whenever you activate its menu. If you would rather have the whole Hyperbole system loaded when you start up so that you can always use the Smart Keys and other facilities, add the additional line:

(require 'hsite)

If you use mouse keys, be sure to add the above lines after any setup of mouse key bindings, to ensure that Hyperbole's mouse keys are properly initialized. See section 4. Smart Keys, for further details. If you use any Hyperbole mail or news support, 3.7.6 Buttons in Mail, be certain to perform all of your personal mail/news initializations before the point at which you load Hyperbole. Otherwise, the mail/news support may not be configured properly. For example, if you use the Emacs add-on Supercite package, its setup should come before Hyperbole initialization.

The Hyperbole Manual is included in the distribution in two forms:

`man/hyperbole.info' - online version `man/hyperbole.texi' - source form

To add pointers to the Info version of the Hyperbole manual within your Info directory, follow these instructions. If Info-directory-list is bound as a variable within your Emacs (all versions except V18 and Epoch), then you can simply set it so that <HYPERBOLE-DIR> is an element in the list:

(setq Info-directory-list (cons "<HYPERBOLE-DIR>" Info-directory-list))

Otherwise, from a shell:

cd to the directory given by your Info-directory variable rm hyperbole.info*; cp <HYPERBOLE-DIR>/man/hyperbole.info* .

For all versions of Emacs, add an Info menu entry for the Hyperbole manual in your Info `dir' file (the `*' should be placed in the first column of the file):

* Hyperbole:: GNU Emacs-based everyday information management system. Use {C-h h d d} for a demonstration. Includes context-sensitive mouse and keyboard support, a powerful rolodex, an autonumbered outliner with hyperlink anchors for each outline cell, and extensible hypertext facilities including hyper-links in mail and news messages.

That's all there is to the installation. Once Hyperbole has been installed for use at your site, you can invoke it with {C-h h} or {M-x hyperbole RET} to bring up the Hyperbole main menu in the minibuffer window.