README.md

   1 # Screenshots
   2
   3 ![eldoc-overlay screenshot](eldoc-overlay screenshot.png)
   4
   5 # eldoc-overlay
   6
   7 Eldoc displays the function signature of the closest function call
   8 around point either in the minibuffer or in the modeline.  This
   9 package modifies Eldoc to display this documentation inline using a
  10 buffer text overlay.
  11
  12 `eldoc-overlay-mode` is a per-buffer minor mode.
  13    A call to `eldoc-overlay-enable` turns it on.
  14    A call to `eldoc-overlay-disable` turns it off
  15
  16    <kbd>C-x C-h</kbd> interactively calls `eldoc-overlay-toggle` and tells
  17    you the mode's new state.
  18
  19 `global-eldoc-overlay-mode` can be used to toggle this for all buffers.
  20    A call to `global-eldoc-overlay-enable` turns it on.
  21    A call to `global-eldoc-overlay-disable` turns it off
  22
  23    <kbd>C-u C-x C-h</kbd> interactively calls `global-eldoc-overlay-toggle` and tells
  24    you the mode's new state.
  25
  26 By default, the overlay is not used in the minibuffer, eldoc is shown in the modeline
  27 in this case.  Set the option `eldoc-overlay-in-minibuffer-flag` non-nil if you want
  28 to enable overlay use in the minibuffer.
  29
  30 The key used to toggle the mode can be customized by setting the `eldoc-overlay-key`
  31 option.
  32
  33 # Installation
  34
  35 ```emacs-lisp
  36 (use-package eldoc-overlay
  37   :ensure t
  38   :init (eldoc-overlay-mode 1))
  39 ```
  40
  41 # Usage
  42
  43 Eldoc displays the function signature of the closest function call around point
  44 either in the minibuffer or in the modeline.
  45
  46 This package modifies Eldoc to display this documentation inline using a buffer
  47 text overlay.
  48
  49 - `eldoc-overlay-mode` is a per-buffer minor mode.
  50 - A call to `eldoc-overlay-enable' turns it on.
  51 - A call to `eldoc-overlay-disable' turns it off
  52
  53 {C-x C-h} interactively calls `eldoc-overlay-toggle' and tells you the mode's
  54 new state.
  55
  56 - `global-eldoc-overlay-mode' can be used to toggle this for all buffers.
  57 - A call to `global-eldoc-overlay-enable' turns it on.
  58 - A call to `global-eldoc-overlay-disable' turns it off
  59
  60 {C-u C-x C-h} interactively calls `global-eldoc-overlay-toggle` and tells you
  61 the mode's new state.
  62
  63 By default, the overlay is not used in the minibuffer, eldoc is shown in the
  64 modeline in this case. Set the option `eldoc-overlay-in-minibuffer-flag` non-nil
  65 if you want to enable overlay use in the minibuffer.
  66
  67 The key used to toggle the mode can be customized by setting the
  68 `eldoc-overlay-key` option.
  69
  70 Finally, see the documentation for `eldoc-overlay-backend` if you want to try a
  71 different overlay display package backend.
  72
  73 # Changelog
  74
  75 ## break backward compatible upgrading changes
  76
  77
  78 This source code originally came from an answer to [justbur](https://emacs.stackexchange.com/users/14114/justbur)
  79 of this [question](https://emacs.stackexchange.com/questions/29256/display-eldoc-help-info-behind-point).