|
| 1 | +--- |
| 2 | +layout: vimdoc |
| 3 | +helpname: 'ft_hare' |
| 4 | +--- |
| 5 | +<div id='vimCodeElement'> |
| 6 | +<a class="Constant" href="ft_hare.html" name="ft_hare.txt">ft_hare.txt</a> Support for the Hare programming language<br> |
| 7 | +<br> |
| 8 | +<span class="PreProc">==============================================================================</span><br> |
| 9 | +<span class="Statement">CONTENTS </span><a class="Constant" href="ft_hare.html#hare" name="hare">hare</a><br> |
| 10 | +<br> |
| 11 | +1. Introduction <a class="Identifier" href="ft_hare.html#hare-intro">hare-intro</a><br> |
| 12 | +2. Filetype plugin <a class="Identifier" href="ft_hare.html#hare-plugin">hare-plugin</a><br> |
| 13 | +3. Settings <a class="Identifier" href="ft_hare.html#hare-settings">hare-settings</a><br> |
| 14 | +<br> |
| 15 | +<span class="PreProc">==============================================================================</span><br> |
| 16 | +<span class="Statement">INTRODUCTION </span><a class="Constant" href="ft_hare.html#hare-intro" name="hare-intro">hare-intro</a><br> |
| 17 | +<br> |
| 18 | +This plugin provides syntax highlighting, indentation, and other functionality<br> |
| 19 | +for the Hare programming language. Support is also provided for README files<br> |
| 20 | +inside Hare modules, but this must be enabled by setting <a class="Identifier" href="ft_hare.html#g:filetype_haredoc">g:filetype_haredoc</a>.<br> |
| 21 | +<br> |
| 22 | +<span class="PreProc">==============================================================================</span><br> |
| 23 | +<span class="Statement">FILETYPE PLUGIN </span><a class="Constant" href="ft_hare.html#hare-plugin" name="hare-plugin">hare-plugin</a><br> |
| 24 | +<br> |
| 25 | +This plugin automatically sets the value of <a class="Type" href="options.html#'path'">'path'</a> to include the contents of<br> |
| 26 | +the HAREPATH environment variable, allowing commands such as <a class="Identifier" href="editing.html#gf">gf</a> to directly<br> |
| 27 | +open standard library or third-party modules. If HAREPATH is not set, it<br> |
| 28 | +defaults to the recommended paths for most Unix-like filesystems, namely<br> |
| 29 | +/usr/src/hare/stdlib and /usr/src/hare/third-party.<br> |
| 30 | +<br> |
| 31 | +<span class="PreProc">==============================================================================</span><br> |
| 32 | +<span class="Statement">SETTINGS </span><a class="Constant" href="ft_hare.html#hare-settings" name="hare-settings">hare-settings</a><br> |
| 33 | +<br> |
| 34 | +This plugin provides a small number of variables that you can define in your<br> |
| 35 | +vimrc to configure its behavior.<br> |
| 36 | +<br> |
| 37 | + <a class="Constant" href="ft_hare.html#g:filetype_haredoc" name="g:filetype_haredoc">g:filetype_haredoc</a><br> |
| 38 | +This plugin is able to automatically detect Hare modules and set the "haredoc"<br> |
| 39 | +filetype for any README files. As the recursive directory search used as a<br> |
| 40 | +heuristic has a minor performance impact, this feature is disabled by default<br> |
| 41 | +and must be specifically opted into:<br> |
| 42 | +<div class="helpExample"> let g:filetype_haredoc = 1</div> |
| 43 | +<br> |
| 44 | +See <a class="Identifier" href="ft_hare.html#g:haredoc_search_depth">g:haredoc_search_depth</a> for ways to tweak the searching behavior.<br> |
| 45 | +<br> |
| 46 | + <a class="Constant" href="ft_hare.html#g:hare_recommended_style" name="g:hare_recommended_style">g:hare_recommended_style</a><br> |
| 47 | +The following options are set by default, in accordance with the official Hare<br> |
| 48 | +style guide:<br> |
| 49 | +<div class="helpExample"> setlocal noexpandtab<br> |
| 50 | + setlocal shiftwidth=0<br> |
| 51 | + setlocal softtabstop=0<br> |
| 52 | + setlocal tabstop=8<br> |
| 53 | + setlocal textwidth=80</div> |
| 54 | +<br> |
| 55 | +To disable this behavior:<br> |
| 56 | +<div class="helpExample"> let g:hare_recommended_style = 0</div> |
| 57 | +<br> |
| 58 | + <a class="Constant" href="ft_hare.html#g:hare_space_error" name="g:hare_space_error">g:hare_space_error</a><br> |
| 59 | +By default, trailing whitespace and tabs preceded by space characters are<br> |
| 60 | +highlighted as errors. This is automatically turned off when in insert mode.<br> |
| 61 | +To disable this highlighting completely:<br> |
| 62 | +<div class="helpExample"> let g:hare_space_error = 0</div> |
| 63 | +<br> |
| 64 | + <a class="Constant" href="ft_hare.html#g:haredoc_search_depth" name="g:haredoc_search_depth">g:haredoc_search_depth</a><br> |
| 65 | +By default, when <a class="Identifier" href="ft_hare.html#g:filetype_haredoc">g:filetype_haredoc</a> is enabled, only the current directory<br> |
| 66 | +and its immediate subdirectories are searched for Hare files. The maximum<br> |
| 67 | +search depth may be adjusted with:<br> |
| 68 | +<div class="helpExample"> let g:haredoc_search_depth = 2</div> |
| 69 | +<br> |
| 70 | + <span class="PreProc">Value Effect</span><br> |
| 71 | + 0 Only search the current directory.<br> |
| 72 | + 1 Search the current directory and immediate<br> |
| 73 | + subdirectories.<br> |
| 74 | + 2 Search the current directory and two levels of<br> |
| 75 | + subdirectories.<br> |
| 76 | +<br> |
| 77 | +The maximum search depth can be set to any integer, but using values higher<br> |
| 78 | +than 2 is not recommended, and will likely provide no tangible benefit in most<br> |
| 79 | +situations.<br> |
| 80 | +<br> |
| 81 | +<span class="PreProc">==============================================================================</span><br> |
| 82 | + vim:tw=78:ts=8:noet:ft=help:norl:<br> |
| 83 | +</div> |
0 commit comments