sascha/vlfi
1
0
Fork 0
mirror of https://github.com/m00natic/vlfi.git synced 2025-09-19 19:52:08 +01:00
Code Issues Releases Wiki Activity

Minor documentation fixes.

Browse Source
This commit is contained in:
Andrey Kotlarski
2013-05-01 02:02:28 +03:00
parent 7bfe665524
commit 3d652fe71d
2 changed files with 20 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.org
View File

@@ -33,10 +33,11 @@ Emacs' Unicode support is leveraged so you'll not see bare bytes but
characters decoded as if file is normally opened. This holds for characters decoded as if file is normally opened. This holds for
editing, search and indexing. editing, search and indexing.
** Bignums ** 32-bit GNU/Emacs
Regular Emacs integers are used, so if you have really huge file and Regular Emacs integers are used, so if you use 32-bit Emacs without
Emacs doesn't have bignum support, VLFI will probably not quite work. bignum support and have really huge file (with size beyond the maximum
integer value), VLFI will probably not quite work.
** Memory control ** Memory control
@@ -49,8 +50,9 @@ example you can directly press digits to enter prefix arguments.
** Changing major mode ** Changing major mode
You can temporarily change major mode to whatever you like. Saving You can (temporarily) change major mode to whatever you like (for
will insert contents as intended. You can return to *vlfi-mode* too. example hexl-mode). Saving will insert contents as intended. You can
return to *vlfi-mode* too.
* Detail usage * Detail usage
@@ -82,17 +84,20 @@ you'd better set somewhat bigger batch size beforehand.
*l* jumps to given line in file. This is done by searching from the *l* jumps to given line in file. This is done by searching from the
beginning, so again the bigger current batch size, the quicker. beginning, so again the bigger current batch size, the quicker.
** Edit
*e* enters VLFI 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
(batch size + difference to the original chunk size) x 2.
** Occur over whole file ** Occur over whole file
*o* builds index for given regular expression just like occur-mode. *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 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 you prematurely stop it with *C-g*, it will still show index of what's
found so far. found so far.
** Edit
*e* enters VLFI 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
#+BEGIN_EXAMPLE
(batch size + difference to the original chunk size) x 2
#+END_EXAMPLE

4
vlfi.el
View File

@@ -26,9 +26,9 @@
;;; Commentary: ;;; Commentary:
;; This package provides the M-x vlfi command, which visits part of a ;; This package provides the M-x vlfi command, which visits part of a
;; large file in a read-only buffer without visiting the entire file. ;; large file without loading the entire file.
;; The buffer uses VLFI mode, which defines several commands for ;; The buffer uses VLFI mode, which defines several commands for
;; moving around, searching and editing selected chunk of file. ;; moving around, searching and editing selected part of file.
;; This package is upgraded version of the vlf.el package. ;; This package is upgraded version of the vlf.el package.