README.md

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