register-quicknav/README.md

54 lines
2.2 KiB
Markdown
Raw Normal View History

2020-02-19 17:00:03 +01:00
# register-quicknav - Quickly jump to next/previous register
*Author:* tastytea <tastytea@tastytea.de><br>
*Version:* 0.3.2<br>
2020-02-19 19:23:16 +01:00
*URL:* [https://schlomp.space/tastytea/register-quicknav](https://schlomp.space/tastytea/register-quicknav)<br>
2020-02-19 17:00:03 +01:00
2020-02-19 17:02:54 +01:00
This package is built on top of `register.el` and allows you to quickly jump
to the next/previous position register. If you reach the end, the search
2020-03-08 12:17:05 +01:00
wraps around and continues with the first (or last) register. It can be used
across all files or individually for each buffer.
2020-02-19 17:00:03 +01:00
## Features
* Cycle through all position registers in both directions.
* Clear current register.
* Store point in unused register (range configurable).
2020-02-19 17:00:03 +01:00
## Installation
**Note:** The function and variable names were previously separated by “/”
from the namespace. To conform with MELPA rules the separator has been
changed to “-”.
To use `register-quicknav.el`, get it from
[MELPA](https://melpa.org/#/register-quicknav) or put it in your load-path
and add the following to your init.el:
2020-02-19 17:00:03 +01:00
(require 'register-quicknav)
(global-set-key (kbd "<C-f5>") #'register-quicknav-prev-register)
(global-set-key (kbd "<C-f6>") #'register-quicknav-next-register)
(global-set-key (kbd "M-r") #'register-quicknav-clear-current-register)
(global-set-key (kbd "C-M-r") #'register-quicknav-point-to-unused-register)
2020-02-19 17:00:03 +01:00
Or, with use-package:
(use-package register-quicknav
:bind (("C-<f5>" . register-quicknav-prev-register)
("C-<f6>" . register-quicknav-next-register)
("M-r" . register-quicknav-clear-current-register)
("C-M-r" . register-quicknav-point-to-unused-register)))
2020-02-24 22:12:09 +01:00
## Variables
2020-02-19 19:00:30 +01:00
* `register-quicknav-buffer-only`: Cycle only through position registers in
current buffer. Can be safely set as file- and/or dir-local variable.
* `register-quicknav-unused-registers-begin`: Beginning of the range that is
used to search for unused registers. Defaults to `?A`.
* `register-quicknav-unused-registers-end`: End of the range that is used to
search for unused registers. Defaults to `?Z`.
2020-02-19 19:00:30 +01:00
2020-02-19 17:00:03 +01:00
---
Converted from `register-quicknav.el` by [*el2markdown*](https://github.com/Lindydancer/el2markdown).