Skip to content

Commit 9bf9d43

Browse files
kennypetechrisbra
kennypete
authored and
chrisbra
committed
runtime(doc): various netrw related corrections
closes: #19391 Signed-off-by: Peter Kenny <[email protected]> Signed-off-by: Christian Brabandt <[email protected]>
1 parent fb5777f commit 9bf9d43

1 file changed

Lines changed: 71 additions & 85 deletions

File tree

‎runtime/doc/usr_22.txt‎

Lines changed: 71 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*usr_22.txt* For Vim version 9.1. Last change: 2025 Nov 09
1+
*usr_22.txt* For Vim version 9.1. Last change: 2026 Feb 13
22

33

44
VIM USER MANUAL by Bram Moolenaar
@@ -33,7 +33,7 @@ with the contents of the directory. It looks like this (slightly cleaned up
3333
so that it fits within 78 chars): >
3434
3535
" ==========================================================================
36-
" Netrw Directory Listing (netrw v180)
36+
" Netrw Directory Listing (netrw v184)
3737
" /path/to/vim/runtime/doc
3838
" Sorted by name
3939
" Sort sequence: [\/]$,*,\(\.bak\|\~\|\.o\|\.h\|\.info\|\.swp\)[*@]\=$
@@ -51,15 +51,12 @@ so that it fits within 78 chars): >
5151
5252
You can see these items:
5353

54-
1. The name of the browsing tool and its version number
55-
2. The name of the browsing directory
56-
3. The method of sorting (may be by name, time, or size)
57-
4. How names are to be sorted (directories first, then *.h files,
58-
*.c files, etc)
59-
5. How to get help (use the <F1> key), and an abbreviated listing
60-
of available commands
61-
6. A listing of files, including "../", which allows one to list
62-
the parent directory.
54+
1. The name of the browsing tool and its version number
55+
2. The name of the browsing directory
56+
3. The method of sorting (may be by name, time, or size)
57+
4. How names are to be sorted (directories first, then by extension, etc.)
58+
5. How to get help (the <F1> key), and an abridged list of available commands
59+
6. A listing of files, including "../" (it will list the parent directory).
6360

6461
If you have syntax highlighting enabled, the different parts are highlighted
6562
so as to make it easier to spot them.
@@ -76,76 +73,66 @@ higher. Pressing "-" does the same thing, without the need to move to the
7673
"../" item first.
7774

7875
You can press <F1> to get help on the things you can do in the netrw file
79-
browser. This is what you get: >
80-
81-
9. Directory Browsing netrw-browse netrw-dir netrw-list netrw-help
82-
83-
MAPS netrw-maps
84-
<F1>.............Help.......................................|netrw-help|
85-
<cr>.............Browsing...................................|netrw-cr|
86-
<del>............Deleting Files or Directories..............|netrw-delete|
87-
-................Going Up...................................|netrw--|
88-
a................Hiding Files or Directories................|netrw-a|
89-
mb...............Bookmarking a Directory....................|netrw-mb|
90-
gb...............Changing to a Bookmarked Directory.........|netrw-gb|
91-
cd...............Make Browsing Directory The Current Dir....|netrw-c|
92-
d................Make A New Directory.......................|netrw-d|
93-
D................Deleting Files or Directories..............|netrw-D|
94-
<c-h>............Edit File/Directory Hiding List............|netrw-ctrl-h|
95-
i................Change Listing Style.......................|netrw-i|
96-
<c-l>............Refreshing the Listing.....................|netrw-ctrl-l|
97-
o................Browsing with a Horizontal Split...........|netrw-o|
98-
p................Use Preview Window.........................|netrw-p|
99-
P................Edit in Previous Window....................|netrw-p|
100-
q................Listing Bookmarks and History..............|netrw-qb|
101-
r................Reversing Sorting Order....................|netrw-r|
102-
< (etc)
103-
76+
browser. This is what you get:
77+
>
78+
QUICK HELP netrw-quickhelp
79+
(Use ctrl-] to select a topic)
80+
Intro to Browsing...............................netrw-intro-browse
81+
Quick Reference: Maps.........................netrw-quickmap
82+
Quick Reference: Commands.....................netrw-browse-cmds
83+
<
10484
The <F1> key thus brings you to a netrw directory browsing contents help page.
10585
It's a regular help page; use the usual |CTRL-]| to jump to tagged help items
106-
and |CTRL-O| to jump back.
107-
108-
To select files for display and editing: (with the cursor is atop a filename)
109-
110-
<enter> Open the file in the current window. |netrw-cr|
111-
o Horizontally split window and display file |netrw-o|
112-
v Vertically split window and display file |netrw-v|
113-
p Use the |preview-window| |netrw-p|
114-
P Edit in the previous window |netrw-P|
115-
t Open file in a new tab |netrw-t|
116-
86+
and |CTRL-O| to jump back. So, if you CTRL-] on |netrw-quickmap| you will
87+
jump to this:
88+
>
89+
netrw-quickmap netrw-quickmaps
90+
QUICK REFERENCE: MAPS netrw-browse-maps
91+
92+
--- ----------------- ----
93+
Map Quick Explanation Link
94+
--- ----------------- ----
95+
<F1> Causes Netrw to issue help
96+
<cr> Netrw will enter the directory or read the file netrw-cr
97+
<del> Netrw will attempt to remove the file/directory netrw-del
98+
< (etc.)
99+
100+
To select files for display and editing (with the cursor atop a filename):
101+
>
102+
o Enter the file/directory under the cursor in a new netrw-o
103+
browser window. A horizontal split is used.
104+
O Obtain a file specified by cursor netrw-O
105+
p Preview the file netrw-p
106+
P Browse in the previously used window netrw-P
107+
v Enter the file/directory under the cursor in a new netrw-v
108+
browser window. A vertical split is used.
109+
<
117110
The following normal-mode commands may be used to control the browser display:
118-
119-
i Controls listing style (thin, long, wide, and tree).
120-
The long listing includes size and date information.
121-
s Repeatedly pressing s will change the way the files
122-
are sorted; one may sort on name, modification time,
123-
or size.
124-
r Reverse the sorting order.
125-
111+
>
112+
i Cycle between thin, long, wide, and tree listings netrw-i
113+
r Reverse sorting order netrw-r
114+
s Select sorting style: by name, time, or file size netrw-s
115+
<
126116
As a sampling of extra normal-mode commands:
127-
128-
cd Change Vim's notion of the current directory to be
129-
the same as the browser directory. (see
130-
|g:netrw_keepdir| to control this, too)
131-
R Rename the file or directory under the cursor; a
132-
prompt will be issued for the new name.
133-
D Delete the file or directory under the cursor; a
134-
confirmation request will be issued.
135-
mb gb Make bookmark/goto bookmark
136-
137-
117+
>
118+
cd Make browsing directory the current directory netrw-cd
119+
D Attempt to remove the file(s)/directory(ies) netrw-D
120+
gb Go to previous bookmarked directory netrw-gb
121+
mb Bookmark current directory netrw-mb
122+
R Rename the designated file(s)/directory(ies) netrw-R
123+
<
138124
One may also use command mode; again, just a sampling:
139-
140-
:Explore [directory] Browse specified/current directory
141-
:NetrwSettings A comprehensive list of your current netrw
142-
settings with help linkage.
143-
144-
The netrw browser is not limited to just your local machine; one may use
145-
urls such as: (that trailing / is important)
125+
>
126+
:Explore[!] [dir] Explore directory of current file......netrw-explore
127+
:Hexplore[!] [dir] Horizontal Split & Explore.............netrw-explore
128+
<
129+
The netrw browser is not limited to just your local machine; one may use URLs
130+
such as: >
146131
147132
:Explore ftp://somehost/path/to/dir/
148133
:e scp://somehost/path/to/dir/
134+
<
135+
Note: The trailing "/" is important.
149136

