aboutsummaryrefslogtreecommitdiff
path: root/doc/big_file_options.txt
blob: a4ec5bbbeb6ce6c062653d5d97244a07c886626a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
*big_file_options.txt*	For Vim version 7.0	Last change: 2018 May 31

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.

It's similar to the much older and more sophisticated LargeFile plugin by
Charles Campbell, which is based on VimTip #611:
<http://vim.wikia.com/wiki/Faster_loading_of_large_files>

If you want more options and bells and whistles, you should definitely use
that instead. I'm intentionally keeping this very small and simple; it should
be install-and-forget.

REQUIREMENTS					*big_file_options-requirements*

This plugin is only available if 'compatible' is not set. It also requires the
|+autocmd| feature.

OPTIONS						*big_file_options-options*

There are a few options you can set in your |vimrc| before loading the plugin:

						*g:big_file_size*
Set `g:big_file_size` to the threshold in bytes beyond which a file should be
considered "big"; this defaults to 10 MiB.

						*g:big_file_syntax*
Set `g:big_file_syntax` to either 1 or 0 depending on whether you want to
disable syntax highlighting completely on large files.

						*g:big_file_synmaxcol*
Set `g:big_file_synmaxcol` to the number of columns for which syntax
highlighting should be done on big files, assuming |g:big_file_syntax| is
enabled. It defaults to 256 and only works if you have the |+synmaxcol|
feature.

AUTHOR						*big_file_options-author*

Written and maintained by Tom Ryder <tom@sanctum.geek.nz>.

LICENSE						*big_file_options-license*

Licensed for distribution under the same terms as Vim itself (see |license|).

 vim:tw=78:ts=8:ft=help:norl: