Nvim :help pages, generated
from source
using the tree-sitter-vimdoc parser.
cinkeys-format indentkeys-format
The 'cinkeys' option is a string that controls Vim's indenting in response to
typing certain characters or commands in certain contexts. Note that this not
only triggers C-indenting. When 'indentexpr' is not empty 'indentkeys' is
used instead. The format of 'cinkeys' and 'indentkeys' is equal.CTRL-F (which is not inserted)
"o" if you type a <CR> anywhere or use the "o" command (not in
insert mode!)
"O" if you use the "O" command (not in insert mode!)
"e" if you type the second 'e' for an "else" at the start of a
linei_CTRL-F
! When a "!" precedes the key, Vim will not insert the key but will
instead reindent the current line. This allows you to define a
command key for reindenting the current line. CTRL-F is the default
key for this. Be careful if you define CTRL-I for this because CTRL-I
is the ASCII code for <Tab>.
* When a "*" precedes the key, Vim will reindent the line before
inserting the key. If 'cinkeys' contains "*<Return>", Vim reindents
the current line before opening a new line.
0 When a zero precedes the key (but appears after "!" or "*") Vim will
reindent the line only if the key is the first character you type in
the line. When used before "=" Vim will only reindent the line if
there is only white space before the word.CTRL-F.
o Reindent a line when you use the "o" command or when Vim opens a new
line below the current one (e.g., when you type <Enter> in insert
mode).
O Reindent a line when you use the "O" command.
e Reindent a line that starts with "else" when you type the second 'e'.
: Reindent a line when a ':' is typed which is after a label or case
statement. Don't reindent for a ":" in "class::method" for C++. To
Reindent for any ":", use "<:>".
=word Reindent when typing the last character of "word". "word" may
actually be part of another word. Thus "=end" would cause reindenting
when typing the "d" in "endif" or "endwhile". But not when typing
"bend". Also reindent when completion produces a word that starts
with "word". "0=word" reindents when there is only white space before
the word.
=~word Like =word, but ignore case.<Enter> but only if you press <Tab>, I suggest:
:set cinkeys=0{,0},:,0#,!<Tab>,!^F
You might also want to switch off 'autoindent' then.<BS>, <Tab>, or <Space> in the indent or
used CTRL-T or CTRL-D.cinoptions-values
The 'cinoptions' option sets how Vim performs indentation. The value after
the option character can be one of these (N is any number):
N indent N spaces
-N indent N spaces to the left
Ns N times 'shiftwidth' spaces
-Ns N times 'shiftwidth' spaces to the leftcino->
>N Amount added for "normal" indent. Used after a line that should
increase the indent (lines starting with "if", an opening brace,
etc.). (default 'shiftwidth').if (cond) if (cond) if (cond)
{ { {
foo; foo; foo;
} } }cino-e
eN Add N to the prevailing indent inside a set of braces if the
opening brace at the End of the line (more precise: is not the
first character in a line). This is useful if you want a
different indent when the "{" is at the start of the line from
when "{" is at the end of the line. (default 0).if (cond) { if (cond) { if (cond) {
foo; foo; foo;
} } }
else else else
{ { {
bar; bar; bar;
} } }cino-n
nN Add N to the prevailing indent for a statement after an "if",
"while", etc., if it is NOT inside a set of braces. This is
useful if you want a different indent when there is no "{"
before the statement from when there is a "{" before it.
(default 0).if (cond) if (cond) if (cond)
foo; foo; foo;
else else else
{ { {
bar; bar; bar;
} } }cino-f
fN Place the first opening brace of a function or other block in
column N. This applies only for an opening brace that is not
inside other braces and is at the start of the line. What comes
after the brace is put relative to this brace. (default 0).func() func() func()
{ { {
int foo; int foo; int foo;cino-{
{N Place opening braces N characters from the prevailing indent.
This applies only for opening braces that are inside other
braces. (default 0).if (cond) if (cond) if (cond)
{ { {
foo; foo; foo;cino-}
}N Place closing braces N characters from the matching opening
brace. (default 0).if (cond) if (cond) if (cond)
{ { {
foo; foo; foo;
} } }cino-^
^N Add N to the prevailing indent inside a set of braces if the
opening brace is in column 0. This can specify a different
indent for whole of a function (some may like to set it to a
negative number). (default 0).func() func() func()
{ { {
if (cond) if (cond) if (cond)
{ { {
a = b; a = b; a = b;
} } }
} } }cino-L
LN Controls placement of jump labels. If N is negative, the label
will be placed at column 1. If N is non-negative, the indent of
the label will be the prevailing indent minus N. (default -1).func() func() func()
{ { {
{ { {
stmt; stmt; stmt;
LABEL: LABEL: LABEL:
} } }
} } }cino-:
:N Place case labels N characters from the indent of the switch().
(default 'shiftwidth').switch (x) switch(x)
{ {
case 1: case 1:
a = b; a = b;
default: default:
} }cino-=
=N Place statements occurring after a case label N characters from
the indent of the label. (default 'shiftwidth').case 11: case 11: a = a + 1;
a = a + 1; b = b + 1;cino-l
lN If N != 0 Vim will align with a case label instead of the
statement after it in the same line.switch (a) { switch (a) {
case 1: { case 1: {
break; break;
} }cino-b
bN If N != 0 Vim will align a final "break" with the case label,
so that case..break looks like a sort of block. (default: 0).
When using 1, consider adding "0=break" to 'cinkeys'.switch (x) switch(x)
{ {
case 1: case 1:
a = b; a = b;
break; break;
default: default:
a = 0; a = 0;
break; break;
} }cino-g
gN Place C++ scope declarations N characters from the indent of the
block they are in. (default 'shiftwidth'). By default, a scope
declaration is "public:", "protected:" or "private:". This can
be adjusted with the 'cinscopedecls' option.{ {
public: public:
a = b; a = b;
private: private:
} }cino-h
hN Place statements occurring after a C++ scope declaration N
characters from the indent of the label. (default
'shiftwidth').public: public: a = a + 1;
a = a + 1; b = b + 1;cino-N
NN Indent inside C++ namespace N characters extra compared to a
normal block. (default 0).namespace { namespace {
void function(); void function();
} }
namespace my namespace my
{ {
void function(); void function();
} }cino-E
EN Indent inside C++ linkage specifications (extern "C" or
extern "C++") N characters extra compared to a normal block.
(default 0).extern "C" { extern "C" {
void function(); void function();
} }
extern "C" extern "C"
{ {
void function(); void function();
} }cino-p
pN Parameter declarations for K&R-style function declarations will
be indented N characters from the margin. (default
'shiftwidth').func(a, b) func(a, b) func(a, b)
int a; int a; int a;
char b; char b; char b;cino-t
tN Indent a function return type declaration N characters from the
margin. (default 'shiftwidth').int int int func() func() func()
cino-i
iN Indent C++ base class declarations and constructor
initializations, if they start in a new line (otherwise they
are aligned at the right side of the ':').
(default 'shiftwidth').class MyClass : class MyClass :
public BaseClass public BaseClass
{} {}
MyClass::MyClass() : MyClass::MyClass() :
BaseClass(3) BaseClass(3)
{} {}cino-+
+N Indent a continuation line (a line that spills onto the next)
inside a function N additional characters. (default
'shiftwidth').
Outside of a function, when the previous line ended in a
backslash, the 2 * N is used.a = b + 9 * a = b + 9 *
c; c;cino-c
cN Indent comment lines after the comment opener, when there is no
other text with which to align, N characters from the comment
opener. (default 3). See also format-comments./* /* text. text. */ */
cino-C
CN When N is non-zero, indent comment lines by the amount specified
with the c flag above even if there is other text behind the
comment opener. (default 0)./******** /******** text. text. ********/ ********/
cino-/
/N Indent comment lines N characters extra. (default 0).
cino= cino=/4a = b; a = b; /* comment */ /* comment */ c = d; c = d;
cino-(
(N When in unclosed parentheses, indent N characters from the line
with the unclosed parenthesis. Add a 'shiftwidth' for every
extra unclosed parentheses. When N is 0 or the unclosed
parenthesis is the first non-white character in its line, line
up with the next non-white character after the unclosed
parenthesis. (default 'shiftwidth' * 2).if (c1 && (c2 || if (c1 && (c2 ||
c3)) c3))
foo; foo;
if (c1 && if (c1 &&
(c2 || c3)) (c2 || c3))
{ {cino-u
uN Same as (N, but for one nesting level deeper.
(default 'shiftwidth').if (c123456789 if (c123456789
&& (c22345 && (c22345
|| c3)) || c3))cino-U
UN When N is non-zero, do not ignore the indenting specified by
( or u in case that the unclosed parenthesis is the first
non-white character in its line. (default 0).c = c1 && c = c1 &&
( (
c2 || c2 ||
c3 c3
) && c4; ) && c4;cino-w
wN When in unclosed parentheses and N is non-zero and either
using "(0" or "u0", respectively, or using "U0" and the unclosed
parenthesis is the first non-white character in its line, line
up with the character immediately after the unclosed parenthesis
rather than the first non-white character. (default 0).if ( c1 if ( c1
&& ( c2 && ( c2
|| c3)) || c3))
foo; foo;cino-W
WN When in unclosed parentheses and N is non-zero and either
using "(0" or "u0", respectively and the unclosed parenthesis is
the last non-white character in its line and it is not the
closing parenthesis, indent the following line N characters
relative to the outer context (i.e. start of the line or the
next unclosed parenthesis). (default: 0).a_long_line( a_long_line(
argument, argument,
argument); argument);
a_short_line(argument, a_short_line(argument,
argument); argument);cino-k
kN When in unclosed parentheses which follow "if", "for" or
"while" and N is non-zero, overrides the behaviour defined by
"(N": causes the indent to be N characters relative to the outer
context (i.e. the line where "if", "for" or "while" is). Has
no effect on deeper levels of nesting. Affects flags like "wN"
only for the "if", "for" and "while" conditions. If 0, defaults
to behaviour defined by the "(N" flag. (default: 0).if (condition1 if (condition1
&& condition2) && condition2)
action(); action();
function(argument1 function(argument1
&& argument2); && argument2);cino-m
mN When N is non-zero, line up a line starting with a closing
parenthesis with the first character of the line with the
matching opening parenthesis. (default 0).c = c1 && ( c = c1 && (
c2 || c2 ||
c3 c3
) && c4; ) && c4;
if ( if (
c1 && c2 c1 && c2
) )
foo; foo;cino-M
MN When N is non-zero, line up a line starting with a closing
parenthesis with the first character of the previous line.
(default 0).if (cond1 && if (cond1 &&
cond2 cond2
) )java-cinoptions java-indenting cino-j
jN Indent Java anonymous classes correctly. Also works well for
Javascript. The value 'N' is currently unused but must be
non-zero (e.g. 'j1'). 'j1' will indent for example the
following code snippet correctly:object.add(new ChangeListener() {
public void stateChanged(ChangeEvent e) {
do_something();
}
});javascript-cinoptions javascript-indenting cino-J
JN Indent JavaScript object declarations correctly by not confusing
them with labels. The value 'N' is currently unused but must be
non-zero (e.g. 'J1'). If you enable this you probably also want
to set cino-j.var bar = {
foo: {
that: this,
some: ok,
},
"bar":{
a : 2,
b: "123abc",
x: 4,
"y": 5
}
}cino-)
)N Vim searches for unclosed parentheses at most N lines away.
This limits the time needed to search for parentheses. (default
20 lines).cino-star
*N Vim searches for unclosed comments at most N lines away. This
limits the time needed to search for the start of a comment.
If your /* */ comments stop indenting after N lines this is the
value you will want to change.
(default 70 lines).cino-#
#N When N is non-zero recognize shell/Perl comments starting with
'#', do not recognize preprocessor lines; allow right-shifting
lines that start with "#".
When N is zero (default): don't recognize '#' comments, do
recognize preprocessor lines; right-shifting lines that start
with "#" does not work.cino-P
PN When N is non-zero recognize C pragmas, and indent them like any
other code; does not concern other preprocessor directives.
When N is zero (default): don't recognize C pragmas, treating
them like every other preprocessor directive.cinoptions=>s,e0,n0,f0,{0,}0,^0,L-1,:s,=s,l0,b0,gs,hs,N0,E0,ps,ts,is,+s,
c3,C0,/0,(2s,us,U0,w0,W0,k0,m0,j0,J0,)20,*70,#0,P0
Vim puts a line in column 1 if:
searchpairpos(). Larger values trade
performance for correctness when dealing with very long forms. A value of
0 will scan without limits. The default is 300.(defn bad []
"Incorrect indentation")
(defn good []
"Correct indentation")" Default
let g:clojure_fuzzy_indent = 1
let g:clojure_fuzzy_indent_patterns = ['^with', '^def', '^let']
let g:clojure_fuzzy_indent_blacklist =
\ ['-fn$', '\v^with-%(meta|out-str|loading-context)$']"^foo" will match all these
candidates: foobar, my.ns/foobar, and #'foobar." Default let g:clojure_special_indent_words = \ 'deftype,defrecord,reify,proxy,extend-type,extend-protocol,letfn'
(def default "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.") (def aligned "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.")
(foo bar baz)
1 changes this behaviour so that all subforms are
aligned to the same column, emulating the default behaviour of
clojure-mode.el:
(foo bar baz)
let fortran_do_enddo=1in which case do loops will be indented. If all your loops are of do/enddo type only in, say, .f90 files, then you should set a buffer flag with an autocommand such as
au! BufRead,BufNewFile *.f90 let b:fortran_do_enddo=1to get do loops indented in .f90 files and left alone in Fortran files with other extensions such as .for.
let fortran_indent_less=1A finer level of control can be achieved by setting the corresponding buffer-local variable as follows
let b:fortran_indent_less=1
<script> and <style>
"blocktags" (default "zero")::let g:html_indent_script1 = "inc" :let g:html_indent_style1 = "inc"
:let g:html_indent_attribute = 1
:let g:html_indent_inctags = "html,body,head,tbody"You can also remove such tags with:
:let g:html_indent_autotags = "th,td,tr,tfoot,thead"Default value is empty for both variables. Note: the initial "inctags" are only defined once per Vim session.
:call HtmlIndent_CheckUserSettings()Detail: Calculation of indent inside "blocktags" with "alien" content:
<script> : {customizable} if first line of block
: cindent(v:lnum) if attributes empty or contain "java"
: -1 else (vbscript, tcl, ...)
<style> : {customizable} if first line of block
: GetCSSIndent() else
<!-- --> : -1:let g:MATLAB_function_indent = {0, 1 or 2 (default)}
Where 0 is for Classic, 1 for Indent nested functions and 2 for Indent all
functions.:%s /\r$//gOr, you can simply :let the variable PHP_removeCRwhenUnix to 1 and the script will silently remove them when Vim loads a PHP file (at each BufRead).
php-comment PHP_autoformatcomment
To not enable auto-formatting of comments by default (if you want to use your
own 'formatoptions')::let g:PHP_autoformatcomment = 0Else, 't' will be removed from the 'formatoptions' string and "qrowcb" will be added, see fo-table for more information.
PHP_outdentSLComments
To add extra indentation to single-line comments::let g:PHP_outdentSLComments = NWith N being the number of 'shiftwidth' to add.
# Comment // Comment /* Comment */
PHP_default_indenting
To add extra indentation to every PHP lines with N being the number of
'shiftwidth' to add::let g:PHP_default_indenting = NFor example, with N = 1, this will give:
<?php
if (!isset($History_lst_sel))
if (!isset($History_lst_sel))
if (!isset($History_lst_sel)) {
$History_lst_sel=0;
} else
$foo="bar";
$command_hist = TRUE;
?>
(Notice the extra indentation between the PHP container markers and the code)PHP_outdentphpescape
To indent PHP escape tags as the surrounding non-PHP code (only affects the
PHP escape tags)::let g:PHP_outdentphpescape = 0
PHP_removeCRwhenUnix
To automatically remove '\r' characters when the 'fileformat' is set to Unix::let g:PHP_removeCRwhenUnix = 1
PHP_BracesAtCodeLevel
To indent braces at the same level than the code they contain::let g:PHP_BracesAtCodeLevel = 1This will give the following result:
if ($foo)
{
foo();
}
Instead of:if ($foo)
{
foo();
}
NOTE: Indenting will be a bit slower if this option is used because some
optimizations won't be available.PHP_vintage_case_default_indent
To indent 'case:' and 'default:' statements in switch() blocks::let g:PHP_vintage_case_default_indent = 1In PHP braces are not required inside 'case/default' blocks therefore 'case:' and 'default:' are indented at the same level than the 'switch()' to avoid meaningless indentation. You can use the above option to return to the traditional way.
PHP_noArrowMatching
By default the indent script will indent multi-line chained calls by matching
the position of the '->':$user_name_very_long->name()
->age()
->info();:let g:PHP_noArrowMatching = 1
$user_name_very_long->name()
->age()
->info();PHP_IndentFunctionCallParameters
Extra indentation levels to add to parameters in multi-line function calls.let g:PHP_IndentFunctionCallParameters = 1Function call arguments will indent 1 extra level. For two-space indentation:
function call_the_thing(
$with_this,
$and_that
) {
$this->do_the_thing(
$with_this,
$and_that
);
}PHP_IndentFunctionDeclarationParameters
Extra indentation levels to add to arguments in multi-line function
definitions.let g:PHP_IndentFunctionDeclarationParameters = 1
function call_the_thing(
$with_this,
$and_that
) {
$this->do_the_thing(
$with_this,
$and_that
);
}g:python_indent Dictionary, which
needs to be created before adding the items:let g:python_indent = {}
The examples given are the defaults. Note that the dictionary values are set
to an expression, so that you can change the value of 'shiftwidth' later
without having to update these values.let g:python_indent.open_paren = 'shiftwidth() * 2'Indent after a nested paren:
let g:python_indent.nested_paren = 'shiftwidth()'Indent for a continuation line:
let g:python_indent.continue = 'shiftwidth() * 2'By default, the closing paren on a multiline construct lines up under the first non-whitespace character of the previous line. If you prefer that it's lined up under the first character of the line that starts the multiline construct, reset this key:
let g:python_indent.closed_paren_align_last_line = v:falseThe method uses searchpair() to look back for unclosed parentheses. This can sometimes be slow, thus it timeouts after 150 msec. If you notice the indenting isn't correct, you can set a larger timeout in msec:
let g:python_indent.searchpair_timeout = 500If looking back for unclosed parenthesis is still too slow, especially during a copy-paste operation, or if you don't need indenting inside multi-line parentheses, you can completely disable this feature:
let g:python_indent.disable_parentheses_indenting = 1For backward compatibility, these variables are also supported:
g:pyindent_open_paren g:pyindent_nested_paren g:pyindent_continue g:pyindent_searchpair_timeout g:pyindent_disable_parentheses_indentingR
ft-r-indentlet r_indent_align_args = 0
let r_indent_ess_comments = 1
let r_indent_comment_column = 30
let r_indent_ess_compatible = 1
### r_indent_ess_compatible = 1 ### r_indent_ess_compatible = 0
foo <- foo <-
function(x) function(x)
{ {
paste(x) paste(x)
} }'\(&\||\|+\|-\|\*\|/\|=\|\~\|%\|->\)\s*$'. If you want indentation after
lines that match a different pattern, you should set the appropriate value of
r_indent_op_pattern in your vimrc.let b:verilog_indent_modules = 1then the module blocks will be indented. To stop this, remove the variable:
:unlet b:verilog_indent_modulesTo set the variable only for Verilog file. The following statements can be used:
au BufReadPost * if exists("b:current_syntax")
au BufReadPost * if b:current_syntax == "verilog"
au BufReadPost * let b:verilog_indent_modules = 1
au BufReadPost * endif
au BufReadPost * endif
Furthermore, setting the variable b:verilog_indent_width to change the
indenting width (default is 'shiftwidth'):let b:verilog_indent_width = 4 let b:verilog_indent_width = shiftwidth() * 2In addition, you can turn the verbose mode for debug issue:
let b:verilog_indent_verbose = 1Make sure to do ":set cmdheight=2" first to allow the display of the message.
ENTITY sync IS
PORT (
clk : IN STD_LOGIC;
reset_n : IN STD_LOGIC;
data_input : IN STD_LOGIC;
data_out : OUT STD_LOGIC
);
END ENTITY sync;
To turn this off, addlet g:vhdl_indent_genportmap = 0to the vimrc file, which causes the previous alignment example to change:
ENTITY sync IS PORT ( clk : IN STD_LOGIC; reset_n : IN STD_LOGIC; data_input : IN STD_LOGIC; data_out : OUT STD_LOGIC ); END ENTITY sync;Alignment of right-hand side assignment "<=" statements are performed by default. This causes the following alignment example:
sig_out <= (bus_a(1) AND
(sig_b OR sig_c)) OR
(bus_a(0) AND sig_d);
To turn this off, addlet g:vhdl_indent_rhsassign = 0to the vimrc file, which causes the previous alignment example to change:
sig_out <= (bus_a(1) AND (sig_b OR sig_c)) OR (bus_a(0) AND sig_d);Full-line comments (lines that begin with "--") are indented to be aligned with the very previous line's comment, PROVIDED that a whitespace follows after "--".
sig_a <= sig_b; -- start of a comment
-- continuation of the comment
-- more of the same comment
While in Insert mode, after typing "-- " (note the space " "), hitting CTRL-F
will align the current "-- " with the previous line's "--".sig_c <= sig_d; -- comment 0
-- comment 1
-- comment 2
--debug_code:
--PROCESS(debug_in)
--BEGIN
-- FOR i IN 15 DOWNTO 0 LOOP
-- debug_out(8*i+7 DOWNTO 8*i) <= debug_in(15-i);
-- END LOOP;
--END PROCESS debug_code;
-- comment 3
sig_e <= sig_f; -- comment 4
-- comment 5
results in:sig_c <= sig_d; -- comment 0
-- comment 1
-- comment 2
--debug_code:
--PROCESS(debug_in)
--BEGIN
-- FOR i IN 15 DOWNTO 0 LOOP
-- debug_out(8*i+7 DOWNTO 8*i) <= debug_in(15-i);
-- END LOOP;
--END PROCESS debug_code;
-- comment 3
sig_e <= sig_f; -- comment 4
-- comment 5
Notice that "--debug_code:" does not align with "-- comment 2"
because there is no whitespace that follows after "--" in "--debug_code:".g:vim_indent_cont
For indenting Vim scripts there is one variable that specifies the amount of
indent for a continuation line, a line that starts with a backslash::let g:vim_indent_cont = shiftwidth() * 3Three times shiftwidth is the default value.
let g:yaml_indent_multiline_scalar = 1