GitHub/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim synced 2025-07-15 16:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(manual): fix treesitter parsing errors

Browse Source
This commit is contained in:
Christian Clason
2022-12-31 14:40:47 +01:00
parent ad184b213d
commit 2f0c023f52
12 changed files with 86 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
runtime/doc/usr_02.txt
View File

@ -33,7 +33,7 @@ On Unix you can type this at any command prompt. If you are running Microsoft
Windows, open a Command Prompt and enter the command. In either case, Vim
starts editing a file called file.txt. Because this is a new file, you get a
blank window. This is what your screen will look like:
>
+---------------------------------------+
|# |
|~ |
@ -43,7 +43,7 @@ blank window. This is what your screen will look like:
|"file.txt" [New file] |
+---------------------------------------+
('#' is the cursor position.)
<
The tilde (~) lines indicate lines not in the file. In other words, when Vim
runs out of file to display, it displays tilde lines. At the bottom of the
screen, a message line indicates the file is named file.txt and shows that you
@ -83,7 +83,7 @@ limerick, this is what you type: >
After typing "turtle" you press the <Enter> key to start a new line. Finally
you press the <Esc> key to stop Insert mode and go back to Normal mode. You
now have two lines of text in your Vim window:
>
+---------------------------------------+
|A very intelligent turtle |
|Found programming Unix a hurdle |
@ -91,7 +91,7 @@ now have two lines of text in your Vim window:
|~ |
| |
+---------------------------------------+
<
WHAT IS THE MODE?
@ -105,7 +105,7 @@ with a colon). Finish this command by pressing the <Enter> key (all commands
that start with a colon are finished this way).
Now, if you type the "i" command Vim will display --INSERT-- at the bottom
of the window. This indicates you are in Insert mode.
>
+---------------------------------------+
|A very intelligent turtle |
|Found programming Unix a hurdle |
@ -113,7 +113,7 @@ of the window. This indicates you are in Insert mode.
|~ |
|-- INSERT -- |
+---------------------------------------+
<
If you press <Esc> to go back to Normal mode the last line will be made blank.
@ -182,7 +182,7 @@ throwback to the old days of the typewriter, when you deleted things by typing
xxxx over them.) Move the cursor to the beginning of the first line, for
example, and type xxxxxxx (seven x's) to delete "A very ". The result should
look like this:
>
+---------------------------------------+
|intelligent turtle |
|Found programming Unix a hurdle |
@ -190,14 +190,14 @@ look like this:
|~ |
| |
+---------------------------------------+
<
Now you can insert new text, for example by typing: >
iA young <Esc>
This begins an insert (the i), inserts the words "A young", and then exits
insert mode (the final <Esc>). The result:
>
+---------------------------------------+
|A young intelligent turtle |
|Found programming Unix a hurdle |
@ -205,13 +205,13 @@ insert mode (the final <Esc>). The result:
|~ |
| |
+---------------------------------------+
<
DELETING A LINE
To delete a whole line use the "dd" command. The following line will
then move up to fill the gap:
>
+---------------------------------------+
|Found programming Unix a hurdle |
|~ |
@ -219,7 +219,7 @@ then move up to fill the gap:
|~ |
| |
+---------------------------------------+
<
DELETING A LINE BREAK

4
runtime/doc/usr_05.txt
View File

@ -107,7 +107,7 @@ Display an incomplete command in the lower right corner of the Vim window,
left of the ruler. For example, when you type "2f", Vim is waiting for you to
type the character to find and "2f" is displayed. When you press "w" next,
the "2fw" command is executed and the displayed "2f" is removed.
>
+-------------------------------------------------+
|text in the Vim window |
|~ |
@ -119,7 +119,7 @@ the "2fw" command is executed and the displayed "2f" is removed.
>
set incsearch
<
Display matches for a search pattern while you type.
>

44
runtime/doc/usr_08.txt
View File

@ -32,7 +32,7 @@ The easiest way to open a new window is to use the following command: >
This command splits the screen into two windows and leaves the cursor in the
top one:
>
+----------------------------------+
|/* file one.c */ |
|~ |
@ -43,7 +43,7 @@ top one:
|one.c=============================|
| |
+----------------------------------+
<
What you see here is two windows on the same file. The line with "====" is
the status line. It displays information about the window above it. (In
practice the status line will be in reverse video.)
@ -87,7 +87,7 @@ The following command opens a second window and starts editing the given file:
:split two.c
If you were editing one.c, then the result looks like this:
>
+----------------------------------+
|/* file two.c */ |
|~ |
@ -98,7 +98,7 @@ If you were editing one.c, then the result looks like this:
|one.c=============================|
| |
+----------------------------------+
<
To open a window on a new, empty file, use this: >
:new
@ -170,7 +170,7 @@ or: >
:vsplit two.c
The result looks something like this:
>
+--------------------------------------+
|/* file two.c */ |/* file one.c */ |
|~ |~ |
@ -179,7 +179,7 @@ The result looks something like this:
|two.c===============one.c=============|
| |
+--------------------------------------+
<
Actually, the | lines in the middle will be in reverse video. This is called
the vertical separator. It separates the two windows left and right of it.
@ -218,7 +218,7 @@ cursor keys can also be used, if you like.
You have split a few windows, but now they are in the wrong place. Then you
need a command to move the window somewhere else. For example, you have three
windows like this:
>
+----------------------------------+
|/* file two.c */ |
|~ |
@ -233,7 +233,7 @@ windows like this:
|one.c=============================|
| |
+----------------------------------+
<
Clearly the last one should be at the top. Go to that window (using CTRL-W w)
and then type this command: >
@ -244,7 +244,7 @@ the very top. You will notice that K is again used for moving upwards.
When you have vertical splits, CTRL-W K will move the current window to the
top and make it occupy the full width of the Vim window. If this is your
layout:
>
+-------------------------------------------+
|/* two.c */ |/* three.c */ |/* one.c */ |
|~ |~ |~ |
@ -255,9 +255,9 @@ layout:
|two.c=========three.c=========one.c========|
| |
+-------------------------------------------+
<
Then using CTRL-W K in the middle window (three.c) will result in:
>
+-------------------------------------------+
|/* three.c */ |
|~ |
@ -268,7 +268,7 @@ Then using CTRL-W K in the middle window (three.c) will result in:
|two.c==================one.c===============|
| |
+-------------------------------------------+
<
The other three similar commands (you can probably guess these now):
CTRL-W H move window to the far left
@ -316,7 +316,7 @@ To make Vim open a window for each file, start it with the "-o" argument: >
vim -o one.txt two.txt three.txt
This results in:
>
+-------------------------------+
|file one.txt |
|~ |
@ -329,7 +329,7 @@ This results in:
|three.txt======================|
| |
+-------------------------------+
<
The "-O" argument is used to get vertically split windows.
When Vim is already running, the ":all" command opens a window for each
file in the argument list. ":vertical all" does it with vertical splits.
@ -347,7 +347,7 @@ Type this command in a shell to start Nvim in diff mode: >
Vim will start, with two windows side by side. You will only see the line
in which you added characters, and a few lines above and below it.
>
VV VV
+-----------------------------------------+
|+ +--123 lines: /* a|+ +--123 lines: /* a| <- fold
@ -366,7 +366,7 @@ in which you added characters, and a few lines above and below it.
|main.c~==============main.c==============|
| |
+-----------------------------------------+
<
(This picture doesn't show the highlighting, use "nvim -d" for that.)
The lines that were not modified have been collapsed into one line. This is
@ -519,7 +519,7 @@ Assume you are editing "thisfile". To create a new tab page use this command: >
This will edit the file "thatfile" in a window that occupies the whole Vim
window. And you will notice a bar at the top with the two file names:
>
+----------------------------------+
| thisfile | /thatfile/ __________X| (thatfile is bold)
|/* thatfile */ |
@ -530,13 +530,13 @@ window. And you will notice a bar at the top with the two file names:
|~ |
| |
+----------------------------------+
<
You now have two tab pages. The first one has a window for "thisfile" and the
second one a window for "thatfile". It's like two pages that are on top of
each other, with a tab sticking out of each page showing the file name.
Now use the mouse to click on "thisfile" in the top line. The result is
>
+----------------------------------+
| /thisfile/ | thatfile __________X| (thisfile is bold)
|/* thisfile */ |
@ -547,7 +547,7 @@ Now use the mouse to click on "thisfile" in the top line. The result is
|~ |
| |
+----------------------------------+
<
Thus you can switch between tab pages by clicking on the label in the top
line. If you don't have a mouse or don't want to use it, you can use the "gt"
command. Mnemonic: Goto Tab.
@ -558,7 +558,7 @@ Now let's create another tab page with the command: >
This makes a new tab page with one window that is editing the same buffer as
the window we were in:
>
+-------------------------------------+
| thisfile | /thisfile/ | thatfile __X| (thisfile is bold)
|/* thisfile */ |
@ -569,7 +569,7 @@ the window we were in:
|~ |
| |
+-------------------------------------+
<
You can put ":tab" before any Ex command that opens a window. The window will
be opened in a new tab page. Another example: >

6
runtime/doc/usr_10.txt
View File

@ -813,10 +813,10 @@ REDRAWING THE SCREEN
If the external command produced an error message, the display may have been
messed up. Vim is very efficient and only redraws those parts of the screen
that it knows need redrawing. But it can't know about what another program
has written. To tell Vim to redraw the screen: >
has written. To tell Vim to redraw the screen:
>
CTRL-L
<
==============================================================================
Next chapter: |usr_11.txt| Recovering from a crash

4
runtime/doc/usr_20.txt
View File

@ -338,7 +338,7 @@ Open the command line window with this command: >
Vim now opens a (small) window at the bottom. It contains the command line
history, and an empty line at the end:
>
+-------------------------------------+
|other window |
|~ |
@ -353,7 +353,7 @@ history, and an empty line at the end:
|command-line=========================|
| |
+-------------------------------------+
<
You are now in Normal mode. You can use the "hjkl" keys to move around. For
example, move up with "5k" to the ":e config.h.in" line. Type "$h" to go to
the "i" of "in" and type "cwout". Now you have changed the line to:

6
runtime/doc/usr_21.txt
View File

@ -302,7 +302,7 @@ session file as a starting point.
use, and save this in a session. Then you can go back to this layout whenever
you want.
For example, this is a nice layout to use:
>
+----------------------------------------+
| VIM - main help file |
| |
@ -318,7 +318,7 @@ you want.
|~/=========|[No File]===================|
| |
+----------------------------------------+
<
This has a help window at the top, so that you can read this text. The narrow
vertical window on the left contains a file explorer. This is a Vim plugin
that lists the contents of a directory. You can select files to edit there.
@ -454,7 +454,7 @@ Use this format for the modeline:
The "any-text" indicates that you can put any text before and after the part
that Vim will use. This allows making it look like a comment, like what was
done above with /* and */.
done above with "/*" and "*/".
The " vim:" part is what makes Vim recognize this line. There must be
white space before "vim", or "vim" must be at the start of the line. Thus
using something like "gvim:" will not work.

35
runtime/doc/usr_25.txt
View File

@ -325,16 +325,16 @@ Let's attempt to show this with one line of text. The cursor is on the "w" of
currently visible. The "window"s below the text indicate the text that is
visible after the command left of it.
|<-- current window -->|
`|<-- current window -->|`
some long text, part of which is visible in the window ~
ze |<-- window -->|
zH |<-- window -->|
4zh |<-- window -->|
zh |<-- window -->|
zl |<-- window -->|
4zl |<-- window -->|
zL |<-- window -->|
zs |<-- window -->|
ze `|<-- window -->|`
zH `|<-- window -->|`
4zh `|<-- window -->|`
zh `|<-- window -->|`
zl `|<-- window -->|`
4zl `|<-- window -->|`
zL `|<-- window -->|`
zs `|<-- window -->|`
MOVING WITH WRAP OFF
@ -350,7 +350,7 @@ scroll:
gM to middle of the text in this line
g$ to last visible character in this line
|<-- window -->|
`|<-- window -->|`
some long text, part of which is visible in one line ~
g0 g^ gm gM g$
@ -365,7 +365,7 @@ broken halfway, which makes them hard to read.
'linebreak' option. Vim then breaks lines at an appropriate place when
displaying the line. The text in the file remains unchanged.
Without 'linebreak' text might look like this:
>
+---------------------------------+
|letter generation program for a b|
|ank. They wanted to send out a s|
@ -373,12 +373,13 @@ displaying the line. The text in the file remains unchanged.
|eir richest 1000 customers. Unfo|
|rtunately for the programmer, he |
+---------------------------------+
<
After: >
:set linebreak
it looks like this:
>
+---------------------------------+
|letter generation program for a |
|bank. They wanted to send out a |
@ -386,7 +387,7 @@ it looks like this:
|their richest 1000 customers. |
|Unfortunately for the programmer,|
+---------------------------------+
<
Related options:
'breakat' specifies the characters where a break can be inserted.
'showbreak' specifies a string to show at the start of broken line.
@ -425,7 +426,7 @@ That looks complicated. Let's break it up in pieces:
into one line.
Starting with this text, containing eight lines broken at column 30:
>
+----------------------------------+
|A letter generation program |
|for a bank. They wanted to |
@ -436,9 +437,9 @@ Starting with this text, containing eight lines broken at column 30:
|customers. Unfortunately for |
|the programmer, |
+----------------------------------+
<
You end up with two lines:
>
+----------------------------------+
|A letter generation program for a |
|bank. They wanted to send out a s|
@ -446,7 +447,7 @@ You end up with two lines:
|To their richest 1000 customers. |
|Unfortunately for the programmer, |
+----------------------------------+
<
Note that this doesn't work when the separating line is blank but not empty;
when it contains spaces and/or tabs. This command does work with blank lines:
>

16
runtime/doc/usr_29.txt
View File

@ -53,7 +53,7 @@ function.
The "write_line" function calls "write_char". You need to figure out what
it does. So you position the cursor over the call to "write_char" and press
CTRL-]. Now you are at the definition of "write_char".
>
+-------------------------------------+
|void write_block(char **s; int cnt) |
|{ |
@ -79,7 +79,7 @@ CTRL-]. Now you are at the definition of "write_char".
| putchar((int)(unsigned char)c); |
|} |
+------------------------------------+
<
The ":tags" command shows the list of tags that you traversed through:
:tags
@ -425,7 +425,7 @@ MOVING IN COMMENTS
To move back to the start of a comment use "[/". Move forward to the end of a
comment with "]/". This only works for /* - */ comments.
>
+-> +-> /*
| [/ | * A comment about --+
[/ | +-- * wonderful life. | ]/
@ -434,7 +434,7 @@ comment with "]/". This only works for /* - */ comments.
+-- foo = bar * 3; --+
| ]/
/* a short comment */ <-+
<
==============================================================================
*29.4* Finding global identifiers
@ -575,7 +575,7 @@ and jump to the first place where the word under the cursor is used: >
Hint: Goto Definition. This command is very useful to find a variable or
function that was declared locally ("static", in C terms). Example (cursor on
"counter"):
>
+-> static int counter = 0;
|
| int get_counter(void)
@ -583,7 +583,7 @@ function that was declared locally ("static", in C terms). Example (cursor on
| ++counter;
+-- return counter;
}
<
To restrict the search even further, and look only in the current function,
use this command: >
@ -593,7 +593,7 @@ This will go back to the start of the current function and find the first
occurrence of the word under the cursor. Actually, it searches backwards to
an empty line above a "{" in the first column. From there it searches forward
for the identifier. Example (cursor on "idx"):
>
int find_entry(char *name)
{
+-> int idx;
@ -602,7 +602,7 @@ for the identifier. Example (cursor on "idx"):
| if (strcmp(table[idx].name, name) == 0)
+-- return idx;
}
<
==============================================================================
Next chapter: |usr_30.txt| Editing programs

