[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/vlf f34986a 142/310: Update README.
From: |
Stefan Monnier |
Subject: |
[elpa] externals/vlf f34986a 142/310: Update README. |
Date: |
Sat, 28 Nov 2020 00:33:03 -0500 (EST) |
branch: externals/vlf
commit f34986a9b8411e11d3d1843c02df22b42c79912c
Author: Andrey Kotlarski <m00naticus@gmail.com>
Commit: Andrey Kotlarski <m00naticus@gmail.com>
Update README.
---
README.org | 74 ++++++++++++++++++++++++++++----------------------------------
1 file changed, 33 insertions(+), 41 deletions(-)
diff --git a/README.org b/README.org
index 5f51108..efe161a 100644
--- a/README.org
+++ b/README.org
@@ -1,8 +1,8 @@
* View Large Files
-An Emacs mode that allows viewing, editing and searching in large
-files in chunks. Batch size can be adjusted on the fly and bounds the
-memory that is to be used for operations on the file.
+Emacs minor mode that allows viewing, editing and searching large
+files in batches. Batch size can be adjusted on the fly and bounds
+the memory that is to be used for operations on the file.
This is development version of the GNU ELPA
[[http://elpa.gnu.org/packages/vlf][vlf.el]] package. Here's
what it does in a nutshell:
@@ -41,64 +41,56 @@ integer value), VLF will probably not quite work.
*vlf-batch-size* bounds the memory used for all operations.
-** Special mode
-
-VLF is derived from special-mode and keeps all its properties. For
-example you can directly press digits to enter prefix arguments.
-
-** Change major mode
-
-You can change major mode to whatever you like (for example
-hexl-mode). Saving will insert contents as intended. You can return
-to *vlf-mode* too.
-
* Detail usage
** Control batch size
-*+* and *-* control current batch size by factors of 2.
+*C-c C-v +* and *C-c C-v -* control current batch size by factors
+of 2.
You can also set by hand local variable *vlf-batch-size* and then
-refresh with *g*.
+refresh with *C-c C-v g*.
** Move around
-*M-PgUp* and *M-PgDn* move chunk by chunk. With positive prefix
-argument they move prefix number of batches. With negative - append
-prefix number of batches.
+*C-c C-v PgUp* and *C-c C-v PgDn* move batch by batch. With positive
+prefix argument they move prefix number of batches. With negative -
+append prefix number of batches.
-*[* and *]* take you to the beginning and end of file respectively.
+*C-c C-v [* and *C-c C-v ]* take you to the beginning and end of file
+respectively.
-*j* jumps to given chunk. To see where you are in file and how many chunks
-there are (using the current batch size), look at the bracketed part
-of the buffer name, batch size is also there - at the end.
+*C-c C-v j* jumps to given chunk. To see where you are in file and
+how many chunks there are (using the current batch size), look at the
+bracketed part of the buffer name, batch size is indicated in the
+mode-line.
** Search whole file
-*s* and *r* search forward and backward respectively over the whole
-file. This is done chunk by chunk so if you have really huge file -
-you'd better set somewhat bigger batch size beforehand.
+*C-c C-v s* and *C-c C-v r* search forward and backward respectively
+over the whole file. This is done batch by batch so if you have
+really huge file - you'd better set somewhat bigger batch size
+beforehand.
** Occur over whole file
-*o* builds index for given regular expression just like occur-mode.
-It does this chunk by chunk over the whole file. Note that even if
-you prematurely stop it with *C-g*, it will still show index of what's
-found so far.
+*C-c C-v o* builds index for given regular expression just like M-x
+occur*. It does this batch by batch over the whole file. Note that
+even if you prematurely stop it with *C-g*, it will still show index
+of what's found so far.
** Jump to line
-*l* jumps to given line in file. This is done by searching from the
-beginning, so again the bigger current batch size, the quicker. With
-negative argument, lines are counted from the end of file.
+*C-c C-v l* jumps to given line in file. This is done by searching
+from the beginning, so again the bigger current batch size, the
+quicker. With negative argument, lines are counted from the end of
+file.
-** Edit
+** Edit and save
-*e* enters VLF in edit mode. If editing doesn't change size of
-the chunk, only this chunk is saved. Otherwise the remaining part of
-the file is adjusted chunk by chunk, so again you'd better have bigger
-current batch size. If chunk has been expanded the memory used is
+If editing doesn't change size of the chunk, only this chunk is saved.
+Otherwise the remaining part of the file is adjusted batch by batch,
+so again you'd better have bigger current batch size.
-#+BEGIN_EXAMPLE
-(batch size + difference to the original chunk size) x 2
-#+END_EXAMPLE
+*Warning* Saving changes to non-ASCII chunks is a bit risky right
+now.
- [elpa] externals/vlf ce9441f 120/310: Update info as VLFI is merging back to VLF. Bump version., (continued)
- [elpa] externals/vlf ce9441f 120/310: Update info as VLFI is merging back to VLF. Bump version., Stefan Monnier, 2020/11/28
- [elpa] externals/vlf 7cb0474 122/310: Add forgotten vlfi-encode-size local variable creation., Stefan Monnier, 2020/11/28
- [elpa] externals/vlf 02a37c4 123/310: Merge branch 'master' into chunk-opt2, Stefan Monnier, 2020/11/28
- [elpa] externals/vlf 2d71996 125/310: Add end character shift when adjusting chunk. Apply partial chunk, Stefan Monnier, 2020/11/28
- [elpa] externals/vlf 737c1e9 126/310: Remove encode size bookkeeping., Stefan Monnier, 2020/11/28
- [elpa] externals/vlf d1b34dc 127/310: Add autoload cookie for `file-size-human-readable' not to break GNU, Stefan Monnier, 2020/11/28
- [elpa] externals/vlf 4c631bc 129/310: Rename vlfi.el to vlf.el., Stefan Monnier, 2020/11/28
- [elpa] externals/vlf 17c6612 130/310: Rename anything vlfi -> vlf., Stefan Monnier, 2020/11/28
- [elpa] externals/vlf bc68eed 131/310: Add dummy vlfi.el that urges move to the vlf package., Stefan Monnier, 2020/11/28
- [elpa] externals/vlf 025399a 133/310: Merge branch 'master' into keep-edit, Stefan Monnier, 2020/11/28
- [elpa] externals/vlf f34986a 142/310: Update README.,
Stefan Monnier <=
- [elpa] externals/vlf 931ca52 145/310: Stylistic refinements., Stefan Monnier, 2020/11/28
- [elpa] externals/vlf 2ac3e7d 146/310: Fix prematurely ending search/occur not to ask for modified buffer, Stefan Monnier, 2020/11/28
- [elpa] externals/vlf 0080991 154/310: Fix chunk end adjustment and save for trunk Emacs., Stefan Monnier, 2020/11/28
- [elpa] externals/vlf a3901b8 157/310: Fix deletion when moving to partially overlapping chunk and enable more, Stefan Monnier, 2020/11/28
- [elpa] externals/vlf 371c560 158/310: Bump version and remove warning - save is now reliable., Stefan Monnier, 2020/11/28
- [elpa] externals/vlf c68c34e 160/310: Add vlf-application customization which refines control over when, Stefan Monnier, 2020/11/28
- [elpa] externals/vlf a0cafa7 161/310: Explicitly offer vlf-prefix-map so user can easily define another prefix, Stefan Monnier, 2020/11/28
- [elpa] externals/vlf ea46386 168/310: Don't apply VLF by default over image and pdf files., Stefan Monnier, 2020/11/28
- [elpa] externals/vlf 2470fc0 181/310: Fix vlf-shift-undo-list to reverse resulting list., Stefan Monnier, 2020/11/28
- [elpa] externals/vlf 161a4ec 184/310: Prevent inserting of too small file regions for GNU Emacs later than, Stefan Monnier, 2020/11/28