diff options
| author | Tom Ryder <tom@sanctum.geek.nz> | 2018-07-07 18:04:23 +1200 |
|---|---|---|
| committer | Tom Ryder <tom@sanctum.geek.nz> | 2018-07-07 18:05:14 +1200 |
| commit | 966e123a2ce8976405dc1aef09b4ae422f064102 (patch) | |
| tree | 4786ff12c46ae0adaa52021f13ded917f4cf23d0 /doc | |
| parent | Use full plugin name in options prefix (diff) | |
| download | vim-big-file-options-966e123a2ce8976405dc1aef09b4ae422f064102.tar.gz vim-big-file-options-966e123a2ce8976405dc1aef09b4ae422f064102.zip | |
Overhaul for new version
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/big_file_options.txt | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/doc/big_file_options.txt b/doc/big_file_options.txt index aaea917..532d2d0 100644 --- a/doc/big_file_options.txt +++ b/doc/big_file_options.txt @@ -1,11 +1,11 @@ -*big_file_options.txt* For Vim version 6.0 Last change: 2018 June 17 +*big_file_options.txt* For Vim version 6.0 Last change: 2018 July 7 DESCRIPTION *big_file_options* This plugin adds an |autocmd| hook to check the file size of an incoming -buffer, and if it's over a certain threshold, disables certain options in -order to make the file a bit easier to edit. It disables backups, swap files, -undo files, and by default syntax highlighting. +buffer, and if it's over a certain threshold, disables certain options in order +to make the file a bit easier to edit. It makes the buffer read-only, and +disables filetypes, swap files, undo files, and syntax highlighting. It's similar to the much older and more sophisticated LargeFile plugin by Charles Campbell, which is based on VimTip #611: @@ -25,18 +25,22 @@ OPTIONS *big_file_options-options* There are a few options you can set at any time before loading big files; it's probably best to put them in your |vimrc|. - *g:big_file_options_size* -Set `g:big_file_options_size` to the threshold in bytes beyond which a file + *g:big_file_options_limit* +Set `g:big_file_options_limit` to the threshold in bytes beyond which a file should be considered "big"; this defaults to 10 MiB. + *g:big_file_options_readonly* +Set `g:big_file_options_readonly` to either 1 or 0 depending on whether you +want to make the buffer read-only; this defaults to on. + *g:big_file_options_syntax* Set `g:big_file_options_syntax` to either 1 or 0 depending on whether you want -to disable syntax highlighting completely on large files. +to disable syntax highlighting completely on large files; this defaults to on. *g:big_file_options_synmaxcol* Set `g:big_file_options_synmaxcol` to the number of columns for which syntax highlighting should be done on big files, assuming |g:big_file_options_syntax| -is enabled. It defaults to 256 and only works if you have the |+synmaxcol| +is enabled. This defaults to 256, and only works if you have the |+synmaxcol| feature. AUTHOR *big_file_options-author* |