branch: externals/vlf
commit 72fec35f4462c48c914e5819c1bd3cc0b247ddd1
Author: Andrey Kotlarski <[email protected]>
Commit: Andrey Kotlarski <[email protected]>
Update README and bump version.
---
README.org | 34 ++++++++++++++++++++++++++++------
vlf.el | 2 +-
2 files changed, 29 insertions(+), 7 deletions(-)
diff --git a/README.org b/README.org
index 0477e45..045ab0c 100644
--- a/README.org
+++ b/README.org
@@ -17,6 +17,8 @@ what it does in a nutshell:
- newly added content is acknowledged if file has changed size
meanwhile
- automatic scrolling of batches
+- as VLF is minor mode, font locking and functionality of the
+ respective major mode is also present
- VLF is added as an option when opening large files
GNU Emacs 23 and 24 are supported.
@@ -43,6 +45,30 @@ integer value), VLF will probably not quite work.
* Detail usage
+** Applicability
+
+You can control when vlf-mode is invoked or offered as choice with the
+*vlf-application* customization option. By default it will offer VLF
+when opening large files. There are also options to never use it (you
+can still call *vlf* command explicitly); to use it without asking for
+large files or to invoke it on all files. Here's example setup such
+that vlf-mode automatically launches for large files:
+
+#+BEGIN_EXAMPLE
+(custom-set-variables
+ '(vlf-application 'dont-ask))
+#+END_EXAMPLE
+
+** Keymap
+
+All VLF operations are grouped under the *C-c C-v* prefix by default.
+Here's example how to add another prefix (*C-x v*):
+
+#+BEGIN_EXAMPLE
+(eval-after-load "vlf"
+ '(define-key vlf-prefix-map "\C-xv" vlf-mode-map))
+#+END_EXAMPLE
+
** Control batch size
*C-c C-v +* and *C-c C-v -* control current batch size by factors
@@ -53,11 +79,11 @@ refresh with *C-c C-v g*.
** Move around
-*C-c C-v PgUp* and *C-c C-v PgDn* move batch by batch. With positive
+*C-c C-v n* and *C-c C-v p* move batch by batch. With positive
prefix argument they move prefix number of batches. With negative -
append prefix number of batches.
-*C-c C-v n* displays batch starting from current point.
+*C-c C-v SPC* displays batch starting from current point.
*C-c C-v [* and *C-c C-v ]* take you to the beginning and end of file
respectively.
@@ -88,10 +114,6 @@ from the beginning, so again the bigger current batch size,
the
quicker. With negative argument, lines are counted from the end of
file.
-** Reload
-
-*C-c C-v g* discards modifications (if such) and reloads chunk.
-
** Edit and save
If editing doesn't change size of the chunk, only this chunk is saved.
diff --git a/vlf.el b/vlf.el
index 5b46a4f..c275da2 100644
--- a/vlf.el
+++ b/vlf.el
@@ -2,7 +2,7 @@
;; Copyright (C) 2006, 2012, 2013 Free Software Foundation, Inc.
-;; Version: 1.1
+;; Version: 1.2
;; Keywords: large files, utilities
;; Maintainer: Andrey Kotlarski <[email protected]>
;; Authors: 2006 Mathias Dahl <[email protected]>
