config

Personal configuration.
git clone git://code.dwrz.net/config
Log | Files | Refs

README.org (1208B)


      1 #+title: Popon - "Pop" floating text "on" a window
      2 
      3 Popon allows you to pop text on a window, what we call a popon.
      4 Popons are window-local and sticky, they don't move while scrolling,
      5 and they even don't go away when switching buffer, but you can bind a
      6 popon to a specific buffer to only show on that buffer.
      7 
      8 If some popons are annoying you and you can't kill them, do
      9 =M-x popon-kill-all= to kill all popons.
     10 
     11 * Installation
     12 
     13 ** Package
     14 
     15 Install from NonGNU ELPA.
     16 
     17 ** Quelpa
     18 
     19 #+begin_src emacs-lisp
     20 (quelpa '(popon :fetcher git
     21                 :url "https://codeberg.org/akib/emacs-popon.git"))
     22 #+end_src
     23 
     24 ** Straight.el
     25 
     26 #+begin_src emacs-lisp
     27 (straight-use-package
     28  '(popon :type git :repo "https://codeberg.org/akib/emacs-popon.git"))
     29 #+end_src
     30 
     31 ** Manual
     32 
     33 Download =popon.el= and put it in your ~load-path~.
     34 
     35 * Usage
     36 
     37 The main entry point is ~popon-create~, which creates a popon and
     38 returns that.  Use ~popon-kill~ to kill it.  Popons are immutable, you
     39 can't modify them.  Most of time you'll want to place the popon at
     40 certain point of buffer; call ~popon-x-y-at-pos~ with the point and
     41 use the return value as the coordinates.  Be sure see the docstring of
     42 each function, they describe the best.