diff options
| -rw-r--r-- | doc/beancount.txt | 41 |
1 files changed, 36 insertions, 5 deletions
diff --git a/doc/beancount.txt b/doc/beancount.txt index 2a2f37c..7da58f3 100644 --- a/doc/beancount.txt +++ b/doc/beancount.txt @@ -11,6 +11,7 @@ Filetype plugin and functions for working with beancount files. Contents: Commands.............|beancount-commands| + Options...............|beancount-options| Completion.........|beancount-completion| Syntax.................|beancount-syntax| Compiler.............|beancount-compiler| @@ -23,7 +24,7 @@ COMMANDS *beancount-commands* *beancount-:AlignCommodity* :AlignCommodity Adds spaces between an account and commodity so that the decimal points of the commodities all occur in the column - given by `g:decimal_separator_col`. If an amount has no + given by |g:beancount_separator_col|. If an amount has no decimal point, the imaginary decimal point to the right of the least significant digit will align. @@ -34,7 +35,7 @@ COMMANDS *beancount-commands* that it remains on the same character. The alignment character can be set using - `g:beancount_decimal_separator`. The script assumes the + |g:beancount_decimal_separator|. The script assumes the use of spaces for alignment. It does not understand tabs. You can use the following insert-mode remap to @@ -60,6 +61,35 @@ COMMANDS *beancount-commands* nnoremap <buffer> <LocalLeader>c :GetContext<CR> < +OPTIONS *beancount-options* + +*g:beancount_account_completion* + Sets the behaviour of the completion. See |beancount-completion|. + Can be either 'default' or 'chunks'. + + Default value: 'default' + +*g:beancount_detailed_first* + If non-zero, accounts higher down the hierarchy will be listed first as + completions. + + Default value: 0 + +*g:beancount_separator_col* + The column that the decimal separator is aligned to. + + Default value: 50 + +*g:beancount_decimal_separator* + Set the decimal separator that numbers are aligned by. + + Default value: '.' + +*b:beancount_root* + Set the root Beancount file. This is used to gather values for the + completion. If not set, the current file will be used. + + Default value: not set COMPLETION *beancount-completion* @@ -77,15 +107,16 @@ has to match at the beginning of that level of the account hierarchy, e.g. `Ex:Oth` would match `Expenses:Other` but not `Expenses:Other:Something` nor one of the two examples given above. `Ex:Oth:` would, however, list all direct sub-accounts of `Expenses:Other`. -To enable this mode use +To enable this mode use > let g:beancount_account_completion = 'chunks' - +< Optionally, the list of candidates can be sorted by the number of levels in the account hierarchy (e.g. return 'Expenses:Other' before 'Expenses'). -This behavior can be enabled using +This behavior can be enabled using > let g:beancount_detailed_first = 1 +< SYNTAX *beancount-syntax* |