4
runtime/doc/usr_30.txt
View File

@ -56,7 +56,7 @@ From this you can see that you have errors in the file "main.c". When you
press <Enter>, Vim displays the file "main.c", with the cursor positioned on
line 6, the first line with an error. You did not need to specify the file or
the line number, Vim knew where to go by looking in the error messages.
>
+---------------------------------------------------+
|int main() |
|{ |
@ -69,7 +69,7 @@ the line number, Vim knew where to go by looking in the error messages.
| ~ |
|(3 of 12): too many arguments to function 'do_sub' |
+---------------------------------------------------+
<
The following command goes to where the next error occurs: >
:cnext

6
runtime/doc/usr_32.txt
View File

@ -169,10 +169,10 @@ To travel forward in time again use the |:later| command: >
The arguments are "s", "m" and "h", just like with |:earlier|.
If you want even more details, or want to manipulate the information, you can
use the |undotree()| function. To see what it returns: >
use the |undotree()| function. To see what it returns:
>
:echo undotree()
<
==============================================================================
Next chapter: |usr_40.txt| Make new commands

8
runtime/doc/usr_40.txt
View File

@ -226,7 +226,7 @@ When using a space inside a mapping, use <Space> (seven characters): >
This makes the spacebar move a blank-separated word forward.
It is not possible to put a comment directly after a mapping, because the "
character is considered to be part of the mapping. You can use |", this
character is considered to be part of the mapping. You can use `|"`, this
starts a new, empty command with a comment. Example: >
:map <Space> W| " Use spacebar to move forward a word
@ -657,10 +657,10 @@ To ignore all events, use the following command: >
:set eventignore=all
To set it back to the normal behavior, make 'eventignore' empty: >
To set it back to the normal behavior, make 'eventignore' empty:
>
:set eventignore=
<
==============================================================================
Next chapter: |usr_41.txt| Write a Vim script

14
runtime/doc/usr_42.txt
View File

@ -81,7 +81,7 @@ the far right.
The second number (340) determines the location of the item within the
pull-down menu. Lower numbers go on top, higher number on the bottom. These
are the priorities in the File menu:
>
+-----------------+
10.310 |Open... |
10.320 |Split-Open... |
@ -99,7 +99,7 @@ are the priorities in the File menu:
10.610 |Save-Exit |
10.620 |Exit |
+-----------------+
<
Notice that there is room in between the numbers. This is where you can
insert your own items, if you really want to (it's often better to leave the
standard menus alone and add a new menu for your own items).
@ -168,11 +168,11 @@ inserts a CTRL-C or CTRL-O for you. For example, if you use this command:
Then the resulting menu commands will be:
Normal mode: *
Visual mode: CTRL-C *
Operator-pending mode: CTRL-C *
Insert mode: CTRL-O *
Command-line mode: CTRL-C *
Normal mode: `*`
Visual mode: CTRL-C `*`
Operator-pending mode: CTRL-C `*`
Insert mode: CTRL-O `*`
Command-line mode: CTRL-C `*`
When in Command-line mode the CTRL-C will abandon the command typed so far.
In Visual and Operator-pending mode CTRL-C will stop the mode. The CTRL-O in