150137
See |netrw-browse| for more.
151138

@@ -219,8 +206,8 @@ TAB LOCAL DIRECTORY
219206

220207
When you open a new tab page, it uses the directory of the window in the
221208
previous tab page from which the new tab page was opened. You can change the
222-
directory of the current tab page using the `:tcd` command. All the windows in
223-
a tab page share this directory except for windows with a window-local
209+
directory of the current tab page using the `:tcd` command. All the windows
210+
in a tab page share this directory except for windows with a window-local
224211
directory. Any new windows opened in this tab page will use this directory as
225212
the current working directory. Using a `:cd` command in a tab page will not
226213
change the working directory of tab pages which have a tab local directory.
@@ -318,13 +305,13 @@ without making sure you have saved all the buffers.
318305

319306
INACTIVE BUFFERS
320307

321-
When a buffer has been used once, Vim remembers some information about it.
308+
When a buffer has been used once, Vim remembers some information about it.
322309
When it is not displayed in a window and it is not hidden, it is still in the
323310
buffer list. This is called an inactive buffer. Overview:
324311

325-
Active Appears in a window, text loaded.
326-
Hidden Not in a window, text loaded.
327-
Inactive Not in a window, no text loaded.
312+
Active Appears in a window, text loaded.
313+
Hidden Not in a window, text loaded.
314+
Inactive Not in a window, no text loaded.
328315

329316
The inactive buffers are remembered, because Vim keeps information about them,
330317
like marks. And remembering the file name is useful too, so that you can see
@@ -404,12 +391,11 @@ will be closed. If you delete the current buffer, the current window will be
404391
closed. If it was the last window, Vim will find another buffer to edit. You
405392
can't be editing nothing!
406393

407-
Note:
408-
Even after removing the buffer with ":bdelete" Vim still remembers it.
409-
It's actually made "unlisted", it no longer appears in the list from
410-
":buffers". The ":buffers!" command will list unlisted buffers (yes,
411-
Vim can do the impossible). To really make Vim forget about a buffer,
412-
use ":bwipe". Also see the 'buflisted' option.
394+
Note: Even after removing the buffer with ":bdelete" Vim still
395+
remembers it. It's actually made "unlisted", it no longer appears in
396+
the list from ":buffers". The ":buffers!" command will list unlisted
397+
buffers (yes, Vim can do the impossible). To really make Vim forget
398+
about a buffer, use ":bwipe". Also see the 'buflisted' option.
413399

414400
==============================================================================
415401

0 commit comments

Comments
 (0)