cgit.sxemacs.org Git - packages/blob - xemacs-packages/speedbar/INSTALL

   1 Installation instructions for Speedbar
   2
   3 The following updates to your .emacs file will help you get the most out
   4 of this update of speedbar.
   5
   6 1) Build speedbar
   7 2) Add speedbar's directory to your load path.
   8
   9    Follow the INSTALL file in the top level of this distribution.
  10
  11 3) Add bindings to make it easier to use speedbar.
  12
  13    If you want to choose it from a menu, such as "Tools", and it doesn't
  14    already exist in your version of Emacs:
  15
  16    Emacs:
  17    (define-key-after (lookup-key global-map [menu-bar tools])
  18       [speedbar] '("Speedbar" . speedbar-frame-mode) [calendar])
  19
  20    XEmacs:
  21    (add-menu-button '("Tools")
  22                       ["Speedbar" speedbar-frame-mode
  23                        :style toggle
  24                        :selected (and (boundp 'speedbar-frame)
  25                                       (frame-live-p speedbar-frame)
  26                                       (frame-visible-p speedbar-frame))]
  27                       "--")
  28
  29    Note: New versions of Emacs already have this in the menu.
  30
  31    If you want to access speedbar using only the keyboard, do this:
  32
  33    (global-set-key [(f4)] 'speedbar-get-focus)
  34
  35    Using F4, you can now toggle between the speedbar frame, and the
  36    frame speedbar was started from.
  37
  38 4) Add auto loads for the auxiliary packages.
  39
  40    For any version of emacs:
  41
  42    ;; Texinfo fancy chapter tags
  43    (add-hook 'texinfo-mode-hook (lambda () (require 'sb-texinfo)))
  44
  45    ;; HTML fancy chapter tags
  46    (add-hook 'html-mode-hook (lambda () (require 'sb-html)))
  47
  48    For any verison of emacs on a linux RPM based system:
  49    (autoload 'rpm "sb-rpm" "Rpm package listing in speedbar.")
  50
  51    For any version of emacs where w3 is installed:
  52
  53    ;; w3 link listings
  54    (autoload 'w3-speedbar-buttons "sb-w3" "s3 specific speedbar button generator.")
  55
  56    For XEmacs, or Emacs earlier than 20.2:
  57
  58    ;; chapter listings
  59    (autoload 'Info-speedbar-buttons "sb-info" "Info specific speedbar button generator.")
  60    ;; folder listings
  61    (autoload 'rmail-speedbar-buttons "sb-rmail" "Rmail specific speedbar button generator.")
  62    ;; current stack display
  63    (autoload 'gud-speedbar-buttons "sb-gud" "GUD specific speedbar button generator.")
  64
  65    For an info mode in Emacs 20.x and XEmacs, it may be necessary to
  66    do this instead:
  67
  68    (eval-after-load "info" '(require 'sb-info))