sascha/vlfi
1
0
Fork 0
mirror of https://github.com/m00natic/vlfi.git synced 2025-01-31 10:10:48 +00:00
Code Issues Releases Wiki Activity

Update README.

Browse Source
This commit is contained in:
Andrey Kotlarski 2013-12-03 02:54:33 +02:00
parent 452b7eb42d
commit f34986a9b8
1 changed files with 33 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
README.org
View File

@ -1,8 +1,8 @@
* View Large Files * View Large Files
An Emacs mode that allows viewing, editing and searching in large Emacs minor mode that allows viewing, editing and searching large
files in chunks. Batch size can be adjusted on the fly and bounds the files in batches. Batch size can be adjusted on the fly and bounds
memory that is to be used for operations on the file. 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 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: 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. *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 * Detail usage
** Control batch size ** 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 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 ** Move around
*M-PgUp* and *M-PgDn* move chunk by chunk. With positive prefix *C-c C-v PgUp* and *C-c C-v PgDn* move batch by batch. With positive
argument they move prefix number of batches. With negative - append prefix argument they move prefix number of batches. With negative -
prefix number of batches. 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 *C-c C-v j* jumps to given chunk. To see where you are in file and
there are (using the current batch size), look at the bracketed part how many chunks there are (using the current batch size), look at the
of the buffer name, batch size is also there - at the end. bracketed part of the buffer name, batch size is indicated in the
mode-line.
** Search whole file ** Search whole file
*s* and *r* search forward and backward respectively over the whole *C-c C-v s* and *C-c C-v r* search forward and backward respectively
file. This is done chunk by chunk so if you have really huge file - over the whole file. This is done batch by batch so if you have
you'd better set somewhat bigger batch size beforehand. really huge file - you'd better set somewhat bigger batch size
beforehand.
** Occur over whole file ** Occur over whole file
*o* builds index for given regular expression just like occur-mode. *C-c C-v o* builds index for given regular expression just like M-x
It does this chunk by chunk over the whole file. Note that even if occur*. It does this batch by batch over the whole file. Note that
you prematurely stop it with *C-g*, it will still show index of what's even if you prematurely stop it with *C-g*, it will still show index
found so far. of what's found so far.
** Jump to line ** Jump to line
*l* jumps to given line in file. This is done by searching from the *C-c C-v l* jumps to given line in file. This is done by searching
beginning, so again the bigger current batch size, the quicker. With from the beginning, so again the bigger current batch size, the
negative argument, lines are counted from the end of file. 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 If editing doesn't change size of the chunk, only this chunk is saved.
the chunk, only this chunk is saved. Otherwise the remaining part of Otherwise the remaining part of the file is adjusted batch by batch,
the file is adjusted chunk by chunk, so again you'd better have bigger so again you'd better have bigger current batch size.
current batch size. If chunk has been expanded the memory used is
#+BEGIN_EXAMPLE *Warning* Saving changes to non-ASCII chunks is a bit risky right
(batch size + difference to the original chunk size) x 2 now.
#+END_EXAMPLE