addons/LargeFile/doc/LargeFile.txt

   1 *LargeFile.txt* Editing Large Files Quickly                     Sep 23, 2008
   2
   3 Author:  Charles E. Campbell, Jr.  <NdrOchip@ScampbellPfamily.AbizM>
   4           (remove NOSPAM from Campbell's email first)
   5 Copyright: (c) 2004-2008 by Charles E. Campbell, Jr.    *LargeFile-copyright*
   6            The VIM LICENSE applies to LargeFile.vim
   7            (see |copyright|) except use "LargeFile" instead of "Vim"
   8            No warranty, express or implied.  Use At-Your-Own-Risk.
   9
  10 ==============================================================================
  11 1. Large File Plugin                                            *largefile* {{{1
  12
  13 The LargeFile plugin is fairly short -- it simply sets up an |autocmd| that
  14 checks for large files.  There is one parameter: >
  15         g:LargeFile
  16 which, by default, is 20MB.  Thus with this value of g:LargeFile, 20MByte
  17 files and larger are considered to be "large files"; smaller ones aren't.  Of
  18 course, you as a user may set g:LargeFile to whatever you want in your
  19 <.vimrc> (in units of MBytes).
  20
  21 LargeFile.vim always assumes that when the file size is larger than what
  22 can fit into a signed integer (2^31, ie. about 2GB) that the file is "Large".
  23
  24 Basically, this autocmd simply turns off a number of features in Vim,
  25 including event handling, undo, and syntax highlighting, in the interest of
  26 speed and responsiveness.
  27
  28 LargeFile.vim borrows from vimtip#611.
  29
  30 To undo what LargeFile does, type >
  31         :Unlarge
  32 <
  33 To redo what LargeFile does, type >
  34         :Large
  35 <
  36 Note that LargeFile cannot alleviate hardware limitations; vim on 32-bit
  37 machines are limited to editing 2G files.  If your vim is compiled on a 64-bit
  38 machine such that it can take advantage of the additional address space, then
  39 presumably vim could edit up to 9.7 quadrillion byte files (not that I've ever
  40 tried that!).
  41
  42 ==============================================================================
  43 2. History                                              *largefile-history* {{{1
  44
  45   4 : Jan 03, 2008 * made LargeFile.vim :AutoInstall:-able by getscript
  46       Apr 11, 2008 * (Daniel Shahaf suggested) that :Large! do the large-file
  47                      handling irregardless of file size.  Implemented.
  48       Sep 23, 2008 * if getfsize() returns -2 then the file is assumed to be
  49                      large
  50   3 : May 24, 2007 * Unlarge command included
  51                    * If getfsize() returns something less than -1, then it
  52                      will automatically be assumed to be a large file.
  53
  54 ==============================================================================
  55 vim:tw=78:ts=8:ft=help:fdm=marker: