narrow-x

Extra functions for narrowing in Emacs
git clone git://jamzattack.xyz/narrow-x.git
Log | Files | Refs | LICENSE

commit b6c3ed89f24fe2f392fd0b5f96e991f4184ee040
parent db597f8db4c96358924645ad3348e1ba9e6b53fc
Author: Jamie Beardslee <jdb@jamzattack.xyz>
Date:   Thu, 17 Sep 2020 18:00:00 +1200

Add README

Diffstat:
AREADME.org | 83+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 83 insertions(+), 0 deletions(-)

diff --git a/README.org b/README.org @@ -0,0 +1,83 @@ +#+title: Narrow-x +#+author: Jamie Beardslee +#+email: jdb@jamzattack.xyz + +This package provides a few extra convenience features for [[info:emacs#Narrowing][narrowing]]. + +Mainly, it provides narrowing to the next or previous thing. +Currently implemented: +- page +- defun +- paragraph + +It also defines the missing [[help:narrow-to-paragraph][narrow-to-paragraph]]. + +* Installation +** package.el +Download narrow-x.el, and use =M-x package-install-file RET +path/to/narrow-x.el=. + +** straight.el +Use the following recipe: + +#+begin_src emacs-lisp + (narrow-x :type git + :flavor melpa + :repo "git://jamzattack.xyz/narrow-x") +#+end_src + +** Manual installation +1. Download narrow-x.el +2. Stick it in [[help:load-path][load-path]] +3. Update autoloads +4. (optionally) byte-compile it + +* Command index + +- *Function*: ([[help:narrow-to-next-page][narrow-to-next-page]] (&optional count)) + + Narrow to the next page. + Prefix arg COUNT is passed to [[help:forward-page][forward-page]], rather than + [[help:narrow-to-page][narrow-to-page]]. + +- *Function*: ([[help:narrow-to-prev-page][narrow-to-prev-page]] (&optional count)) + + Narrow to the previous page. + Negated prefix arg COUNT is passed to [[help:forward-page][forward-page]], rather than + [[help:narrow-to-page][narrow-to-page]]. + +- *Function*: ([[help:narrow-to-next-defun][narrow-to-next-defun]] (&optional count)) + + Narrow to the next defun. + Point will be moved to the beginning of the defun. Prefix arg + COUNT is passed to [[help:beginning-of-defun][beginning-of-defun]], rather than + [[help:narrow-to-defun][narrow-to-defun]]. + +- *Function*: ([[help:narrow-to-prev-defun][narrow-to-prev-defun]] (&optional count)) + + Narrow to the previous defun. + Point will be moved to the beginning of the defun. Negated + prefix arg COUNT is passed to [[help:beginning-of-defun][beginning-of-defun]], rather than + [[help:narrow-to-defun][narrow-to-defun]]. + +- *Function*: ([[help:narrow-to-paragraph][narrow-to-paragraph]] (&optional arg)) + + Narrow to the next ARG paragraphs. + +- *Function*: ([[help:narrow-to-next-paragraph][narrow-to-next-paragraph]] (&optional count)) + + Narrow to the next paragraph. + Point will be moved to the beginning of the paragraph. Prefix + arg COUNT is passed to [[help:forward-paragraph][forward-paragraph]], rather than + [[help:narrow-to-paragraph][narrow-to-paragraph]]. + +- *Function*: ([[help:narrow-to-prev-paragraph][narrow-to-prev-paragraph]] (&optional count)) + + Narrow to the previous paragraph. + Point will be moved to the beginning of the paragraph. Negated + prefix arg COUNT is passed to [[help:forward-paragraph][forward-paragraph]], rather than + [[help:narrow-to-paragraph][narrow-to-paragraph]]. + +* License + +GPL3+