blob: a9564374f5a177744d57e857e636c135502f8c32 [file] [log] [blame]
Konfekt3d7e5672024-10-27 22:16:49 +01001*pi_netrw.txt* For Vim version 9.1. Last change: 2024 Oct 27
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
Bram Moolenaarff034192013-04-24 18:51:19 +02003 ------------------------------------------------
4 NETRW REFERENCE MANUAL by Charles E. Campbell
5 ------------------------------------------------
Bram Moolenaar29634562020-01-09 21:46:04 +01006Author: Charles E. Campbell <NcampObell@SdrPchip.AorgM-NOSPAM>
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007 (remove NOSPAM from Campbell's email first)
8
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01009Copyright: Copyright (C) 2017 Charles E Campbell *netrw-copyright*
Bram Moolenaar5b435d62012-04-05 17:33:26 +020010 The VIM LICENSE applies to the files in this package, including
Konfekt3d7e5672024-10-27 22:16:49 +010011 netrw.vim, pi_netrw.txt, netrwSettings.vim, and
Bram Moolenaar5b435d62012-04-05 17:33:26 +020012 syntax/netrw.vim. Like anything else that's free, netrw.vim and its
13 associated files are provided *as is* and comes with no warranty of
14 any kind, either expressed or implied. No guarantees of
15 merchantability. No guarantees of suitability for any purpose. By
16 using this plugin, you agree that in no event will the copyright
17 holder be liable for any damages resulting from the use of this
Christian Brabandtc5e24ee2024-07-13 18:19:03 +020018 software. Use at your own risk! For bug reports, see |bugs|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000019
Bram Moolenaar8feef4f2015-01-07 16:57:10 +010020 *netrw*
Bram Moolenaar00a927d2010-05-14 23:24:24 +020021 *dav* *ftp* *netrw-file* *rcp* *scp*
22 *davs* *http* *netrw.vim* *rsync* *sftp*
Bram Moolenaar8feef4f2015-01-07 16:57:10 +010023 *fetch* *network*
Bram Moolenaar071d4272004-06-13 20:20:40 +000024
25==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +0000261. Contents *netrw-contents* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +000027
Bram Moolenaarff034192013-04-24 18:51:19 +0200281. Contents..............................................|netrw-contents|
292. Starting With Netrw...................................|netrw-start|
303. Netrw Reference.......................................|netrw-ref|
31 EXTERNAL APPLICATIONS AND PROTOCOLS.................|netrw-externapp|
32 READING.............................................|netrw-read|
33 WRITING.............................................|netrw-write|
34 SOURCING............................................|netrw-source|
35 DIRECTORY LISTING...................................|netrw-dirlist|
36 CHANGING THE USERID AND PASSWORD....................|netrw-chgup|
37 VARIABLES AND SETTINGS..............................|netrw-variables|
38 PATHS...............................................|netrw-path|
394. Network-Oriented File Transfer........................|netrw-xfer|
40 NETRC...............................................|netrw-netrc|
41 PASSWORD............................................|netrw-passwd|
425. Activation............................................|netrw-activate|
436. Transparent Remote File Editing.......................|netrw-transparent|
447. Ex Commands...........................................|netrw-ex|
458. Variables and Options.................................|netrw-variables|
469. Browsing..............................................|netrw-browse|
47 Introduction To Browsing............................|netrw-intro-browse|
48 Quick Reference: Maps...............................|netrw-browse-maps|
49 Quick Reference: Commands...........................|netrw-browse-cmds|
Bram Moolenaare0fa3742016-02-20 15:47:01 +010050 Banner Display......................................|netrw-I|
Bram Moolenaarff034192013-04-24 18:51:19 +020051 Bookmarking A Directory.............................|netrw-mb|
52 Browsing............................................|netrw-cr|
Bram Moolenaare0fa3742016-02-20 15:47:01 +010053 Squeezing the Current Tree-Listing Directory........|netrw-s-cr|
Bram Moolenaarff034192013-04-24 18:51:19 +020054 Browsing With A Horizontally Split Window...........|netrw-o|
55 Browsing With A New Tab.............................|netrw-t|
56 Browsing With A Vertically Split Window.............|netrw-v|
Bram Moolenaar89a9c152021-08-29 21:55:35 +020057 Change File Permission..............................|netrw-gp|
Bram Moolenaarff034192013-04-24 18:51:19 +020058 Change Listing Style.(thin wide long tree)..........|netrw-i|
59 Changing To A Bookmarked Directory..................|netrw-gb|
60 Changing To A Predecessor Directory.................|netrw-u|
61 Changing To A Successor Directory...................|netrw-U|
Bram Moolenaar8feef4f2015-01-07 16:57:10 +010062 Customizing Browsing With A Special Handler.........|netrw-x|
Bram Moolenaarff034192013-04-24 18:51:19 +020063 Deleting Bookmarks..................................|netrw-mB|
64 Deleting Files Or Directories.......................|netrw-D|
65 Directory Exploring Commands........................|netrw-explore|
66 Exploring With Stars and Patterns...................|netrw-star|
67 Displaying Information About File...................|netrw-qf|
68 Edit File Or Directory Hiding List..................|netrw-ctrl-h|
69 Editing The Sorting Sequence........................|netrw-S|
70 Forcing treatment as a file or directory............|netrw-gd| |netrw-gf|
71 Going Up............................................|netrw--|
72 Hiding Files Or Directories.........................|netrw-a|
73 Improving Browsing..................................|netrw-ssh-hack|
74 Listing Bookmarks And History.......................|netrw-qb|
75 Making A New Directory..............................|netrw-d|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +010076 Making The Browsing Directory The Current Directory.|netrw-cd|
Bram Moolenaarff034192013-04-24 18:51:19 +020077 Marking Files.......................................|netrw-mf|
78 Unmarking Files.....................................|netrw-mF|
Bram Moolenaare0fa3742016-02-20 15:47:01 +010079 Marking Files By Location List......................|netrw-qL|
Bram Moolenaarff034192013-04-24 18:51:19 +020080 Marking Files By QuickFix List......................|netrw-qF|
81 Marking Files By Regular Expression.................|netrw-mr|
Bram Moolenaar8feef4f2015-01-07 16:57:10 +010082 Marked Files: Arbitrary Shell Command...............|netrw-mx|
83 Marked Files: Arbitrary Shell Command, En Bloc......|netrw-mX|
84 Marked Files: Arbitrary Vim Command.................|netrw-mv|
Bram Moolenaare0fa3742016-02-20 15:47:01 +010085 Marked Files: Argument List.........................|netrw-ma| |netrw-mA|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +010086 Marked Files: Buffer List...........................|netrw-cb| |netrw-cB|
Bram Moolenaarff034192013-04-24 18:51:19 +020087 Marked Files: Compression And Decompression.........|netrw-mz|
88 Marked Files: Copying...............................|netrw-mc|
89 Marked Files: Diff..................................|netrw-md|
90 Marked Files: Editing...............................|netrw-me|
91 Marked Files: Grep..................................|netrw-mg|
92 Marked Files: Hiding and Unhiding by Suffix.........|netrw-mh|
93 Marked Files: Moving................................|netrw-mm|
94 Marked Files: Printing..............................|netrw-mp|
95 Marked Files: Sourcing..............................|netrw-ms|
96 Marked Files: Setting the Target Directory..........|netrw-mt|
97 Marked Files: Tagging...............................|netrw-mT|
98 Marked Files: Target Directory Using Bookmarks......|netrw-Tb|
99 Marked Files: Target Directory Using History........|netrw-Th|
100 Marked Files: Unmarking.............................|netrw-mu|
101 Netrw Browser Variables.............................|netrw-browser-var|
102 Netrw Browsing And Option Incompatibilities.........|netrw-incompatible|
103 Netrw Settings Window...............................|netrw-settings-window|
104 Obtaining A File....................................|netrw-O|
105 Preview Window......................................|netrw-p|
106 Previous Window.....................................|netrw-P|
107 Refreshing The Listing..............................|netrw-ctrl-l|
108 Reversing Sorting Order.............................|netrw-r|
109 Renaming Files Or Directories.......................|netrw-R|
110 Selecting Sorting Style.............................|netrw-s|
111 Setting Editing Window..............................|netrw-C|
11210. Problems and Fixes....................................|netrw-problems|
11311. Debugging Netrw Itself................................|netrw-debug|
11412. History...............................................|netrw-history|
11513. Todo..................................................|netrw-todo|
11614. Credits...............................................|netrw-credits|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000117
Bram Moolenaar071d4272004-06-13 20:20:40 +0000118==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00001192. Starting With Netrw *netrw-start* {{{1
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000120
Bram Moolenaar446cb832008-06-24 21:56:24 +0000121Netrw makes reading files, writing files, browsing over a network, and
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100122local browsing easy! First, make sure that you have plugins enabled, so
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123you'll need to have at least the following in your <.vimrc>:
124(or see |netrw-activate|) >
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000125
Bram Moolenaar9964e462007-05-05 17:54:07 +0000126 set nocp " 'compatible' is not set
127 filetype plugin on " plugins are enabled
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000128<
129(see |'cp'| and |:filetype-plugin-on|)
130
131Netrw supports "transparent" editing of files on other machines using urls
132(see |netrw-transparent|). As an example of this, let's assume you have an
Bram Moolenaar446cb832008-06-24 21:56:24 +0000133account on some other machine; if you can use scp, try: >
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000134
135 vim scp://hostname/path/to/file
136<
Bram Moolenaar446cb832008-06-24 21:56:24 +0000137Want to make ssh/scp easier to use? Check out |netrw-ssh-hack|!
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000138
Bram Moolenaar446cb832008-06-24 21:56:24 +0000139So, what if you have ftp, not ssh/scp? That's easy, too; try >
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000140
141 vim ftp://hostname/path/to/file
142<
143Want to make ftp simpler to use? See if your ftp supports a file called
144<.netrc> -- typically it goes in your home directory, has read/write
145permissions for only the user to read (ie. not group, world, other, etc),
146and has lines resembling >
147
148 machine HOSTNAME login USERID password "PASSWORD"
149 machine HOSTNAME login USERID password "PASSWORD"
150 ...
Bram Moolenaar9964e462007-05-05 17:54:07 +0000151 default login USERID password "PASSWORD"
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000152<
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200153Windows' ftp doesn't support .netrc; however, one may have in one's .vimrc: >
154
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200155 let g:netrw_ftp_cmd= 'c:\Windows\System32\ftp -s:C:\Users\MyUserName\MACHINE'
Bram Moolenaar97d62492012-11-15 21:28:22 +0100156<
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100157Netrw will substitute the host's machine name for "MACHINE" from the URL it is
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200158attempting to open, and so one may specify >
159 userid
160 password
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200161for each site in a separate file: c:\Users\MyUserName\MachineName.
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200162
Bram Moolenaar446cb832008-06-24 21:56:24 +0000163Now about browsing -- when you just want to look around before editing a
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000164file. For browsing on your current host, just "edit" a directory: >
165
166 vim .
167 vim /home/userid/path
168<
169For browsing on a remote host, "edit" a directory (but make sure that
170the directory name is followed by a "/"): >
171
172 vim scp://hostname/
173 vim ftp://hostname/path/to/dir/
174<
175See |netrw-browse| for more!
176
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100177There are more protocols supported by netrw than just scp and ftp, too: see the
178next section, |netrw-externapp|, on how to use these external applications with
179netrw and vim.
180
Bram Moolenaar13600302014-05-22 18:26:40 +0200181PREVENTING LOADING *netrw-noload*
Bram Moolenaar446cb832008-06-24 21:56:24 +0000182
183If you want to use plugins, but for some reason don't wish to use netrw, then
184you need to avoid loading both the plugin and the autoload portions of netrw.
185You may do so by placing the following two lines in your <.vimrc>: >
186
187 :let g:loaded_netrw = 1
188 :let g:loaded_netrwPlugin = 1
189<
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000190
191==============================================================================
Bram Moolenaar13600302014-05-22 18:26:40 +02001923. Netrw Reference *netrw-ref* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100194 Netrw supports several protocols in addition to scp and ftp as mentioned
Bram Moolenaar446cb832008-06-24 21:56:24 +0000195 in |netrw-start|. These include dav, fetch, http,... well, just look
196 at the list in |netrw-externapp|. Each protocol is associated with a
197 variable which holds the default command supporting that protocol.
198
199EXTERNAL APPLICATIONS AND PROTOCOLS *netrw-externapp* {{{2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200
Bram Moolenaar8d043172014-01-23 14:24:41 +0100201 Protocol Variable Default Value
202 -------- ---------------- -------------
203 dav: *g:netrw_dav_cmd* = "cadaver" if cadaver is executable
204 dav: g:netrw_dav_cmd = "curl -o" elseif curl is available
205 fetch: *g:netrw_fetch_cmd* = "fetch -o" if fetch is available
206 ftp: *g:netrw_ftp_cmd* = "ftp"
207 http: *g:netrw_http_cmd* = "elinks" if elinks is available
208 http: g:netrw_http_cmd = "links" elseif links is available
209 http: g:netrw_http_cmd = "curl" elseif curl is available
210 http: g:netrw_http_cmd = "wget" elseif wget is available
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100211 http: g:netrw_http_cmd = "fetch" elseif fetch is available
Bram Moolenaar8d043172014-01-23 14:24:41 +0100212 http: *g:netrw_http_put_cmd* = "curl -T"
213 rcp: *g:netrw_rcp_cmd* = "rcp"
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100214 rsync: *g:netrw_rsync_cmd* = "rsync" (see |g:netrw_rsync_sep|)
Bram Moolenaar8d043172014-01-23 14:24:41 +0100215 scp: *g:netrw_scp_cmd* = "scp -q"
216 sftp: *g:netrw_sftp_cmd* = "sftp"
Bram Moolenaar8feef4f2015-01-07 16:57:10 +0100217 file: *g:netrw_file_cmd* = "elinks" or "links"
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100218
219 *g:netrw_http_xcmd* : the option string for http://... protocols are
220 specified via this variable and may be independently overridden. By
221 default, the option arguments for the http-handling commands are: >
222
223 elinks : "-source >"
Bram Moolenaar97d62492012-11-15 21:28:22 +0100224 links : "-dump >"
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100225 curl : "-L -o"
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100226 wget : "-q -O"
227 fetch : "-o"
228<
229 For example, if your system has elinks, and you'd rather see the
230 page using an attempt at rendering the text, you may wish to have >
231 let g:netrw_http_xcmd= "-dump >"
232< in your .vimrc.
233
Bram Moolenaar8d043172014-01-23 14:24:41 +0100234 g:netrw_http_put_cmd: this option specifies both the executable and
235 any needed options. This command does a PUT operation to the url.
236
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237
Bram Moolenaar446cb832008-06-24 21:56:24 +0000238READING *netrw-read* *netrw-nread* {{{2
239
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100240 Generally, one may just use the URL notation with a normal editing
Bram Moolenaar446cb832008-06-24 21:56:24 +0000241 command, such as >
242
243 :e ftp://[user@]machine/path
244<
245 Netrw also provides the Nread command:
246
Bram Moolenaar071d4272004-06-13 20:20:40 +0000247 :Nread ? give help
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000248 :Nread "machine:path" uses rcp
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000249 :Nread "machine path" uses ftp w/ <.netrc>
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000250 :Nread "machine id password path" uses ftp
251 :Nread "dav://machine[:port]/path" uses cadaver
252 :Nread "fetch://[user@]machine/path" uses fetch
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000253 :Nread "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc>
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000254 :Nread "http://[user@]machine/path" uses http uses wget
255 :Nread "rcp://[user@]machine/path" uses rcp
256 :Nread "rsync://[user@]machine[:port]/path" uses rsync
257 :Nread "scp://[user@]machine[[:#]port]/path" uses scp
258 :Nread "sftp://[user@]machine/path" uses sftp
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259
Bram Moolenaar446cb832008-06-24 21:56:24 +0000260WRITING *netrw-write* *netrw-nwrite* {{{2
261
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100262 One may just use the URL notation with a normal file writing
Bram Moolenaar446cb832008-06-24 21:56:24 +0000263 command, such as >
264
265 :w ftp://[user@]machine/path
266<
267 Netrw also provides the Nwrite command:
268
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000269 :Nwrite ? give help
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000270 :Nwrite "machine:path" uses rcp
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000271 :Nwrite "machine path" uses ftp w/ <.netrc>
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000272 :Nwrite "machine id password path" uses ftp
273 :Nwrite "dav://machine[:port]/path" uses cadaver
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000274 :Nwrite "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc>
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000275 :Nwrite "rcp://[user@]machine/path" uses rcp
276 :Nwrite "rsync://[user@]machine[:port]/path" uses rsync
277 :Nwrite "scp://[user@]machine[[:#]port]/path" uses scp
278 :Nwrite "sftp://[user@]machine/path" uses sftp
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279 http: not supported!
280
Bram Moolenaar446cb832008-06-24 21:56:24 +0000281SOURCING *netrw-source* {{{2
282
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100283 One may just use the URL notation with the normal file sourcing
Bram Moolenaar446cb832008-06-24 21:56:24 +0000284 command, such as >
285
286 :so ftp://[user@]machine/path
287<
288 Netrw also provides the Nsource command:
289
Bram Moolenaar9964e462007-05-05 17:54:07 +0000290 :Nsource ? give help
291 :Nsource "dav://machine[:port]/path" uses cadaver
292 :Nsource "fetch://[user@]machine/path" uses fetch
293 :Nsource "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc>
294 :Nsource "http://[user@]machine/path" uses http uses wget
295 :Nsource "rcp://[user@]machine/path" uses rcp
296 :Nsource "rsync://[user@]machine[:port]/path" uses rsync
297 :Nsource "scp://[user@]machine[[:#]port]/path" uses scp
298 :Nsource "sftp://[user@]machine/path" uses sftp
299
Bram Moolenaar13600302014-05-22 18:26:40 +0200300DIRECTORY LISTING *netrw-trailingslash* *netrw-dirlist* {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +0000301
302 One may browse a directory to get a listing by simply attempting to
303 edit the directory: >
304
305 :e scp://[user]@hostname/path/
306 :e ftp://[user]@hostname/path/
307<
Bram Moolenaar251e1912011-06-19 05:09:16 +0200308 For remote directory listings (ie. those using scp or ftp), that
309 trailing "/" is necessary (the slash tells netrw to treat the argument
310 as a directory to browse instead of as a file to download).
Bram Moolenaar446cb832008-06-24 21:56:24 +0000311
Bram Moolenaar251e1912011-06-19 05:09:16 +0200312 The Nread command may also be used to accomplish this (again, that
313 trailing slash is necessary): >
Bram Moolenaar446cb832008-06-24 21:56:24 +0000314
Bram Moolenaar251e1912011-06-19 05:09:16 +0200315 :Nread [protocol]://[user]@hostname/path/
316<
Bram Moolenaar446cb832008-06-24 21:56:24 +0000317 *netrw-login* *netrw-password*
318CHANGING USERID AND PASSWORD *netrw-chgup* *netrw-userpass* {{{2
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +0000319
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320 Attempts to use ftp will prompt you for a user-id and a password.
Bram Moolenaar15146672011-10-20 22:22:38 +0200321 These will be saved in global variables |g:netrw_uid| and
322 |s:netrw_passwd|; subsequent use of ftp will re-use those two strings,
323 thereby simplifying use of ftp. However, if you need to use a
324 different user id and/or password, you'll want to call |NetUserPass()|
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +0000325 first. To work around the need to enter passwords, check if your ftp
326 supports a <.netrc> file in your home directory. Also see
327 |netrw-passwd| (and if you're using ssh/scp hoping to figure out how
Bram Moolenaar15146672011-10-20 22:22:38 +0200328 to not need to use passwords for scp, look at |netrw-ssh-hack|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000329
330 :NetUserPass [uid [password]] -- prompts as needed
331 :call NetUserPass() -- prompts for uid and password
332 :call NetUserPass("uid") -- prompts for password
333 :call NetUserPass("uid","password") -- sets global uid and password
334
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200335(Related topics: |ftp| |netrw-userpass| |netrw-start|)
336
Bram Moolenaar446cb832008-06-24 21:56:24 +0000337NETRW VARIABLES AND SETTINGS *netrw-variables* {{{2
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200338 (Also see:
339 |netrw-browser-var| : netrw browser option variables
340 |netrw-protocol| : file transfer protocol option variables
341 |netrw-settings| : additional file transfer options
342 |netrw-browser-options| : these options affect browsing directories
343 )
Bram Moolenaar9964e462007-05-05 17:54:07 +0000344
Bram Moolenaar446cb832008-06-24 21:56:24 +0000345Netrw provides a lot of variables which allow you to customize netrw to your
346preferences. One way to look at them is via the command :NetrwSettings (see
347|netrw-settings|) which will display your current netrw settings. Most such
348settings are described below, in |netrw-browser-options|, and in
349|netrw-externapp|:
Bram Moolenaar9964e462007-05-05 17:54:07 +0000350
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100351 *b:netrw_lastfile* last file Network-read/written retained on a
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200352 per-buffer basis (supports plain :Nw )
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100353
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200354 *g:netrw_bufsettings* the settings that netrw buffers have
Bram Moolenaar8feef4f2015-01-07 16:57:10 +0100355 (default) noma nomod nonu nowrap ro nobl
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200356
Bram Moolenaar13600302014-05-22 18:26:40 +0200357 *g:netrw_chgwin* specifies a window number where subsequent file edits
358 will take place. (also see |netrw-C|)
359 (default) -1
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100360
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200361 *g:Netrw_funcref* specifies a function (or functions) to be called when
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200362 netrw edits a file. The file is first edited, and
363 then the function reference (|Funcref|) is called.
364 This variable may also hold a |List| of Funcrefs.
365 (default) not defined. (the capital in g:Netrw...
366 is required by its holding a function reference)
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200367>
368 Example: place in .vimrc; affects all file opening
369 fun! MyFuncRef()
370 endfun
371 let g:Netrw_funcref= function("MyFuncRef")
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100372
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200373<
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100374 *g:Netrw_UserMaps* specifies a function or |List| of functions which can
375 be used to set up user-specified maps and functionality.
376 See |netrw-usermaps|
377
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200378 *g:netrw_ftp* if it doesn't exist, use default ftp
379 =0 use default ftp (uid password)
380 =1 use alternate ftp method (user uid password)
381 If you're having trouble with ftp, try changing the
382 value of this variable to see if the alternate ftp
383 method works for your setup.
384
Bram Moolenaar13600302014-05-22 18:26:40 +0200385 *g:netrw_ftp_options* Chosen by default, these options are supposed to
386 turn interactive prompting off and to restrain ftp
387 from attempting auto-login upon initial connection.
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200388 However, it appears that not all ftp implementations
389 support this (ex. ncftp).
390 ="-i -n"
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000391
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100392 *g:netrw_ftpextracmd* default: doesn't exist
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200393 If this variable exists, then any string it contains
394 will be placed into the commands set to your ftp
395 client. As an example:
396 ="passive"
Bram Moolenaar9964e462007-05-05 17:54:07 +0000397
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000398 *g:netrw_ftpmode* ="binary" (default)
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200399 ="ascii"
Bram Moolenaarf6cf9872005-08-08 22:00:59 +0000400
Bram Moolenaar9964e462007-05-05 17:54:07 +0000401 *g:netrw_ignorenetrc* =0 (default for linux, cygwin)
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200402 =1 If you have a <.netrc> file but it doesn't work and
403 you want it ignored, then set this variable as
404 shown. (default for Windows + cmd.exe)
Bram Moolenaar9964e462007-05-05 17:54:07 +0000405
406 *g:netrw_menu* =0 disable netrw's menu
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200407 =1 (default) netrw's menu enabled
Bram Moolenaar9964e462007-05-05 17:54:07 +0000408
409 *g:netrw_nogx* if this variable exists, then the "gx" map will not
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200410 be available (see |netrw-gx|)
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000411
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100412 *g:netrw_uid* (ftp) user-id, retained on a per-vim-session basis
Bram Moolenaar8feef4f2015-01-07 16:57:10 +0100413 *s:netrw_passwd* (ftp) password, retained on a per-vim-session basis
Bram Moolenaar446cb832008-06-24 21:56:24 +0000414
415 *g:netrw_preview* =0 (default) preview window shown in a horizontally
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200416 split window
417 =1 preview window shown in a vertically split window.
Bram Moolenaar13600302014-05-22 18:26:40 +0200418 Also affects the "previous window" (see |netrw-P|)
419 in the same way.
Bram Moolenaar8feef4f2015-01-07 16:57:10 +0100420 The |g:netrw_alto| variable may be used to provide
421 additional splitting control:
422 g:netrw_preview g:netrw_alto result
423 0 0 |:aboveleft|
424 0 1 |:belowright|
425 1 0 |:topleft|
426 1 1 |:botright|
427 To control sizing, see |g:netrw_winsize|
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000428
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200429 *g:netrw_scpport* = "-P" : option to use to set port for scp
430 *g:netrw_sshport* = "-p" : option to use to set port for ssh
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +0000431
Bram Moolenaar8feef4f2015-01-07 16:57:10 +0100432 *g:netrw_sepchr* =\0xff
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200433 =\0x01 for enc == euc-jp (and perhaps it should be for
434 others, too, please let me know)
435 Separates priority codes from filenames internally.
436 See |netrw-p12|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100437
Bram Moolenaar446cb832008-06-24 21:56:24 +0000438 *g:netrw_silent* =0 : transfers done normally
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200439 =1 : transfers done silently
Bram Moolenaar446cb832008-06-24 21:56:24 +0000440
Bram Moolenaar1d59aa12020-09-19 18:50:13 +0200441 *g:netrw_use_errorwindow* =2: messages from netrw will use a popup window
442 Move the mouse and pause to remove the popup window.
Bram Moolenaard592deb2022-06-17 15:42:40 +0100443 (default value if popup windows are available)
Bram Moolenaar1d59aa12020-09-19 18:50:13 +0200444 =1 : messages from netrw will use a separate one
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200445 line window. This window provides reliable
Bram Moolenaar1d59aa12020-09-19 18:50:13 +0200446 delivery of messages.
Bram Moolenaard592deb2022-06-17 15:42:40 +0100447 (default value if popup windows are not available)
Bram Moolenaar8ada2cc2010-07-29 20:43:36 +0200448 =0 : messages from netrw will use echoerr ;
449 messages don't always seem to show up this
450 way, but one doesn't have to quit the window.
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +0000451
Bram Moolenaar8feef4f2015-01-07 16:57:10 +0100452 *g:netrw_cygwin* =1 assume scp under windows is from cygwin. Also
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200453 permits network browsing to use ls with time and
454 size sorting (default if windows)
455 =0 assume Windows' scp accepts windows-style paths
456 Network browsing uses dir instead of ls
457 This option is ignored if you're using unix
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000458
459 *g:netrw_use_nt_rcp* =0 don't use the rcp of WinNT, Win2000 and WinXP
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200460 =1 use WinNT's rcp in binary mode (default)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000461
Bram Moolenaar446cb832008-06-24 21:56:24 +0000462PATHS *netrw-path* {{{2
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000463
464Paths to files are generally user-directory relative for most protocols.
465It is possible that some protocol will make paths relative to some
466associated directory, however.
467>
468 example: vim scp://user@host/somefile
469 example: vim scp://user@host/subdir1/subdir2/somefile
470<
Bram Moolenaar446cb832008-06-24 21:56:24 +0000471where "somefile" is in the "user"'s home directory. If you wish to get a
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000472file using root-relative paths, use the full path:
473>
474 example: vim scp://user@host//somefile
475 example: vim scp://user@host//subdir1/subdir2/somefile
476<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000477
478==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00004794. Network-Oriented File Transfer *netrw-xfer* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000480
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100481Network-oriented file transfer under Vim is implemented by a vim script
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000482(<netrw.vim>) using plugin techniques. It currently supports both reading and
483writing across networks using rcp, scp, ftp or ftp+<.netrc>, scp, fetch,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484dav/cadaver, rsync, or sftp.
485
486http is currently supported read-only via use of wget or fetch.
487
488<netrw.vim> is a standard plugin which acts as glue between Vim and the
489various file transfer programs. It uses autocommand events (BufReadCmd,
490FileReadCmd, BufWriteCmd) to intercept reads/writes with url-like filenames. >
491
492 ex. vim ftp://hostname/path/to/file
493<
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000494The characters preceding the colon specify the protocol to use; in the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000495example, it's ftp. The <netrw.vim> script then formulates a command or a
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000496series of commands (typically ftp) which it issues to an external program
497(ftp, scp, etc) which does the actual file transfer/protocol. Files are read
498from/written to a temporary file (under Unix/Linux, /tmp/...) which the
499<netrw.vim> script will clean up.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100501Now, a word about Jan Minář's "FTP User Name and Password Disclosure"; first,
502ftp is not a secure protocol. User names and passwords are transmitted "in
503the clear" over the internet; any snooper tool can pick these up; this is not
504a netrw thing, this is a ftp thing. If you're concerned about this, please
505try to use scp or sftp instead.
506
507Netrw re-uses the user id and password during the same vim session and so long
508as the remote hostname remains the same.
509
510Jan seems to be a bit confused about how netrw handles ftp; normally multiple
511commands are performed in a "ftp session", and he seems to feel that the
512uid/password should only be retained over one ftp session. However, netrw
513does every ftp operation in a separate "ftp session"; so remembering the
514uid/password for just one "ftp session" would be the same as not remembering
515the uid/password at all. IMHO this would rapidly grow tiresome as one
516browsed remote directories, for example.
517
518On the other hand, thanks go to Jan M. for pointing out the many
519vulnerabilities that netrw (and vim itself) had had in handling "crafted"
520filenames. The |shellescape()| and |fnameescape()| functions were written in
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200521response by Bram Moolenaar to handle these sort of problems, and netrw has
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100522been modified to use them. Still, my advice is, if the "filename" looks like
523a vim command that you aren't comfortable with having executed, don't open it.
524
Bram Moolenaar9964e462007-05-05 17:54:07 +0000525 *netrw-putty* *netrw-pscp* *netrw-psftp*
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000526One may modify any protocol's implementing external application by setting a
527variable (ex. scp uses the variable g:netrw_scp_cmd, which is defaulted to
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000528"scp -q"). As an example, consider using PuTTY: >
Bram Moolenaar9964e462007-05-05 17:54:07 +0000529
530 let g:netrw_scp_cmd = '"c:\Program Files\PuTTY\pscp.exe" -q -batch'
531 let g:netrw_sftp_cmd= '"c:\Program Files\PuTTY\psftp.exe"'
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000532<
Bram Moolenaar15146672011-10-20 22:22:38 +0200533(note: it has been reported that windows 7 with putty v0.6's "-batch" option
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100534 doesn't work, so its best to leave it off for that system)
Bram Moolenaar15146672011-10-20 22:22:38 +0200535
Bram Moolenaar9964e462007-05-05 17:54:07 +0000536See |netrw-p8| for more about putty, pscp, psftp, etc.
537
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538Ftp, an old protocol, seems to be blessed by numerous implementations.
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000539Unfortunately, some implementations are noisy (ie., add junk to the end of the
540file). Thus, concerned users may decide to write a NetReadFixup() function
541that will clean up after reading with their ftp. Some Unix systems (ie.,
542FreeBSD) provide a utility called "fetch" which uses the ftp protocol but is
543not noisy and more convenient, actually, for <netrw.vim> to use.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100544Consequently, if "fetch" is available (ie. executable), it may be preferable
545to use it for ftp://... based transfers.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000546
547For rcp, scp, sftp, and http, one may use network-oriented file transfers
Bram Moolenaar83bab712005-08-01 21:58:57 +0000548transparently; ie.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549>
550 vim rcp://[user@]machine/path
551 vim scp://[user@]machine/path
552<
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100553If your ftp supports <.netrc>, then it too can be transparently used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554if the needed triad of machine name, user id, and password are present in
555that file. Your ftp must be able to use the <.netrc> file on its own, however.
556>
557 vim ftp://[user@]machine[[:#]portnumber]/path
558<
Bram Moolenaaradc21822011-04-01 18:03:16 +0200559Windows provides an ftp (typically c:\Windows\System32\ftp.exe) which uses
560an option, -s:filename (filename can and probably should be a full path)
561which contains ftp commands which will be automatically run whenever ftp
562starts. You may use this feature to enter a user and password for one site: >
563 userid
564 password
Bram Moolenaar13600302014-05-22 18:26:40 +0200565< *netrw-windows-netrc* *netrw-windows-s*
566If |g:netrw_ftp_cmd| contains -s:[path/]MACHINE, then (on Windows machines
567only) netrw will substitute the current machine name requested for ftp
568connections for MACHINE. Hence one can have multiple machine.ftp files
569containing login and password for ftp. Example: >
Bram Moolenaaradc21822011-04-01 18:03:16 +0200570
Bram Moolenaarff034192013-04-24 18:51:19 +0200571 let g:netrw_ftp_cmd= 'c:\Windows\System32\ftp -s:C:\Users\Myself\MACHINE'
572 vim ftp://myhost.somewhere.net/
Bram Moolenaar13600302014-05-22 18:26:40 +0200573
Bram Moolenaaradc21822011-04-01 18:03:16 +0200574will use a file >
Bram Moolenaar13600302014-05-22 18:26:40 +0200575
Bram Moolenaaradc21822011-04-01 18:03:16 +0200576 C:\Users\Myself\myhost.ftp
577<
578Often, ftp will need to query the user for the userid and password.
Bram Moolenaar83bab712005-08-01 21:58:57 +0000579The latter will be done "silently"; ie. asterisks will show up instead of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000580the actually-typed-in password. Netrw will retain the userid and password
581for subsequent read/writes from the most recent transfer so subsequent
582transfers (read/write) to or from that machine will take place without
583additional prompting.
584
585 *netrw-urls*
586 +=================================+============================+============+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000587 | Reading | Writing | Uses |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588 +=================================+============================+============+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000589 | DAV: | | |
590 | dav://host/path | | cadaver |
591 | :Nread dav://host/path | :Nwrite dav://host/path | cadaver |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592 +---------------------------------+----------------------------+------------+
Bram Moolenaar446cb832008-06-24 21:56:24 +0000593 | DAV + SSL: | | |
594 | davs://host/path | | cadaver |
595 | :Nread davs://host/path | :Nwrite davs://host/path | cadaver |
596 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000597 | FETCH: | | |
598 | fetch://[user@]host/path | | |
599 | fetch://[user@]host:http/path | Not Available | fetch |
600 | :Nread fetch://[user@]host/path| | |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000601 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000602 | FILE: | | |
603 | file:///* | file:///* | |
604 | file://localhost/* | file://localhost/* | |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000605 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000606 | FTP: (*3) | (*3) | |
607 | ftp://[user@]host/path | ftp://[user@]host/path | ftp (*2) |
608 | :Nread ftp://host/path | :Nwrite ftp://host/path | ftp+.netrc |
609 | :Nread host path | :Nwrite host path | ftp+.netrc |
610 | :Nread host uid pass path | :Nwrite host uid pass path | ftp |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000612 | HTTP: wget is executable: (*4) | | |
613 | http://[user@]host/path | Not Available | wget |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000615 | HTTP: fetch is executable (*4) | | |
616 | http://[user@]host/path | Not Available | fetch |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000617 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000618 | RCP: | | |
619 | rcp://[user@]host/path | rcp://[user@]host/path | rcp |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000621 | RSYNC: | | |
622 | rsync://[user@]host/path | rsync://[user@]host/path | rsync |
623 | :Nread rsync://host/path | :Nwrite rsync://host/path | rsync |
624 | :Nread rcp://host/path | :Nwrite rcp://host/path | rcp |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000625 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000626 | SCP: | | |
627 | scp://[user@]host/path | scp://[user@]host/path | scp |
628 | :Nread scp://host/path | :Nwrite scp://host/path | scp (*1) |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000629 +---------------------------------+----------------------------+------------+
Bram Moolenaar9964e462007-05-05 17:54:07 +0000630 | SFTP: | | |
631 | sftp://[user@]host/path | sftp://[user@]host/path | sftp |
632 | :Nread sftp://host/path | :Nwrite sftp://host/path | sftp (*1) |
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 +=================================+============================+============+
634
635 (*1) For an absolute path use scp://machine//path.
636
637 (*2) if <.netrc> is present, it is assumed that it will
638 work with your ftp client. Otherwise the script will
Bram Moolenaar9964e462007-05-05 17:54:07 +0000639 prompt for user-id and password.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640
zeertzjqd086b8f2024-02-25 15:42:52 +0800641 (*3) for ftp, "machine" may be machine#port or machine:port
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642 if a different port is needed than the standard ftp port
643
644 (*4) for http:..., if wget is available it will be used. Otherwise,
645 if fetch is available it will be used.
646
647Both the :Nread and the :Nwrite ex-commands can accept multiple filenames.
648
649
650NETRC *netrw-netrc*
651
Bram Moolenaar446cb832008-06-24 21:56:24 +0000652The <.netrc> file, typically located in your home directory, contains lines
653therein which map a hostname (machine name) to the user id and password you
654prefer to use with it.
655
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656The typical syntax for lines in a <.netrc> file is given as shown below.
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000657Ftp under Unix usually supports <.netrc>; ftp under Windows usually doesn't.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658>
659 machine {full machine name} login {user-id} password "{password}"
660 default login {user-id} password "{password}"
661
662Your ftp client must handle the use of <.netrc> on its own, but if the
663<.netrc> file exists, an ftp transfer will not ask for the user-id or
664password.
665
666 Note:
667 Since this file contains passwords, make very sure nobody else can
668 read this file! Most programs will refuse to use a .netrc that is
669 readable for others. Don't forget that the system administrator can
Bram Moolenaar446cb832008-06-24 21:56:24 +0000670 still read the file! Ie. for Linux/Unix: chmod 600 .netrc
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200672Even though Windows' ftp clients typically do not support .netrc, netrw has
673a work-around: see |netrw-windows-s|.
674
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675
676PASSWORD *netrw-passwd*
677
678The script attempts to get passwords for ftp invisibly using |inputsecret()|,
Bram Moolenaar8ada2cc2010-07-29 20:43:36 +0200679a built-in Vim function. See |netrw-userpass| for how to change the password
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680after one has set it.
681
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000682Unfortunately there doesn't appear to be a way for netrw to feed a password to
683scp. Thus every transfer via scp will require re-entry of the password.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000684However, |netrw-ssh-hack| can help with this problem.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685
686
687==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00006885. Activation *netrw-activate* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000690Network-oriented file transfers are available by default whenever Vim's
Bram Moolenaar446cb832008-06-24 21:56:24 +0000691|'nocompatible'| mode is enabled. Netrw's script files reside in your
692system's plugin, autoload, and syntax directories; just the
693plugin/netrwPlugin.vim script is sourced automatically whenever you bring up
694vim. The main script in autoload/netrw.vim is only loaded when you actually
695use netrw. I suggest that, at a minimum, you have at least the following in
696your <.vimrc> customization file: >
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000697
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000698 set nocp
699 if version >= 600
700 filetype plugin indent on
701 endif
702<
Bram Moolenaar8feef4f2015-01-07 16:57:10 +0100703By also including the following lines in your .vimrc, one may have netrw
704immediately activate when using [g]vim without any filenames, showing the
705current directory: >
706
707 " Augroup VimStartup:
708 augroup VimStartup
709 au!
710 au VimEnter * if expand("%") == "" | e . | endif
711 augroup END
712<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713
714==============================================================================
Bram Moolenaar13600302014-05-22 18:26:40 +02007156. Transparent Remote File Editing *netrw-transparent* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716
717Transparent file transfers occur whenever a regular file read or write
Bram Moolenaar446cb832008-06-24 21:56:24 +0000718(invoked via an |:autocmd| for |BufReadCmd|, |BufWriteCmd|, or |SourceCmd|
719events) is made. Thus one may read, write, or source files across networks
720just as easily as if they were local files! >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000721
722 vim ftp://[user@]machine/path
723 ...
724 :wq
725
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000726See |netrw-activate| for more on how to encourage your vim to use plugins
727such as netrw.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728
Bram Moolenaar1d59aa12020-09-19 18:50:13 +0200729For password-free use of scp:, see |netrw-ssh-hack|.
730
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000731
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00007337. Ex Commands *netrw-ex* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734
Bram Moolenaarc01140a2006-03-24 22:21:52 +0000735The usual read/write commands are supported. There are also a few
Bram Moolenaar446cb832008-06-24 21:56:24 +0000736additional commands available. Often you won't need to use Nwrite or
Bram Moolenaar9964e462007-05-05 17:54:07 +0000737Nread as shown in |netrw-transparent| (ie. simply use >
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100738 :e URL
739 :r URL
740 :w URL
Bram Moolenaar9964e462007-05-05 17:54:07 +0000741instead, as appropriate) -- see |netrw-urls|. In the explanations
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100742below, a {netfile} is a URL to a remote file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200744 *:Nwrite* *:Nw*
Bram Moolenaar446cb832008-06-24 21:56:24 +0000745:[range]Nw[rite] Write the specified lines to the current
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 file as specified in b:netrw_lastfile.
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200747 (related: |netrw-nwrite|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748
Bram Moolenaar446cb832008-06-24 21:56:24 +0000749:[range]Nw[rite] {netfile} [{netfile}]...
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750 Write the specified lines to the {netfile}.
751
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200752 *:Nread* *:Nr*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100753:Nr[ead] Read the lines from the file specified in b:netrw_lastfile
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200754 into the current buffer. (related: |netrw-nread|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000755
Bram Moolenaar446cb832008-06-24 21:56:24 +0000756:Nr[ead] {netfile} {netfile}...
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757 Read the {netfile} after the current line.
758
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200759 *:Nsource* *:Ns*
Bram Moolenaar446cb832008-06-24 21:56:24 +0000760:Ns[ource] {netfile}
Bram Moolenaar9964e462007-05-05 17:54:07 +0000761 Source the {netfile}.
762 To start up vim using a remote .vimrc, one may use
763 the following (all on one line) (tnx to Antoine Mechelynck) >
764 vim -u NORC -N
765 --cmd "runtime plugin/netrwPlugin.vim"
766 --cmd "source scp://HOSTNAME/.vimrc"
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200767< (related: |netrw-source|)
768
769:call NetUserPass() *NetUserPass()*
Bram Moolenaar446cb832008-06-24 21:56:24 +0000770 If g:netrw_uid and s:netrw_passwd don't exist,
771 this function will query the user for them.
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200772 (related: |netrw-userpass|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773
774:call NetUserPass("userid")
Bram Moolenaar446cb832008-06-24 21:56:24 +0000775 This call will set the g:netrw_uid and, if
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 the password doesn't exist, will query the user for it.
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200777 (related: |netrw-userpass|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778
779:call NetUserPass("userid","passwd")
Bram Moolenaar446cb832008-06-24 21:56:24 +0000780 This call will set both the g:netrw_uid and s:netrw_passwd.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 The user-id and password are used by ftp transfers. One may
Bram Moolenaar446cb832008-06-24 21:56:24 +0000782 effectively remove the user-id and password by using empty
783 strings (ie. "").
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200784 (related: |netrw-userpass|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785
Bram Moolenaar9964e462007-05-05 17:54:07 +0000786:NetrwSettings This command is described in |netrw-settings| -- used to
zeertzjqd086b8f2024-02-25 15:42:52 +0800787 display netrw settings and change netrw behavior.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +0000788
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789
790==============================================================================
Bram Moolenaar13600302014-05-22 18:26:40 +02007918. Variables and Options *netrw-var* *netrw-settings* {{{1
Bram Moolenaar446cb832008-06-24 21:56:24 +0000792
Bram Moolenaar15146672011-10-20 22:22:38 +0200793(also see: |netrw-options| |netrw-variables| |netrw-protocol|
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200794 |netrw-browser-settings| |netrw-browser-options| )
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795
Bram Moolenaar9964e462007-05-05 17:54:07 +0000796The <netrw.vim> script provides several variables which act as options to
Bram Moolenaar446cb832008-06-24 21:56:24 +0000797affect <netrw.vim>'s file transfer behavior. These variables typically may be
798set in the user's <.vimrc> file: (see also |netrw-settings| |netrw-protocol|)
Bram Moolenaar15146672011-10-20 22:22:38 +0200799 *netrw-options*
Bram Moolenaar446cb832008-06-24 21:56:24 +0000800>
Bram Moolenaar9964e462007-05-05 17:54:07 +0000801 -------------
802 Netrw Options
803 -------------
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000804 Option Meaning
805 -------------- -----------------------------------------------
806<
Bram Moolenaar9964e462007-05-05 17:54:07 +0000807 b:netrw_col Holds current cursor position (during NetWrite)
808 g:netrw_cygwin =1 assume scp under windows is from cygwin
809 (default/windows)
810 =0 assume scp under windows accepts windows
811 style paths (default/else)
812 g:netrw_ftp =0 use default ftp (uid password)
813 g:netrw_ftpmode ="binary" (default)
814 ="ascii" (your choice)
815 g:netrw_ignorenetrc =1 (default)
816 if you have a <.netrc> file but you don't
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 want it used, then set this variable. Its
818 mere existence is enough to cause <.netrc>
819 to be ignored.
Bram Moolenaar9964e462007-05-05 17:54:07 +0000820 b:netrw_lastfile Holds latest method/machine/path.
821 b:netrw_line Holds current line number (during NetWrite)
Bram Moolenaar9964e462007-05-05 17:54:07 +0000822 g:netrw_silent =0 transfers done normally
823 =1 transfers done silently
824 g:netrw_uid Holds current user-id for ftp.
Bram Moolenaar9964e462007-05-05 17:54:07 +0000825 g:netrw_use_nt_rcp =0 don't use WinNT/2K/XP's rcp (default)
826 =1 use WinNT/2K/XP's rcp, binary mode
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000827 -----------------------------------------------------------------------
828<
Bram Moolenaar13600302014-05-22 18:26:40 +0200829 *netrw-internal-variables*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830The script will also make use of the following variables internally, albeit
831temporarily.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000832>
833 -------------------
834 Temporary Variables
835 -------------------
836 Variable Meaning
837 -------- ------------------------------------
838<
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100839 b:netrw_method Index indicating rcp/ftp+.netrc/ftp
840 w:netrw_method (same as b:netrw_method)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 g:netrw_machine Holds machine name parsed from input
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100842 b:netrw_fname Holds filename being accessed >
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000843 ------------------------------------------------------------
844<
Bram Moolenaar446cb832008-06-24 21:56:24 +0000845 *netrw-protocol*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000846
847Netrw supports a number of protocols. These protocols are invoked using the
848variables listed below, and may be modified by the user.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849>
850 ------------------------
Bram Moolenaar9964e462007-05-05 17:54:07 +0000851 Protocol Control Options
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852 ------------------------
Bram Moolenaar9964e462007-05-05 17:54:07 +0000853 Option Type Setting Meaning
854 --------- -------- -------------- ---------------------------
Bram Moolenaar8d043172014-01-23 14:24:41 +0100855< netrw_ftp variable =doesn't exist userid set by "user userid"
Bram Moolenaar9964e462007-05-05 17:54:07 +0000856 =0 userid set by "user userid"
857 =1 userid set by "userid"
858 NetReadFixup function =doesn't exist no change
859 =exists Allows user to have files
860 read via ftp automatically
861 transformed however they wish
862 by NetReadFixup()
Bram Moolenaar8d043172014-01-23 14:24:41 +0100863 g:netrw_dav_cmd var ="cadaver" if cadaver is executable
864 g:netrw_dav_cmd var ="curl -o" elseif curl is executable
865 g:netrw_fetch_cmd var ="fetch -o" if fetch is available
866 g:netrw_ftp_cmd var ="ftp"
867 g:netrw_http_cmd var ="fetch -o" if fetch is available
868 g:netrw_http_cmd var ="wget -O" else if wget is available
869 g:netrw_http_put_cmd var ="curl -T"
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100870 |g:netrw_list_cmd| var ="ssh USEPORT HOSTNAME ls -Fa"
Bram Moolenaar8d043172014-01-23 14:24:41 +0100871 g:netrw_rcp_cmd var ="rcp"
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100872 g:netrw_rsync_cmd var ="rsync"
873 *g:netrw_rsync_sep* var ="/" used to separate the hostname
874 from the file spec
Bram Moolenaar8d043172014-01-23 14:24:41 +0100875 g:netrw_scp_cmd var ="scp -q"
876 g:netrw_sftp_cmd var ="sftp" >
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000877 -------------------------------------------------------------------------
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878<
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000879 *netrw-ftp*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880
Bram Moolenaar9964e462007-05-05 17:54:07 +0000881The g:netrw_..._cmd options (|g:netrw_ftp_cmd| and |g:netrw_sftp_cmd|)
882specify the external program to use handle the ftp protocol. They may
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200883include command line options (such as -p for passive mode). Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +0200885 let g:netrw_ftp_cmd= "ftp -p"
886<
Bram Moolenaar9964e462007-05-05 17:54:07 +0000887Browsing is supported by using the |g:netrw_list_cmd|; the substring
888"HOSTNAME" will be changed via substitution with whatever the current request
889is for a hostname.
890
891Two options (|g:netrw_ftp| and |netrw-fixup|) both help with certain ftp's
892that give trouble . In order to best understand how to use these options if
893ftp is giving you troubles, a bit of discussion is provided on how netrw does
894ftp reads.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000895
896For ftp, netrw typically builds up lines of one of the following formats in a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897temporary file:
898>
899 IF g:netrw_ftp !exists or is not 1 IF g:netrw_ftp exists and is 1
900 ---------------------------------- ------------------------------
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000901<
Bram Moolenaar9964e462007-05-05 17:54:07 +0000902 open machine [port] open machine [port]
903 user userid password userid password
904 [g:netrw_ftpmode] password
Bram Moolenaar8ada2cc2010-07-29 20:43:36 +0200905 [g:netrw_ftpextracmd] [g:netrw_ftpmode]
Bram Moolenaar9964e462007-05-05 17:54:07 +0000906 get filename tempfile [g:netrw_extracmd]
907 get filename tempfile >
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000908 ---------------------------------------------------------------------
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909<
Bram Moolenaar8ada2cc2010-07-29 20:43:36 +0200910The |g:netrw_ftpmode| and |g:netrw_ftpextracmd| are optional.
Bram Moolenaar9964e462007-05-05 17:54:07 +0000911
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912Netrw then executes the lines above by use of a filter:
913>
914 :%! {g:netrw_ftp_cmd} -i [-n]
915<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916where
917 g:netrw_ftp_cmd is usually "ftp",
918 -i tells ftp not to be interactive
919 -n means don't use netrc and is used for Method #3 (ftp w/o <.netrc>)
920
921If <.netrc> exists it will be used to avoid having to query the user for
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000922userid and password. The transferred file is put into a temporary file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923The temporary file is then read into the main editing session window that
924requested it and the temporary file deleted.
925
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000926If your ftp doesn't accept the "user" command and immediately just demands a
927userid, then try putting "let netrw_ftp=1" in your <.vimrc>.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000929 *netrw-cadaver*
930To handle the SSL certificate dialog for untrusted servers, one may pull
931down the certificate and place it into /usr/ssl/cert.pem. This operation
932renders the server treatment as "trusted".
933
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000934 *netrw-fixup* *netreadfixup*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935If your ftp for whatever reason generates unwanted lines (such as AUTH
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100936messages) you may write a NetReadFixup() function:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937>
938 function! NetReadFixup(method,line1,line2)
939 " a:line1: first new line in current file
940 " a:line2: last new line in current file
941 if a:method == 1 "rcp
942 elseif a:method == 2 "ftp + <.netrc>
943 elseif a:method == 3 "ftp + machine,uid,password,filename
944 elseif a:method == 4 "scp
945 elseif a:method == 5 "http/wget
946 elseif a:method == 6 "dav/cadaver
947 elseif a:method == 7 "rsync
948 elseif a:method == 8 "fetch
949 elseif a:method == 9 "sftp
Bram Moolenaar9964e462007-05-05 17:54:07 +0000950 else " complain
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951 endif
952 endfunction
953>
Bram Moolenaar1afcace2005-11-25 19:54:28 +0000954The NetReadFixup() function will be called if it exists and thus allows you to
Nir Lichtman1e34b952024-05-08 19:19:34 +0200955customize your reading process.
956
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200957(Related topics: |ftp| |netrw-userpass| |netrw-start|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000958
959==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00009609. Browsing *netrw-browsing* *netrw-browse* *netrw-help* {{{1
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100961 *netrw-browser* *netrw-dir* *netrw-list*
Bram Moolenaar83bab712005-08-01 21:58:57 +0000962
Bram Moolenaar446cb832008-06-24 21:56:24 +0000963INTRODUCTION TO BROWSING *netrw-intro-browse* {{{2
964 (Quick References: |netrw-quickmaps| |netrw-quickcoms|)
Bram Moolenaar83bab712005-08-01 21:58:57 +0000965
Bram Moolenaar446cb832008-06-24 21:56:24 +0000966Netrw supports the browsing of directories on your local system and on remote
967hosts; browsing includes listing files and directories, entering directories,
968editing files therein, deleting files/directories, making new directories,
969moving (renaming) files and directories, copying files and directories, etc.
970One may mark files and execute any system command on them! The Netrw browser
971generally implements the previous explorer's maps and commands for remote
972directories, although details (such as pertinent global variable names)
973necessarily differ. To browse a directory, simply "edit" it! >
Bram Moolenaar269ec652004-07-29 08:43:53 +0000974
Bram Moolenaar446cb832008-06-24 21:56:24 +0000975 vim /your/directory/
976 vim .
977 vim c:\your\directory\
978<
979(Related topics: |netrw-cr| |netrw-o| |netrw-p| |netrw-P| |netrw-t|
980 |netrw-mf| |netrw-mx| |netrw-D| |netrw-R| |netrw-v| )
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000981
982The Netrw remote file and directory browser handles two protocols: ssh and
Bram Moolenaar446cb832008-06-24 21:56:24 +0000983ftp. The protocol in the url, if it is ftp, will cause netrw also to use ftp
984in its remote browsing. Specifying any other protocol will cause it to be
985used for file transfers; but the ssh protocol will be used to do remote
986browsing.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000987
Bram Moolenaar446cb832008-06-24 21:56:24 +0000988To use Netrw's remote directory browser, simply attempt to read a "file" with
989a trailing slash and it will be interpreted as a request to list a directory:
990>
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000991 vim [protocol]://[user@]hostname/path/
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +0000992<
Bram Moolenaar446cb832008-06-24 21:56:24 +0000993where [protocol] is typically scp or ftp. As an example, try: >
Bram Moolenaar4ea8fe12006-03-09 22:32:39 +0000994
Bram Moolenaar446cb832008-06-24 21:56:24 +0000995 vim ftp://ftp.home.vim.org/pub/vim/
996<
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100997For local directories, the trailing slash is not required. Again, because it's
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100998easy to miss: to browse remote directories, the URL must terminate with a
Bram Moolenaar446cb832008-06-24 21:56:24 +0000999slash!
Bram Moolenaar83bab712005-08-01 21:58:57 +00001000
Bram Moolenaar446cb832008-06-24 21:56:24 +00001001If you'd like to avoid entering the password repeatedly for remote directory
1002listings with ssh or scp, see |netrw-ssh-hack|. To avoid password entry with
1003ftp, see |netrw-netrc| (if your ftp supports it).
Bram Moolenaar83bab712005-08-01 21:58:57 +00001004
Bram Moolenaar446cb832008-06-24 21:56:24 +00001005There are several things you can do to affect the browser's display of files:
Bram Moolenaar83bab712005-08-01 21:58:57 +00001006
Bram Moolenaar446cb832008-06-24 21:56:24 +00001007 * To change the listing style, press the "i" key (|netrw-i|).
1008 Currently there are four styles: thin, long, wide, and tree.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001009 To make that change "permanent", see |g:netrw_liststyle|.
Bram Moolenaar83bab712005-08-01 21:58:57 +00001010
Bram Moolenaar446cb832008-06-24 21:56:24 +00001011 * To hide files (don't want to see those xyz~ files anymore?) see
1012 |netrw-ctrl-h|.
Bram Moolenaar83bab712005-08-01 21:58:57 +00001013
Bram Moolenaar446cb832008-06-24 21:56:24 +00001014 * Press s to sort files by name, time, or size.
1015
1016See |netrw-browse-cmds| for all the things you can do with netrw!
1017
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001018 *netrw-getftype* *netrw-filigree* *netrw-ftype*
1019The |getftype()| function is used to append a bit of filigree to indicate
1020filetype to locally listed files:
1021
1022 directory : /
1023 executable : *
1024 fifo : |
1025 links : @
1026 sockets : =
1027
1028The filigree also affects the |g:netrw_sort_sequence|.
1029
Bram Moolenaar446cb832008-06-24 21:56:24 +00001030
1031QUICK HELP *netrw-quickhelp* {{{2
1032 (Use ctrl-] to select a topic)~
1033 Intro to Browsing...............................|netrw-intro-browse|
1034 Quick Reference: Maps.........................|netrw-quickmap|
1035 Quick Reference: Commands.....................|netrw-browse-cmds|
1036 Hiding
1037 Edit hiding list..............................|netrw-ctrl-h|
1038 Hiding Files or Directories...................|netrw-a|
1039 Hiding/Unhiding by suffix.....................|netrw-mh|
1040 Hiding dot-files.............................|netrw-gh|
1041 Listing Style
1042 Select listing style (thin/long/wide/tree)....|netrw-i|
1043 Associated setting variable...................|g:netrw_liststyle|
1044 Shell command used to perform listing.........|g:netrw_list_cmd|
1045 Quick file info...............................|netrw-qf|
1046 Sorted by
1047 Select sorting style (name/time/size).........|netrw-s|
1048 Editing the sorting sequence..................|netrw-S|
Bram Moolenaarc236c162008-07-13 17:41:49 +00001049 Sorting options...............................|g:netrw_sort_options|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001050 Associated setting variable...................|g:netrw_sort_sequence|
1051 Reverse sorting order.........................|netrw-r|
1052
1053
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001054 *netrw-quickmap* *netrw-quickmaps*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001055QUICK REFERENCE: MAPS *netrw-browse-maps* {{{2
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00001056>
Bram Moolenaar446cb832008-06-24 21:56:24 +00001057 --- ----------------- ----
1058 Map Quick Explanation Link
1059 --- ----------------- ----
1060< <F1> Causes Netrw to issue help
1061 <cr> Netrw will enter the directory or read the file |netrw-cr|
1062 <del> Netrw will attempt to remove the file/directory |netrw-del|
Bram Moolenaara0f849e2015-10-30 14:37:44 +01001063 <c-h> Edit file hiding list |netrw-ctrl-h|
1064 <c-l> Causes Netrw to refresh the directory listing |netrw-ctrl-l|
1065 <c-r> Browse using a gvim server |netrw-ctrl-r|
1066 <c-tab> Shrink/expand a netrw/explore window |netrw-c-tab|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001067 - Makes Netrw go up one directory |netrw--|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001068 a Cycles between normal display, |netrw-a|
Bram Moolenaar938ae282023-02-20 20:44:55 +00001069 hiding (suppress display of files matching g:netrw_list_hide)
1070 and showing (display only files which match g:netrw_list_hide)
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001071 cd Make browsing directory the current directory |netrw-cd|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001072 C Setting the editing window |netrw-C|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001073 d Make a directory |netrw-d|
1074 D Attempt to remove the file(s)/directory(ies) |netrw-D|
1075 gb Go to previous bookmarked directory |netrw-gb|
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001076 gd Force treatment as directory |netrw-gd|
1077 gf Force treatment as file |netrw-gf|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001078 gh Quick hide/unhide of dot-files |netrw-gh|
Bram Moolenaara0f849e2015-10-30 14:37:44 +01001079 gn Make top of tree the directory below the cursor |netrw-gn|
Bram Moolenaar89a9c152021-08-29 21:55:35 +02001080 gp Change local-only file permissions |netrw-gp|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001081 i Cycle between thin, long, wide, and tree listings |netrw-i|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001082 I Toggle the displaying of the banner |netrw-I|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001083 mb Bookmark current directory |netrw-mb|
1084 mc Copy marked files to marked-file target directory |netrw-mc|
1085 md Apply diff to marked files (up to 3) |netrw-md|
1086 me Place marked files on arg list and edit them |netrw-me|
1087 mf Mark a file |netrw-mf|
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001088 mF Unmark files |netrw-mF|
1089 mg Apply vimgrep to marked files |netrw-mg|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001090 mh Toggle marked file suffices' presence on hiding list |netrw-mh|
1091 mm Move marked files to marked-file target directory |netrw-mm|
1092 mp Print marked files |netrw-mp|
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001093 mr Mark files using a shell-style |regexp| |netrw-mr|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001094 mt Current browsing directory becomes markfile target |netrw-mt|
1095 mT Apply ctags to marked files |netrw-mT|
1096 mu Unmark all marked files |netrw-mu|
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001097 mv Apply arbitrary vim command to marked files |netrw-mv|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001098 mx Apply arbitrary shell command to marked files |netrw-mx|
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001099 mX Apply arbitrary shell command to marked files en bloc|netrw-mX|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001100 mz Compress/decompress marked files |netrw-mz|
1101 o Enter the file/directory under the cursor in a new |netrw-o|
Bram Moolenaar938ae282023-02-20 20:44:55 +00001102 browser window. A horizontal split is used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001103 O Obtain a file specified by cursor |netrw-O|
1104 p Preview the file |netrw-p|
1105 P Browse in the previously used window |netrw-P|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001106 qb List bookmarked directories and history |netrw-qb|
1107 qf Display information on file |netrw-qf|
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001108 qF Mark files using a quickfix list |netrw-qF|
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001109 qL Mark files using a |location-list| |netrw-qL|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001110 r Reverse sorting order |netrw-r|
Bram Moolenaara0f849e2015-10-30 14:37:44 +01001111 R Rename the designated file(s)/directory(ies) |netrw-R|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001112 s Select sorting style: by name, time, or file size |netrw-s|
1113 S Specify suffix priority for name-sorting |netrw-S|
1114 t Enter the file/directory under the cursor in a new tab|netrw-t|
1115 u Change to recently-visited directory |netrw-u|
1116 U Change to subsequently-visited directory |netrw-U|
1117 v Enter the file/directory under the cursor in a new |netrw-v|
Bram Moolenaar938ae282023-02-20 20:44:55 +00001118 browser window. A vertical split is used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001119 x View file with an associated program |netrw-x|
Bram Moolenaar97d62492012-11-15 21:28:22 +01001120 X Execute filename under cursor via |system()| |netrw-X|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001121
Bram Moolenaarc236c162008-07-13 17:41:49 +00001122 % Open a new file in netrw's current directory |netrw-%|
1123
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001124 *netrw-mouse* *netrw-leftmouse* *netrw-middlemouse* *netrw-rightmouse*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001125 <leftmouse> (gvim only) selects word under mouse as if a <cr>
1126 had been pressed (ie. edit file, change directory)
1127 <middlemouse> (gvim only) same as P selecting word under mouse;
1128 see |netrw-P|
1129 <rightmouse> (gvim only) delete file/directory using word under
1130 mouse
1131 <2-leftmouse> (gvim only) when:
Bram Moolenaar13600302014-05-22 18:26:40 +02001132 * in a netrw-selected file, AND
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001133 * |g:netrw_retmap| == 1 AND
Bram Moolenaar13600302014-05-22 18:26:40 +02001134 * the user doesn't already have a <2-leftmouse>
Bram Moolenaarff034192013-04-24 18:51:19 +02001135 mapping defined before netrw is autoloaded,
Bram Moolenaar446cb832008-06-24 21:56:24 +00001136 then a double clicked leftmouse button will return
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001137 to the netrw browser window. See |g:netrw_retmap|.
Bram Moolenaar8d043172014-01-23 14:24:41 +01001138 <s-leftmouse> (gvim only) like mf, will mark files. Dragging
1139 the shifted leftmouse will mark multiple files.
1140 (see |netrw-mf|)
Bram Moolenaar446cb832008-06-24 21:56:24 +00001141
Bram Moolenaar00a927d2010-05-14 23:24:24 +02001142 (to disable mouse buttons while browsing: |g:netrw_mousemaps|)
1143
Bram Moolenaar446cb832008-06-24 21:56:24 +00001144 *netrw-quickcom* *netrw-quickcoms*
1145QUICK REFERENCE: COMMANDS *netrw-explore-cmds* *netrw-browse-cmds* {{{2
Bram Moolenaar8d043172014-01-23 14:24:41 +01001146 :NetrwClean[!]............................................|netrw-clean|
1147 :NetrwSettings............................................|netrw-settings|
1148 :Ntree....................................................|netrw-ntree|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001149 :Explore[!] [dir] Explore directory of current file......|netrw-explore|
1150 :Hexplore[!] [dir] Horizontal Split & Explore.............|netrw-explore|
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001151 :Lexplore[!] [dir] Left Explorer Toggle...................|netrw-explore|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001152 :Nexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
1153 :Pexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
1154 :Rexplore Return to Explorer.....................|netrw-explore|
1155 :Sexplore[!] [dir] Split & Explore directory .............|netrw-explore|
1156 :Texplore[!] [dir] Tab & Explore..........................|netrw-explore|
1157 :Vexplore[!] [dir] Vertical Split & Explore...............|netrw-explore|
1158
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001159
1160BANNER DISPLAY *netrw-I*
1161
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001162One may toggle the displaying of the banner by pressing "I".
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001163
1164Also See: |g:netrw_banner|
1165
1166
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001167BOOKMARKING A DIRECTORY *netrw-mb* *netrw-bookmark* *netrw-bookmarks* {{{2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001168
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001169One may easily "bookmark" the currently browsed directory by using >
Bram Moolenaar446cb832008-06-24 21:56:24 +00001170
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001171 mb
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00001172<
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001173 *.netrwbook*
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001174Bookmarks are retained in between sessions of vim in a file called .netrwbook
1175as a |List|, which is typically stored in the first directory on the user's
Bram Moolenaar8024f932020-01-14 19:29:13 +01001176'runtimepath'; entries are kept in sorted order.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001177
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001178If there are marked files and/or directories, mb will add them to the bookmark
1179list.
1180
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001181 *netrw-:NetrwMB*
Bram Moolenaarb7398fe2023-05-14 18:50:25 +01001182Additionally, one may use :NetrwMB to bookmark files or directories. >
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001183
1184 :NetrwMB[!] [files/directories]
1185
1186< No bang: enters files/directories into Netrw's bookmark system
1187
1188 No argument and in netrw buffer:
Bram Moolenaara0f849e2015-10-30 14:37:44 +01001189 if there are marked files : bookmark marked files
1190 otherwise : bookmark file/directory under cursor
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001191 No argument and not in netrw buffer: bookmarks current open file
Bram Moolenaara0f849e2015-10-30 14:37:44 +01001192 Has arguments : |glob()|s each arg and bookmarks them
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001193
1194 With bang: deletes files/directories from Netrw's bookmark system
1195
1196The :NetrwMB command is available outside of netrw buffers (once netrw has been
1197invoked in the session).
1198
1199The file ".netrwbook" holds bookmarks when netrw (and vim) is not active. By
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001200default, its stored on the first directory on the user's |'runtimepath'|.
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001201
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001202Related Topics:
1203 |netrw-gb| how to return (go) to a bookmark
1204 |netrw-mB| how to delete bookmarks
1205 |netrw-qb| how to list bookmarks
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001206 |g:netrw_home| controls where .netrwbook is kept
Bram Moolenaar4a85b412006-04-23 22:40:29 +00001207
1208
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001209BROWSING *netrw-enter* *netrw-cr* {{{2
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001210
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001211Browsing is simple: move the cursor onto a file or directory of interest.
Bram Moolenaar843ee412004-06-30 16:16:41 +00001212Hitting the <cr> (the return key) will select the file or directory.
1213Directories will themselves be listed, and files will be opened using the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001214protocol given in the original read request.
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001215
Bram Moolenaar446cb832008-06-24 21:56:24 +00001216 CAVEAT: There are four forms of listing (see |netrw-i|). Netrw assumes that
1217 two or more spaces delimit filenames and directory names for the long and
1218 wide listing formats. Thus, if your filename or directory name has two or
1219 more sequential spaces embedded in it, or any trailing spaces, then you'll
1220 need to use the "thin" format to select it.
Bram Moolenaar843ee412004-06-30 16:16:41 +00001221
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001222The |g:netrw_browse_split| option, which is zero by default, may be used to
Bram Moolenaar446cb832008-06-24 21:56:24 +00001223cause the opening of files to be done in a new window or tab instead of the
1224default. When the option is one or two, the splitting will be taken
1225horizontally or vertically, respectively. When the option is set to three, a
1226<cr> will cause the file to appear in a new tab.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001227
Bram Moolenaar83bab712005-08-01 21:58:57 +00001228
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001229When using the gui (gvim), one may select a file by pressing the <leftmouse>
1230button. In addition, if
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001231
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001232 * |g:netrw_retmap| == 1 AND (its default value is 0)
Bram Moolenaar446cb832008-06-24 21:56:24 +00001233 * in a netrw-selected file, AND
1234 * the user doesn't already have a <2-leftmouse> mapping defined before
1235 netrw is loaded
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001236
Bram Moolenaar446cb832008-06-24 21:56:24 +00001237then a doubly-clicked leftmouse button will return to the netrw browser
1238window.
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001239
Bram Moolenaar446cb832008-06-24 21:56:24 +00001240Netrw attempts to speed up browsing, especially for remote browsing where one
1241may have to enter passwords, by keeping and re-using previously obtained
1242directory listing buffers. The |g:netrw_fastbrowse| variable is used to
1243control this behavior; one may have slow browsing (no buffer re-use), medium
1244speed browsing (re-use directory buffer listings only for remote directories),
1245and fast browsing (re-use directory buffer listings as often as possible).
1246The price for such re-use is that when changes are made (such as new files
1247are introduced into a directory), the listing may become out-of-date. One may
1248always refresh directory listing buffers by pressing ctrl-L (see
1249|netrw-ctrl-l|).
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001250
1251 *netrw-s-cr*
1252Squeezing the Current Tree-Listing Directory~
1253
1254When the tree listing style is enabled (see |netrw-i|) and one is using
1255gvim, then the <s-cr> mapping may be used to squeeze (close) the
1256directory currently containing the cursor.
1257
1258Otherwise, one may remap a key combination of one's own choice to get
1259this effect: >
1260
1261 nmap <buffer> <silent> <nowait> YOURKEYCOMBO <Plug>NetrwTreeSqueeze
1262<
1263Put this line in $HOME/ftplugin/netrw/netrw.vim; it needs to be generated
1264for netrw buffers only.
Bram Moolenaara6878372014-03-22 21:02:50 +01001265
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001266Related topics:
1267 |netrw-ctrl-r| |netrw-o| |netrw-p|
1268 |netrw-P| |netrw-t| |netrw-v|
1269Associated setting variables:
1270 |g:netrw_browse_split| |g:netrw_fastbrowse|
1271 |g:netrw_ftp_list_cmd| |g:netrw_ftp_sizelist_cmd|
1272 |g:netrw_ftp_timelist_cmd| |g:netrw_ssh_browse_reject|
1273 |g:netrw_ssh_cmd| |g:netrw_use_noswf|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001274
1275
1276BROWSING WITH A HORIZONTALLY SPLIT WINDOW *netrw-o* *netrw-horiz* {{{2
1277
1278Normally one enters a file or directory using the <cr>. However, the "o" map
1279allows one to open a new window to hold the new directory listing or file. A
1280horizontal split is used. (for vertical splitting, see |netrw-v|)
1281
1282Normally, the o key splits the window horizontally with the new window and
Bram Moolenaar15146672011-10-20 22:22:38 +02001283cursor at the top.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001284
1285Associated setting variables: |g:netrw_alto| |g:netrw_winsize|
1286
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001287Related topics:
1288 |netrw-ctrl-r| |netrw-o| |netrw-p|
1289 |netrw-P| |netrw-t| |netrw-v|
Bram Moolenaar15146672011-10-20 22:22:38 +02001290Associated setting variables:
1291 |g:netrw_alto| control above/below splitting
1292 |g:netrw_winsize| control initial sizing
Bram Moolenaar446cb832008-06-24 21:56:24 +00001293
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001294BROWSING WITH A NEW TAB *netrw-t* {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +00001295
1296Normally one enters a file or directory using the <cr>. The "t" map
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001297allows one to open a new window holding the new directory listing or file in
Bram Moolenaarff034192013-04-24 18:51:19 +02001298a new tab.
1299
1300If you'd like to have the new listing in a background tab, use |gT|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001301
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001302Related topics:
1303 |netrw-ctrl-r| |netrw-o| |netrw-p|
1304 |netrw-P| |netrw-t| |netrw-v|
Bram Moolenaar15146672011-10-20 22:22:38 +02001305Associated setting variables:
1306 |g:netrw_winsize| control initial sizing
Bram Moolenaar446cb832008-06-24 21:56:24 +00001307
1308BROWSING WITH A VERTICALLY SPLIT WINDOW *netrw-v* {{{2
1309
1310Normally one enters a file or directory using the <cr>. However, the "v" map
1311allows one to open a new window to hold the new directory listing or file. A
1312vertical split is used. (for horizontal splitting, see |netrw-o|)
1313
1314Normally, the v key splits the window vertically with the new window and
Bram Moolenaar15146672011-10-20 22:22:38 +02001315cursor at the left.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001316
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001317There is only one tree listing buffer; using "v" on a displayed subdirectory
Bram Moolenaar446cb832008-06-24 21:56:24 +00001318will split the screen, but the same buffer will be shown twice.
1319
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001320Related topics:
1321 |netrw-ctrl-r| |netrw-o| |netrw-p|
1322 |netrw-P| |netrw-t| |netrw-v|
Bram Moolenaar15146672011-10-20 22:22:38 +02001323Associated setting variables:
1324 |g:netrw_altv| control right/left splitting
1325 |g:netrw_winsize| control initial sizing
1326
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001327
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001328BROWSING USING A GVIM SERVER *netrw-ctrl-r* {{{2
1329
1330One may keep a browsing gvim separate from the gvim being used to edit.
1331Use the <c-r> map on a file (not a directory) in the netrw browser, and it
1332will use a gvim server (see |g:netrw_servername|). Subsequent use of <cr>
1333(see |netrw-cr|) will re-use that server for editing files.
1334
1335Related topics:
1336 |netrw-ctrl-r| |netrw-o| |netrw-p|
1337 |netrw-P| |netrw-t| |netrw-v|
1338Associated setting variables:
1339 |g:netrw_servername| : sets name of server
1340 |g:netrw_browse_split| : controls how <cr> will open files
1341
1342
1343CHANGE LISTING STYLE (THIN LONG WIDE TREE) *netrw-i* {{{2
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001344
Bram Moolenaar9964e462007-05-05 17:54:07 +00001345The "i" map cycles between the thin, long, wide, and tree listing formats.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001346
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001347The thin listing format gives just the files' and directories' names.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001348
Bram Moolenaar8299df92004-07-10 09:47:34 +00001349The long listing is either based on the "ls" command via ssh for remote
Bram Moolenaar1afcace2005-11-25 19:54:28 +00001350directories or displays the filename, file size (in bytes), and the time and
1351date of last modification for local directories. With the long listing
1352format, netrw is not able to recognize filenames which have trailing spaces.
1353Use the thin listing format for such files.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001354
Bram Moolenaar9964e462007-05-05 17:54:07 +00001355The wide listing format uses two or more contiguous spaces to delineate
1356filenames; when using that format, netrw won't be able to recognize or use
1357filenames which have two or more contiguous spaces embedded in the name or any
1358trailing spaces. The thin listing format will, however, work with such files.
Bram Moolenaar13600302014-05-22 18:26:40 +02001359The wide listing format is the most compact.
Bram Moolenaar9964e462007-05-05 17:54:07 +00001360
1361The tree listing format has a top directory followed by files and directories
Bram Moolenaar13600302014-05-22 18:26:40 +02001362preceded by one or more "|"s, which indicate the directory depth. One may
1363open and close directories by pressing the <cr> key while atop the directory
1364name.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001365
1366One may make a preferred listing style your default; see |g:netrw_liststyle|.
1367As an example, by putting the following line in your .vimrc, >
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001368 let g:netrw_liststyle= 3
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001369the tree style will become your default listing style.
Bram Moolenaar8299df92004-07-10 09:47:34 +00001370
Bram Moolenaar5b435d62012-04-05 17:33:26 +02001371One typical way to use the netrw tree display is to: >
1372
1373 vim .
1374 (use i until a tree display shows)
1375 navigate to a file
1376 v (edit as desired in vertically split window)
1377 ctrl-w h (to return to the netrw listing)
1378 P (edit newly selected file in the previous window)
1379 ctrl-w h (to return to the netrw listing)
1380 P (edit newly selected file in the previous window)
1381 ...etc...
1382<
Bram Moolenaar446cb832008-06-24 21:56:24 +00001383Associated setting variables: |g:netrw_liststyle| |g:netrw_maxfilenamelen|
1384 |g:netrw_timefmt| |g:netrw_list_cmd|
Bram Moolenaar8299df92004-07-10 09:47:34 +00001385
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001386CHANGE FILE PERMISSION *netrw-gp* {{{2
1387
1388"gp" will ask you for a new permission for the file named under the cursor.
1389Currently, this only works for local files.
1390
1391Associated setting variables: |g:netrw_chgperm|
1392
Bram Moolenaar83bab712005-08-01 21:58:57 +00001393
Bram Moolenaar446cb832008-06-24 21:56:24 +00001394CHANGING TO A BOOKMARKED DIRECTORY *netrw-gb* {{{2
Bram Moolenaar843ee412004-06-30 16:16:41 +00001395
Bram Moolenaar446cb832008-06-24 21:56:24 +00001396To change directory back to a bookmarked directory, use
Bram Moolenaar843ee412004-06-30 16:16:41 +00001397
Bram Moolenaar446cb832008-06-24 21:56:24 +00001398 {cnt}gb
Bram Moolenaar843ee412004-06-30 16:16:41 +00001399
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001400Any count may be used to reference any of the bookmarks.
Bram Moolenaarff034192013-04-24 18:51:19 +02001401Note that |netrw-qb| shows both bookmarks and history; to go
1402to a location stored in the history see |netrw-u| and |netrw-U|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001403
1404Related Topics:
1405 |netrw-mB| how to delete bookmarks
1406 |netrw-mb| how to make a bookmark
1407 |netrw-qb| how to list bookmarks
Bram Moolenaar843ee412004-06-30 16:16:41 +00001408
Bram Moolenaar843ee412004-06-30 16:16:41 +00001409
Bram Moolenaar00a927d2010-05-14 23:24:24 +02001410CHANGING TO A PREDECESSOR DIRECTORY *netrw-u* *netrw-updir* {{{2
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001411
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001412Every time you change to a new directory (new for the current session), netrw
1413will save the directory in a recently-visited directory history list (unless
1414|g:netrw_dirhistmax| is zero; by default, it holds ten entries). With the "u"
1415map, one can change to an earlier directory (predecessor). To do the
1416opposite, see |netrw-U|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001417
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001418The "u" map also accepts counts to go back in the history several slots. For
1419your convenience, qb (see |netrw-qb|) lists the history number which may be
1420used in that count.
Bram Moolenaarff034192013-04-24 18:51:19 +02001421
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001422 *.netrwhist*
Bram Moolenaarff034192013-04-24 18:51:19 +02001423See |g:netrw_dirhistmax| for how to control the quantity of history stack
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001424slots. The file ".netrwhist" holds history when netrw (and vim) is not
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001425active. By default, its stored on the first directory on the user's
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001426|'runtimepath'|.
1427
1428Related Topics:
1429 |netrw-U| changing to a successor directory
1430 |g:netrw_home| controls where .netrwhist is kept
Bram Moolenaarff034192013-04-24 18:51:19 +02001431
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001432
Bram Moolenaar446cb832008-06-24 21:56:24 +00001433CHANGING TO A SUCCESSOR DIRECTORY *netrw-U* *netrw-downdir* {{{2
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001434
1435With the "U" map, one can change to a later directory (successor).
1436This map is the opposite of the "u" map. (see |netrw-u|) Use the
Bram Moolenaara0f849e2015-10-30 14:37:44 +01001437qb map to list both the bookmarks and history. (see |netrw-qb|)
Bram Moolenaar446cb832008-06-24 21:56:24 +00001438
Bram Moolenaarff034192013-04-24 18:51:19 +02001439The "U" map also accepts counts to go forward in the history several slots.
1440
1441See |g:netrw_dirhistmax| for how to control the quantity of history stack
1442slots.
1443
Bram Moolenaar446cb832008-06-24 21:56:24 +00001444
Bram Moolenaara0f849e2015-10-30 14:37:44 +01001445CHANGING TREE TOP *netrw-ntree* *:Ntree* *netrw-gn* {{{2
Bram Moolenaar8d043172014-01-23 14:24:41 +01001446
1447One may specify a new tree top for tree listings using >
1448
1449 :Ntree [dirname]
1450
1451Without a "dirname", the current line is used (and any leading depth
1452information is elided).
1453With a "dirname", the specified directory name is used.
1454
Bram Moolenaara0f849e2015-10-30 14:37:44 +01001455The "gn" map will take the word below the cursor and use that for
1456changing the top of the tree listing.
1457
Bram Moolenaar8d043172014-01-23 14:24:41 +01001458
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001459NETRW CLEAN *netrw-clean* *:NetrwClean* {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +00001460
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001461With :NetrwClean one may easily remove netrw from one's home directory;
Bram Moolenaar446cb832008-06-24 21:56:24 +00001462more precisely, from the first directory on your |'runtimepath'|.
1463
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001464With :NetrwClean!, netrw will attempt to remove netrw from all directories on
Bram Moolenaara0f849e2015-10-30 14:37:44 +01001465your |'runtimepath'|. Of course, you have to have write/delete permissions
1466correct to do this.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001467
1468With either form of the command, netrw will first ask for confirmation
1469that the removal is in fact what you want to do. If netrw doesn't have
1470permission to remove a file, it will issue an error message.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001471
Konfekt3d7e5672024-10-27 22:16:49 +01001472 *netrw-gx* *Open* *Launch*
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001473CUSTOMIZING BROWSING WITH A SPECIAL HANDLER *netrw-x* *netrw-handler* {{{2
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001474
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001475Certain files, such as html, gif, jpeg, (word/office) doc, etc, files, are
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001476best seen with a special handler (ie. a tool provided with your computer's
Konfekt3d7e5672024-10-27 22:16:49 +01001477operating system). Netrw allows one to invoke such special handlers by:
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001478
Konfekt3d7e5672024-10-27 22:16:49 +01001479 * hitting gx with the cursor atop the file path or alternatively x
1480 in a netrw buffer; the former can be disabled by defining the
1481 |g:netrw_nogx| variable
1482 * when in command line, typing :Open <path>
Bram Moolenaara0f849e2015-10-30 14:37:44 +01001483
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001484One may also use visual mode (see |visual-start|) to select the text that the
Konfekt3d7e5672024-10-27 22:16:49 +01001485special handler will use. Normally gx checks for a close-by URL or file name
1486to pick up the text under the cursor; one may change what |expand()| uses via the
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001487|g:netrw_gx| variable (options include "<cword>", "<cWORD>"). Note that
1488expand("<cfile>") depends on the |'isfname'| setting. Alternatively, one may
1489select the text to be used by gx by making a visual selection (see
1490|visual-block|) and then pressing gx.
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001491
Konfekt3d7e5672024-10-27 22:16:49 +01001492The selection function can be adapted for each filetype by adding a function
1493Netrw_get_URL_<filetype>, where <filetype> is given by &filetype.
1494The function should return the URL or file name to be used by gx, and will
1495fall back to the default behavior if it returns an empty string.
1496For example, special handlers for links Markdown and HTML are
1497>
1498" make gx work on concealed links regardless of exact cursor position
1499function Netrw_get_URL_markdown()
1500 " markdown URL such as [link text](http://ya.ru 'yandex search')
1501 try
1502 let save_view = winsaveview()
1503 if searchpair('\[.\{-}\](', '', ')\zs', 'cbW', '', line('.')) > 0
1504 return matchstr(getline('.')[col('.')-1:], '\[.\{-}\](\zs' .. g:netrw_regex_url .. '\ze\(\s\+.\{-}\)\?)')
1505 endif
1506 finally
1507 call winrestview(save_view)
1508 return ''
1509 endtry
1510endfunction
1511
1512function Netrw_get_URL_html()
1513 " HTML URL such as <a href='http://www.python.org'>Python is here</a>
1514 " <a href="http://www.python.org"/>
1515 try
1516 let save_view = winsaveview()
1517 if searchpair('<a\s\+href=', '', '\%(</a>\|/>\)\zs', 'cbW', '', line('.')) > 0
1518 return matchstr(getline('.')[col('.') - 1 : ],
1519 \ 'href=["'.."'"..']\?\zs\S\{-}\ze["'.."'"..']\?/\?>')
1520 endif
1521 finally
1522 call winrestview(save_view)
1523 return ''
1524 endtry
1525endfunction
1526<
1527
1528Other than a file path, the text under the cursor may be a URL. Netrw uses
1529by default the following regular expression to determine if the text under the
1530cursor is a URL:
1531>
1532 g:netrw_regex_url = '\%(\%(http\|ftp\|irc\)s\?\|file\)://\S\{-}'
1533<
1534
1535Netrw determines which special handler by the following method:
1536
1537 * if |g:netrw_browsex_viewer| exists, then it will be used to attempt to
1538 view files. Examples of useful settings (place into your <.vimrc>):
1539 If the viewer you wish to use does not support handling of a remote URL
1540 directory, set |g:netrw_browsex_support_remote| to 0.
1541 * otherwise:
1542
1543 * for Windows : explorer.exe is used
1544 * for Mac OS X : open is used.
1545 * for Linux : xdg-open is used.
1546
1547To open a file <filepath> by the appropriate handler, type
1548
1549 :Open <filepath>
1550
1551No escaping, neither for the shell, nor for Vim's command-line is needed.
1552
1553To launch a specific application <app> <args>, often <args> being <filepath>,
1554
1555 :Launch <app> <args>.
1556
1557Since <args> can be arbitrarily complex, in particular contain many file
1558paths, the escaping is left to the user.
1559
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001560Associated setting variables:
1561 |g:netrw_gx| control how gx picks up the text under the cursor
1562 |g:netrw_nogx| prevent gx map while editing
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02001563 |g:netrw_suppress_gx_mesg| controls gx's suppression of browser messages
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001564
Bram Moolenaar446cb832008-06-24 21:56:24 +00001565 *netrw-curdir*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001566DELETING BOOKMARKS *netrw-mB* {{{2
1567
1568To delete a bookmark, use >
1569
1570 {cnt}mB
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001571
1572If there are marked files, then mB will remove them from the
1573bookmark list.
1574
1575Alternatively, one may use :NetrwMB! (see |netrw-:NetrwMB|). >
1576
1577 :NetrwMB! [files/directories]
1578
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001579Related Topics:
1580 |netrw-gb| how to return (go) to a bookmark
1581 |netrw-mb| how to make a bookmark
1582 |netrw-qb| how to list bookmarks
1583
1584
Bram Moolenaar446cb832008-06-24 21:56:24 +00001585DELETING FILES OR DIRECTORIES *netrw-delete* *netrw-D* *netrw-del* {{{2
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001586
Bram Moolenaar446cb832008-06-24 21:56:24 +00001587If files have not been marked with |netrw-mf|: (local marked file list)
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001588
Bram Moolenaar446cb832008-06-24 21:56:24 +00001589 Deleting/removing files and directories involves moving the cursor to the
1590 file/directory to be deleted and pressing "D". Directories must be empty
1591 first before they can be successfully removed. If the directory is a
1592 softlink to a directory, then netrw will make two requests to remove the
1593 directory before succeeding. Netrw will ask for confirmation before doing
1594 the removal(s). You may select a range of lines with the "V" command
1595 (visual selection), and then pressing "D".
Bram Moolenaar9964e462007-05-05 17:54:07 +00001596
Bram Moolenaar446cb832008-06-24 21:56:24 +00001597If files have been marked with |netrw-mf|: (local marked file list)
1598
1599 Marked files (and empty directories) will be deleted; again, you'll be
1600 asked to confirm the deletion before it actually takes place.
1601
Bram Moolenaar13600302014-05-22 18:26:40 +02001602A further approach is to delete files which match a pattern.
1603
1604 * use :MF pattern (see |netrw-:MF|); then press "D".
1605
1606 * use mr (see |netrw-mr|) which will prompt you for pattern.
1607 This will cause the matching files to be marked. Then,
1608 press "D".
1609
K.Takata71d0ba02024-01-10 03:21:05 +09001610Please note that only empty directories may be deleted with the "D" mapping.
1611Regular files are deleted with |delete()|, too.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001612
Bram Moolenaar446cb832008-06-24 21:56:24 +00001613The |g:netrw_rm_cmd|, |g:netrw_rmf_cmd|, and |g:netrw_rmdir_cmd| variables are
Bram Moolenaar13600302014-05-22 18:26:40 +02001614used to control the attempts to remove remote files and directories. The
Bram Moolenaar446cb832008-06-24 21:56:24 +00001615g:netrw_rm_cmd is used with files, and its default value is:
1616
1617 g:netrw_rm_cmd: ssh HOSTNAME rm
1618
1619The g:netrw_rmdir_cmd variable is used to support the removal of directories.
1620Its default value is:
1621
Bram Moolenaar13600302014-05-22 18:26:40 +02001622 |g:netrw_rmdir_cmd|: ssh HOSTNAME rmdir
Bram Moolenaar446cb832008-06-24 21:56:24 +00001623
1624If removing a directory fails with g:netrw_rmdir_cmd, netrw then will attempt
1625to remove it again using the g:netrw_rmf_cmd variable. Its default value is:
1626
Bram Moolenaar13600302014-05-22 18:26:40 +02001627 |g:netrw_rmf_cmd|: ssh HOSTNAME rm -f
Bram Moolenaar446cb832008-06-24 21:56:24 +00001628
Bram Moolenaar15146672011-10-20 22:22:38 +02001629Related topics: |netrw-d|
K.Takata71d0ba02024-01-10 03:21:05 +09001630Associated setting variable: |g:netrw_rm_cmd| |g:netrw_ssh_cmd|
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001631
1632
Bram Moolenaar446cb832008-06-24 21:56:24 +00001633*netrw-explore* *netrw-hexplore* *netrw-nexplore* *netrw-pexplore*
Bram Moolenaar8d043172014-01-23 14:24:41 +01001634*netrw-rexplore* *netrw-sexplore* *netrw-texplore* *netrw-vexplore* *netrw-lexplore*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001635DIRECTORY EXPLORATION COMMANDS {{{2
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001636
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001637 :[N]Explore[!] [dir]... Explore directory of current file *:Explore*
1638 :[N]Hexplore[!] [dir]... Horizontal Split & Explore *:Hexplore*
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001639 :[N]Lexplore[!] [dir]... Left Explorer Toggle *:Lexplore*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001640 :[N]Sexplore[!] [dir]... Split&Explore current file's directory *:Sexplore*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001641 :[N]Vexplore[!] [dir]... Vertical Split & Explore *:Vexplore*
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001642 :Texplore [dir]... Tab & Explore *:Texplore*
1643 :Rexplore ... Return to/from Explorer *:Rexplore*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001644
1645 Used with :Explore **/pattern : (also see |netrw-starstar|)
1646 :Nexplore............. go to next matching file *:Nexplore*
1647 :Pexplore............. go to previous matching file *:Pexplore*
1648
Bram Moolenaara6878372014-03-22 21:02:50 +01001649 *netrw-:Explore*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001650:Explore will open the local-directory browser on the current file's
1651 directory (or on directory [dir] if specified). The window will be
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001652 split only if the file has been modified and |'hidden'| is not set,
1653 otherwise the browsing window will take over that window. Normally
1654 the splitting is taken horizontally.
Bram Moolenaara6878372014-03-22 21:02:50 +01001655 Also see: |netrw-:Rexplore|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001656:Explore! is like :Explore, but will use vertical splitting.
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001657
Bram Moolenaara6878372014-03-22 21:02:50 +01001658 *netrw-:Hexplore*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001659:Hexplore [dir] does an :Explore with |:belowright| horizontal splitting.
1660:Hexplore! [dir] does an :Explore with |:aboveleft| horizontal splitting.
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001661
1662 *netrw-:Lexplore*
1663:[N]Lexplore [dir] toggles a full height Explorer window on the left hand side
1664 of the current tab. It will open a netrw window on the current
1665 directory if [dir] is omitted; a :Lexplore [dir] will show the
1666 specified directory in the left-hand side browser display no matter
Bram Moolenaara0f849e2015-10-30 14:37:44 +01001667 from which window the command is issued.
1668
1669 By default, :Lexplore will change an uninitialized |g:netrw_chgwin|
1670 to 2; edits will thus preferentially be made in window#2.
1671
1672 The [N] specifies a |g:netrw_winsize| just for the new :Lexplore
K.Takata71d0ba02024-01-10 03:21:05 +09001673 window. That means that
1674 if [N] < 0 : use |N| columns for the Lexplore window
1675 if [N] = 0 : a normal split is made
1676 if [N] > 0 : use N% of the current window will be used for the
1677 new window
Bram Moolenaara0f849e2015-10-30 14:37:44 +01001678
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001679 Those who like this method often also like tree style displays;
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001680 see |g:netrw_liststyle|.
1681
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001682:[N]Lexplore! [dir] is similar to :Lexplore, except that the full-height
1683 Explorer window will open on the right hand side and an
1684 uninitialized |g:netrw_chgwin| will be set to 1 (eg. edits will
1685 preferentially occur in the leftmost window).
1686
Bram Moolenaara0f849e2015-10-30 14:37:44 +01001687 Also see: |netrw-C| |g:netrw_browse_split| |g:netrw_wiw|
1688 |netrw-p| |netrw-P| |g:netrw_chgwin|
1689 |netrw-c-tab| |g:netrw_winsize|
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001690
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001691 *netrw-:Sexplore*
1692:[N]Sexplore will always split the window before invoking the local-directory
1693 browser. As with Explore, the splitting is normally done
1694 horizontally.
1695:[N]Sexplore! [dir] is like :Sexplore, but the splitting will be done vertically.
1696
Bram Moolenaara6878372014-03-22 21:02:50 +01001697 *netrw-:Texplore*
Bram Moolenaar8d043172014-01-23 14:24:41 +01001698:Texplore [dir] does a |:tabnew| before generating the browser window
Bram Moolenaar446cb832008-06-24 21:56:24 +00001699
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001700 *netrw-:Vexplore*
1701:[N]Vexplore [dir] does an :Explore with |:leftabove| vertical splitting.
1702:[N]Vexplore! [dir] does an :Explore with |:rightbelow| vertical splitting.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001703
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001704The optional parameters are:
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001705
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001706 [N]: This parameter will override |g:netrw_winsize| to specify the quantity of
1707 rows and/or columns the new explorer window should have.
1708 Otherwise, the |g:netrw_winsize| variable, if it has been specified by the
1709 user, is used to control the quantity of rows and/or columns new
1710 explorer windows should have.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001711
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001712 [dir]: By default, these explorer commands use the current file's directory.
1713 However, one may explicitly provide a directory (path) to use instead;
1714 ie. >
1715
1716 :Explore /some/path
1717<
Bram Moolenaara6878372014-03-22 21:02:50 +01001718 *netrw-:Rexplore*
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001719:Rexplore This command is a little different from the other Explore commands
1720 as it doesn't necessarily open an Explorer window.
Bram Moolenaara6878372014-03-22 21:02:50 +01001721
1722 Return to Explorer~
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001723 When one edits a file using netrw which can occur, for example,
1724 when pressing <cr> while the cursor is atop a filename in a netrw
1725 browser window, a :Rexplore issued while editing that file will
1726 return the display to that of the last netrw browser display in
1727 that window.
Bram Moolenaara6878372014-03-22 21:02:50 +01001728
1729 Return from Explorer~
1730 Conversely, when one is editing a directory, issuing a :Rexplore
Bram Moolenaar13600302014-05-22 18:26:40 +02001731 will return to editing the file that was last edited in that
Bram Moolenaara6878372014-03-22 21:02:50 +01001732 window.
1733
1734 The <2-leftmouse> map (which is only available under gvim and
1735 cooperative terms) does the same as :Rexplore.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001736
Bram Moolenaar8d043172014-01-23 14:24:41 +01001737Also see: |g:netrw_alto| |g:netrw_altv| |g:netrw_winsize|
1738
Bram Moolenaar446cb832008-06-24 21:56:24 +00001739
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001740*netrw-star* *netrw-starpat* *netrw-starstar* *netrw-starstarpat* *netrw-grep*
1741EXPLORING WITH STARS AND PATTERNS {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +00001742
1743When Explore, Sexplore, Hexplore, or Vexplore are used with one of the
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001744following four patterns Explore generates a list of files which satisfy the
1745request for the local file system. These exploration patterns will not work
1746with remote file browsing.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001747
1748 */filepat files in current directory which satisfy filepat
1749 **/filepat files in current directory or below which satisfy the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001750 file pattern
Bram Moolenaar446cb832008-06-24 21:56:24 +00001751 *//pattern files in the current directory which contain the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001752 pattern (vimgrep is used)
Bram Moolenaar446cb832008-06-24 21:56:24 +00001753 **//pattern files in the current directory or below which contain
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001754 the pattern (vimgrep is used)
Bram Moolenaar572cb562005-08-05 21:35:02 +00001755<
Bram Moolenaar446cb832008-06-24 21:56:24 +00001756The cursor will be placed on the first file in the list. One may then
1757continue to go to subsequent files on that list via |:Nexplore| or to
1758preceding files on that list with |:Pexplore|. Explore will update the
1759directory and place the cursor appropriately.
1760
1761A plain >
1762 :Explore
1763will clear the explore list.
1764
1765If your console or gui produces recognizable shift-up or shift-down sequences,
1766then you'll likely find using shift-downarrow and shift-uparrow convenient.
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001767They're mapped by netrw as follows:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001768
1769 <s-down> == Nexplore, and
1770 <s-up> == Pexplore.
1771
1772As an example, consider
1773>
1774 :Explore */*.c
1775 :Nexplore
1776 :Nexplore
1777 :Pexplore
1778<
1779The status line will show, on the right hand side of the status line, a
1780message like "Match 3 of 20".
1781
Bram Moolenaara6878372014-03-22 21:02:50 +01001782Associated setting variables:
1783 |g:netrw_keepdir| |g:netrw_browse_split|
1784 |g:netrw_fastbrowse| |g:netrw_ftp_browse_reject|
1785 |g:netrw_ftp_list_cmd| |g:netrw_ftp_sizelist_cmd|
1786 |g:netrw_ftp_timelist_cmd| |g:netrw_list_cmd|
1787 |g:netrw_liststyle|
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001788
1789
Bram Moolenaar446cb832008-06-24 21:56:24 +00001790DISPLAYING INFORMATION ABOUT FILE *netrw-qf* {{{2
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001791
Bram Moolenaar446cb832008-06-24 21:56:24 +00001792With the cursor atop a filename, pressing "qf" will reveal the file's size
1793and last modification timestamp. Currently this capability is only available
1794for local files.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001795
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001796
Bram Moolenaar446cb832008-06-24 21:56:24 +00001797EDIT FILE OR DIRECTORY HIDING LIST *netrw-ctrl-h* *netrw-edithide* {{{2
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001798
Bram Moolenaar446cb832008-06-24 21:56:24 +00001799The "<ctrl-h>" map brings up a requestor allowing the user to change the
1800file/directory hiding list contained in |g:netrw_list_hide|. The hiding list
1801consists of one or more patterns delimited by commas. Files and/or
1802directories satisfying these patterns will either be hidden (ie. not shown) or
1803be the only ones displayed (see |netrw-a|).
1804
1805The "gh" mapping (see |netrw-gh|) quickly alternates between the usual
1806hiding list and the hiding of files or directories that begin with ".".
1807
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001808As an example, >
1809 let g:netrw_list_hide= '\(^\|\s\s\)\zs\.\S\+'
1810Effectively, this makes the effect of a |netrw-gh| command the initial setting.
1811What it means:
1812
1813 \(^\|\s\s\) : if the line begins with the following, -or-
1814 two consecutive spaces are encountered
1815 \zs : start the hiding match now
1816 \. : if it now begins with a dot
1817 \S\+ : and is followed by one or more non-whitespace
1818 characters
1819
Bram Moolenaar446cb832008-06-24 21:56:24 +00001820Associated setting variables: |g:netrw_hide| |g:netrw_list_hide|
1821Associated topics: |netrw-a| |netrw-gh| |netrw-mh|
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001822
Bram Moolenaar15146672011-10-20 22:22:38 +02001823 *netrw-sort-sequence*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001824EDITING THE SORTING SEQUENCE *netrw-S* *netrw-sortsequence* {{{2
1825
1826When "Sorted by" is name, one may specify priority via the sorting sequence
1827(g:netrw_sort_sequence). The sorting sequence typically prioritizes the
1828name-listing by suffix, although any pattern will do. Patterns are delimited
1829by commas. The default sorting sequence is (all one line):
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001830
1831For Unix: >
1832 '[\/]$,\<core\%(\.\d\+\)\=,\.[a-np-z]$,\.h$,\.c$,\.cpp$,*,\.o$,\.obj$,
1833 \.info$,\.swp$,\.bak$,\~$'
1834<
1835Otherwise: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00001836 '[\/]$,\.[a-np-z]$,\.h$,\.c$,\.cpp$,*,\.o$,\.obj$,\.info$,
1837 \.swp$,\.bak$,\~$'
1838<
1839The lone * is where all filenames not covered by one of the other patterns
1840will end up. One may change the sorting sequence by modifying the
1841g:netrw_sort_sequence variable (either manually or in your <.vimrc>) or by
1842using the "S" map.
1843
Bram Moolenaarc236c162008-07-13 17:41:49 +00001844Related topics: |netrw-s| |netrw-S|
1845Associated setting variables: |g:netrw_sort_sequence| |g:netrw_sort_options|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001846
1847
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001848EXECUTING FILE UNDER CURSOR VIA SYSTEM() *netrw-X* {{{2
Bram Moolenaar97d62492012-11-15 21:28:22 +01001849
1850Pressing X while the cursor is atop an executable file will yield a prompt
1851using the filename asking for any arguments. Upon pressing a [return], netrw
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001852will then call |system()| with that command and arguments. The result will be
1853displayed by |:echomsg|, and so |:messages| will repeat display of the result.
1854Ansi escape sequences will be stripped out.
1855
1856See |cmdline-window| for directions for more on how to edit the arguments.
Bram Moolenaar97d62492012-11-15 21:28:22 +01001857
1858
Bram Moolenaaradc21822011-04-01 18:03:16 +02001859FORCING TREATMENT AS A FILE OR DIRECTORY *netrw-gd* *netrw-gf* {{{2
1860
1861Remote symbolic links (ie. those listed via ssh or ftp) are problematic
1862in that it is difficult to tell whether they link to a file or to a
1863directory.
1864
1865To force treatment as a file: use >
Bram Moolenaar97d62492012-11-15 21:28:22 +01001866 gf
Bram Moolenaaradc21822011-04-01 18:03:16 +02001867<
1868To force treatment as a directory: use >
Bram Moolenaar97d62492012-11-15 21:28:22 +01001869 gd
Bram Moolenaaradc21822011-04-01 18:03:16 +02001870<
1871
Bram Moolenaar446cb832008-06-24 21:56:24 +00001872GOING UP *netrw--* {{{2
1873
1874To go up a directory, press "-" or press the <cr> when atop the ../ directory
1875entry in the listing.
1876
1877Netrw will use the command in |g:netrw_list_cmd| to perform the directory
1878listing operation after changing HOSTNAME to the host specified by the
Bram Moolenaara6878372014-03-22 21:02:50 +01001879user-prpvided url. By default netrw provides the command as: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00001880
1881 ssh HOSTNAME ls -FLa
Bram Moolenaara6878372014-03-22 21:02:50 +01001882<
Bram Moolenaar446cb832008-06-24 21:56:24 +00001883where the HOSTNAME becomes the [user@]hostname as requested by the attempt to
1884read. Naturally, the user may override this command with whatever is
1885preferred. The NetList function which implements remote browsing
1886expects that directories will be flagged by a trailing slash.
1887
1888
1889HIDING FILES OR DIRECTORIES *netrw-a* *netrw-hiding* {{{2
1890
1891Netrw's browsing facility allows one to use the hiding list in one of three
1892ways: ignore it, hide files which match, and show only those files which
1893match.
1894
1895If no files have been marked via |netrw-mf|:
1896
1897The "a" map allows the user to cycle through the three hiding modes.
1898
1899The |g:netrw_list_hide| variable holds a comma delimited list of patterns
1900based on regular expressions (ex. ^.*\.obj$,^\.) which specify the hiding list.
1901(also see |netrw-ctrl-h|) To set the hiding list, use the <c-h> map. As an
1902example, to hide files which begin with a ".", one may use the <c-h> map to
1903set the hiding list to '^\..*' (or one may put let g:netrw_list_hide= '^\..*'
1904in one's <.vimrc>). One may then use the "a" key to show all files, hide
1905matching files, or to show only the matching files.
1906
1907 Example: \.[ch]$
1908 This hiding list command will hide/show all *.c and *.h files.
1909
1910 Example: \.c$,\.h$
1911 This hiding list command will also hide/show all *.c and *.h
1912 files.
1913
1914Don't forget to use the "a" map to select the mode (normal/hiding/show) you
1915want!
1916
1917If files have been marked using |netrw-mf|, then this command will:
1918
1919 if showing all files or non-hidden files:
1920 modify the g:netrw_list_hide list by appending the marked files to it
1921 and showing only non-hidden files.
1922
1923 else if showing hidden files only:
1924 modify the g:netrw_list_hide list by removing the marked files from it
1925 and showing only non-hidden files.
1926 endif
1927
1928 *netrw-gh* *netrw-hide*
1929As a quick shortcut, one may press >
1930 gh
1931to toggle between hiding files which begin with a period (dot) and not hiding
1932them.
1933
Bram Moolenaar8d043172014-01-23 14:24:41 +01001934Associated setting variables: |g:netrw_list_hide| |g:netrw_hide|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001935Associated topics: |netrw-a| |netrw-ctrl-h| |netrw-mh|
1936
Bram Moolenaar8d043172014-01-23 14:24:41 +01001937 *netrw-gitignore*
1938Netrw provides a helper function 'netrw_gitignore#Hide()' that, when used with
1939|g:netrw_list_hide| automatically hides all git-ignored files.
1940
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001941'netrw_gitignore#Hide' searches for patterns in the following files: >
1942
Bram Moolenaar8d043172014-01-23 14:24:41 +01001943 './.gitignore'
1944 './.git/info/exclude'
1945 global gitignore file: `git config --global core.excludesfile`
1946 system gitignore file: `git config --system core.excludesfile`
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001947<
Bram Moolenaar8d043172014-01-23 14:24:41 +01001948Files that do not exist, are ignored.
1949Git-ignore patterns are taken from existing files, and converted to patterns for
1950hiding files. For example, if you had '*.log' in your '.gitignore' file, it
1951would be converted to '.*\.log'.
1952
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001953To use this function, simply assign its output to |g:netrw_list_hide| option. >
Bram Moolenaar8d043172014-01-23 14:24:41 +01001954
1955 Example: let g:netrw_list_hide= netrw_gitignore#Hide()
1956 Git-ignored files are hidden in Netrw.
1957
1958 Example: let g:netrw_list_hide= netrw_gitignore#Hide('my_gitignore_file')
1959 Function can take additional files with git-ignore patterns.
1960
Bram Moolenaarb7398fe2023-05-14 18:50:25 +01001961 Example: let g:netrw_list_hide= netrw_gitignore#Hide() .. '.*\.swp$'
Bram Moolenaar8d043172014-01-23 14:24:41 +01001962 Combining 'netrw_gitignore#Hide' with custom patterns.
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001963<
Bram Moolenaar8d043172014-01-23 14:24:41 +01001964
Bram Moolenaar446cb832008-06-24 21:56:24 +00001965IMPROVING BROWSING *netrw-listhack* *netrw-ssh-hack* {{{2
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001966
1967Especially with the remote directory browser, constantly entering the password
1968is tedious.
1969
Bram Moolenaar9964e462007-05-05 17:54:07 +00001970For Linux/Unix systems, the book "Linux Server Hacks - 100 industrial strength
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00001971tips & tools" by Rob Flickenger (O'Reilly, ISBN 0-596-00461-3) gives a tip
1972for setting up no-password ssh and scp and discusses associated security
Bram Moolenaar9964e462007-05-05 17:54:07 +00001973issues. It used to be available at http://hacks.oreilly.com/pub/h/66 ,
1974but apparently that address is now being redirected to some "hackzine".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001975I'll attempt a summary based on that article and on a communication from
1976Ben Schmidt:
Bram Moolenaar843ee412004-06-30 16:16:41 +00001977
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001978 1. Generate a public/private key pair on the local machine
1979 (ssh client): >
1980 ssh-keygen -t rsa
1981 (saving the file in ~/.ssh/id_rsa as prompted)
1982<
1983 2. Just hit the <CR> when asked for passphrase (twice) for no
1984 passphrase. If you do use a passphrase, you will also need to use
1985 ssh-agent so you only have to type the passphrase once per session.
1986 If you don't use a passphrase, simply logging onto your local
1987 computer or getting access to the keyfile in any way will suffice
1988 to access any ssh servers which have that key authorized for login.
1989
1990 3. This creates two files: >
1991 ~/.ssh/id_rsa
1992 ~/.ssh/id_rsa.pub
1993<
1994 4. On the target machine (ssh server): >
1995 cd
1996 mkdir -p .ssh
1997 chmod 0700 .ssh
1998<
1999 5. On your local machine (ssh client): (one line) >
2000 ssh {serverhostname}
2001 cat '>>' '~/.ssh/authorized_keys2' < ~/.ssh/id_rsa.pub
2002<
2003 or, for OpenSSH, (one line) >
2004 ssh {serverhostname}
2005 cat '>>' '~/.ssh/authorized_keys' < ~/.ssh/id_rsa.pub
2006<
2007You can test it out with >
2008 ssh {serverhostname}
2009and you should be log onto the server machine without further need to type
2010anything.
2011
2012If you decided to use a passphrase, do: >
2013 ssh-agent $SHELL
2014 ssh-add
2015 ssh {serverhostname}
2016You will be prompted for your key passphrase when you use ssh-add, but not
2017subsequently when you use ssh. For use with vim, you can use >
2018 ssh-agent vim
2019and, when next within vim, use >
2020 :!ssh-add
2021Alternatively, you can apply ssh-agent to the terminal you're planning on
2022running vim in: >
2023 ssh-agent xterm &
2024and do ssh-add whenever you need.
Bram Moolenaar843ee412004-06-30 16:16:41 +00002025
Bram Moolenaar9964e462007-05-05 17:54:07 +00002026For Windows, folks on the vim mailing list have mentioned that Pageant helps
2027with avoiding the constant need to enter the password.
Bram Moolenaar433f7c82006-03-21 21:29:36 +00002028
Bram Moolenaar446cb832008-06-24 21:56:24 +00002029Kingston Fung wrote about another way to avoid constantly needing to enter
2030passwords:
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002031
Bram Moolenaar446cb832008-06-24 21:56:24 +00002032 In order to avoid the need to type in the password for scp each time, you
2033 provide a hack in the docs to set up a non password ssh account. I found a
2034 better way to do that: I can use a regular ssh account which uses a
2035 password to access the material without the need to key-in the password
2036 each time. It's good for security and convenience. I tried ssh public key
Christian Brabandt1c5728e2024-05-11 11:12:40 +02002037 authorization + ssh-agent, implementing this, and it works!
Bram Moolenaar446cb832008-06-24 21:56:24 +00002038
2039
Bram Moolenaar8d043172014-01-23 14:24:41 +01002040 Ssh hints:
2041
2042 Thomer Gil has provided a hint on how to speed up netrw+ssh:
2043 http://thomer.com/howtos/netrw_ssh.html
2044
2045 Alex Young has several hints on speeding ssh up:
2046 http://usevim.com/2012/03/16/editing-remote-files/
2047
2048
Bram Moolenaar446cb832008-06-24 21:56:24 +00002049LISTING BOOKMARKS AND HISTORY *netrw-qb* *netrw-listbookmark* {{{2
2050
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002051Pressing "qb" (query bookmarks) will list both the bookmarked directories and
2052directory traversal history.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002053
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002054Related Topics:
2055 |netrw-gb| how to return (go) to a bookmark
2056 |netrw-mb| how to make a bookmark
2057 |netrw-mB| how to delete bookmarks
2058 |netrw-u| change to a predecessor directory via the history stack
2059 |netrw-U| change to a successor directory via the history stack
Bram Moolenaar446cb832008-06-24 21:56:24 +00002060
2061MAKING A NEW DIRECTORY *netrw-d* {{{2
2062
2063With the "d" map one may make a new directory either remotely (which depends
2064on the global variable g:netrw_mkdir_cmd) or locally (which depends on the
Bram Moolenaar5b435d62012-04-05 17:33:26 +02002065global variable g:netrw_localmkdir). Netrw will issue a request for the new
Bram Moolenaar446cb832008-06-24 21:56:24 +00002066directory's name. A bare <CR> at that point will abort the making of the
2067directory. Attempts to make a local directory that already exists (as either
2068a file or a directory) will be detected, reported on, and ignored.
2069
Bram Moolenaar15146672011-10-20 22:22:38 +02002070Related topics: |netrw-D|
Bram Moolenaar8d043172014-01-23 14:24:41 +01002071Associated setting variables: |g:netrw_localmkdir| |g:netrw_mkdir_cmd|
2072 |g:netrw_remote_mkdir| |netrw-%|
Bram Moolenaar446cb832008-06-24 21:56:24 +00002073
2074
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002075MAKING THE BROWSING DIRECTORY THE CURRENT DIRECTORY *netrw-cd* {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +00002076
2077By default, |g:netrw_keepdir| is 1. This setting means that the current
Bram Moolenaarff034192013-04-24 18:51:19 +02002078directory will not track the browsing directory. (done for backwards
2079compatibility with v6's file explorer).
Bram Moolenaar446cb832008-06-24 21:56:24 +00002080
Bram Moolenaarff034192013-04-24 18:51:19 +02002081Setting g:netrw_keepdir to 0 tells netrw to make vim's current directory
Bram Moolenaar446cb832008-06-24 21:56:24 +00002082track netrw's browsing directory.
2083
2084However, given the default setting for g:netrw_keepdir of 1 where netrw
2085maintains its own separate notion of the current directory, in order to make
Bram Moolenaar85850f32019-07-19 22:05:51 +02002086the two directories the same, use the "cd" map (type cd). That map will
Bram Moolenaar446cb832008-06-24 21:56:24 +00002087set Vim's notion of the current directory to netrw's current browsing
2088directory.
2089
Bram Moolenaar89a9c152021-08-29 21:55:35 +02002090|netrw-cd| : This map's name was changed from "c" to cd (see |netrw-cd|).
2091 This change was done to allow for |netrw-cb| and |netrw-cB| maps.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002092
Bram Moolenaar446cb832008-06-24 21:56:24 +00002093Associated setting variable: |g:netrw_keepdir|
2094
Bram Moolenaara6878372014-03-22 21:02:50 +01002095MARKING FILES *netrw-:MF* *netrw-mf* {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +00002096 (also see |netrw-mr|)
2097
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002098Netrw provides several ways to mark files:
Bram Moolenaara6878372014-03-22 21:02:50 +01002099
2100 * One may mark files with the cursor atop a filename and
Bram Moolenaar13600302014-05-22 18:26:40 +02002101 then pressing "mf".
Bram Moolenaara6878372014-03-22 21:02:50 +01002102
2103 * With gvim, in addition one may mark files with
Bram Moolenaar13600302014-05-22 18:26:40 +02002104 <s-leftmouse>. (see |netrw-mouse|)
Bram Moolenaara6878372014-03-22 21:02:50 +01002105
2106 * One may use the :MF command, which takes a list of
Bram Moolenaar13600302014-05-22 18:26:40 +02002107 files (for local directories, the list may include
2108 wildcards -- see |glob()|) >
Bram Moolenaara6878372014-03-22 21:02:50 +01002109
2110 :MF *.c
2111<
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002112 (Note that :MF uses |<f-args>| to break the line
2113 at spaces)
2114
2115 * Mark files using the |argument-list| (|netrw-mA|)
2116
2117 * Mark files based upon a |location-list| (|netrw-qL|)
Bram Moolenaar13600302014-05-22 18:26:40 +02002118
2119 * Mark files based upon the quickfix list (|netrw-qF|)
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002120 (|quickfix-error-lists|)
Bram Moolenaara6878372014-03-22 21:02:50 +01002121
2122The following netrw maps make use of marked files:
Bram Moolenaar446cb832008-06-24 21:56:24 +00002123
2124 |netrw-a| Hide marked files/directories
2125 |netrw-D| Delete marked files/directories
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002126 |netrw-ma| Move marked files' names to |arglist|
2127 |netrw-mA| Move |arglist| filenames to marked file list
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002128 |netrw-mb| Append marked files to bookmarks
2129 |netrw-mB| Delete marked files from bookmarks
Bram Moolenaar446cb832008-06-24 21:56:24 +00002130 |netrw-mc| Copy marked files to target
2131 |netrw-md| Apply vimdiff to marked files
2132 |netrw-me| Edit marked files
Bram Moolenaarff034192013-04-24 18:51:19 +02002133 |netrw-mF| Unmark marked files
Bram Moolenaar446cb832008-06-24 21:56:24 +00002134 |netrw-mg| Apply vimgrep to marked files
Bram Moolenaara6878372014-03-22 21:02:50 +01002135 |netrw-mm| Move marked files to target
Bram Moolenaar446cb832008-06-24 21:56:24 +00002136 |netrw-mp| Print marked files
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002137 |netrw-ms| Netrw will source marked files
Bram Moolenaar446cb832008-06-24 21:56:24 +00002138 |netrw-mt| Set target for |netrw-mm| and |netrw-mc|
2139 |netrw-mT| Generate tags using marked files
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002140 |netrw-mv| Apply vim command to marked files
Bram Moolenaar446cb832008-06-24 21:56:24 +00002141 |netrw-mx| Apply shell command to marked files
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002142 |netrw-mX| Apply shell command to marked files, en bloc
Bram Moolenaar446cb832008-06-24 21:56:24 +00002143 |netrw-mz| Compress/Decompress marked files
2144 |netrw-O| Obtain marked files
2145 |netrw-R| Rename marked files
2146
2147One may unmark files one at a time the same way one marks them; ie. place
2148the cursor atop a marked file and press "mf". This process also works
2149with <s-leftmouse> using gvim. One may unmark all files by pressing
2150"mu" (see |netrw-mu|).
2151
Bram Moolenaaradc21822011-04-01 18:03:16 +02002152Marked files are highlighted using the "netrwMarkFile" highlighting group,
2153which by default is linked to "Identifier" (see Identifier under
2154|group-name|). You may change the highlighting group by putting something
2155like >
2156
2157 highlight clear netrwMarkFile
2158 hi link netrwMarkFile ..whatever..
2159<
2160into $HOME/.vim/after/syntax/netrw.vim .
2161
Bram Moolenaar8d043172014-01-23 14:24:41 +01002162If the mouse is enabled and works with your vim, you may use <s-leftmouse> to
2163mark one or more files. You may mark multiple files by dragging the shifted
2164leftmouse. (see |netrw-mouse|)
2165
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002166 *markfilelist* *global_markfilelist* *local_markfilelist*
Bram Moolenaar446cb832008-06-24 21:56:24 +00002167All marked files are entered onto the global marked file list; there is only
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002168one such list. In addition, every netrw buffer also has its own buffer-local
2169marked file list; since netrw buffers are associated with specific
2170directories, this means that each directory has its own local marked file
2171list. The various commands which operate on marked files use one or the other
2172of the marked file lists.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002173
Bram Moolenaara6878372014-03-22 21:02:50 +01002174Known Problem: if one is using tree mode (|g:netrw_liststyle|) and several
2175directories have files with the same name, then marking such a file will
2176result in all such files being highlighted as if they were all marked. The
2177|markfilelist|, however, will only have the selected file in it. This problem
2178is unlikely to be fixed.
2179
Bram Moolenaar446cb832008-06-24 21:56:24 +00002180
Bram Moolenaarff034192013-04-24 18:51:19 +02002181UNMARKING FILES *netrw-mF* {{{2
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002182 (also see |netrw-mf|, |netrw-mu|)
Bram Moolenaarff034192013-04-24 18:51:19 +02002183
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002184The "mF" command will unmark all files in the current buffer. One may also use
2185mf (|netrw-mf|) on a specific, already marked, file to unmark just that file.
Bram Moolenaarff034192013-04-24 18:51:19 +02002186
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002187MARKING FILES BY LOCATION LIST *netrw-qL* {{{2
2188 (also see |netrw-mf|)
Bram Moolenaarff034192013-04-24 18:51:19 +02002189
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002190One may convert |location-list|s into a marked file list using "qL".
2191You may then proceed with commands such as me (|netrw-me|) to edit them.
2192
2193
2194MARKING FILES BY QUICKFIX LIST *netrw-qF* {{{2
Bram Moolenaarff034192013-04-24 18:51:19 +02002195 (also see |netrw-mf|)
2196
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002197One may convert |quickfix-error-lists| into a marked file list using "qF".
2198You may then proceed with commands such as me (|netrw-me|) to edit them.
2199Quickfix error lists are generated, for example, by calls to |:vimgrep|.
Bram Moolenaarff034192013-04-24 18:51:19 +02002200
2201
Bram Moolenaar446cb832008-06-24 21:56:24 +00002202MARKING FILES BY REGULAR EXPRESSION *netrw-mr* {{{2
2203 (also see |netrw-mf|)
2204
2205One may also mark files by pressing "mr"; netrw will then issue a prompt,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002206"Enter regexp: ". You may then enter a shell-style regular expression such
2207as *.c$ (see |glob()|). For remote systems, glob() doesn't work -- so netrw
2208converts "*" into ".*" (see |regexp|) and marks files based on that. In the
2209future I may make it possible to use |regexp|s instead of glob()-style
2210expressions (yet-another-option).
Bram Moolenaar446cb832008-06-24 21:56:24 +00002211
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002212See |cmdline-window| for directions on more on how to edit the regular
2213expression.
2214
Bram Moolenaar446cb832008-06-24 21:56:24 +00002215
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002216MARKED FILES, ARBITRARY VIM COMMAND *netrw-mv* {{{2
2217 (See |netrw-mf| and |netrw-mr| for how to mark files)
2218 (uses the local marked-file list)
2219
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002220The "mv" map causes netrw to execute an arbitrary vim command on each file on
2221the local marked file list, individually:
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002222
2223 * 1split
2224 * sil! keepalt e file
2225 * run vim command
2226 * sil! keepalt wq!
2227
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002228A prompt, "Enter vim command: ", will be issued to elicit the vim command you
2229wish used. See |cmdline-window| for directions for more on how to edit the
2230command.
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002231
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002232
2233MARKED FILES, ARBITRARY SHELL COMMAND *netrw-mx* {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +00002234 (See |netrw-mf| and |netrw-mr| for how to mark files)
2235 (uses the local marked-file list)
2236
2237Upon activation of the "mx" map, netrw will query the user for some (external)
2238command to be applied to all marked files. All "%"s in the command will be
2239substituted with the name of each marked file in turn. If no "%"s are in the
2240command, then the command will be followed by a space and a marked filename.
2241
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002242Example:
2243 (mark files)
2244 mx
2245 Enter command: cat
2246
2247 The result is a series of shell commands:
2248 cat 'file1'
2249 cat 'file2'
2250 ...
2251
2252
Bram Moolenaar938ae282023-02-20 20:44:55 +00002253MARKED FILES, ARBITRARY SHELL COMMAND, EN BLOC *netrw-mX* {{{2
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002254 (See |netrw-mf| and |netrw-mr| for how to mark files)
2255 (uses the global marked-file list)
2256
2257Upon activation of the 'mX' map, netrw will query the user for some (external)
2258command to be applied to all marked files on the global marked file list. The
2259"en bloc" means that one command will be executed on all the files at once: >
2260
2261 command files
2262
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002263This approach is useful, for example, to select files and make a tarball: >
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002264
2265 (mark files)
2266 mX
2267 Enter command: tar cf mynewtarball.tar
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002268<
2269The command that will be run with this example:
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002270
2271 tar cf mynewtarball.tar 'file1' 'file2' ...
2272
Bram Moolenaar446cb832008-06-24 21:56:24 +00002273
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002274MARKED FILES: ARGUMENT LIST *netrw-ma* *netrw-mA*
2275 (See |netrw-mf| and |netrw-mr| for how to mark files)
2276 (uses the global marked-file list)
2277
2278Using ma, one moves filenames from the marked file list to the argument list.
2279Using mA, one moves filenames from the argument list to the marked file list.
2280
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002281See Also: |netrw-cb| |netrw-cB| |netrw-qF| |argument-list| |:args|
2282
2283
2284MARKED FILES: BUFFER LIST *netrw-cb* *netrw-cB*
2285 (See |netrw-mf| and |netrw-mr| for how to mark files)
2286 (uses the global marked-file list)
2287
2288Using cb, one moves filenames from the marked file list to the buffer list.
2289Using cB, one copies filenames from the buffer list to the marked file list.
2290
2291See Also: |netrw-ma| |netrw-mA| |netrw-qF| |buffer-list| |:buffers|
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002292
2293
Bram Moolenaar446cb832008-06-24 21:56:24 +00002294MARKED FILES: COMPRESSION AND DECOMPRESSION *netrw-mz* {{{2
2295 (See |netrw-mf| and |netrw-mr| for how to mark files)
2296 (uses the local marked file list)
2297
2298If any marked files are compressed, then "mz" will decompress them.
2299If any marked files are decompressed, then "mz" will compress them
2300using the command specified by |g:netrw_compress|; by default,
2301that's "gzip".
2302
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002303For decompression, netrw uses a |Dictionary| of suffices and their
Bram Moolenaar446cb832008-06-24 21:56:24 +00002304associated decompressing utilities; see |g:netrw_decompress|.
2305
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002306Remember that one can mark multiple files by regular expression
2307(see |netrw-mr|); this is particularly useful to facilitate compressing and
2308decompressing a large number of files.
2309
Bram Moolenaar446cb832008-06-24 21:56:24 +00002310Associated setting variables: |g:netrw_compress| |g:netrw_decompress|
2311
2312MARKED FILES: COPYING *netrw-mc* {{{2
2313 (See |netrw-mf| and |netrw-mr| for how to mark files)
2314 (Uses the global marked file list)
2315
2316Select a target directory with mt (|netrw-mt|). Then change directory,
Bram Moolenaaradc21822011-04-01 18:03:16 +02002317select file(s) (see |netrw-mf|), and press "mc". The copy is done
2318from the current window (where one does the mf) to the target.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002319
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002320If one does not have a target directory set with |netrw-mt|, then netrw
2321will query you for a directory to copy to.
2322
2323One may also copy directories and their contents (local only) to a target
2324directory.
2325
2326Associated setting variables:
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002327 |g:netrw_localcopycmd| |g:netrw_localcopycmdopt|
2328 |g:netrw_localcopydircmd| |g:netrw_localcopydircmdopt|
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002329 |g:netrw_ssh_cmd|
Bram Moolenaar446cb832008-06-24 21:56:24 +00002330
2331MARKED FILES: DIFF *netrw-md* {{{2
2332 (See |netrw-mf| and |netrw-mr| for how to mark files)
2333 (uses the global marked file list)
2334
2335Use |vimdiff| to visualize difference between selected files (two or
2336three may be selected for this). Uses the global marked file list.
2337
2338MARKED FILES: EDITING *netrw-me* {{{2
2339 (See |netrw-mf| and |netrw-mr| for how to mark files)
2340 (uses the global marked file list)
2341
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002342The "me" command will place the marked files on the |arglist| and commence
Bram Moolenaar446cb832008-06-24 21:56:24 +00002343editing them. One may return the to explorer window with |:Rexplore|.
Bram Moolenaarff034192013-04-24 18:51:19 +02002344(use |:n| and |:p| to edit next and previous files in the arglist)
Bram Moolenaar446cb832008-06-24 21:56:24 +00002345
2346MARKED FILES: GREP *netrw-mg* {{{2
2347 (See |netrw-mf| and |netrw-mr| for how to mark files)
2348 (uses the global marked file list)
2349
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002350The "mg" command will apply |:vimgrep| to the marked files.
Bram Moolenaarff034192013-04-24 18:51:19 +02002351The command will ask for the requested pattern; one may then enter: >
2352
Bram Moolenaar446cb832008-06-24 21:56:24 +00002353 /pattern/[g][j]
2354 ! /pattern/[g][j]
2355 pattern
2356<
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002357With /pattern/, editing will start with the first item on the |quickfix| list
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002358that vimgrep sets up (see |:copen|, |:cnext|, |:cprevious|, |:cclose|). The |:vimgrep|
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002359command is in use, so without 'g' each line is added to quickfix list only
2360once; with 'g' every match is included.
2361
2362With /pattern/j, "mg" will winnow the current marked file list to just those
2363marked files also possessing the specified pattern. Thus, one may use >
2364
2365 mr ...file-pattern...
2366 mg /pattern/j
2367<
2368to have a marked file list satisfying the file-pattern but also restricted to
2369files containing some desired pattern.
2370
Bram Moolenaarff034192013-04-24 18:51:19 +02002371
Bram Moolenaar446cb832008-06-24 21:56:24 +00002372MARKED FILES: HIDING AND UNHIDING BY SUFFIX *netrw-mh* {{{2
2373 (See |netrw-mf| and |netrw-mr| for how to mark files)
2374 (uses the local marked file list)
2375
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002376The "mh" command extracts the suffices of the marked files and toggles their
Bram Moolenaar446cb832008-06-24 21:56:24 +00002377presence on the hiding list. Please note that marking the same suffix
2378this way multiple times will result in the suffix's presence being toggled
2379for each file (so an even quantity of marked files having the same suffix
2380is the same as not having bothered to select them at all).
2381
2382Related topics: |netrw-a| |g:netrw_list_hide|
2383
2384MARKED FILES: MOVING *netrw-mm* {{{2
2385 (See |netrw-mf| and |netrw-mr| for how to mark files)
2386 (uses the global marked file list)
2387
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002388 WARNING: moving files is more dangerous than copying them.
2389 A file being moved is first copied and then deleted; if the
2390 copy operation fails and the delete succeeds, you will lose
2391 the file. Either try things out with unimportant files
2392 first or do the copy and then delete yourself using mc and D.
2393 Use at your own risk!
2394
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002395Select a target directory with mt (|netrw-mt|). Then change directory,
Bram Moolenaaradc21822011-04-01 18:03:16 +02002396select file(s) (see |netrw-mf|), and press "mm". The move is done
2397from the current window (where one does the mf) to the target.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002398
2399Associated setting variable: |g:netrw_localmovecmd| |g:netrw_ssh_cmd|
2400
2401MARKED FILES: PRINTING *netrw-mp* {{{2
2402 (See |netrw-mf| and |netrw-mr| for how to mark files)
2403 (uses the local marked file list)
2404
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002405When "mp" is used, netrw will apply the |:hardcopy| command to marked files.
2406What netrw does is open each file in a one-line window, execute hardcopy, then
2407close the one-line window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002408
2409
2410MARKED FILES: SOURCING *netrw-ms* {{{2
2411 (See |netrw-mf| and |netrw-mr| for how to mark files)
2412 (uses the local marked file list)
2413
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002414With "ms", netrw will source the marked files (using vim's |:source| command)
Bram Moolenaar446cb832008-06-24 21:56:24 +00002415
2416
Bram Moolenaarff034192013-04-24 18:51:19 +02002417MARKED FILES: SETTING THE TARGET DIRECTORY *netrw-mt* {{{2
2418 (See |netrw-mf| and |netrw-mr| for how to mark files)
2419
2420Set the marked file copy/move-to target (see |netrw-mc| and |netrw-mm|):
2421
2422 * If the cursor is atop a file name, then the netrw window's currently
2423 displayed directory is used for the copy/move-to target.
2424
2425 * Also, if the cursor is in the banner, then the netrw window's currently
2426 displayed directory is used for the copy/move-to target.
2427 Unless the target already is the current directory. In which case,
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002428 typing "mf" clears the target.
Bram Moolenaarff034192013-04-24 18:51:19 +02002429
2430 * However, if the cursor is atop a directory name, then that directory is
2431 used for the copy/move-to target
2432
Bram Moolenaara6878372014-03-22 21:02:50 +01002433 * One may use the :MT [directory] command to set the target *netrw-:MT*
2434 This command uses |<q-args>|, so spaces in the directory name are
2435 permitted without escaping.
2436
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002437 * With mouse-enabled vim or with gvim, one may select a target by using
2438 <c-leftmouse>
2439
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002440There is only one copy/move-to target at a time in a vim session; ie. the
2441target is a script variable (see |s:var|) and is shared between all netrw
2442windows (in an instance of vim).
Bram Moolenaarff034192013-04-24 18:51:19 +02002443
2444When using menus and gvim, netrw provides a "Targets" entry which allows one
2445to pick a target from the list of bookmarks and history.
2446
2447Related topics:
2448 Marking Files......................................|netrw-mf|
2449 Marking Files by Regular Expression................|netrw-mr|
2450 Marked Files: Target Directory Using Bookmarks.....|netrw-Tb|
2451 Marked Files: Target Directory Using History.......|netrw-Th|
2452
2453
Bram Moolenaar446cb832008-06-24 21:56:24 +00002454MARKED FILES: TAGGING *netrw-mT* {{{2
2455 (See |netrw-mf| and |netrw-mr| for how to mark files)
2456 (uses the global marked file list)
2457
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002458The "mT" mapping will apply the command in |g:netrw_ctags| (by default, it is
Bram Moolenaar446cb832008-06-24 21:56:24 +00002459"ctags") to marked files. For remote browsing, in order to create a tags file
2460netrw will use ssh (see |g:netrw_ssh_cmd|), and so ssh must be available for
2461this to work on remote systems. For your local system, see |ctags| on how to
2462get a version. I myself use hdrtags, currently available at
Bram Moolenaar97d62492012-11-15 21:28:22 +01002463http://www.drchip.org/astronaut/src/index.html , and have >
Bram Moolenaar446cb832008-06-24 21:56:24 +00002464
2465 let g:netrw_ctags= "hdrtag"
2466<
2467in my <.vimrc>.
2468
2469When a remote set of files are tagged, the resulting tags file is "obtained";
Bram Moolenaara6878372014-03-22 21:02:50 +01002470ie. a copy is transferred to the local system's directory. The now local tags
Bram Moolenaar446cb832008-06-24 21:56:24 +00002471file is then modified so that one may use it through the network. The
Bram Moolenaara6878372014-03-22 21:02:50 +01002472modification made concerns the names of the files in the tags; each filename is
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002473preceded by the netrw-compatible URL used to obtain it. When one subsequently
2474uses one of the go to tag actions (|tags|), the URL will be used by netrw to
Bram Moolenaar446cb832008-06-24 21:56:24 +00002475edit the desired file and go to the tag.
2476
Bram Moolenaarc236c162008-07-13 17:41:49 +00002477Associated setting variables: |g:netrw_ctags| |g:netrw_ssh_cmd|
Bram Moolenaar446cb832008-06-24 21:56:24 +00002478
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002479MARKED FILES: TARGET DIRECTORY USING BOOKMARKS *netrw-Tb* {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +00002480
Bram Moolenaara6878372014-03-22 21:02:50 +01002481Sets the marked file copy/move-to target.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002482
Bram Moolenaarff034192013-04-24 18:51:19 +02002483The |netrw-qb| map will give you a list of bookmarks (and history).
2484One may choose one of the bookmarks to become your marked file
2485target by using [count]Tb (default count: 1).
Bram Moolenaar446cb832008-06-24 21:56:24 +00002486
Bram Moolenaarff034192013-04-24 18:51:19 +02002487Related topics:
Bram Moolenaara6878372014-03-22 21:02:50 +01002488 Copying files to target............................|netrw-mc|
Bram Moolenaarff034192013-04-24 18:51:19 +02002489 Listing Bookmarks and History......................|netrw-qb|
2490 Marked Files: Setting The Target Directory.........|netrw-mt|
2491 Marked Files: Target Directory Using History.......|netrw-Th|
2492 Marking Files......................................|netrw-mf|
2493 Marking Files by Regular Expression................|netrw-mr|
Bram Moolenaara6878372014-03-22 21:02:50 +01002494 Moving files to target.............................|netrw-mm|
Bram Moolenaar446cb832008-06-24 21:56:24 +00002495
Bram Moolenaar446cb832008-06-24 21:56:24 +00002496
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002497MARKED FILES: TARGET DIRECTORY USING HISTORY *netrw-Th* {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +00002498
Bram Moolenaara6878372014-03-22 21:02:50 +01002499Sets the marked file copy/move-to target.
Bram Moolenaarff034192013-04-24 18:51:19 +02002500
2501The |netrw-qb| map will give you a list of history (and bookmarks).
2502One may choose one of the history entries to become your marked file
2503target by using [count]Th (default count: 0; ie. the current directory).
2504
2505Related topics:
Bram Moolenaara6878372014-03-22 21:02:50 +01002506 Copying files to target............................|netrw-mc|
Bram Moolenaarff034192013-04-24 18:51:19 +02002507 Listing Bookmarks and History......................|netrw-qb|
2508 Marked Files: Setting The Target Directory.........|netrw-mt|
2509 Marked Files: Target Directory Using Bookmarks.....|netrw-Tb|
2510 Marking Files......................................|netrw-mf|
2511 Marking Files by Regular Expression................|netrw-mr|
Bram Moolenaara6878372014-03-22 21:02:50 +01002512 Moving files to target.............................|netrw-mm|
Bram Moolenaarff034192013-04-24 18:51:19 +02002513
Bram Moolenaar446cb832008-06-24 21:56:24 +00002514
2515MARKED FILES: UNMARKING *netrw-mu* {{{2
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002516 (See |netrw-mf|, |netrw-mF|)
Bram Moolenaar446cb832008-06-24 21:56:24 +00002517
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002518The "mu" mapping will unmark all currently marked files. This command differs
2519from "mF" as the latter only unmarks files in the current directory whereas
2520"mu" will unmark global and all buffer-local marked files.
2521(see |netrw-mF|)
2522
Bram Moolenaar446cb832008-06-24 21:56:24 +00002523
Bram Moolenaar15146672011-10-20 22:22:38 +02002524 *netrw-browser-settings*
Bram Moolenaar446cb832008-06-24 21:56:24 +00002525NETRW BROWSER VARIABLES *netrw-browser-options* *netrw-browser-var* {{{2
2526
Bram Moolenaar15146672011-10-20 22:22:38 +02002527(if you're interested in the netrw file transfer settings, see |netrw-options|
2528 and |netrw-protocol|)
Bram Moolenaar446cb832008-06-24 21:56:24 +00002529
2530The <netrw.vim> browser provides settings in the form of variables which
2531you may modify; by placing these settings in your <.vimrc>, you may customize
2532your browsing preferences. (see also: |netrw-settings|)
2533>
2534 --- -----------
2535 Var Explanation
2536 --- -----------
Bram Moolenaar8d043172014-01-23 14:24:41 +01002537< *g:netrw_altfile* some like |CTRL-^| to return to the last
2538 edited file. Choose that by setting this
2539 parameter to 1.
2540 Others like |CTRL-^| to return to the
2541 netrw browsing buffer. Choose that by setting
2542 this parameter to 0.
2543 default: =0
2544
2545 *g:netrw_alto* change from above splitting to below splitting
Bram Moolenaar446cb832008-06-24 21:56:24 +00002546 by setting this variable (see |netrw-o|)
2547 default: =&sb (see |'sb'|)
2548
Bram Moolenaarff034192013-04-24 18:51:19 +02002549 *g:netrw_altv* change from left splitting to right splitting
Bram Moolenaar446cb832008-06-24 21:56:24 +00002550 by setting this variable (see |netrw-v|)
2551 default: =&spr (see |'spr'|)
2552
Bram Moolenaarff034192013-04-24 18:51:19 +02002553 *g:netrw_banner* enable/suppress the banner
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002554 =0: suppress the banner
2555 =1: banner is enabled (default)
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002556
Bram Moolenaare6ae6222013-05-21 21:01:10 +02002557 *g:netrw_bannerbackslash* if this variable exists and is not zero, the
2558 banner will be displayed with backslashes
2559 rather than forward slashes.
2560
Bram Moolenaarff034192013-04-24 18:51:19 +02002561 *g:netrw_browse_split* when browsing, <cr> will open the file by:
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002562 =0: re-using the same window (default)
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002563 =1: horizontally splitting the window first
2564 =2: vertically splitting the window first
Bram Moolenaar446cb832008-06-24 21:56:24 +00002565 =3: open file in new tab
2566 =4: act like "P" (ie. open previous window)
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002567 Note that |g:netrw_preview| may be used
2568 to get vertical splitting instead of
2569 horizontal splitting.
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002570 =[servername,tab-number,window-number]
2571 Given a |List| such as this, a remote server
2572 named by the "servername" will be used for
2573 editing. It will also use the specified tab
2574 and window numbers to perform editing
2575 (see |clientserver|, |netrw-ctrl-r|)
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002576 This option does not affect the production of
2577 |:Lexplore| windows.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002578
Bram Moolenaar8d043172014-01-23 14:24:41 +01002579 Related topics:
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002580 |g:netrw_alto| |g:netrw_altv|
2581 |netrw-C| |netrw-cr|
2582 |netrw-ctrl-r|
Bram Moolenaar8d043172014-01-23 14:24:41 +01002583
Bram Moolenaarff034192013-04-24 18:51:19 +02002584 *g:netrw_browsex_viewer* specify user's preference for a viewer: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00002585 "kfmclient exec"
2586 "gnome-open"
Luca Saccarolaa7d45612024-10-21 21:27:03 +02002587<
Bram Moolenaar89a9c152021-08-29 21:55:35 +02002588 *g:netrw_browsex_support_remote*
2589 specify if the specified viewer supports a
2590 remote URL. (see |netrw-handler|).
2591
Bram Moolenaarff034192013-04-24 18:51:19 +02002592 *g:netrw_chgperm* Unix/Linux: "chmod PERM FILENAME"
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002593 Windows: "cacls FILENAME /e /p PERM"
2594 Used to change access permission for a file.
2595
Bram Moolenaar89a9c152021-08-29 21:55:35 +02002596 *g:netrw_clipboard* =1
Bram Moolenaar938ae282023-02-20 20:44:55 +00002597 By default, netrw will attempt to insure that
Bram Moolenaar89a9c152021-08-29 21:55:35 +02002598 the clipboard's values will remain unchanged.
2599 However, some users report that they have
2600 speed problems with this; consequently, this
2601 option, when set to zero, lets such users
2602 prevent netrw from saving and restoring the
2603 clipboard (the latter is done only as needed).
2604 That means that if the clipboard is changed
2605 (inadvertently) by normal netrw operation that
2606 it will not be restored to its prior state.
2607
Bram Moolenaarff034192013-04-24 18:51:19 +02002608 *g:netrw_compress* ="gzip"
Bram Moolenaar89a9c152021-08-29 21:55:35 +02002609 Will compress marked files with this
2610 command
Bram Moolenaar446cb832008-06-24 21:56:24 +00002611
Bram Moolenaarff034192013-04-24 18:51:19 +02002612 *g:Netrw_corehandler* Allows one to specify something additional
Bram Moolenaar15146672011-10-20 22:22:38 +02002613 to do when handling <core> files via netrw's
2614 browser's "x" command (see |netrw-x|). If
2615 present, g:Netrw_corehandler specifies
2616 either one or more function references
2617 (see |Funcref|). (the capital g:Netrw...
2618 is required its holding a function reference)
2619
2620
Bram Moolenaarff034192013-04-24 18:51:19 +02002621 *g:netrw_ctags* ="ctags"
2622 The default external program used to create
2623 tags
Bram Moolenaarc236c162008-07-13 17:41:49 +00002624
Bram Moolenaarff034192013-04-24 18:51:19 +02002625 *g:netrw_cursor* = 2 (default)
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002626 This option controls the use of the
Bram Moolenaaradc21822011-04-01 18:03:16 +02002627 |'cursorline'| (cul) and |'cursorcolumn'|
2628 (cuc) settings by netrw:
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002629
Bram Moolenaaradc21822011-04-01 18:03:16 +02002630 Value Thin-Long-Tree Wide
2631 =0 u-cul u-cuc u-cul u-cuc
2632 =1 u-cul u-cuc cul u-cuc
2633 =2 cul u-cuc cul u-cuc
2634 =3 cul u-cuc cul cuc
2635 =4 cul cuc cul cuc
Bram Moolenaar89a9c152021-08-29 21:55:35 +02002636 =5 U-cul U-cuc U-cul U-cuc
2637 =6 U-cul U-cuc cul U-cuc
2638 =7 cul U-cuc cul U-cuc
2639 =8 cul U-cuc cul cuc
Bram Moolenaaradc21822011-04-01 18:03:16 +02002640
2641 Where
Bram Moolenaar89a9c152021-08-29 21:55:35 +02002642 u-cul : user's |'cursorline'| initial setting used
2643 u-cuc : user's |'cursorcolumn'| initial setting used
2644 U-cul : user's |'cursorline'| current setting used
2645 U-cuc : user's |'cursorcolumn'| current setting used
2646 cul : |'cursorline'| will be locally set
2647 cuc : |'cursorcolumn'| will be locally set
2648
2649 The "initial setting" means the values of
2650 the |'cuc'| and |'cul'| settings in effect when
2651 netrw last saw |g:netrw_cursor| >= 5 or when
2652 netrw was initially run.
Bram Moolenaaradc21822011-04-01 18:03:16 +02002653
Bram Moolenaarff034192013-04-24 18:51:19 +02002654 *g:netrw_decompress* = { ".gz" : "gunzip" ,
Bram Moolenaar446cb832008-06-24 21:56:24 +00002655 ".bz2" : "bunzip2" ,
2656 ".zip" : "unzip" ,
2657 ".tar" : "tar -xf"}
2658 A dictionary mapping suffices to
2659 decompression programs.
2660
Bram Moolenaaradc21822011-04-01 18:03:16 +02002661 *g:netrw_dirhistmax* =10: controls maximum quantity of past
Bram Moolenaar89a9c152021-08-29 21:55:35 +02002662 history. May be zero to suppress
Bram Moolenaaradc21822011-04-01 18:03:16 +02002663 history.
2664 (related: |netrw-qb| |netrw-u| |netrw-U|)
2665
Bram Moolenaar97d62492012-11-15 21:28:22 +01002666 *g:netrw_dynamic_maxfilenamelen* =32: enables dynamic determination of
2667 |g:netrw_maxfilenamelen|, which affects
2668 local file long listing.
Bram Moolenaara6878372014-03-22 21:02:50 +01002669
Bram Moolenaar5b435d62012-04-05 17:33:26 +02002670 *g:netrw_errorlvl* =0: error levels greater than or equal to
2671 this are permitted to be displayed
2672 0: notes
2673 1: warnings
2674 2: errors
2675
Bram Moolenaarff034192013-04-24 18:51:19 +02002676 *g:netrw_fastbrowse* =0: slow speed directory browsing;
Bram Moolenaar13600302014-05-22 18:26:40 +02002677 never re-uses directory listings;
Bram Moolenaar446cb832008-06-24 21:56:24 +00002678 always obtains directory listings.
2679 =1: medium speed directory browsing;
2680 re-use directory listings only
2681 when remote directory browsing.
2682 (default value)
2683 =2: fast directory browsing;
2684 only obtains directory listings when the
2685 directory hasn't been seen before
2686 (or |netrw-ctrl-l| is used).
2687
2688 Fast browsing retains old directory listing
2689 buffers so that they don't need to be
2690 re-acquired. This feature is especially
2691 important for remote browsing. However, if
2692 a file is introduced or deleted into or from
2693 such directories, the old directory buffer
2694 becomes out-of-date. One may always refresh
2695 such a directory listing with |netrw-ctrl-l|.
2696 This option gives the user the choice of
2697 trading off accuracy (ie. up-to-date listing)
2698 versus speed.
2699
Bram Moolenaar13600302014-05-22 18:26:40 +02002700 *g:netrw_ffkeep* (default: doesn't exist)
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002701 If this variable exists and is zero, then
Bram Moolenaar13600302014-05-22 18:26:40 +02002702 netrw will not do a save and restore for
2703 |'fileformat'|.
2704
Bram Moolenaarff034192013-04-24 18:51:19 +02002705 *g:netrw_fname_escape* =' ?&;%'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002706 Used on filenames before remote reading/writing
Bram Moolenaar446cb832008-06-24 21:56:24 +00002707
Bram Moolenaarff034192013-04-24 18:51:19 +02002708 *g:netrw_ftp_browse_reject* ftp can produce a number of errors and warnings
Bram Moolenaar446cb832008-06-24 21:56:24 +00002709 that can show up as "directories" and "files"
2710 in the listing. This pattern is used to
2711 remove such embedded messages. By default its
2712 value is:
2713 '^total\s\+\d\+$\|
2714 ^Trying\s\+\d\+.*$\|
2715 ^KERBEROS_V\d rejected\|
2716 ^Security extensions not\|
2717 No such file\|
2718 : connect to address [0-9a-fA-F:]*
2719 : No route to host$'
2720
Bram Moolenaarff034192013-04-24 18:51:19 +02002721 *g:netrw_ftp_list_cmd* options for passing along to ftp for directory
Bram Moolenaar446cb832008-06-24 21:56:24 +00002722 listing. Defaults:
2723 unix or g:netrw_cygwin set: : "ls -lF"
2724 otherwise "dir"
2725
2726
Bram Moolenaarff034192013-04-24 18:51:19 +02002727 *g:netrw_ftp_sizelist_cmd* options for passing along to ftp for directory
Bram Moolenaar446cb832008-06-24 21:56:24 +00002728 listing, sorted by size of file.
2729 Defaults:
2730 unix or g:netrw_cygwin set: : "ls -slF"
2731 otherwise "dir"
2732
Bram Moolenaarff034192013-04-24 18:51:19 +02002733 *g:netrw_ftp_timelist_cmd* options for passing along to ftp for directory
Bram Moolenaar446cb832008-06-24 21:56:24 +00002734 listing, sorted by time of last modification.
2735 Defaults:
2736 unix or g:netrw_cygwin set: : "ls -tlF"
2737 otherwise "dir"
2738
Bram Moolenaar5b435d62012-04-05 17:33:26 +02002739 *g:netrw_glob_escape* ='[]*?`{~$' (unix)
Bram Moolenaar00a927d2010-05-14 23:24:24 +02002740 ='[]*?`{$' (windows
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002741 These characters in directory names are
Bram Moolenaar446cb832008-06-24 21:56:24 +00002742 escaped before applying glob()
2743
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002744 *g:netrw_gx* ="<cfile>"
Bram Moolenaar938ae282023-02-20 20:44:55 +00002745 This option controls how gx (|netrw-gx|) picks
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002746 up the text under the cursor. See |expand()|
2747 for possibilities.
2748
Bram Moolenaarff034192013-04-24 18:51:19 +02002749 *g:netrw_hide* Controlled by the "a" map (see |netrw-a|)
2750 =0 : show all
2751 =1 : show not-hidden files
2752 =2 : show hidden files only
Bram Moolenaar85850f32019-07-19 22:05:51 +02002753 default: =1
Bram Moolenaar446cb832008-06-24 21:56:24 +00002754
Bram Moolenaarff034192013-04-24 18:51:19 +02002755 *g:netrw_home* The home directory for where bookmarks and
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002756 history are saved (as .netrwbook and
2757 .netrwhist).
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002758 Netrw uses |expand()|on the string.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002759 default: the first directory on the
2760 |'runtimepath'|
2761
Bram Moolenaarff034192013-04-24 18:51:19 +02002762 *g:netrw_keepdir* =1 (default) keep current directory immune from
Bram Moolenaar446cb832008-06-24 21:56:24 +00002763 the browsing directory.
2764 =0 keep the current directory the same as the
2765 browsing directory.
2766 The current browsing directory is contained in
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002767 b:netrw_curdir (also see |netrw-cd|)
Bram Moolenaar446cb832008-06-24 21:56:24 +00002768
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002769 *g:netrw_keepj* ="keepj" (default) netrw attempts to keep the
2770 |:jumps| table unaffected.
2771 ="" netrw will not use |:keepjumps| with
2772 exceptions only for the
2773 saving/restoration of position.
2774
Bram Moolenaarff034192013-04-24 18:51:19 +02002775 *g:netrw_list_cmd* command for listing remote directories
Bram Moolenaar446cb832008-06-24 21:56:24 +00002776 default: (if ssh is executable)
2777 "ssh HOSTNAME ls -FLa"
2778
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002779 *g:netrw_list_cmd_options* If this variable exists, then its contents are
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002780 appended to the g:netrw_list_cmd. For
2781 example, use "2>/dev/null" to get rid of banner
2782 messages on unix systems.
2783
2784
Bram Moolenaarff034192013-04-24 18:51:19 +02002785 *g:netrw_liststyle* Set the default listing style:
Bram Moolenaar446cb832008-06-24 21:56:24 +00002786 = 0: thin listing (one file per line)
2787 = 1: long listing (one file per line with time
2788 stamp information and file size)
2789 = 2: wide listing (multiple files in columns)
2790 = 3: tree style listing
Bram Moolenaar8d043172014-01-23 14:24:41 +01002791
Bram Moolenaarb7398fe2023-05-14 18:50:25 +01002792 *g:netrw_list_hide* comma-separated pattern list for hiding files
Bram Moolenaar446cb832008-06-24 21:56:24 +00002793 Patterns are regular expressions (see |regexp|)
Bram Moolenaar8d043172014-01-23 14:24:41 +01002794 There's some special support for git-ignore
2795 files: you may add the output from the helper
2796 function 'netrw_gitignore#Hide() automatically
2797 hiding all gitignored files.
2798 For more details see |netrw-gitignore|.
2799
2800 Examples:
2801 let g:netrw_list_hide= '.*\.swp$'
Bram Moolenaarb7398fe2023-05-14 18:50:25 +01002802 let g:netrw_list_hide= netrw_gitignore#Hide() .. '.*\.swp$'
Bram Moolenaar8d043172014-01-23 14:24:41 +01002803 default: ""
Bram Moolenaar446cb832008-06-24 21:56:24 +00002804
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002805 *g:netrw_localcopycmd* ="cp" Linux/Unix/MacOS/Cygwin
2806 =expand("$COMSPEC") Windows
Bram Moolenaar446cb832008-06-24 21:56:24 +00002807 Copies marked files (|netrw-mf|) to target
2808 directory (|netrw-mt|, |netrw-mc|)
2809
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002810 *g:netrw_localcopycmdopt* ='' Linux/Unix/MacOS/Cygwin
Bram Moolenaar938ae282023-02-20 20:44:55 +00002811 =' \c copy' Windows
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002812 Options for the |g:netrw_localcopycmd|
2813
2814 *g:netrw_localcopydircmd* ="cp" Linux/Unix/MacOS/Cygwin
Bram Moolenaar938ae282023-02-20 20:44:55 +00002815 =expand("$COMSPEC") Windows
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002816 Copies directories to target directory.
2817 (|netrw-mc|, |netrw-mt|)
2818
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002819 *g:netrw_localcopydircmdopt* =" -R" Linux/Unix/MacOS/Cygwin
2820 =" /c xcopy /e /c /h/ /i /k" Windows
2821 Options for |g:netrw_localcopydircmd|
Bram Moolenaare6ae6222013-05-21 21:01:10 +02002822
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002823 *g:netrw_localmkdir* ="mkdir" Linux/Unix/MacOS/Cygwin
2824 =expand("$COMSPEC") Windows
2825 command for making a local directory
2826
2827 *g:netrw_localmkdiropt* ="" Linux/Unix/MacOS/Cygwin
2828 =" /c mkdir" Windows
2829 Options for |g:netrw_localmkdir|
2830
2831 *g:netrw_localmovecmd* ="mv" Linux/Unix/MacOS/Cygwin
2832 =expand("$COMSPEC") Windows
Bram Moolenaar446cb832008-06-24 21:56:24 +00002833 Moves marked files (|netrw-mf|) to target
2834 directory (|netrw-mt|, |netrw-mm|)
2835
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002836 *g:netrw_localmovecmdopt* ="" Linux/Unix/MacOS/Cygwin
2837 =" /c move" Windows
2838 Options for |g:netrw_localmovecmd|
2839
Bram Moolenaarff034192013-04-24 18:51:19 +02002840 *g:netrw_maxfilenamelen* =32 by default, selected so as to make long
Bram Moolenaar446cb832008-06-24 21:56:24 +00002841 listings fit on 80 column displays.
2842 If your screen is wider, and you have file
2843 or directory names longer than 32 bytes,
2844 you may set this option to keep listings
2845 columnar.
2846
Bram Moolenaarff034192013-04-24 18:51:19 +02002847 *g:netrw_mkdir_cmd* command for making a remote directory
Bram Moolenaar15146672011-10-20 22:22:38 +02002848 via ssh (also see |g:netrw_remote_mkdir|)
Bram Moolenaar446cb832008-06-24 21:56:24 +00002849 default: "ssh USEPORT HOSTNAME mkdir"
2850
Bram Moolenaar251e1912011-06-19 05:09:16 +02002851 *g:netrw_mousemaps* =1 (default) enables mouse buttons while
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002852 browsing to:
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002853 leftmouse : open file/directory
2854 shift-leftmouse : mark file
2855 middlemouse : same as P
2856 rightmouse : remove file/directory
2857 =0: disables mouse maps
2858
Bram Moolenaar15146672011-10-20 22:22:38 +02002859 *g:netrw_nobeval* doesn't exist (default)
2860 If this variable exists, then balloon
2861 evaluation will be suppressed
2862 (see |'ballooneval'|)
2863
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002864 *g:netrw_sizestyle* not defined: actual bytes (default)
Bram Moolenaar938ae282023-02-20 20:44:55 +00002865 ="b" : actual bytes (default)
2866 ="h" : human-readable (ex. 5k, 4m, 3g)
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002867 uses 1000 base
Bram Moolenaar938ae282023-02-20 20:44:55 +00002868 ="H" : human-readable (ex. 5K, 4M, 3G)
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002869 uses 1024 base
2870 The long listing (|netrw-i|) and query-file
2871 maps (|netrw-qf|) will display file size
2872 using the specified style.
2873
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002874 *g:netrw_usetab* if this variable exists and is non-zero, then
2875 the <tab> map supporting shrinking/expanding a
2876 Lexplore or netrw window will be enabled.
2877 (see |netrw-c-tab|)
2878
Bram Moolenaara6878372014-03-22 21:02:50 +01002879 *g:netrw_remote_mkdir* command for making a remote directory
Bram Moolenaar15146672011-10-20 22:22:38 +02002880 via ftp (also see |g:netrw_mkdir_cmd|)
2881 default: "mkdir"
2882
Bram Moolenaarff034192013-04-24 18:51:19 +02002883 *g:netrw_retmap* if it exists and is set to one, then:
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002884 * if in a netrw-selected file, AND
2885 * no normal-mode <2-leftmouse> mapping exists,
2886 then the <2-leftmouse> will be mapped for easy
Bram Moolenaar446cb832008-06-24 21:56:24 +00002887 return to the netrw browser window.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002888 example: click once to select and open a file,
2889 double-click to return.
2890
2891 Note that one may instead choose to:
2892 * let g:netrw_retmap= 1, AND
2893 * nmap <silent> YourChoice <Plug>NetrwReturn
2894 and have another mapping instead of
2895 <2-leftmouse> to invoke the return.
2896
2897 You may also use the |:Rexplore| command to do
2898 the same thing.
2899
Bram Moolenaar446cb832008-06-24 21:56:24 +00002900 default: =0
2901
Bram Moolenaar13600302014-05-22 18:26:40 +02002902 *g:netrw_rm_cmd* command for removing remote files
Bram Moolenaar446cb832008-06-24 21:56:24 +00002903 default: "ssh USEPORT HOSTNAME rm"
2904
Bram Moolenaar13600302014-05-22 18:26:40 +02002905 *g:netrw_rmdir_cmd* command for removing remote directories
Bram Moolenaar446cb832008-06-24 21:56:24 +00002906 default: "ssh USEPORT HOSTNAME rmdir"
2907
Bram Moolenaar13600302014-05-22 18:26:40 +02002908 *g:netrw_rmf_cmd* command for removing remote softlinks
Bram Moolenaar446cb832008-06-24 21:56:24 +00002909 default: "ssh USEPORT HOSTNAME rm -f"
2910
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01002911 *g:netrw_servername* use this variable to provide a name for
2912 |netrw-ctrl-r| to use for its server.
2913 default: "NETRWSERVER"
2914
Bram Moolenaara0f849e2015-10-30 14:37:44 +01002915 *g:netrw_sort_by* sort by "name", "time", "size", or
Bram Moolenaar938ae282023-02-20 20:44:55 +00002916 "exten".
Bram Moolenaar446cb832008-06-24 21:56:24 +00002917 default: "name"
2918
Bram Moolenaarff034192013-04-24 18:51:19 +02002919 *g:netrw_sort_direction* sorting direction: "normal" or "reverse"
Bram Moolenaar446cb832008-06-24 21:56:24 +00002920 default: "normal"
2921
Bram Moolenaarff034192013-04-24 18:51:19 +02002922 *g:netrw_sort_options* sorting is done using |:sort|; this
Bram Moolenaarc236c162008-07-13 17:41:49 +00002923 variable's value is appended to the
2924 sort command. Thus one may ignore case,
2925 for example, with the following in your
2926 .vimrc: >
2927 let g:netrw_sort_options="i"
2928< default: ""
2929
Bram Moolenaarff034192013-04-24 18:51:19 +02002930 *g:netrw_sort_sequence* when sorting by name, first sort by the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002931 comma-separated pattern sequence. Note that
Bram Moolenaara6878372014-03-22 21:02:50 +01002932 any filigree added to indicate filetypes
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002933 should be accounted for in your pattern.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002934 default: '[\/]$,*,\.bak$,\.o$,\.h$,
2935 \.info$,\.swp$,\.obj$'
2936
Bram Moolenaarff034192013-04-24 18:51:19 +02002937 *g:netrw_special_syntax* If true, then certain files will be shown
Bram Moolenaar5b435d62012-04-05 17:33:26 +02002938 using special syntax in the browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00002939
2940 netrwBak : *.bak
2941 netrwCompress: *.gz *.bz2 *.Z *.zip
Bram Moolenaar85850f32019-07-19 22:05:51 +02002942 netrwCoreDump: core.\d\+
Bram Moolenaar446cb832008-06-24 21:56:24 +00002943 netrwData : *.dat
Bram Moolenaar85850f32019-07-19 22:05:51 +02002944 netrwDoc : *.doc,*.txt,*.pdf,
2945 *.pdf,*.docx
Bram Moolenaar446cb832008-06-24 21:56:24 +00002946 netrwHdr : *.h
Bram Moolenaar85850f32019-07-19 22:05:51 +02002947 netrwLex : *.l *.lex
Bram Moolenaar446cb832008-06-24 21:56:24 +00002948 netrwLib : *.a *.so *.lib *.dll
2949 netrwMakefile: [mM]akefile *.mak
2950 netrwObj : *.o *.obj
Bram Moolenaar85850f32019-07-19 22:05:51 +02002951 netrwPix : *.bmp,*.fit,*.fits,*.gif,
2952 *.jpg,*.jpeg,*.pcx,*.ppc
2953 *.pgm,*.png,*.psd,*.rgb
2954 *.tif,*.xbm,*.xcf
Bram Moolenaar446cb832008-06-24 21:56:24 +00002955 netrwTags : tags ANmenu ANtags
Bram Moolenaara6878372014-03-22 21:02:50 +01002956 netrwTilde : *
Bram Moolenaar446cb832008-06-24 21:56:24 +00002957 netrwTmp : tmp* *tmp
Bram Moolenaar85850f32019-07-19 22:05:51 +02002958 netrwYacc : *.y
Bram Moolenaar446cb832008-06-24 21:56:24 +00002959
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002960 In addition, those groups mentioned in
2961 |'suffixes'| are also added to the special
2962 file highlighting group.
2963 These syntax highlighting groups are linked
2964 to netrwGray or Folded by default
2965 (see |hl-Folded|), but one may put lines like >
Bram Moolenaar446cb832008-06-24 21:56:24 +00002966 hi link netrwCompress Visual
2967< into one's <.vimrc> to use one's own
Bram Moolenaara6878372014-03-22 21:02:50 +01002968 preferences. Alternatively, one may
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002969 put such specifications into >
2970 .vim/after/syntax/netrw.vim.
2971< The netrwGray highlighting is set up by
2972 netrw when >
Bram Moolenaar938ae282023-02-20 20:44:55 +00002973 * netrwGray has not been previously
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002974 defined
2975 * the gui is running
2976< As an example, I myself use a dark-background
Bram Moolenaara6878372014-03-22 21:02:50 +01002977 colorscheme with the following in
2978 .vim/after/syntax/netrw.vim: >
2979
2980 hi netrwCompress term=NONE cterm=NONE gui=NONE ctermfg=10 guifg=green ctermbg=0 guibg=black
2981 hi netrwData term=NONE cterm=NONE gui=NONE ctermfg=9 guifg=blue ctermbg=0 guibg=black
2982 hi netrwHdr term=NONE cterm=NONE,italic gui=NONE guifg=SeaGreen1
2983 hi netrwLex term=NONE cterm=NONE,italic gui=NONE guifg=SeaGreen1
2984 hi netrwYacc term=NONE cterm=NONE,italic gui=NONE guifg=SeaGreen1
2985 hi netrwLib term=NONE cterm=NONE gui=NONE ctermfg=14 guifg=yellow
2986 hi netrwObj term=NONE cterm=NONE gui=NONE ctermfg=12 guifg=red
2987 hi netrwTilde term=NONE cterm=NONE gui=NONE ctermfg=12 guifg=red
2988 hi netrwTmp term=NONE cterm=NONE gui=NONE ctermfg=12 guifg=red
2989 hi netrwTags term=NONE cterm=NONE gui=NONE ctermfg=12 guifg=red
2990 hi netrwDoc term=NONE cterm=NONE gui=NONE ctermfg=220 ctermbg=27 guifg=yellow2 guibg=Blue3
2991 hi netrwSymLink term=NONE cterm=NONE gui=NONE ctermfg=220 ctermbg=27 guifg=grey60
2992<
Bram Moolenaarff034192013-04-24 18:51:19 +02002993 *g:netrw_ssh_browse_reject* ssh can sometimes produce unwanted lines,
Bram Moolenaar446cb832008-06-24 21:56:24 +00002994 messages, banners, and whatnot that one doesn't
2995 want masquerading as "directories" and "files".
2996 Use this pattern to remove such embedded
2997 messages. By default its value is:
2998 '^total\s\+\d\+$'
2999
Bram Moolenaare6ae6222013-05-21 21:01:10 +02003000 *g:netrw_ssh_cmd* One may specify an executable command
3001 to use instead of ssh for remote actions
3002 such as listing, file removal, etc.
3003 default: ssh
3004
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02003005 *g:netrw_suppress_gx_mesg* =1 : browsers sometimes produce messages
3006 which are normally unwanted intermixed
3007 with the page.
3008 However, when using links, for example,
3009 those messages are what the browser produces.
3010 By setting this option to 0, netrw will not
3011 suppress browser messages.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003012
Bram Moolenaarff034192013-04-24 18:51:19 +02003013 *g:netrw_tmpfile_escape* =' &;'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003014 escape() is applied to all temporary files
Bram Moolenaar446cb832008-06-24 21:56:24 +00003015 to escape these characters.
3016
Bram Moolenaarff034192013-04-24 18:51:19 +02003017 *g:netrw_timefmt* specify format string to vim's strftime().
Bram Moolenaar446cb832008-06-24 21:56:24 +00003018 The default, "%c", is "the preferred date
3019 and time representation for the current
3020 locale" according to my manpage entry for
3021 strftime(); however, not all are satisfied
3022 with it. Some alternatives:
3023 "%a %d %b %Y %T",
3024 " %a %Y-%m-%d %I-%M-%S %p"
3025 default: "%c"
3026
Bram Moolenaarff034192013-04-24 18:51:19 +02003027 *g:netrw_use_noswf* netrw normally avoids writing swapfiles
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003028 for browser buffers. However, under some
Bram Moolenaar446cb832008-06-24 21:56:24 +00003029 systems this apparently is causing nasty
3030 ml_get errors to appear; if you're getting
3031 ml_get errors, try putting
3032 let g:netrw_use_noswf= 0
3033 in your .vimrc.
Bram Moolenaara6878372014-03-22 21:02:50 +01003034 default: 1
Bram Moolenaar446cb832008-06-24 21:56:24 +00003035
Bram Moolenaarff034192013-04-24 18:51:19 +02003036 *g:netrw_winsize* specify initial size of new windows made with
Bram Moolenaar446cb832008-06-24 21:56:24 +00003037 "o" (see |netrw-o|), "v" (see |netrw-v|),
Bram Moolenaar251e1912011-06-19 05:09:16 +02003038 |:Hexplore| or |:Vexplore|. The g:netrw_winsize
3039 is an integer describing the percentage of the
3040 current netrw buffer's window to be used for
3041 the new window.
Bram Moolenaar15146672011-10-20 22:22:38 +02003042 If g:netrw_winsize is less than zero, then
Bram Moolenaar85850f32019-07-19 22:05:51 +02003043 the absolute value of g:netrw_winsize will be
3044 used to specify the quantity of lines or
3045 columns for the new window.
Bram Moolenaar13600302014-05-22 18:26:40 +02003046 If g:netrw_winsize is zero, then a normal
3047 split will be made (ie. |'equalalways'| will
3048 take effect, for example).
Bram Moolenaar251e1912011-06-19 05:09:16 +02003049 default: 50 (for 50%)
Bram Moolenaar446cb832008-06-24 21:56:24 +00003050
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003051 *g:netrw_wiw* =1 specifies the minimum window width to use
3052 when shrinking a netrw/Lexplore window
3053 (see |netrw-c-tab|).
3054
Bram Moolenaarff034192013-04-24 18:51:19 +02003055 *g:netrw_xstrlen* Controls how netrw computes string lengths,
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003056 including multi-byte characters' string
Bram Moolenaar446cb832008-06-24 21:56:24 +00003057 length. (thanks to N Weibull, T Mechelynck)
3058 =0: uses Vim's built-in strlen()
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003059 =1: number of codepoints (Latin a + combining
Bram Moolenaar446cb832008-06-24 21:56:24 +00003060 circumflex is two codepoints) (DEFAULT)
3061 =2: number of spacing codepoints (Latin a +
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003062 combining circumflex is one spacing
Bram Moolenaar446cb832008-06-24 21:56:24 +00003063 codepoint; a hard tab is one; wide and
3064 narrow CJK are one each; etc.)
3065 =3: virtual length (counting tabs as anything
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003066 between 1 and |'tabstop'|, wide CJK as 2
Bram Moolenaar446cb832008-06-24 21:56:24 +00003067 rather than 1, Arabic alif as zero when
3068 immediately preceded by lam, one
3069 otherwise, etc)
3070
Bram Moolenaarff034192013-04-24 18:51:19 +02003071 *g:NetrwTopLvlMenu* This variable specifies the top level
Bram Moolenaar446cb832008-06-24 21:56:24 +00003072 menu name; by default, it's "Netrw.". If
3073 you wish to change this, do so in your
3074 .vimrc.
3075
3076NETRW BROWSING AND OPTION INCOMPATIBILITIES *netrw-incompatible* {{{2
3077
3078Netrw has been designed to handle user options by saving them, setting the
3079options to something that's compatible with netrw's needs, and then restoring
3080them. However, the autochdir option: >
3081 :set acd
Bram Moolenaara6878372014-03-22 21:02:50 +01003082is problematic. Autochdir sets the current directory to that containing the
Bram Moolenaar446cb832008-06-24 21:56:24 +00003083file you edit; this apparently also applies to directories. In other words,
3084autochdir sets the current directory to that containing the "file" (even if
3085that "file" is itself a directory).
3086
Bram Moolenaar15146672011-10-20 22:22:38 +02003087NETRW SETTINGS WINDOW *netrw-settings-window* {{{2
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00003088
3089With the NetrwSettings.vim plugin, >
3090 :NetrwSettings
3091will bring up a window with the many variables that netrw uses for its
Bram Moolenaar1afcace2005-11-25 19:54:28 +00003092settings. You may change any of their values; when you save the file, the
3093settings therein will be used. One may also press "?" on any of the lines for
3094help on what each of the variables do.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00003095
Bram Moolenaar5b435d62012-04-05 17:33:26 +02003096(also see: |netrw-browser-var| |netrw-protocol| |netrw-variables|)
Bram Moolenaar9964e462007-05-05 17:54:07 +00003097
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00003098
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00003099==============================================================================
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003100OBTAINING A FILE *netrw-obtain* *netrw-O* {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +00003101
3102If there are no marked files:
3103
3104 When browsing a remote directory, one may obtain a file under the cursor
3105 (ie. get a copy on your local machine, but not edit it) by pressing the O
3106 key.
3107
3108If there are marked files:
3109
3110 The marked files will be obtained (ie. a copy will be transferred to your
3111 local machine, but not set up for editing).
3112
3113Only ftp and scp are supported for this operation (but since these two are
3114available for browsing, that shouldn't be a problem). The status bar will
3115then show, on its right hand side, a message like "Obtaining filename". The
3116statusline will be restored after the transfer is complete.
3117
3118Netrw can also "obtain" a file using the local browser. Netrw's display
3119of a directory is not necessarily the same as Vim's "current directory",
3120unless |g:netrw_keepdir| is set to 0 in the user's <.vimrc>. One may select
3121a file using the local browser (by putting the cursor on it) and pressing
3122"O" will then "obtain" the file; ie. copy it to Vim's current directory.
3123
3124Related topics:
3125 * To see what the current directory is, use |:pwd|
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003126 * To make the currently browsed directory the current directory, see
3127 |netrw-cd|
Bram Moolenaar446cb832008-06-24 21:56:24 +00003128 * To automatically make the currently browsed directory the current
3129 directory, see |g:netrw_keepdir|.
3130
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003131 *netrw-newfile* *netrw-createfile*
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003132OPEN A NEW FILE IN NETRW'S CURRENT DIRECTORY *netrw-%* {{{2
Bram Moolenaarc236c162008-07-13 17:41:49 +00003133
Bram Moolenaara6878372014-03-22 21:02:50 +01003134To open a new file in netrw's current directory, press "%". This map
3135will query the user for a new filename; an empty file by that name will
3136be placed in the netrw's current directory (ie. b:netrw_curdir).
Bram Moolenaarc236c162008-07-13 17:41:49 +00003137
Bram Moolenaar89a9c152021-08-29 21:55:35 +02003138If Lexplore (|netrw-:Lexplore|) is in use, the new file will be generated
3139in the |g:netrw_chgwin| window.
3140
Bram Moolenaar8d043172014-01-23 14:24:41 +01003141Related topics: |netrw-d|
3142
Bram Moolenaarc236c162008-07-13 17:41:49 +00003143
Bram Moolenaar446cb832008-06-24 21:56:24 +00003144PREVIEW WINDOW *netrw-p* *netrw-preview* {{{2
3145
3146One may use a preview window by using the "p" key when the cursor is atop the
3147desired filename to be previewed. The display will then split to show both
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003148the browser (where the cursor will remain) and the file (see |:pedit|). By
3149default, the split will be taken horizontally; one may use vertical splitting
3150if one has set |g:netrw_preview| first.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003151
Bram Moolenaar00a927d2010-05-14 23:24:24 +02003152An interesting set of netrw settings is: >
3153
3154 let g:netrw_preview = 1
3155 let g:netrw_liststyle = 3
3156 let g:netrw_winsize = 30
3157
3158These will:
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003159
Bram Moolenaar00a927d2010-05-14 23:24:24 +02003160 1. Make vertical splitting the default for previewing files
3161 2. Make the default listing style "tree"
3162 3. When a vertical preview window is opened, the directory listing
Bram Moolenaar5b435d62012-04-05 17:33:26 +02003163 will use only 30% of the columns available; the rest of the window
3164 is used for the preview window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003165
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003166 Related: if you like this idea, you may also find :Lexplore
3167 (|netrw-:Lexplore|) or |g:netrw_chgwin| of interest
3168
Bram Moolenaare0fa3742016-02-20 15:47:01 +01003169Also see: |g:netrw_chgwin| |netrw-P| |'previewwindow'| |CTRL-W_z| |:pclose|
Bram Moolenaara6878372014-03-22 21:02:50 +01003170
3171
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003172PREVIOUS WINDOW *netrw-P* *netrw-prvwin* {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +00003173
Bram Moolenaare0fa3742016-02-20 15:47:01 +01003174To edit a file or directory under the cursor in the previously used (last
3175accessed) window (see :he |CTRL-W_p|), press a "P". If there's only one
3176window, then the one window will be horizontally split (by default).
Bram Moolenaar446cb832008-06-24 21:56:24 +00003177
3178If there's more than one window, the previous window will be re-used on
3179the selected file/directory. If the previous window's associated buffer
3180has been modified, and there's only one window with that buffer, then
3181the user will be asked if s/he wishes to save the buffer first (yes,
3182no, or cancel).
3183
Bram Moolenaarff034192013-04-24 18:51:19 +02003184Related Actions |netrw-cr| |netrw-o| |netrw-t| |netrw-v|
Bram Moolenaar15146672011-10-20 22:22:38 +02003185Associated setting variables:
3186 |g:netrw_alto| control above/below splitting
3187 |g:netrw_altv| control right/left splitting
3188 |g:netrw_preview| control horizontal vs vertical splitting
3189 |g:netrw_winsize| control initial sizing
3190
Bram Moolenaara6878372014-03-22 21:02:50 +01003191Also see: |g:netrw_chgwin| |netrw-p|
3192
Bram Moolenaar446cb832008-06-24 21:56:24 +00003193
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003194REFRESHING THE LISTING *netrw-refresh* *netrw-ctrl-l* *netrw-ctrl_l* {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +00003195
3196To refresh either a local or remote directory listing, press ctrl-l (<c-l>) or
3197hit the <cr> when atop the ./ directory entry in the listing. One may also
3198refresh a local directory by using ":e .".
3199
3200
Bram Moolenaarff034192013-04-24 18:51:19 +02003201REVERSING SORTING ORDER *netrw-r* *netrw-reverse* {{{2
3202
3203One may toggle between normal and reverse sorting order by pressing the
3204"r" key.
3205
3206Related topics: |netrw-s|
3207Associated setting variable: |g:netrw_sort_direction|
3208
3209
Bram Moolenaar446cb832008-06-24 21:56:24 +00003210RENAMING FILES OR DIRECTORIES *netrw-move* *netrw-rename* *netrw-R* {{{2
3211
3212If there are no marked files: (see |netrw-mf|)
3213
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003214 Renaming files and directories involves moving the cursor to the
Bram Moolenaar446cb832008-06-24 21:56:24 +00003215 file/directory to be moved (renamed) and pressing "R". You will then be
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003216 queried for what you want the file/directory to be renamed to. You may
3217 select a range of lines with the "V" command (visual selection), and then
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003218 press "R"; you will be queried for each file as to what you want it
3219 renamed to.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003220
3221If there are marked files: (see |netrw-mf|)
3222
3223 Marked files will be renamed (moved). You will be queried as above in
3224 order to specify where you want the file/directory to be moved.
3225
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003226 If you answer a renaming query with a "s/frompattern/topattern/", then
3227 subsequent files on the marked file list will be renamed by taking each
3228 name, applying that substitute, and renaming each file to the result.
3229 As an example : >
3230
Bram Moolenaar938ae282023-02-20 20:44:55 +00003231 mr [query: reply with *.c]
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003232 R [query: reply with s/^\(.*\)\.c$/\1.cpp/]
3233<
3234 This example will mark all *.c files and then rename them to *.cpp
Bram Moolenaar29634562020-01-09 21:46:04 +01003235 files. Netrw will protect you from overwriting local files without
3236 confirmation, but not remote ones.
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003237
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003238 The ctrl-X character has special meaning for renaming files: >
3239
Bram Moolenaar938ae282023-02-20 20:44:55 +00003240 <c-x> : a single ctrl-x tells netrw to ignore the portion of the response
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003241 lying between the last '/' and the ctrl-x.
3242
3243 <c-x><c-x> : a pair of contiguous ctrl-x's tells netrw to ignore any
3244 portion of the string preceding the double ctrl-x's.
3245<
Bram Moolenaar446cb832008-06-24 21:56:24 +00003246 WARNING:~
3247
3248 Note that moving files is a dangerous operation; copies are safer. That's
3249 because a "move" for remote files is actually a copy + delete -- and if
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003250 the copy fails and the delete succeeds you may lose the file.
Bram Moolenaara6878372014-03-22 21:02:50 +01003251 Use at your own risk.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003252
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003253The *g:netrw_rename_cmd* variable is used to implement remote renaming. By
3254default its value is: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00003255
3256 ssh HOSTNAME mv
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003257<
Bram Moolenaar446cb832008-06-24 21:56:24 +00003258One may rename a block of files and directories by selecting them with
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003259V (|linewise-visual|) when using thin style.
3260
3261See |cmdline-editing| for more on how to edit the command line; in particular,
3262you'll find <ctrl-f> (initiates cmdline window editing) and <ctrl-c> (uses the
3263command line under the cursor) useful in conjunction with the R command.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003264
3265
Bram Moolenaar446cb832008-06-24 21:56:24 +00003266SELECTING SORTING STYLE *netrw-s* *netrw-sort* {{{2
3267
3268One may select the sorting style by name, time, or (file) size. The "s" map
3269allows one to circulate amongst the three choices; the directory listing will
3270automatically be refreshed to reflect the selected style.
3271
3272Related topics: |netrw-r| |netrw-S|
3273Associated setting variables: |g:netrw_sort_by| |g:netrw_sort_sequence|
3274
3275
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003276SETTING EDITING WINDOW *netrw-editwindow* *netrw-C* *netrw-:NetrwC* {{{2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003277
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003278One may select a netrw window for editing with the "C" mapping, using the
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003279:NetrwC [win#] command, or by setting |g:netrw_chgwin| to the selected window
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003280number. Subsequent selection of a file to edit (|netrw-cr|) will use that
3281window.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003282
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003283 * C : by itself, will select the current window holding a netrw buffer
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003284 for subsequent editing via |netrw-cr|. The C mapping is only available
3285 while in netrw buffers.
Bram Moolenaar13600302014-05-22 18:26:40 +02003286
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003287 * [count]C : the count will be used as the window number to be used
3288 for subsequent editing via |netrw-cr|.
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003289
3290 * :NetrwC will set |g:netrw_chgwin| to the current window
3291
3292 * :NetrwC win# will set |g:netrw_chgwin| to the specified window
3293 number
3294
Bram Moolenaar13600302014-05-22 18:26:40 +02003295Using >
3296 let g:netrw_chgwin= -1
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003297will restore the default editing behavior
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003298(ie. subsequent editing will use the current window).
Bram Moolenaar13600302014-05-22 18:26:40 +02003299
Bram Moolenaar8d043172014-01-23 14:24:41 +01003300Related topics: |netrw-cr| |g:netrw_browse_split|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003301Associated setting variables: |g:netrw_chgwin|
3302
3303
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003304SHRINKING OR EXPANDING A NETRW OR LEXPLORE WINDOW *netrw-c-tab* {{{2
3305
3306The <c-tab> key will toggle a netrw or |:Lexplore| window's width,
3307but only if |g:netrw_usetab| exists and is non-zero (and, of course,
3308only if your terminal supports differentiating <c-tab> from a plain
3309<tab>).
3310
3311 * If the current window is a netrw window, toggle its width
3312 (between |g:netrw_wiw| and its original width)
3313
3314 * Else if there is a |:Lexplore| window in the current tab, toggle
3315 its width
3316
3317 * Else bring up a |:Lexplore| window
3318
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003319If |g:netrw_usetab| exists and is zero, or if there is a pre-existing mapping
Bram Moolenaare0fa3742016-02-20 15:47:01 +01003320for <c-tab>, then the <c-tab> will not be mapped. One may map something other
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003321than a <c-tab>, too: (but you'll still need to have had |g:netrw_usetab| set). >
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003322
3323 nmap <unique> (whatever) <Plug>NetrwShrink
3324<
3325Related topics: |:Lexplore|
3326Associated setting variable: |g:netrw_usetab|
3327
3328
3329USER SPECIFIED MAPS *netrw-usermaps* {{{1
3330
3331One may make customized user maps. Specify a variable, |g:Netrw_UserMaps|,
3332to hold a |List| of lists of keymap strings and function names: >
3333
3334 [["keymap-sequence","ExampleUserMapFunc"],...]
3335<
3336When netrw is setting up maps for a netrw buffer, if |g:Netrw_UserMaps|
3337exists, then the internal function netrw#UserMaps(islocal) is called.
3338This function goes through all the entries in the |g:Netrw_UserMaps| list:
3339
3340 * sets up maps: >
3341 nno <buffer> <silent> KEYMAP-SEQUENCE
3342 :call s:UserMaps(islocal,"ExampleUserMapFunc")
3343< * refreshes if result from that function call is the string
3344 "refresh"
3345 * if the result string is not "", then that string will be
3346 executed (:exe result)
3347 * if the result is a List, then the above two actions on results
3348 will be taken for every string in the result List
3349
3350The user function is passed one argument; it resembles >
3351
3352 fun! ExampleUserMapFunc(islocal)
3353<
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003354where a:islocal is 1 if its a local-directory system call or 0 when
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003355remote-directory system call.
3356
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003357 *netrw-call* *netrw-expose* *netrw-modify*
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003358Use netrw#Expose("varname") to access netrw-internal (script-local)
3359 variables.
3360Use netrw#Modify("varname",newvalue) to change netrw-internal variables.
3361Use netrw#Call("funcname"[,args]) to call a netrw-internal function with
3362 specified arguments.
3363
3364Example: Get a copy of netrw's marked file list: >
3365
3366 let netrwmarkfilelist= netrw#Expose("netrwmarkfilelist")
3367<
3368Example: Modify the value of netrw's marked file list: >
3369
3370 call netrw#Modify("netrwmarkfilelist",[])
3371<
3372Example: Clear netrw's marked file list via a mapping on gu >
3373 " ExampleUserMap: {{{2
3374 fun! ExampleUserMap(islocal)
3375 call netrw#Modify("netrwmarkfilelist",[])
3376 call netrw#Modify('netrwmarkfilemtch_{bufnr("%")}',"")
3377 let retval= ["refresh"]
3378 return retval
3379 endfun
3380 let g:Netrw_UserMaps= [["gu","ExampleUserMap"]]
3381<
3382
Bram Moolenaar446cb832008-06-24 21:56:24 +0000338310. Problems and Fixes *netrw-problems* {{{1
Bram Moolenaarc0197e22004-09-13 20:26:32 +00003384
3385 (This section is likely to grow as I get feedback)
3386 (also see |netrw-debug|)
Bram Moolenaar488c6512005-08-11 20:09:58 +00003387 *netrw-p1*
Nir Lichtman1e34b952024-05-08 19:19:34 +02003388 P1. I use Windows, and my network browsing with ftp doesn't sort by {{{2
Bram Moolenaar9964e462007-05-05 17:54:07 +00003389 time or size! -or- The remote system is a Windows server; why
3390 don't I get sorts by time or size?
Bram Moolenaarc0197e22004-09-13 20:26:32 +00003391
3392 Windows' ftp has a minimal support for ls (ie. it doesn't
3393 accept sorting options). It doesn't support the -F which
3394 gives an explanatory character (ABC/ for "ABC is a directory").
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003395 Netrw then uses "dir" to get both its thin and long listings.
Bram Moolenaar9964e462007-05-05 17:54:07 +00003396 If you think your ftp does support a full-up ls, put the
3397 following into your <.vimrc>: >
Bram Moolenaarc0197e22004-09-13 20:26:32 +00003398
Bram Moolenaar9964e462007-05-05 17:54:07 +00003399 let g:netrw_ftp_list_cmd = "ls -lF"
3400 let g:netrw_ftp_timelist_cmd= "ls -tlF"
3401 let g:netrw_ftp_sizelist_cmd= "ls -slF"
3402<
Bram Moolenaarc0197e22004-09-13 20:26:32 +00003403 Alternatively, if you have cygwin on your Windows box, put
Bram Moolenaar9964e462007-05-05 17:54:07 +00003404 into your <.vimrc>: >
Bram Moolenaarc0197e22004-09-13 20:26:32 +00003405
3406 let g:netrw_cygwin= 1
Bram Moolenaar9964e462007-05-05 17:54:07 +00003407<
3408 This problem also occurs when the remote system is Windows.
3409 In this situation, the various g:netrw_ftp_[time|size]list_cmds
3410 are as shown above, but the remote system will not correctly
3411 modify its listing behavior.
3412
Bram Moolenaarc0197e22004-09-13 20:26:32 +00003413
Nir Lichtman1e34b952024-05-08 19:19:34 +02003414 *netrw-p2*
3415 P2. I tried rcp://user@host/ (or protocol other than ftp) and netrw {{{2
Bram Moolenaarc0197e22004-09-13 20:26:32 +00003416 used ssh! That wasn't what I asked for...
3417
3418 Netrw has two methods for browsing remote directories: ssh
3419 and ftp. Unless you specify ftp specifically, ssh is used.
3420 When it comes time to do download a file (not just a directory
3421 listing), netrw will use the given protocol to do so.
3422
Nir Lichtman1e34b952024-05-08 19:19:34 +02003423 *netrw-p3*
3424 P3. I would like long listings to be the default. {{{2
Bram Moolenaarc0197e22004-09-13 20:26:32 +00003425
Bram Moolenaar446cb832008-06-24 21:56:24 +00003426 Put the following statement into your |.vimrc|: >
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00003427
Bram Moolenaar446cb832008-06-24 21:56:24 +00003428 let g:netrw_liststyle= 1
3429<
3430 Check out |netrw-browser-var| for more customizations that
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00003431 you can set.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00003432
Nir Lichtman1e34b952024-05-08 19:19:34 +02003433 *netrw-p4*
3434 P4. My times come up oddly in local browsing {{{2
Bram Moolenaarc0197e22004-09-13 20:26:32 +00003435
3436 Does your system's strftime() accept the "%c" to yield dates
Bram Moolenaarff034192013-04-24 18:51:19 +02003437 such as "Sun Apr 27 11:49:23 1997"? If not, do a
3438 "man strftime" and find out what option should be used. Then
3439 put it into your |.vimrc|: >
Bram Moolenaarc0197e22004-09-13 20:26:32 +00003440
Bram Moolenaar446cb832008-06-24 21:56:24 +00003441 let g:netrw_timefmt= "%X" (where X is the option)
3442<
Nir Lichtman1e34b952024-05-08 19:19:34 +02003443 *netrw-p5*
3444 P5. I want my current directory to track my browsing. {{{2
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00003445 How do I do that?
Bram Moolenaarc0197e22004-09-13 20:26:32 +00003446
Bram Moolenaar446cb832008-06-24 21:56:24 +00003447 Put the following line in your |.vimrc|:
3448>
Bram Moolenaar433f7c82006-03-21 21:29:36 +00003449 let g:netrw_keepdir= 0
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003450<
Nir Lichtman1e34b952024-05-08 19:19:34 +02003451 *netrw-p6*
3452 P6. I use Chinese (or other non-ascii) characters in my filenames, {{{2
Bram Moolenaar85850f32019-07-19 22:05:51 +02003453 and netrw (Explore, Sexplore, Hexplore, etc) doesn't display them!
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00003454
Bram Moolenaar9964e462007-05-05 17:54:07 +00003455 (taken from an answer provided by Wu Yongwei on the vim
3456 mailing list)
Bram Moolenaara6878372014-03-22 21:02:50 +01003457 I now see the problem. Your code page is not 936, right? Vim
Bram Moolenaar9964e462007-05-05 17:54:07 +00003458 seems only able to open files with names that are valid in the
3459 current code page, as are many other applications that do not
3460 use the Unicode version of Windows APIs. This is an OS-related
3461 issue. You should not have such problems when the system
3462 locale uses UTF-8, such as modern Linux distros.
3463
3464 (...it is one more reason to recommend that people use utf-8!)
3465
Nir Lichtman1e34b952024-05-08 19:19:34 +02003466 *netrw-p7*
3467 P7. I'm getting "ssh is not executable on your system" -- what do I {{{2
Bram Moolenaar9964e462007-05-05 17:54:07 +00003468 do?
3469
3470 (Dudley Fox) Most people I know use putty for windows ssh. It
3471 is a free ssh/telnet application. You can read more about it
3472 here:
3473
3474 http://www.chiark.greenend.org.uk/~sgtatham/putty/ Also:
3475
3476 (Marlin Unruh) This program also works for me. It's a single
3477 executable, so he/she can copy it into the Windows\System32
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003478 folder and create a shortcut to it.
Bram Moolenaar9964e462007-05-05 17:54:07 +00003479
3480 (Dudley Fox) You might also wish to consider plink, as it
3481 sounds most similar to what you are looking for. plink is an
3482 application in the putty suite.
3483
3484 http://the.earth.li/~sgtatham/putty/0.58/htmldoc/Chapter7.html#plink
3485
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003486 (Vissale Neang) Maybe you can try OpenSSH for windows, which
Bram Moolenaar9964e462007-05-05 17:54:07 +00003487 can be obtained from:
3488
3489 http://sshwindows.sourceforge.net/
3490
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003491 It doesn't need the full Cygwin package.
Bram Moolenaar9964e462007-05-05 17:54:07 +00003492
3493 (Antoine Mechelynck) For individual Unix-like programs needed
3494 for work in a native-Windows environment, I recommend getting
3495 them from the GnuWin32 project on sourceforge if it has them:
3496
3497 http://gnuwin32.sourceforge.net/
3498
3499 Unlike Cygwin, which sets up a Unix-like virtual machine on
3500 top of Windows, GnuWin32 is a rewrite of Unix utilities with
3501 Windows system calls, and its programs works quite well in the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003502 cmd.exe "Dos box".
Bram Moolenaar9964e462007-05-05 17:54:07 +00003503
3504 (dave) Download WinSCP and use that to connect to the server.
3505 In Preferences > Editors, set gvim as your editor:
3506
3507 - Click "Add..."
3508 - Set External Editor (adjust path as needed, include
3509 the quotes and !.! at the end):
Bram Moolenaar8024f932020-01-14 19:29:13 +01003510 "c:\Program Files\Vim\vim82\gvim.exe" !.!
Bram Moolenaar9964e462007-05-05 17:54:07 +00003511 - Check that the filetype in the box below is
3512 {asterisk}.{asterisk} (all files), or whatever types
3513 you want (cec: change {asterisk} to * ; I had to
3514 write it that way because otherwise the helptags
Bram Moolenaar446cb832008-06-24 21:56:24 +00003515 system thinks it's a tag)
3516 - Make sure it's at the top of the listbox (click it,
3517 then click "Up" if it's not)
Bram Moolenaar9964e462007-05-05 17:54:07 +00003518 If using the Norton Commander style, you just have to hit <F4>
3519 to edit a file in a local copy of gvim.
3520
3521 (Vit Gottwald) How to generate public/private key and save
3522 public key it on server: >
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +02003523 http://www.chiark.greenend.org.uk/~sgtatham/putty/0.60/htmldoc/Chapter8.html#pubkey-gettingready
3524 (8.3 Getting ready for public key authentication)
Bram Moolenaar9964e462007-05-05 17:54:07 +00003525<
Bram Moolenaar446cb832008-06-24 21:56:24 +00003526 How to use a private key with 'pscp': >
3527
Bram Moolenaar5ac3b1a2010-07-27 22:50:36 +02003528 http://www.chiark.greenend.org.uk/~sgtatham/putty/0.60/htmldoc/Chapter5.html
3529 (5.2.4 Using public key authentication with PSCP)
Bram Moolenaar9964e462007-05-05 17:54:07 +00003530<
Bram Moolenaar446cb832008-06-24 21:56:24 +00003531 (Ben Schmidt) I find the ssh included with cwRsync is
3532 brilliant, and install cwRsync or cwRsyncServer on most
3533 Windows systems I come across these days. I guess COPSSH,
3534 packed by the same person, is probably even better for use as
3535 just ssh on Windows, and probably includes sftp, etc. which I
3536 suspect the cwRsync doesn't, though it might
3537
Bram Moolenaar9964e462007-05-05 17:54:07 +00003538 (cec) To make proper use of these suggestions above, you will
3539 need to modify the following user-settable variables in your
3540 .vimrc:
3541
Bram Moolenaar446cb832008-06-24 21:56:24 +00003542 |g:netrw_ssh_cmd| |g:netrw_list_cmd| |g:netrw_mkdir_cmd|
3543 |g:netrw_rm_cmd| |g:netrw_rmdir_cmd| |g:netrw_rmf_cmd|
Bram Moolenaar9964e462007-05-05 17:54:07 +00003544
3545 The first one (|g:netrw_ssh_cmd|) is the most important; most
3546 of the others will use the string in g:netrw_ssh_cmd by
3547 default.
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003548
Nir Lichtman1e34b952024-05-08 19:19:34 +02003549 *netrw-p8* *netrw-ml_get*
3550 P8. I'm browsing, changing directory, and bang! ml_get errors {{{2
Bram Moolenaar9964e462007-05-05 17:54:07 +00003551 appear and I have to kill vim. Any way around this?
3552
3553 Normally netrw attempts to avoid writing swapfiles for
3554 its temporary directory buffers. However, on some systems
3555 this attempt appears to be causing ml_get errors to
3556 appear. Please try setting |g:netrw_use_noswf| to 0
3557 in your <.vimrc>: >
3558 let g:netrw_use_noswf= 0
3559<
Nir Lichtman1e34b952024-05-08 19:19:34 +02003560 *netrw-p9*
3561 P9. I'm being pestered with "[something] is a directory" and {{{2
Bram Moolenaar446cb832008-06-24 21:56:24 +00003562 "Press ENTER or type command to continue" prompts...
3563
3564 The "[something] is a directory" prompt is issued by Vim,
3565 not by netrw, and there appears to be no way to work around
3566 it. Coupled with the default cmdheight of 1, this message
3567 causes the "Press ENTER..." prompt. So: read |hit-enter|;
3568 I also suggest that you set your |'cmdheight'| to 2 (or more) in
3569 your <.vimrc> file.
3570
Nir Lichtman1e34b952024-05-08 19:19:34 +02003571 *netrw-p10*
3572 P10. I want to have two windows; a thin one on the left and my {{{2
Bram Moolenaar85850f32019-07-19 22:05:51 +02003573 editing window on the right. How may I accomplish this?
Bram Moolenaar446cb832008-06-24 21:56:24 +00003574
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003575 You probably want netrw running as in a side window. If so, you
3576 will likely find that ":[N]Lexplore" does what you want. The
3577 optional "[N]" allows you to select the quantity of columns you
Bram Moolenaard7464be2015-11-01 16:49:04 +01003578 wish the |:Lexplore|r window to start with (see |g:netrw_winsize|
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003579 for how this parameter works).
3580
3581 Previous solution:
3582
Bram Moolenaar446cb832008-06-24 21:56:24 +00003583 * Put the following line in your <.vimrc>:
3584 let g:netrw_altv = 1
3585 * Edit the current directory: :e .
3586 * Select some file, press v
3587 * Resize the windows as you wish (see |CTRL-W_<| and
3588 |CTRL-W_>|). If you're using gvim, you can drag
3589 the separating bar with your mouse.
3590 * When you want a new file, use ctrl-w h to go back to the
3591 netrw browser, select a file, then press P (see |CTRL-W_h|
3592 and |netrw-P|). If you're using gvim, you can press
3593 <leftmouse> in the browser window and then press the
3594 <middlemouse> to select the file.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00003595
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003596
Nir Lichtman1e34b952024-05-08 19:19:34 +02003597 *netrw-p11*
3598 P11. My directory isn't sorting correctly, or unwanted letters are {{{2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003599 appearing in the listed filenames, or things aren't lining
3600 up properly in the wide listing, ...
3601
3602 This may be due to an encoding problem. I myself usually use
3603 utf-8, but really only use ascii (ie. bytes from 32-126).
3604 Multibyte encodings use two (or more) bytes per character.
3605 You may need to change |g:netrw_sepchr| and/or |g:netrw_xstrlen|.
3606
Nir Lichtman1e34b952024-05-08 19:19:34 +02003607 *netrw-p12*
3608 P12. I'm a Windows + putty + ssh user, and when I attempt to {{{2
Bram Moolenaar85850f32019-07-19 22:05:51 +02003609 browse, the directories are missing trailing "/"s so netrw treats
3610 them as file transfers instead of as attempts to browse
Bram Moolenaar00a927d2010-05-14 23:24:24 +02003611 subdirectories. How may I fix this?
3612
3613 (mikeyao) If you want to use vim via ssh and putty under Windows,
3614 try combining the use of pscp/psftp with plink. pscp/psftp will
3615 be used to connect and plink will be used to execute commands on
3616 the server, for example: list files and directory using 'ls'.
3617
3618 These are the settings I use to do this:
3619>
3620 " list files, it's the key setting, if you haven't set,
3621 " you will get a blank buffer
3622 let g:netrw_list_cmd = "plink HOSTNAME ls -Fa"
3623 " if you haven't add putty directory in system path, you should
3624 " specify scp/sftp command. For examples:
3625 "let g:netrw_sftp_cmd = "d:\\dev\\putty\\PSFTP.exe"
3626 "let g:netrw_scp_cmd = "d:\\dev\\putty\\PSCP.exe"
3627<
Nir Lichtman1e34b952024-05-08 19:19:34 +02003628 *netrw-p13*
3629 P13. I would like to speed up writes using Nwrite and scp/ssh {{{2
Bram Moolenaar251e1912011-06-19 05:09:16 +02003630 style connections. How? (Thomer M. Gil)
Bram Moolenaar00a927d2010-05-14 23:24:24 +02003631
Bram Moolenaar251e1912011-06-19 05:09:16 +02003632 Try using ssh's ControlMaster and ControlPath (see the ssh_config
3633 man page) to share multiple ssh connections over a single network
3634 connection. That cuts out the cryptographic handshake on each
3635 file write, sometimes speeding it up by an order of magnitude.
3636 (see http://thomer.com/howtos/netrw_ssh.html)
3637 (included by permission)
3638
3639 Add the following to your ~/.ssh/config: >
3640
3641 # you change "*" to the hostname you care about
3642 Host *
3643 ControlMaster auto
3644 ControlPath /tmp/%r@%h:%p
3645
3646< Then create an ssh connection to the host and leave it running: >
3647
3648 ssh -N host.domain.com
3649
3650< Now remotely open a file with Vim's Netrw and enjoy the
3651 zippiness: >
3652
3653 vim scp://host.domain.com//home/user/.bashrc
3654<
Nir Lichtman1e34b952024-05-08 19:19:34 +02003655 *netrw-p14*
3656 P14. How may I use a double-click instead of netrw's usual single {{{2
Bram Moolenaar85850f32019-07-19 22:05:51 +02003657 click to open a file or directory? (Ben Fritz)
Bram Moolenaar251e1912011-06-19 05:09:16 +02003658
3659 First, disable netrw's mapping with >
3660 let g:netrw_mousemaps= 0
3661< and then create a netrw buffer only mapping in
3662 $HOME/.vim/after/ftplugin/netrw.vim: >
3663 nmap <buffer> <2-leftmouse> <CR>
3664< Note that setting g:netrw_mousemaps to zero will turn off
3665 all netrw's mouse mappings, not just the <leftmouse> one.
3666 (see |g:netrw_mousemaps|)
Bram Moolenaar00a927d2010-05-14 23:24:24 +02003667
Nir Lichtman1e34b952024-05-08 19:19:34 +02003668 *netrw-p15*
3669 P15. When editing remote files (ex. :e ftp://hostname/path/file), {{{2
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003670 under Windows I get an |E303| message complaining that its unable
Bram Moolenaar13600302014-05-22 18:26:40 +02003671 to open a swap file.
3672
3673 (romainl) It looks like you are starting Vim from a protected
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003674 directory. Start netrw from your $HOME or other writable
Bram Moolenaar13600302014-05-22 18:26:40 +02003675 directory.
3676
Nir Lichtman1e34b952024-05-08 19:19:34 +02003677 *netrw-p16*
3678 P16. Netrw is closing buffers on its own. {{{2
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003679 What steps will reproduce the problem?
3680 1. :Explore, navigate directories, open a file
3681 2. :Explore, open another file
3682 3. Buffer opened in step 1 will be closed. o
3683 What is the expected output? What do you see instead?
3684 I expect both buffers to exist, but only the last one does.
3685
3686 (Lance) Problem is caused by "set autochdir" in .vimrc.
3687 (drchip) I am able to duplicate this problem with |'acd'| set.
3688 It appears that the buffers are not exactly closed;
3689 a ":ls!" will show them (although ":ls" does not).
3690
Nir Lichtman1e34b952024-05-08 19:19:34 +02003691 *netrw-P17*
3692 P17. How to locally edit a file that's only available via {{{2
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003693 another server accessible via ssh?
3694 See http://stackoverflow.com/questions/12469645/
3695 "Using Vim to Remotely Edit A File on ServerB Only
3696 Accessible From ServerA"
3697
Nir Lichtman1e34b952024-05-08 19:19:34 +02003698 *netrw-P18*
3699 P18. How do I get numbering on in directory listings? {{{2
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003700 With |g:netrw_bufsettings|, you can control netrw's buffer
3701 settings; try putting >
3702 let g:netrw_bufsettings="noma nomod nu nobl nowrap ro nornu"
3703< in your .vimrc. If you'd like to have relative numbering
3704 instead, try >
3705 let g:netrw_bufsettings="noma nomod nonu nobl nowrap ro rnu"
3706<
Nir Lichtman1e34b952024-05-08 19:19:34 +02003707 *netrw-P19*
3708 P19. How may I have gvim start up showing a directory listing? {{{2
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003709 Try putting the following code snippet into your .vimrc: >
3710 augroup VimStartup
3711 au!
3712 au VimEnter * if expand("%") == "" && argc() == 0 &&
3713 \ (v:servername =~ 'GVIM\d*' || v:servername == "")
3714 \ | e . | endif
3715 augroup END
3716< You may use Lexplore instead of "e" if you're so inclined.
3717 This snippet assumes that you have client-server enabled
3718 (ie. a "huge" vim version).
3719
Nir Lichtman1e34b952024-05-08 19:19:34 +02003720 *netrw-P20*
3721 P20. I've made a directory (or file) with an accented character, {{{2
Bram Moolenaar85850f32019-07-19 22:05:51 +02003722 but netrw isn't letting me enter that directory/read that file:
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003723
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003724 Its likely that the shell or o/s is using a different encoding
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003725 than you have vim (netrw) using. A patch to vim supporting
3726 "systemencoding" may address this issue in the future; for
3727 now, just have netrw use the proper encoding. For example: >
3728
3729 au FileType netrw set enc=latin1
3730<
Nir Lichtman1e34b952024-05-08 19:19:34 +02003731 *netrw-P21*
3732 P21. I get an error message when I try to copy or move a file: {{{2
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003733
3734 **error** (netrw) tried using g:netrw_localcopycmd<cp>; it doesn't work!
3735
3736 What's wrong?
3737
3738 Netrw uses several system level commands to do things (see
3739
3740 |g:netrw_localcopycmd|, |g:netrw_localmovecmd|,
K.Takata71d0ba02024-01-10 03:21:05 +09003741 |g:netrw_mkdir_cmd|).
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003742
3743 You may need to adjust the default commands for one or more of
3744 these commands by setting them properly in your .vimrc. Another
3745 source of difficulty is that these commands use vim's local
3746 directory, which may not be the same as the browsing directory
3747 shown by netrw (see |g:netrw_keepdir|).
3748
3749
Bram Moolenaarc0197e22004-09-13 20:26:32 +00003750==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +0000375111. Debugging Netrw Itself *netrw-debug* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003753Step 1: check that the problem you've encountered hasn't already been resolved
3754by obtaining a copy of the latest (often developmental) netrw at:
3755
3756 http://www.drchip.org/astronaut/vim/index.html#NETRW
3757
3758The <netrw.vim> script is typically installed on systems as something like:
Bram Moolenaar488c6512005-08-11 20:09:58 +00003759>
Bram Moolenaar8024f932020-01-14 19:29:13 +01003760 /usr/local/share/vim/vim8x/plugin/netrwPlugin.vim
3761 /usr/local/share/vim/vim8x/autoload/netrw.vim
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003762 (see output of :echo &rtp)
Bram Moolenaar488c6512005-08-11 20:09:58 +00003763<
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003764which is loaded automatically at startup (assuming :set nocp). If you
3765installed a new netrw, then it will be located at >
3766
3767 $HOME/.vim/plugin/netrwPlugin.vim
3768 $HOME/.vim/autoload/netrw.vim
3769<
3770Step 2: assuming that you've installed the latest version of netrw,
3771check that your problem is really due to netrw. Create a file
3772called netrw.vimrc with the following contents: >
3773
3774 set nocp
3775 so $HOME/.vim/plugin/netrwPlugin.vim
3776<
3777Then run netrw as follows: >
3778
Bram Moolenaare0fa3742016-02-20 15:47:01 +01003779 vim -u netrw.vimrc --noplugins -i NONE [some path here]
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003780<
3781Perform whatever netrw commands you need to, and check that the problem is
3782still present. This procedure sidesteps any issues due to personal .vimrc
Bram Moolenaare0fa3742016-02-20 15:47:01 +01003783settings, .viminfo file, and other plugins. If the problem does not appear,
3784then you need to determine which setting in your .vimrc is causing the
3785conflict with netrw or which plugin(s) is/are involved.
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003786
3787Step 3: If the problem still is present, then get a debugging trace from
3788netrw:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789
3790 1. Get the <Decho.vim> script, available as:
3791
Bram Moolenaar97d62492012-11-15 21:28:22 +01003792 http://www.drchip.org/astronaut/vim/index.html#DECHO
Bram Moolenaar071d4272004-06-13 20:20:40 +00003793 or
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003794 http://vim.sourceforge.net/scripts/script.php?script_id=120
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003796 Decho.vim is provided as a "vimball"; see |vimball-intro|. You
3797 should edit the Decho.vba.gz file and source it in: >
Bram Moolenaarf6cf9872005-08-08 22:00:59 +00003798
Bram Moolenaar938ae282023-02-20 20:44:55 +00003799 vim Decho.vba.gz
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003800 :so %
3801 :q
3802<
3803 2. To turn on debug tracing in netrw, then edit the <netrw.vim>
3804 file by typing: >
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003805
3806 vim netrw.vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 :DechoOn
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003808 :wq
Bram Moolenaar446cb832008-06-24 21:56:24 +00003809<
3810 To restore to normal non-debugging behavior, re-edit <netrw.vim>
3811 and type >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003813 vim netrw.vim
3814 :DechoOff
3815 :wq
Bram Moolenaar446cb832008-06-24 21:56:24 +00003816<
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003817 This command, provided by <Decho.vim>, will comment out all
3818 Decho-debugging statements (Dfunc(), Dret(), Decho(), Dredir()).
3819
Bram Moolenaar446cb832008-06-24 21:56:24 +00003820 3. Then bring up vim and attempt to evoke the problem by doing a
3821 transfer or doing some browsing. A set of messages should appear
3822 concerning the steps that <netrw.vim> took in attempting to
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01003823 read/write your file over the network in a separate tab or
3824 server vim window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003826 Change the netrw.vimrc file to include the Decho plugin: >
3827
3828 set nocp
3829 so $HOME/.vim/plugin/Decho.vim
3830 so $HOME/.vim/plugin/netrwPlugin.vim
3831<
3832 You should continue to run vim with >
3833
3834 vim -u netrw.vimrc --noplugins -i NONE [some path here]
3835<
3836 to avoid entanglements with options and other plugins.
3837
3838 To save the file: under linux, the output will be in a separate
3839 remote server window; in it, just save the file with >
3840
Bram Moolenaar938ae282023-02-20 20:44:55 +00003841 :w! DBG
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003842
3843< Under a vim that doesn't support clientserver, your debugging
3844 output will appear in another tab: >
Bram Moolenaar8d043172014-01-23 14:24:41 +01003845
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003846 :tabnext
Bram Moolenaar9964e462007-05-05 17:54:07 +00003847 :set bt=
3848 :w! DBG
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003849<
3850 Furthermore, it'd be helpful if you would type >
Bram Moolenaar8d043172014-01-23 14:24:41 +01003851
Bram Moolenaara6878372014-03-22 21:02:50 +01003852 :Dsep <command>
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003853
Bram Moolenaara6878372014-03-22 21:02:50 +01003854< where <command> is the command you're about to type next,
3855 thereby making it easier to associate which part of the
3856 debugging trace is due to which command.
Bram Moolenaar8d043172014-01-23 14:24:41 +01003857
Christian Brabandtc5e24ee2024-07-13 18:19:03 +02003858 For bug reports, please see |bugs|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859==============================================================================
Bram Moolenaar9964e462007-05-05 17:54:07 +0000386012. History *netrw-history* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861
K.Takata71d0ba02024-01-10 03:21:05 +09003862 v172: Sep 02, 2021 * (Bram Moolenaar) Changed "l:go" to "go"
3863 * (Bram Moolenaar) no need for "b" in
3864 netrw-safe guioptions
3865 Nov 15, 2021 * removed netrw_localrm and netrw_localrmdir
3866 references
zeertzjq8feed3a2024-09-29 10:37:47 +02003867 Aug 18, 2022 * (Miguel Barro) improving compatibility with
K.Takata71d0ba02024-01-10 03:21:05 +09003868 powershell
Bram Moolenaar89a9c152021-08-29 21:55:35 +02003869 v171: Oct 09, 2020 * included code in s:NetrwOptionsSafe()
3870 to allow |'bh'| to be set to delete when
3871 rather than hide when g:netrw_fastbrowse
3872 was zero.
3873 * Installed |g:netrw_clipboard| setting
3874 * Installed option bypass for |'guioptions'|
3875 a/A settings
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01003876 * Changed popup_beval() to |popup_atcursor()|
Bram Moolenaar89a9c152021-08-29 21:55:35 +02003877 in netrw#ErrorMsg (lacygoill). Apparently
3878 popup_beval doesn't reliably close the
3879 popup when the mouse is moved.
3880 * VimEnter() now using win_execute to examine
3881 buffers for an attempt to open a directory.
3882 Avoids issues with popups/terminal from
3883 command line. (lacygoill)
3884 Jun 28, 2021 * (zeertzjq) provided a patch for use of
3885 xmap,xno instead of vmap,vno in
3886 netrwPlugin.vim. Avoids entanglement with
3887 select mode.
3888 Jul 14, 2021 * Fixed problem addressed by tst976; opening
3889 a file using tree mode, going up a
3890 directory, and opening a file there was
3891 opening the file in the wrong directory.
3892 Jul 28, 2021 * (Ingo Karkat) provided a patch fixing an
3893 E488 error with netrwPlugin.vim
3894 (occurred for vim versions < 8.02)
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003895 v170: Mar 11, 2020 * (reported by Reiner Herrmann) netrw+tree
3896 would not hide with the ^\..* pattern
3897 correctly.
3898 * (Marcin Szamotulski) NetrwOptionRestore
3899 did not restore options correctly that
3900 had a single quote in the option string.
3901 Apr 13, 2020 * implemented error handling via popup
3902 windows (see |popup_beval()|)
3903 Apr 30, 2020 * (reported by Manatsu Takahashi) while
3904 using Lexplore, a modified file could
3905 be overwritten. Sol'n: will not overwrite,
3906 but will emit an |E37| (although one cannot
3907 add an ! to override)
3908 Jun 07, 2020 * (reported by Jo Totland) repeatedly invoking
3909 :Lexplore and quitting it left unused
3910 hidden buffers. Netrw will now set netrw
Bram Moolenaar89a9c152021-08-29 21:55:35 +02003911 buffers created by :Lexplore to |'bh'|=wipe.
Bram Moolenaar29634562020-01-09 21:46:04 +01003912 v169: Dec 20, 2019 * (reported by amkarthik) that netrw's x
3913 (|netrw-x|) would throw an error when
3914 attempting to open a local directory.
3915 v168: Dec 12, 2019 * scp timeout error message not reported,
3916 hopefully now fixed (Shane Xb Qian)
Bram Moolenaar91359012019-11-30 17:57:03 +01003917 v167: Nov 29, 2019 * netrw does a save&restore on @* and @+.
3918 That causes problems with the clipboard.
3919 Now restores occurs only if @* or @+ have
3920 been changed.
3921 * netrw will change @* or @+ less often.
3922 Never if I happen to have caught all the
3923 operations that modify the unnamed
3924 register (which also writes @*).
3925 * Modified hiding behavior so that "s"
3926 will not ignore hiding.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01003927 v166: Nov 06, 2019 * Removed a space from a nmap for "-"
3928 * Numerous debugging statement changes
Bram Moolenaar85850f32019-07-19 22:05:51 +02003929 v163: Dec 05, 2017 * (Cristi Balan) reported that a setting ('sel')
3930 was left changed
3931 * (Holger Mitschke) reported a problem with
3932 saving and restoring history. Fixed.
3933 * Hopefully I fixed a nasty bug that caused a
3934 file rename to wipe out a buffer that it
3935 should not have wiped out.
3936 * (Holger Mitschke) amended this help file
3937 with additional |g:netrw_special_syntax|
3938 items
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01003939 * Prioritized wget over curl for
3940 g:netrw_http_cmd
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003941 v162: Sep 19, 2016 * (haya14busa) pointed out two syntax errors
3942 with a patch; these are now fixed.
3943 Oct 26, 2016 * I started using mate-terminal and found that
3944 x and gx (|netrw-x| and |netrw-gx|) were no
3945 longer working. Fixed (using atril when
3946 $DESKTOP_SESSION is "mate").
3947 Nov 04, 2016 * (Martin Vuille) pointed out that @+ was
3948 being restored with keepregstar rather than
3949 keepregplus.
3950 Nov 09, 2016 * Broke apart the command from the options,
3951 mostly for Windows. Introduced new netrw
3952 settings: |g:netrw_localcopycmdopt|
Bram Moolenaarb7398fe2023-05-14 18:50:25 +01003953 |g:netrw_localcopydircmdopt|
3954 |g:netrw_localmkdiropt|
3955 |g:netrw_localmovecmdopt|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003956 Nov 21, 2016 * (mattn) provided a patch for preview; swapped
3957 winwidth() with winheight()
3958 Nov 22, 2016 * (glacambre) reported that files containing
3959 spaces weren't being obtained properly via
3960 scp. Fix: apparently using single quotes
3961 such as with 'file name' wasn't enough; the
3962 spaces inside the quotes also had to be
3963 escaped (ie. 'file\ name').
3964 * Also fixed obtain (|netrw-O|) to be able to
3965 obtain files with spaces in their names
3966 Dec 20, 2016 * (xc1427) Reported that using "I" (|netrw-I|)
3967 when atop "Hiding" in the banner also caused
3968 the active-banner hiding control to occur
3969 Jan 03, 2017 * (Enno Nagel) reported that attempting to
3970 apply netrw to a directory that was without
3971 read permission caused a syntax error.
3972 Jan 13, 2017 * (Ingo Karkat) provided a patch which makes
3973 using netrw#Call() better. Now returns
3974 value of internal routines return, for example.
3975 Jan 13, 2017 * (Ingo Karkat) changed netrw#FileUrlRead to
3976 use |:edit| instead of |:read|. I also
3977 changed the routine name to netrw#FileUrlEdit.
3978 Jan 16, 2017 * (Sayem) reported a problem where :Lexplore
3979 could generate a new listing buffer and
3980 window instead of toggling the netrw display.
3981 Unfortunately, the directions for eliciting
3982 the problem weren't complete, so I may or
3983 may not have fixed that issue.
3984 Feb 06, 2017 * Implemented cb and cB. Changed "c" to "cd".
3985 (see |netrw-cb|, |netrw-cB|, and |netrw-cd|)
3986 Mar 21, 2017 * previously, netrw would specify (safe) settings
3987 even when the setting was already safe for
3988 netrw. Netrw now attempts to leave such
3989 already-netrw-safe settings alone.
3990 (affects s:NetrwOptionRestore() and
3991 s:NetrwSafeOptions(); also introduced
3992 s:NetrwRestoreSetting())
3993 Jun 26, 2017 * (Christian Brabandt) provided a patch to
3994 allow curl to follow redirects (ie. -L
3995 option)
3996 Jun 26, 2017 * (Callum Howard) reported a problem with
3997 :Lexpore not removing the Lexplore window
3998 after a change-directory
3999 Aug 30, 2017 * (Ingo Karkat) one cannot switch to the
4000 previously edited file (e.g. with CTRL-^)
4001 after editing a file:// URL. Patch to
4002 have a "keepalt" included.
4003 Oct 17, 2017 * (Adam Faryna) reported that gn (|netrw-gn|)
4004 did not work on directories in the current
4005 tree
4006 v157: Apr 20, 2016 * (Nicola) had set up a "nmap <expr> ..." with
4007 a function that returned a 0 while silently
4008 invoking a shell command. The shell command
4009 activated a ShellCmdPost event which in turn
4010 called s:LocalBrowseRefresh(). That looks
4011 over all netrw buffers for changes needing
4012 refreshes. However, inside a |:map-<expr>|,
4013 tab and window changes are disallowed. Fixed.
4014 (affects netrw's s:LocalBrowseRefresh())
K.Takata71d0ba02024-01-10 03:21:05 +09004015 * g:netrw_localrmdir not used any more, but
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004016 the relevant patch that causes |delete()| to
4017 take over was #1107 (not #1109).
4018 * |expand()| is now used on |g:netrw_home|;
4019 consequently, g:netrw_home may now use
4020 environment variables
4021 * s:NetrwLeftmouse and s:NetrwCLeftmouse will
4022 return without doing anything if invoked
4023 when inside a non-netrw window
4024 Jun 15, 2016 * gx now calls netrw#GX() which returns
4025 the word under the cursor. The new
4026 wrinkle: if one is in a netrw buffer,
4027 then netrw's s:NetrwGetWord().
4028 Jun 22, 2016 * Netrw was executing all its associated
4029 Filetype commands silently; I'm going
4030 to try doing that "noisily" and see if
4031 folks have a problem with that.
4032 Aug 12, 2016 * Changed order of tool selection for
4033 handling http://... viewing.
4034 (Nikolay Aleksandrovich Pavlov)
4035 Aug 21, 2016 * Included hiding/showing/all for tree
4036 listings
4037 * Fixed refresh (^L) for tree listings
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004038 v156: Feb 18, 2016 * Changed =~ to =~# where appropriate
4039 Feb 23, 2016 * s:ComposePath(base,subdir) now uses
4040 fnameescape() on the base portion
4041 Mar 01, 2016 * (gt_macki) reported where :Explore would
4042 make file unlisted. Fixed (tst943)
4043 Apr 04, 2016 * (reported by John Little) netrw normally
4044 suppresses browser messages, but sometimes
4045 those "messages" are what is wanted.
4046 See |g:netrw_suppress_gx_mesg|
4047 Apr 06, 2016 * (reported by Carlos Pita) deleting a remote
4048 file was giving an error message. Fixed.
4049 Apr 08, 2016 * (Charles Cooper) had a problem with an
4050 undefined b:netrw_curdir. He also provided
4051 a fix.
4052 Apr 20, 2016 * Changed s:NetrwGetBuffer(); now uses
4053 dictionaries. Also fixed the "No Name"
4054 buffer problem.
Bram Moolenaare0fa3742016-02-20 15:47:01 +01004055 v155: Oct 29, 2015 * (Timur Fayzrakhmanov) reported that netrw's
4056 mapping of ctrl-l was not allowing refresh of
4057 other windows when it was done in a netrw
4058 window.
4059 Nov 05, 2015 * Improved s:TreeSqueezeDir() to use search()
4060 instead of a loop
4061 * NetrwBrowse() will return line to
4062 w:netrw_bannercnt if cursor ended up in
4063 banner
4064 Nov 16, 2015 * Added a <Plug>NetrwTreeSqueeze (|netrw-s-cr|)
4065 Nov 17, 2015 * Commented out imaps -- perhaps someone can
4066 tell me how they're useful and should be
4067 retained?
4068 Nov 20, 2015 * Added |netrw-ma| and |netrw-mA| support
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004069 Nov 20, 2015 * gx (|netrw-gx|) on a URL downloaded the
Bram Moolenaare0fa3742016-02-20 15:47:01 +01004070 file in addition to simply bringing up the
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004071 URL in a browser. Fixed.
Bram Moolenaare0fa3742016-02-20 15:47:01 +01004072 Nov 23, 2015 * Added |g:netrw_sizestyle| support
4073 Nov 27, 2015 * Inserted a lot of <c-u>s into various netrw
4074 maps.
4075 Jan 05, 2016 * |netrw-qL| implemented to mark files based
4076 upon |location-list|s; similar to |netrw-qF|.
4077 Jan 19, 2016 * using - call delete(directoryname,"d") -
4078 instead of using g:netrw_localrmdir if
4079 v7.4 + patch#1107 is available
4080 Jan 28, 2016 * changed to using |winsaveview()| and
4081 |winrestview()|
4082 Jan 28, 2016 * s:NetrwTreePath() now does a save and
4083 restore of view
4084 Feb 08, 2016 * Fixed a tree-listing problem with remote
4085 directories
Bram Moolenaara0f849e2015-10-30 14:37:44 +01004086 v154: Feb 26, 2015 * (Yuri Kanivetsky) reported a situation where
4087 a file was not treated properly as a file
4088 due to g:netrw_keepdir == 1
4089 Mar 25, 2015 * (requested by Ben Friz) one may now sort by
4090 extension
4091 Mar 28, 2015 * (requested by Matt Brooks) netrw has a lot
4092 of buffer-local mappings; however, some
4093 plugins (such as vim-surround) set up
4094 conflicting mappings that cause vim to wait.
4095 The "<nowait>" modifier has been included
4096 with most of netrw's mappings to avoid that
4097 delay.
zeertzjq8feed3a2024-09-29 10:37:47 +02004098 Jun 26, 2015 * |netrw-gn| mapping implemented
Bram Moolenaara0f849e2015-10-30 14:37:44 +01004099 * :Ntree NotADir resulted in having
4100 the tree listing expand in the error messages
4101 window. Fixed.
4102 Jun 29, 2015 * Attempting to delete a file remotely caused
4103 an error with "keepsol" mentioned; fixed.
4104 Jul 08, 2015 * Several changes to keep the |:jumps| table
4105 correct when working with
4106 |g:netrw_fastbrowse| set to 2
4107 * wide listing with accented characters fixed
4108 (using %-S instead of %-s with a |printf()|
4109 Jul 13, 2015 * (Daniel Hahler) CheckIfKde() could be true
4110 but kfmclient not installed. Changed order
4111 in netrw#BrowseX(): checks if kde and
4112 kfmclient, then will use xdg-open on a unix
4113 system (if xdg-open is executable)
4114 Aug 11, 2015 * (McDonnell) tree listing mode wouldn't
4115 select a file in a open subdirectory.
4116 * (McDonnell) when multiple subdirectories
4117 were concurrently open in tree listing
4118 mode, a ctrl-L wouldn't refresh properly.
4119 * The netrw:target menu showed duplicate
4120 entries
4121 Oct 13, 2015 * (mattn) provided an exception to handle
4122 windows with shellslash set but no shell
4123 Oct 23, 2015 * if g:netrw_usetab and <c-tab> now used
4124 to control whether NetrwShrink is used
4125 (see |netrw-c-tab|)
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01004126 v153: May 13, 2014 * added another |g:netrw_ffkeep| usage {{{2
4127 May 14, 2014 * changed s:PerformListing() so that it
4128 always sets ft=netrw for netrw buffers
4129 (ie. even when syntax highlighting is
4130 off, not available, etc)
4131 May 16, 2014 * introduced the |netrw-ctrl-r| functionality
4132 May 17, 2014 * introduced the |netrw-:NetrwMB| functionality
4133 * mb and mB (|netrw-mb|, |netrw-mB|) will
4134 add/remove marked files from bookmark list
4135 May 20, 2014 * (Enno Nagel) reported that :Lex <dirname>
4136 wasn't working. Fixed.
4137 May 26, 2014 * restored test to prevent leftmouse window
4138 resizing from causing refresh.
4139 (see s:NetrwLeftmouse())
4140 * fixed problem where a refresh caused cursor
4141 to go just under the banner instead of
4142 staying put
4143 May 28, 2014 * (László Bimba) provided a patch for opening
4144 the |:Lexplore| window 100% high, optionally
4145 on the right, and will work with remote
4146 files.
4147 May 29, 2014 * implemented :NetrwC (see |netrw-:NetrwC|)
4148 Jun 01, 2014 * Removed some "silent"s from commands used
4149 to implemented scp://... and pscp://...
4150 directory listing. Permits request for
4151 password to appear.
4152 Jun 05, 2014 * (Enno Nagel) reported that user maps "/"
4153 caused problems with "b" and "w", which
4154 are mapped (for wide listings only) to
4155 skip over files rather than just words.
4156 Jun 10, 2014 * |g:netrw_gx| introduced to allow users to
4157 override default "<cfile>" with the gx
4158 (|netrw-gx|) map
4159 Jun 11, 2014 * gx (|netrw-gx|), with |'autowrite'| set,
4160 will write modified files. s:NetrwBrowseX()
4161 will now save, turn off, and restore the
4162 |'autowrite'| setting.
4163 Jun 13, 2014 * added visual map for gx use
4164 Jun 15, 2014 * (Enno Nagel) reported that with having hls
4165 set and wide listing style in use, that the
4166 b and w maps caused unwanted highlighting.
4167 Jul 05, 2014 * |netrw-mv| and |netrw-mX| commands included
4168 Jul 09, 2014 * |g:netrw_keepj| included, allowing optional
4169 keepj
4170 Jul 09, 2014 * fixing bugs due to previous update
4171 Jul 21, 2014 * (Bruno Sutic) provided an updated
4172 netrw_gitignore.vim
4173 Jul 30, 2014 * (Yavuz Yetim) reported that editing two
4174 remote files of the same name caused the
4175 second instance to have a "temporary"
4176 name. Fixed: now they use the same buffer.
4177 Sep 18, 2014 * (Yasuhiro Matsumoto) provided a patch which
4178 allows scp and windows local paths to work.
4179 Oct 07, 2014 * gx (see |netrw-gx|) when atop a directory,
4180 will now do |gf| instead
4181 Nov 06, 2014 * For cygwin: cygstart will be available for
4182 netrw#BrowseX() to use if its executable.
4183 Nov 07, 2014 * Began support for file://... urls. Will use
4184 |g:netrw_file_cmd| (typically elinks or links)
4185 Dec 02, 2014 * began work on having mc (|netrw-mc|) copy
4186 directories. Works for linux machines,
4187 cygwin+vim, but not for windows+gvim.
4188 Dec 02, 2014 * in tree mode, netrw was not opening
4189 directories via symbolic links.
4190 Dec 02, 2014 * added resolved link information to
4191 thin and tree modes
4192 Dec 30, 2014 * (issue#231) |:ls| was not showing
4193 remote-file buffers reliably. Fixed.
4194 v152: Apr 08, 2014 * uses the |'noswapfile'| option (requires {{{2
Bram Moolenaar13600302014-05-22 18:26:40 +02004195 vim 7.4 with patch 213)
4196 * (Enno Nagel) turn |'rnu'| off in netrw
4197 buffers.
4198 * (Quinn Strahl) suggested that netrw
4199 allow regular window splitting to occur,
4200 thereby allowing |'equalalways'| to take
4201 effect.
4202 * (qingtian zhao) normally, netrw will
4203 save and restore the |'fileformat'|;
4204 however, sometimes that isn't wanted
4205 Apr 14, 2014 * whenever netrw marks a buffer as ro,
4206 it will also mark it as nomod.
4207 Apr 16, 2014 * sftp protocol now supported by
4208 netrw#Obtain(); this means that one
4209 may use "mc" to copy a remote file
4210 to a local file using sftp, and that
4211 the |netrw-O| command can obtain remote
4212 files via sftp.
4213 * added [count]C support (see |netrw-C|)
4214 Apr 18, 2014 * when |g:netrw_chgwin| is one more than
4215 the last window, then vertically split
4216 the last window and use it as the
4217 chgwin window.
4218 May 09, 2014 * SavePosn was "saving filename under cursor"
4219 from a non-netrw window when using :Rex.
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01004220 v151: Jan 22, 2014 * extended :Rexplore to return to buffer {{{2
Bram Moolenaara6878372014-03-22 21:02:50 +01004221 prior to Explore or editing a directory
4222 * (Ken Takata) netrw gave error when
4223 clipboard was disabled. Sol'n: Placed
4224 several if has("clipboard") tests in.
4225 * Fixed ftp://X@Y@Z// problem; X@Y now
4226 part of user id, and only Z is part of
4227 hostname.
4228 * (A Loumiotis) reported that completion
4229 using a directory name containing spaces
4230 did not work. Fixed with a retry in
4231 netrw#Explore() which removes the
4232 backslashes vim inserted.
4233 Feb 26, 2014 * :Rexplore now records the current file
4234 using w:netrw_rexfile when returning via
4235 |:Rexplore|
4236 Mar 08, 2014 * (David Kotchan) provided some patches
4237 allowing netrw to work properly with
4238 windows shares.
4239 * Multiple one-liner help messages available
4240 by pressing <cr> while atop the "Quick
4241 Help" line
4242 * worked on ShellCmdPost, FocusGained event
4243 handling.
4244 * |:Lexplore| path: will be used to update
4245 a left-side netrw browsing directory.
Bram Moolenaare0fa3742016-02-20 15:47:01 +01004246 Mar 12, 2014 * |netrw-s-cr|: use <s-cr> to close
Bram Moolenaara6878372014-03-22 21:02:50 +01004247 tree directory implemented
4248 Mar 13, 2014 * (Tony Mechylynck) reported that using
4249 the browser with ftp on a directory,
4250 and selecting a gzipped txt file, that
4251 an E19 occurred (which was issued by
4252 gzip.vim). Fixed.
4253 Mar 14, 2014 * Implemented :MF and :MT (see |netrw-:MF|
4254 and |netrw-:MT|, respectively)
4255 Mar 17, 2014 * |:Ntree| [dir] wasn't working properly; fixed
4256 Mar 18, 2014 * Changed all uses of set to setl
4257 Mar 18, 2014 * Commented the netrw_btkeep line in
4258 s:NetrwOptionSave(); the effect is that
4259 netrw buffers will remain as |'bt'|=nofile.
4260 This should prevent swapfiles being created
4261 for netrw buffers.
4262 Mar 20, 2014 * Changed all uses of lcd to use s:NetrwLcd()
4263 instead. Consistent error handling results
4264 and it also handles Window's shares
4265 * Fixed |netrw-d| command when applied with ftp
4266 * https: support included for netrw#NetRead()
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01004267 v150: Jul 12, 2013 * removed a "keepalt" to allow ":e #" to {{{2
Bram Moolenaar8d043172014-01-23 14:24:41 +01004268 return to the netrw directory listing
4269 Jul 13, 2013 * (Jonas Diemer) suggested changing
4270 a <cWORD> to <cfile>.
4271 Jul 21, 2013 * (Yuri Kanivetsky) reported that netrw's
4272 use of mkdir did not produce directories
Bram Moolenaara6878372014-03-22 21:02:50 +01004273 following the user's umask.
Bram Moolenaar8d043172014-01-23 14:24:41 +01004274 Aug 27, 2013 * introduced |g:netrw_altfile| option
4275 Sep 05, 2013 * s:Strlen() now uses |strdisplaywidth()|
4276 when available, by default
4277 Sep 12, 2013 * (Selyano Baldo) reported that netrw wasn't
4278 opening some directories properly from the
4279 command line.
4280 Nov 09, 2013 * |:Lexplore| introduced
4281 * (Ondrej Platek) reported an issue with
4282 netrw's trees (P15). Fixed.
4283 * (Jorge Solis) reported that "t" in
4284 tree mode caused netrw to forget its
4285 line position.
4286 Dec 05, 2013 * Added <s-leftmouse> file marking
4287 (see |netrw-mf|)
4288 Dec 05, 2013 * (Yasuhiro Matsumoto) Explore should use
4289 strlen() instead s:Strlen() when handling
4290 multibyte chars with strpart()
4291 (ie. strpart() is byte oriented, not
4292 display-width oriented).
4293 Dec 09, 2013 * (Ken Takata) Provided a patch; File sizes
4294 and a portion of timestamps were wrongly
4295 highlighted with the directory color when
4296 setting `:let g:netrw_liststyle=1` on Windows.
4297 * (Paul Domaskis) noted that sometimes
4298 cursorline was activating in non-netrw
4299 windows. All but one setting of cursorline
4300 was done via setl; there was one that was
4301 overlooked. Fixed.
4302 Dec 24, 2013 * (esquifit) asked that netrw allow the
4303 /cygdrive prefix be a user-alterable
4304 parameter.
4305 Jan 02, 2014 * Fixed a problem with netrw-based ballon
4306 evaluation (ie. netrw#NetrwBaloonHelp()
4307 not having been loaded error messages)
4308 Jan 03, 2014 * Fixed a problem with tree listings
4309 * New command installed: |:Ntree|
4310 Jan 06, 2014 * (Ivan Brennan) reported a problem with
4311 |netrw-P|. Fixed.
4312 Jan 06, 2014 * Fixed a problem with |netrw-P| when the
4313 modified file was to be abandoned.
4314 Jan 15, 2014 * (Matteo Cavalleri) reported that when the
4315 banner is suppressed and tree listing is
4316 used, a blank line was left at the top of
4317 the display. Fixed.
4318 Jan 20, 2014 * (Gideon Go) reported that, in tree listing
4319 style, with a previous window open, that
4320 the wrong directory was being used to open
4321 a file. Fixed. (P21)
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01004322 v149: Apr 18, 2013 * in wide listing format, now have maps for {{{2
Bram Moolenaare6ae6222013-05-21 21:01:10 +02004323 w and b to move to next/previous file
4324 Apr 26, 2013 * one may now copy files in the same
4325 directory; netrw will issue requests for
4326 what names the files should be copied under
4327 Apr 29, 2013 * Trying Benzinger's problem again. Seems
4328 that commenting out the BufEnter and
4329 installing VimEnter (only) works. Weird
4330 problem! (tree listing, vim -O Dir1 Dir2)
4331 May 01, 2013 * :Explore ftp://... wasn't working. Fixed.
4332 May 02, 2013 * introduced |g:netrw_bannerbackslash| as
4333 requested by Paul Domaskis.
Bram Moolenaar8d043172014-01-23 14:24:41 +01004334 Jul 03, 2013 * Explore now avoids splitting when a buffer
4335 will be hidden.
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01004336 v148: Apr 16, 2013 * changed Netrw's Style menu to allow direct {{{2
Bram Moolenaarff034192013-04-24 18:51:19 +02004337 choice of listing style, hiding style, and
4338 sorting style
Bram Moolenaar071d4272004-06-13 20:20:40 +00004339
4340==============================================================================
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100434113. Todo *netrw-todo* {{{1
4342
434307/29/09 : banner :|g:netrw_banner| can be used to suppress the
4344 suppression banner. This feature is new and experimental,
4345 so its in the process of being debugged.
434609/04/09 : "gp" : See if it can be made to work for remote systems.
4347 : See if it can be made to work with marked files.
4348
4349==============================================================================
435014. Credits *netrw-credits* {{{1
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351
4352 Vim editor by Bram Moolenaar (Thanks, Bram!)
4353 dav support by C Campbell
4354 fetch support by Bram Moolenaar and C Campbell
Bram Moolenaar29634562020-01-09 21:46:04 +01004355 ftp support by C Campbell <NcampObell@SdrPchip.AorgM-NOSPAM>
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 http support by Bram Moolenaar <bram@moolenaar.net>
4357 rcp
4358 rsync support by C Campbell (suggested by Erik Warendorph)
4359 scp support by raf <raf@comdyn.com.au>
4360 sftp support by C Campbell
4361
4362 inputsecret(), BufReadCmd, BufWriteCmd contributed by C Campbell
4363
4364 Jérôme Augé -- also using new buffer method with ftp+.netrc
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004365 Bram Moolenaar -- obviously vim itself, :e and v:cmdarg use,
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00004366 fetch,...
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 Yasuhiro Matsumoto -- pointing out undo+0r problem and a solution
4368 Erik Warendorph -- for several suggestions (g:netrw_..._cmd
4369 variables, rsync etc)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004370 Doug Claar -- modifications to test for success with ftp
Bram Moolenaar7aa9f6a2007-05-10 18:00:30 +00004371 operation
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372
4373==============================================================================
Bram Moolenaar446cb832008-06-24 21:56:24 +00004374Modelines: {{{1
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02004375vim:tw=78:ts=8:ft=help:noet:norl:fdm=marker