comparison runtime/doc/options.txt @ 27459:5825405e4e2c

Update runtime files Commit: https://github.com/vim/vim/commit/f10911e5db16f1fe6ab519c5d091ad0c1df0d063 Author: Bram Moolenaar <Bram@vim.org> Date: Sat Jan 29 22:20:48 2022 +0000 Update runtime files
author Bram Moolenaar <Bram@vim.org>
date Sat, 29 Jan 2022 23:30:04 +0100
parents 674240fcf6de
children 063952f68595
comparison
equal deleted inserted replaced
27458:2a7fc102cb91 27459:5825405e4e2c
1 *options.txt* For Vim version 8.2. Last change: 2022 Jan 22 1 *options.txt* For Vim version 8.2. Last change: 2022 Jan 29
2 2
3 3
4 VIM REFERENCE MANUAL by Bram Moolenaar 4 VIM REFERENCE MANUAL by Bram Moolenaar
5 5
6 6
1556 'charconvert' is not used when the internal iconv() function is 1556 'charconvert' is not used when the internal iconv() function is
1557 supported and is able to do the conversion. Using iconv() is 1557 supported and is able to do the conversion. Using iconv() is
1558 preferred, because it is much faster. 1558 preferred, because it is much faster.
1559 'charconvert' is not used when reading stdin |--|, because there is no 1559 'charconvert' is not used when reading stdin |--|, because there is no
1560 file to convert from. You will have to save the text in a file first. 1560 file to convert from. You will have to save the text in a file first.
1561 The expression must return zero or an empty string for success, 1561 The expression must return zero, false or an empty string for success,
1562 non-zero for failure. 1562 non-zero or true for failure.
1563 The possible encoding names encountered are in 'encoding'. 1563 The possible encoding names encountered are in 'encoding'.
1564 Additionally, names given in 'fileencodings' and 'fileencoding' are 1564 Additionally, names given in 'fileencodings' and 'fileencoding' are
1565 used. 1565 used.
1566 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8" 1566 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1567 is done internally by Vim, 'charconvert' is not used for this. 1567 is done internally by Vim, 'charconvert' is not used for this.
1581 v:fname_in name of the input file 1581 v:fname_in name of the input file
1582 v:fname_out name of the output file 1582 v:fname_out name of the output file
1583 Note that v:fname_in and v:fname_out will never be the same. 1583 Note that v:fname_in and v:fname_out will never be the same.
1584 Note that v:charconvert_from and v:charconvert_to may be different 1584 Note that v:charconvert_from and v:charconvert_to may be different
1585 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4. 1585 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1586
1586 Encryption is not done by Vim when using 'charconvert'. If you want 1587 Encryption is not done by Vim when using 'charconvert'. If you want
1587 to encrypt the file after conversion, 'charconvert' should take care 1588 to encrypt the file after conversion, 'charconvert' should take care
1588 of this. 1589 of this.
1590
1591 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1592 replaced with the script ID (|local-function|). Example: >
1593 set charconvert=s:MyConvert()
1594 set charconvert=<SID>SomeConvert()
1595 < Otherwise the expression is evaluated in the context of the script
1596 where the option was set, thus script-local items are available.
1597
1589 This option cannot be set from a |modeline| or in the |sandbox|, for 1598 This option cannot be set from a |modeline| or in the |sandbox|, for
1590 security reasons. 1599 security reasons.
1591 1600
1592 *'cindent'* *'cin'* *'nocindent'* *'nocin'* 1601 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1593 'cindent' 'cin' boolean (default off) 1602 'cindent' 'cin' boolean (default off)
7775 7784
7776 *'tabstop'* *'ts'* 7785 *'tabstop'* *'ts'*
7777 'tabstop' 'ts' number (default 8) 7786 'tabstop' 'ts' number (default 8)
7778 local to buffer 7787 local to buffer
7779 Number of spaces that a <Tab> in the file counts for. Also see 7788 Number of spaces that a <Tab> in the file counts for. Also see
7780 |:retab| command, and 'softtabstop' option. 7789 the |:retab| command, and the 'softtabstop' option.
7781 7790
7782 Note: Setting 'tabstop' to any other value than 8 can make your file 7791 Note: Setting 'tabstop' to any other value than 8 can make your file
7783 appear wrong in many places (e.g., when printing it). 7792 appear wrong in many places, e.g., when printing it.
7793 The value must be more than 0 and less than 10000.
7784 7794
7785 There are four main ways to use tabs in Vim: 7795 There are four main ways to use tabs in Vim:
7786 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4 7796 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7787 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim 7797 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
7788 will use a mix of tabs and spaces, but typing <Tab> and <BS> will 7798 will use a mix of tabs and spaces, but typing <Tab> and <BS> will