register-quicknav/README.md

67 lines
2.6 KiB
Markdown
Raw Permalink 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>
2020-03-25 17:12:57 +01:00
*Version:* 0.4.3<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).
* Clear all registers in the unused registers range.
2020-02-19 17:00:03 +01:00
## Installation
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)
2020-03-15 22:08:16 +01:00
(global-set-key (kbd "<C-f7>") #'register-quicknav-point-to-unused-register)
(global-set-key (kbd "<C-S-<f7>") #'register-quicknav-clear-current-register)
2020-02-19 17:00:03 +01:00
Or, with use-package:
(use-package register-quicknav
2020-03-15 22:08:16 +01:00
:bind (("C-<f5>" . register-quicknav-prev-register)
("C-<f6>" . register-quicknav-next-register)
("C-<f7>" . register-quicknav-point-to-unused-register)
("C-S-<f7>" . register-quicknav-clear-current-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
## Differences to similar packages
[iregister](https://github.com/atykhonov/iregister.el):
* Opens a minibuffer on each jump (thereby requiring an extra keystroke).
* Doesn't work with file-query registers
* Can't be restricted to the current buffer.
* Doesn't look like it's still maintained.
[register-channel](https://github.com/YangZhao11/register-channel):
* Is limited to 5 position registers by default, needs an extra keybinding
for each additional register.
* Can't be restricted to the current buffer.
* Has no ability to jump to the next/previous register.
2020-02-19 17:00:03 +01:00
---
Converted from `register-quicknav.el` by [*el2markdown*](https://github.com/Lindydancer/el2markdown).