diff options
| author | Lars Ingebrigtsen <larsi@gnus.org> | 2016-04-29 22:28:02 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen <larsi@gnus.org> | 2016-05-01 19:27:09 +0200 |
| commit | 8748c21f7197274177faae7699f5a3d47af4f938 (patch) | |
| tree | b86a7f4884bcd784469aa2e32e49877347ee6694 /lisp | |
| parent | 02c1aa8fe52959df140dd1c0ab8467f00c946a5c (diff) | |
| download | emacs-8748c21f7197274177faae7699f5a3d47af4f938.tar.gz emacs-8748c21f7197274177faae7699f5a3d47af4f938.tar.bz2 emacs-8748c21f7197274177faae7699f5a3d47af4f938.zip | |
Add a doc string to `winner-mode'
* lisp/winner.el (winner-mode): Add a doc string based on the
comments in the file (bug#17716).
(cherry picked from commit 2c3ab9b6e39a3d600e7d82deacc24effaec051bb)
Diffstat (limited to 'lisp')
| -rw-r--r-- | lisp/winner.el | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/lisp/winner.el b/lisp/winner.el index 4b277008d78..9a6f5d5190b 100644 --- a/lisp/winner.el +++ b/lisp/winner.el @@ -346,7 +346,19 @@ You may want to include buffer names such as *Help*, *Apropos*, ;;;###autoload -(define-minor-mode winner-mode nil :global t ; let d-m-m make the doc +(define-minor-mode winner-mode + "Toggle Winner mode on or off. +With a prefix argument ARG, enable Winner mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil, and toggle it if ARG is ‘toggle’. + +Winner mode is a global minor mode that records the changes in +the window configuration (i.e. how the frames are partitioned +into windows) so that the changes can be \"undone\" using the +command `winner-undo'. By default this one is bound to the key +sequence `C-c <left>'. If you change your mind (while undoing), +you can press `C-c <right>' (calling `winner-redo')." + :global t (if winner-mode (progn (add-hook 'window-configuration-change-hook 'winner-change-fun) |