aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2018-05-31 17:41:20 +1200
committerTom Ryder <tom@sanctum.geek.nz>2018-05-31 17:41:20 +1200
commite70de13287c7a7a0a408075b7954e9d14ed606bf (patch)
tree57ce6249662e98fac91129d01b9a6322b28040b2 /doc
downloadvim-big-file-options-e70de13287c7a7a0a408075b7954e9d14ed606bf.tar.gz
vim-big-file-options-e70de13287c7a7a0a408075b7954e9d14ed606bf.zip
Initial commitv0.1.0
Copied with minimal changes from tejr's dotfiles suite, v0.36.0.
Diffstat (limited to 'doc')
-rw-r--r--doc/big_file_options.txt49
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/big_file_options.txt b/doc/big_file_options.txt
new file mode 100644
index 0000000..a4ec5bb
--- /dev/null
+++ b/doc/big_file_options.txt
@@ -0,0 +1,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: