Mercurial > vim
annotate runtime/doc/pi_netrw.txt @ 5734:657ade71d395
Updated runtime files.
| author | Bram Moolenaar <bram@vim.org> |
|---|---|
| date | Sat, 22 Mar 2014 21:02:50 +0100 |
| parents | 350272cbf1fd |
| children | 16d26051085a |
| rev | line source |
|---|---|
| 5734 | 1 *pi_netrw.txt* For Vim version 7.4. Last change: 2014 Mar 20 |
| 4339 | 2 |
| 3 ------------------------------------------------ | |
| 4 NETRW REFERENCE MANUAL by Charles E. Campbell | |
| 5 ------------------------------------------------ | |
| 6 Author: Charles E. Campbell <NdrOchip@ScampbellPfamily.AbizM> | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
7 (remove NOSPAM from Campbell's email first) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
8 |
| 5618 | 9 Copyright: Copyright (C) 1999-2014 Charles E Campbell *netrw-copyright* |
| 3456 | 10 The VIM LICENSE applies to the files in this package, including |
| 11 netrw.vim, pi_netrw.txt, netrwFileHandlers.vim, netrwSettings.vim, and | |
| 12 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 | |
| 18 software. Use at your own risk! | |
| 7 | 19 |
| 559 | 20 |
| 2152 | 21 *dav* *ftp* *netrw-file* *rcp* *scp* |
| 22 *davs* *http* *netrw.vim* *rsync* *sftp* | |
| 23 *fetch* *netrw* *network* | |
| 7 | 24 |
| 25 ============================================================================== | |
| 1621 | 26 1. Contents *netrw-contents* {{{1 |
| 7 | 27 |
| 4339 | 28 1. Contents..............................................|netrw-contents| |
| 29 2. Starting With Netrw...................................|netrw-start| | |
| 30 3. 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| | |
| 39 4. Network-Oriented File Transfer........................|netrw-xfer| | |
| 40 NETRC...............................................|netrw-netrc| | |
| 41 PASSWORD............................................|netrw-passwd| | |
| 42 5. Activation............................................|netrw-activate| | |
| 43 6. Transparent Remote File Editing.......................|netrw-transparent| | |
| 44 7. Ex Commands...........................................|netrw-ex| | |
| 45 8. Variables and Options.................................|netrw-variables| | |
| 46 9. Browsing..............................................|netrw-browse| | |
| 47 Introduction To Browsing............................|netrw-intro-browse| | |
| 48 Quick Reference: Maps...............................|netrw-browse-maps| | |
| 49 Quick Reference: Commands...........................|netrw-browse-cmds| | |
| 50 Bookmarking A Directory.............................|netrw-mb| | |
| 51 Browsing............................................|netrw-cr| | |
| 5734 | 52 Squeezing the Current Tree-Listing Directory......|:netrw-s-cr| |
| 4339 | 53 Browsing With A Horizontally Split Window...........|netrw-o| |
| 54 Browsing With A New Tab.............................|netrw-t| | |
| 55 Browsing With A Vertically Split Window.............|netrw-v| | |
| 56 Change Listing Style.(thin wide long tree)..........|netrw-i| | |
| 57 Changing To A Bookmarked Directory..................|netrw-gb| | |
| 58 Changing To A Predecessor Directory.................|netrw-u| | |
| 59 Changing To A Successor Directory...................|netrw-U| | |
| 60 Customizing Browsing With A User Function...........|netrw-x| | |
| 61 Deleting Bookmarks..................................|netrw-mB| | |
| 62 Deleting Files Or Directories.......................|netrw-D| | |
| 63 Directory Exploring Commands........................|netrw-explore| | |
| 64 Exploring With Stars and Patterns...................|netrw-star| | |
| 65 Displaying Information About File...................|netrw-qf| | |
| 66 Edit File Or Directory Hiding List..................|netrw-ctrl-h| | |
| 67 Editing The Sorting Sequence........................|netrw-S| | |
| 68 Forcing treatment as a file or directory............|netrw-gd| |netrw-gf| | |
| 69 Going Up............................................|netrw--| | |
| 70 Hiding Files Or Directories.........................|netrw-a| | |
| 71 Improving Browsing..................................|netrw-ssh-hack| | |
| 72 Listing Bookmarks And History.......................|netrw-qb| | |
| 73 Making A New Directory..............................|netrw-d| | |
| 74 Making The Browsing Directory The Current Directory.|netrw-c| | |
| 75 Marking Files.......................................|netrw-mf| | |
| 76 Unmarking Files.....................................|netrw-mF| | |
| 77 Marking Files By QuickFix List......................|netrw-qF| | |
| 78 Marking Files By Regular Expression.................|netrw-mr| | |
| 79 Marked Files: Arbitrary Command.....................|netrw-mx| | |
| 80 Marked Files: Compression And Decompression.........|netrw-mz| | |
| 81 Marked Files: Copying...............................|netrw-mc| | |
| 82 Marked Files: Diff..................................|netrw-md| | |
| 83 Marked Files: Editing...............................|netrw-me| | |
| 84 Marked Files: Grep..................................|netrw-mg| | |
| 85 Marked Files: Hiding and Unhiding by Suffix.........|netrw-mh| | |
| 86 Marked Files: Moving................................|netrw-mm| | |
| 87 Marked Files: Printing..............................|netrw-mp| | |
| 88 Marked Files: Sourcing..............................|netrw-ms| | |
| 89 Marked Files: Setting the Target Directory..........|netrw-mt| | |
| 90 Marked Files: Tagging...............................|netrw-mT| | |
| 91 Marked Files: Target Directory Using Bookmarks......|netrw-Tb| | |
| 92 Marked Files: Target Directory Using History........|netrw-Th| | |
| 93 Marked Files: Unmarking.............................|netrw-mu| | |
| 94 Netrw Browser Variables.............................|netrw-browser-var| | |
| 95 Netrw Browsing And Option Incompatibilities.........|netrw-incompatible| | |
| 96 Netrw Settings Window...............................|netrw-settings-window| | |
| 97 Obtaining A File....................................|netrw-O| | |
| 98 Preview Window......................................|netrw-p| | |
| 99 Previous Window.....................................|netrw-P| | |
| 100 Refreshing The Listing..............................|netrw-ctrl-l| | |
| 101 Reversing Sorting Order.............................|netrw-r| | |
| 102 Renaming Files Or Directories.......................|netrw-R| | |
| 103 Selecting Sorting Style.............................|netrw-s| | |
| 104 Setting Editing Window..............................|netrw-C| | |
| 105 10. Problems and Fixes....................................|netrw-problems| | |
| 106 11. Debugging Netrw Itself................................|netrw-debug| | |
| 107 12. History...............................................|netrw-history| | |
| 108 13. Todo..................................................|netrw-todo| | |
| 109 14. Credits...............................................|netrw-credits| | |
| 7 | 110 |
| 111 {Vi does not have any of this} | |
| 112 | |
| 113 ============================================================================== | |
| 1621 | 114 2. Starting With Netrw *netrw-start* {{{1 |
| 115 | |
| 116 Netrw makes reading files, writing files, browsing over a network, and | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
117 local browsing easy! First, make sure that you have plugins enabled, so |
| 1621 | 118 you'll need to have at least the following in your <.vimrc>: |
| 119 (or see |netrw-activate|) > | |
| 650 | 120 |
| 1121 | 121 set nocp " 'compatible' is not set |
| 122 filetype plugin on " plugins are enabled | |
| 650 | 123 < |
| 124 (see |'cp'| and |:filetype-plugin-on|) | |
| 125 | |
| 126 Netrw supports "transparent" editing of files on other machines using urls | |
| 127 (see |netrw-transparent|). As an example of this, let's assume you have an | |
| 1621 | 128 account on some other machine; if you can use scp, try: > |
| 650 | 129 |
| 130 vim scp://hostname/path/to/file | |
| 131 < | |
| 1621 | 132 Want to make ssh/scp easier to use? Check out |netrw-ssh-hack|! |
| 133 | |
| 134 So, what if you have ftp, not ssh/scp? That's easy, too; try > | |
| 650 | 135 |
| 136 vim ftp://hostname/path/to/file | |
| 137 < | |
| 138 Want to make ftp simpler to use? See if your ftp supports a file called | |
| 139 <.netrc> -- typically it goes in your home directory, has read/write | |
| 140 permissions for only the user to read (ie. not group, world, other, etc), | |
| 141 and has lines resembling > | |
| 142 | |
| 143 machine HOSTNAME login USERID password "PASSWORD" | |
| 144 machine HOSTNAME login USERID password "PASSWORD" | |
| 145 ... | |
| 1121 | 146 default login USERID password "PASSWORD" |
| 650 | 147 < |
| 3456 | 148 Windows' ftp doesn't support .netrc; however, one may have in one's .vimrc: > |
| 149 | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
150 let g:netrw_ftp_cmd= 'c:\Windows\System32\ftp -s:C:\Users\MyUserName\MACHINE' |
| 3920 | 151 < |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
152 Netrw will substitute the host's machine name for "MACHINE" from the url it is |
| 3456 | 153 attempting to open, and so one may specify > |
| 154 userid | |
| 155 password | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
156 for each site in a separate file: c:\Users\MyUserName\MachineName. |
| 3456 | 157 |
| 1621 | 158 Now about browsing -- when you just want to look around before editing a |
| 650 | 159 file. For browsing on your current host, just "edit" a directory: > |
| 160 | |
| 161 vim . | |
| 162 vim /home/userid/path | |
| 163 < | |
| 164 For browsing on a remote host, "edit" a directory (but make sure that | |
| 165 the directory name is followed by a "/"): > | |
| 166 | |
| 167 vim scp://hostname/ | |
| 168 vim ftp://hostname/path/to/dir/ | |
| 169 < | |
| 170 See |netrw-browse| for more! | |
| 171 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
172 There are more protocols supported by netrw than just scp and ftp, too: see the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
173 next section, |netrw-externapp|, on how to use these external applications with |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
174 netrw and vim. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
175 |
| 2152 | 176 PREVENTING LOADING *netrw-noload* |
| 1621 | 177 |
| 178 If you want to use plugins, but for some reason don't wish to use netrw, then | |
| 179 you need to avoid loading both the plugin and the autoload portions of netrw. | |
| 180 You may do so by placing the following two lines in your <.vimrc>: > | |
| 181 | |
| 182 :let g:loaded_netrw = 1 | |
| 183 :let g:loaded_netrwPlugin = 1 | |
| 184 < | |
| 650 | 185 |
| 186 ============================================================================== | |
| 2152 | 187 3. Netrw Reference *netrw-ref* {{{1 |
| 1621 | 188 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
189 Netrw supports several protocols in addition to scp and ftp as mentioned |
| 1621 | 190 in |netrw-start|. These include dav, fetch, http,... well, just look |
| 191 at the list in |netrw-externapp|. Each protocol is associated with a | |
| 192 variable which holds the default command supporting that protocol. | |
| 193 | |
| 194 EXTERNAL APPLICATIONS AND PROTOCOLS *netrw-externapp* {{{2 | |
| 7 | 195 |
| 5618 | 196 Protocol Variable Default Value |
| 197 -------- ---------------- ------------- | |
| 198 dav: *g:netrw_dav_cmd* = "cadaver" if cadaver is executable | |
| 199 dav: g:netrw_dav_cmd = "curl -o" elseif curl is available | |
| 200 fetch: *g:netrw_fetch_cmd* = "fetch -o" if fetch is available | |
| 201 ftp: *g:netrw_ftp_cmd* = "ftp" | |
| 202 http: *g:netrw_http_cmd* = "elinks" if elinks is available | |
| 203 http: g:netrw_http_cmd = "links" elseif links is available | |
| 204 http: g:netrw_http_cmd = "curl" elseif curl is available | |
| 205 http: g:netrw_http_cmd = "wget" elseif wget is available | |
| 206 http: g:netrw_http_cmd = "fetch" elseif fetch is available | |
| 207 http: *g:netrw_http_put_cmd* = "curl -T" | |
| 208 rcp: *g:netrw_rcp_cmd* = "rcp" | |
| 209 rsync: *g:netrw_rsync_cmd* = "rsync -a" | |
| 210 scp: *g:netrw_scp_cmd* = "scp -q" | |
| 211 sftp: *g:netrw_sftp_cmd* = "sftp" | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
212 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
213 *g:netrw_http_xcmd* : the option string for http://... protocols are |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
214 specified via this variable and may be independently overridden. By |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
215 default, the option arguments for the http-handling commands are: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
216 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
217 elinks : "-source >" |
| 3920 | 218 links : "-dump >" |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
219 curl : "-o" |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
220 wget : "-q -O" |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
221 fetch : "-o" |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
222 < |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
223 For example, if your system has elinks, and you'd rather see the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
224 page using an attempt at rendering the text, you may wish to have > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
225 let g:netrw_http_xcmd= "-dump >" |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
226 < in your .vimrc. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
227 |
| 5618 | 228 g:netrw_http_put_cmd: this option specifies both the executable and |
| 229 any needed options. This command does a PUT operation to the url. | |
| 230 | |
| 7 | 231 |
| 1621 | 232 READING *netrw-read* *netrw-nread* {{{2 |
| 233 | |
| 234 Generally, one may just use the url notation with a normal editing | |
| 235 command, such as > | |
| 236 | |
| 237 :e ftp://[user@]machine/path | |
| 238 < | |
| 239 Netrw also provides the Nread command: | |
| 240 | |
| 7 | 241 :Nread ? give help |
| 22 | 242 :Nread "machine:path" uses rcp |
| 482 | 243 :Nread "machine path" uses ftp w/ <.netrc> |
| 22 | 244 :Nread "machine id password path" uses ftp |
| 245 :Nread "dav://machine[:port]/path" uses cadaver | |
| 246 :Nread "fetch://[user@]machine/path" uses fetch | |
| 482 | 247 :Nread "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc> |
| 22 | 248 :Nread "http://[user@]machine/path" uses http uses wget |
| 249 :Nread "rcp://[user@]machine/path" uses rcp | |
| 250 :Nread "rsync://[user@]machine[:port]/path" uses rsync | |
| 251 :Nread "scp://[user@]machine[[:#]port]/path" uses scp | |
| 252 :Nread "sftp://[user@]machine/path" uses sftp | |
| 7 | 253 |
| 1621 | 254 WRITING *netrw-write* *netrw-nwrite* {{{2 |
| 255 | |
| 256 One may just use the url notation with a normal file writing | |
| 257 command, such as > | |
| 258 | |
| 259 :w ftp://[user@]machine/path | |
| 260 < | |
| 261 Netrw also provides the Nwrite command: | |
| 262 | |
| 794 | 263 :Nwrite ? give help |
| 22 | 264 :Nwrite "machine:path" uses rcp |
| 482 | 265 :Nwrite "machine path" uses ftp w/ <.netrc> |
| 22 | 266 :Nwrite "machine id password path" uses ftp |
| 267 :Nwrite "dav://machine[:port]/path" uses cadaver | |
| 482 | 268 :Nwrite "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc> |
| 22 | 269 :Nwrite "rcp://[user@]machine/path" uses rcp |
| 270 :Nwrite "rsync://[user@]machine[:port]/path" uses rsync | |
| 271 :Nwrite "scp://[user@]machine[[:#]port]/path" uses scp | |
| 272 :Nwrite "sftp://[user@]machine/path" uses sftp | |
| 7 | 273 http: not supported! |
| 274 | |
| 1621 | 275 SOURCING *netrw-source* {{{2 |
| 276 | |
| 277 One may just use the url notation with the normal file sourcing | |
| 278 command, such as > | |
| 279 | |
| 280 :so ftp://[user@]machine/path | |
| 281 < | |
| 282 Netrw also provides the Nsource command: | |
| 283 | |
| 1121 | 284 :Nsource ? give help |
| 285 :Nsource "dav://machine[:port]/path" uses cadaver | |
| 286 :Nsource "fetch://[user@]machine/path" uses fetch | |
| 287 :Nsource "ftp://[user@]machine[[:#]port]/path" uses ftp w/ <.netrc> | |
| 288 :Nsource "http://[user@]machine/path" uses http uses wget | |
| 289 :Nsource "rcp://[user@]machine/path" uses rcp | |
| 290 :Nsource "rsync://[user@]machine[:port]/path" uses rsync | |
| 291 :Nsource "scp://[user@]machine[[:#]port]/path" uses scp | |
| 292 :Nsource "sftp://[user@]machine/path" uses sftp | |
| 293 | |
| 4339 | 294 DIRECTORY LISTING *netrw-trailingslash* *netrw-dirlist* {{{2 |
| 1621 | 295 |
| 296 One may browse a directory to get a listing by simply attempting to | |
| 297 edit the directory: > | |
| 298 | |
| 299 :e scp://[user]@hostname/path/ | |
| 300 :e ftp://[user]@hostname/path/ | |
| 301 < | |
| 2908 | 302 For remote directory listings (ie. those using scp or ftp), that |
| 303 trailing "/" is necessary (the slash tells netrw to treat the argument | |
| 304 as a directory to browse instead of as a file to download). | |
| 305 | |
| 306 The Nread command may also be used to accomplish this (again, that | |
| 307 trailing slash is necessary): > | |
| 308 | |
| 309 :Nread [protocol]://[user]@hostname/path/ | |
| 310 < | |
| 1621 | 311 *netrw-login* *netrw-password* |
| 312 CHANGING USERID AND PASSWORD *netrw-chgup* *netrw-userpass* {{{2 | |
| 1209 | 313 |
| 7 | 314 Attempts to use ftp will prompt you for a user-id and a password. |
| 3153 | 315 These will be saved in global variables |g:netrw_uid| and |
| 316 |s:netrw_passwd|; subsequent use of ftp will re-use those two strings, | |
| 317 thereby simplifying use of ftp. However, if you need to use a | |
| 318 different user id and/or password, you'll want to call |NetUserPass()| | |
| 1209 | 319 first. To work around the need to enter passwords, check if your ftp |
| 320 supports a <.netrc> file in your home directory. Also see | |
| 321 |netrw-passwd| (and if you're using ssh/scp hoping to figure out how | |
| 3153 | 322 to not need to use passwords for scp, look at |netrw-ssh-hack|). |
| 7 | 323 |
| 324 :NetUserPass [uid [password]] -- prompts as needed | |
| 325 :call NetUserPass() -- prompts for uid and password | |
| 326 :call NetUserPass("uid") -- prompts for password | |
| 327 :call NetUserPass("uid","password") -- sets global uid and password | |
| 328 | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
329 (Related topics: |ftp| |netrw-userpass| |netrw-start|) |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
330 |
| 1621 | 331 NETRW VARIABLES AND SETTINGS *netrw-variables* {{{2 |
| 3456 | 332 (Also see: |
| 333 |netrw-browser-var| : netrw browser option variables | |
| 334 |netrw-protocol| : file transfer protocol option variables | |
| 335 |netrw-settings| : additional file transfer options | |
| 336 |netrw-browser-options| : these options affect browsing directories | |
| 337 ) | |
| 1621 | 338 |
| 339 Netrw provides a lot of variables which allow you to customize netrw to your | |
| 340 preferences. One way to look at them is via the command :NetrwSettings (see | |
| 341 |netrw-settings|) which will display your current netrw settings. Most such | |
| 342 settings are described below, in |netrw-browser-options|, and in | |
| 343 |netrw-externapp|: | |
| 1121 | 344 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
345 *b:netrw_lastfile* last file Network-read/written retained on a |
| 3456 | 346 per-buffer basis (supports plain :Nw ) |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
347 |
|
2420
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
348 *g:netrw_bufsettings* the settings that netrw buffers have |
| 3456 | 349 (default) noma nomod nonu nowrap ro nobl |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
350 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
351 *g:netrw_chgwin* specifies a window number where file edits will take |
| 3456 | 352 place. (also see |netrw-C|) |
| 353 (default) not defined | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
354 |
|
2420
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
355 *g:Netrw_funcref* specifies a function (or functions) to be called when |
| 3456 | 356 netrw edits a file. The file is first edited, and |
| 357 then the function reference (|Funcref|) is called. | |
| 358 This variable may also hold a |List| of Funcrefs. | |
| 359 (default) not defined. (the capital in g:Netrw... | |
| 360 is required by its holding a function reference) | |
|
2420
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
361 > |
|
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
362 Example: place in .vimrc; affects all file opening |
|
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
363 fun! MyFuncRef() |
|
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
364 endfun |
|
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
365 let g:Netrw_funcref= function("MyFuncRef") |
|
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
366 < |
| 3456 | 367 *g:netrw_ftp* if it doesn't exist, use default ftp |
| 368 =0 use default ftp (uid password) | |
| 369 =1 use alternate ftp method (user uid password) | |
| 370 If you're having trouble with ftp, try changing the | |
| 371 value of this variable to see if the alternate ftp | |
| 372 method works for your setup. | |
| 373 | |
| 374 *g:netrw_ftp_options* Chosen by default, these options are supposed to turn | |
| 375 interactive prompting off and to restrain ftp from | |
| 376 attempting auto-login upon initial connection. | |
| 377 However, it appears that not all ftp implementations | |
| 378 support this (ex. ncftp). | |
| 379 ="-i -n" | |
| 482 | 380 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
381 *g:netrw_ftpextracmd* default: doesn't exist |
| 3456 | 382 If this variable exists, then any string it contains |
| 383 will be placed into the commands set to your ftp | |
| 384 client. As an example: | |
| 385 ="passive" | |
| 1121 | 386 |
| 482 | 387 *g:netrw_ftpmode* ="binary" (default) |
| 3456 | 388 ="ascii" |
| 482 | 389 |
| 1121 | 390 *g:netrw_ignorenetrc* =0 (default for linux, cygwin) |
| 3456 | 391 =1 If you have a <.netrc> file but it doesn't work and |
| 392 you want it ignored, then set this variable as | |
| 393 shown. (default for Windows + cmd.exe) | |
| 1121 | 394 |
| 395 *g:netrw_menu* =0 disable netrw's menu | |
| 3456 | 396 =1 (default) netrw's menu enabled |
| 1121 | 397 |
| 398 *g:netrw_nogx* if this variable exists, then the "gx" map will not | |
| 3456 | 399 be available (see |netrw-gx|) |
| 482 | 400 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
401 *g:netrw_uid* (ftp) user-id, retained on a per-vim-session basis |
| 3456 | 402 *s:netrw_passwd* (ftp) password, retained on a per-vim-session basis |
| 1621 | 403 |
| 404 *g:netrw_preview* =0 (default) preview window shown in a horizontally | |
| 3456 | 405 split window |
| 406 =1 preview window shown in a vertically split window. | |
| 407 Also affects the "previous window" (see |netrw-P|) in | |
| 408 the same way. | |
| 409 | |
| 410 *g:netrw_scpport* = "-P" : option to use to set port for scp | |
| 411 *g:netrw_sshport* = "-p" : option to use to set port for ssh | |
| 412 | |
| 413 *g:netrw_sepchr* =\0xff | |
| 414 =\0x01 for enc == euc-jp (and perhaps it should be for | |
| 415 others, too, please let me know) | |
| 416 Separates priority codes from filenames internally. | |
| 417 See |netrw-p12|. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
418 |
| 1621 | 419 *g:netrw_silent* =0 : transfers done normally |
| 3456 | 420 =1 : transfers done silently |
| 1621 | 421 |
| 1209 | 422 *g:netrw_use_errorwindow* =1 : messages from netrw will use a separate one |
| 3456 | 423 line window. This window provides reliable |
|
2432
80229a724a11
Updated runtime files. :TOhtml improvements by Benjamin Fritz.
Bram Moolenaar <bram@vim.org>
parents:
2426
diff
changeset
|
424 delivery of messages. (default) |
|
80229a724a11
Updated runtime files. :TOhtml improvements by Benjamin Fritz.
Bram Moolenaar <bram@vim.org>
parents:
2426
diff
changeset
|
425 =0 : messages from netrw will use echoerr ; |
|
80229a724a11
Updated runtime files. :TOhtml improvements by Benjamin Fritz.
Bram Moolenaar <bram@vim.org>
parents:
2426
diff
changeset
|
426 messages don't always seem to show up this |
|
80229a724a11
Updated runtime files. :TOhtml improvements by Benjamin Fritz.
Bram Moolenaar <bram@vim.org>
parents:
2426
diff
changeset
|
427 way, but one doesn't have to quit the window. |
| 1209 | 428 |
| 482 | 429 *g:netrw_win95ftp* =1 if using Win95, will remove four trailing blank |
| 3456 | 430 lines that o/s's ftp "provides" on transfers |
| 431 =0 force normal ftp behavior (no trailing line removal) | |
| 432 | |
| 433 *g:netrw_cygwin* =1 assume scp under windows is from cygwin. Also | |
| 434 permits network browsing to use ls with time and | |
| 435 size sorting (default if windows) | |
| 436 =0 assume Windows' scp accepts windows-style paths | |
| 437 Network browsing uses dir instead of ls | |
| 438 This option is ignored if you're using unix | |
| 482 | 439 |
| 440 *g:netrw_use_nt_rcp* =0 don't use the rcp of WinNT, Win2000 and WinXP | |
| 3456 | 441 =1 use WinNT's rcp in binary mode (default) |
| 22 | 442 |
| 1621 | 443 PATHS *netrw-path* {{{2 |
| 466 | 444 |
| 482 | 445 Paths to files are generally user-directory relative for most protocols. |
| 446 It is possible that some protocol will make paths relative to some | |
| 447 associated directory, however. | |
| 448 > | |
| 449 example: vim scp://user@host/somefile | |
| 450 example: vim scp://user@host/subdir1/subdir2/somefile | |
| 451 < | |
| 1621 | 452 where "somefile" is in the "user"'s home directory. If you wish to get a |
| 482 | 453 file using root-relative paths, use the full path: |
| 454 > | |
| 455 example: vim scp://user@host//somefile | |
| 456 example: vim scp://user@host//subdir1/subdir2/somefile | |
| 457 < | |
| 7 | 458 |
| 459 ============================================================================== | |
| 1621 | 460 4. Network-Oriented File Transfer *netrw-xfer* {{{1 |
| 7 | 461 |
| 462 Network-oriented file transfer under Vim is implemented by a VimL-based script | |
| 559 | 463 (<netrw.vim>) using plugin techniques. It currently supports both reading and |
| 464 writing across networks using rcp, scp, ftp or ftp+<.netrc>, scp, fetch, | |
| 7 | 465 dav/cadaver, rsync, or sftp. |
| 466 | |
| 467 http is currently supported read-only via use of wget or fetch. | |
| 468 | |
| 469 <netrw.vim> is a standard plugin which acts as glue between Vim and the | |
| 470 various file transfer programs. It uses autocommand events (BufReadCmd, | |
| 471 FileReadCmd, BufWriteCmd) to intercept reads/writes with url-like filenames. > | |
| 472 | |
| 473 ex. vim ftp://hostname/path/to/file | |
| 474 < | |
| 559 | 475 The characters preceding the colon specify the protocol to use; in the |
| 1621 | 476 example, it's ftp. The <netrw.vim> script then formulates a command or a |
| 559 | 477 series of commands (typically ftp) which it issues to an external program |
| 478 (ftp, scp, etc) which does the actual file transfer/protocol. Files are read | |
| 479 from/written to a temporary file (under Unix/Linux, /tmp/...) which the | |
| 480 <netrw.vim> script will clean up. | |
| 7 | 481 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
482 Now, a word about Jan Minář's "FTP User Name and Password Disclosure"; first, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
483 ftp is not a secure protocol. User names and passwords are transmitted "in |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
484 the clear" over the internet; any snooper tool can pick these up; this is not |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
485 a netrw thing, this is a ftp thing. If you're concerned about this, please |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
486 try to use scp or sftp instead. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
487 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
488 Netrw re-uses the user id and password during the same vim session and so long |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
489 as the remote hostname remains the same. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
490 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
491 Jan seems to be a bit confused about how netrw handles ftp; normally multiple |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
492 commands are performed in a "ftp session", and he seems to feel that the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
493 uid/password should only be retained over one ftp session. However, netrw |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
494 does every ftp operation in a separate "ftp session"; so remembering the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
495 uid/password for just one "ftp session" would be the same as not remembering |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
496 the uid/password at all. IMHO this would rapidly grow tiresome as one |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
497 browsed remote directories, for example. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
498 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
499 On the other hand, thanks go to Jan M. for pointing out the many |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
500 vulnerabilities that netrw (and vim itself) had had in handling "crafted" |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
501 filenames. The |shellescape()| and |fnameescape()| functions were written in |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
502 response by Bram Moolenaar to handle these sort of problems, and netrw has |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
503 been modified to use them. Still, my advice is, if the "filename" looks like |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
504 a vim command that you aren't comfortable with having executed, don't open it. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
505 |
| 1121 | 506 *netrw-putty* *netrw-pscp* *netrw-psftp* |
| 559 | 507 One may modify any protocol's implementing external application by setting a |
| 508 variable (ex. scp uses the variable g:netrw_scp_cmd, which is defaulted to | |
| 794 | 509 "scp -q"). As an example, consider using PuTTY: > |
| 1121 | 510 |
| 511 let g:netrw_scp_cmd = '"c:\Program Files\PuTTY\pscp.exe" -q -batch' | |
| 512 let g:netrw_sftp_cmd= '"c:\Program Files\PuTTY\psftp.exe"' | |
| 794 | 513 < |
| 3153 | 514 (note: it has been reported that windows 7 with putty v0.6's "-batch" option |
| 515 doesn't work, so its best to leave it off for that system) | |
| 516 | |
| 1121 | 517 See |netrw-p8| for more about putty, pscp, psftp, etc. |
| 518 | |
| 7 | 519 Ftp, an old protocol, seems to be blessed by numerous implementations. |
| 559 | 520 Unfortunately, some implementations are noisy (ie., add junk to the end of the |
| 521 file). Thus, concerned users may decide to write a NetReadFixup() function | |
| 522 that will clean up after reading with their ftp. Some Unix systems (ie., | |
| 523 FreeBSD) provide a utility called "fetch" which uses the ftp protocol but is | |
| 524 not noisy and more convenient, actually, for <netrw.vim> to use. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
525 Consequently, if "fetch" is available (ie. executable), it may be preferable |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
526 to use it for ftp://... based transfers. |
| 7 | 527 |
| 528 For rcp, scp, sftp, and http, one may use network-oriented file transfers | |
| 459 | 529 transparently; ie. |
| 7 | 530 > |
| 531 vim rcp://[user@]machine/path | |
| 532 vim scp://[user@]machine/path | |
| 533 < | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
534 If your ftp supports <.netrc>, then it too can be transparently used |
| 7 | 535 if the needed triad of machine name, user id, and password are present in |
| 536 that file. Your ftp must be able to use the <.netrc> file on its own, however. | |
| 537 > | |
| 538 vim ftp://[user@]machine[[:#]portnumber]/path | |
| 539 < | |
| 2751 | 540 Windows provides an ftp (typically c:\Windows\System32\ftp.exe) which uses |
| 541 an option, -s:filename (filename can and probably should be a full path) | |
| 542 which contains ftp commands which will be automatically run whenever ftp | |
| 543 starts. You may use this feature to enter a user and password for one site: > | |
| 544 userid | |
| 545 password | |
| 3456 | 546 < *netrw-windows-netrc* *netrw-windows-s* |
| 2751 | 547 If |g:netrw_ftp_cmd| contains -s:[path/]MACHINE, then (on Windows machines only) |
| 3456 | 548 netrw will substitute the current machine name requested for ftp connections |
| 2751 | 549 for MACHINE. Hence one can have multiple machine.ftp files containing login |
| 550 and password for ftp. Example: > | |
| 551 | |
| 4339 | 552 let g:netrw_ftp_cmd= 'c:\Windows\System32\ftp -s:C:\Users\Myself\MACHINE' |
| 553 vim ftp://myhost.somewhere.net/ | |
| 2751 | 554 will use a file > |
| 555 C:\Users\Myself\myhost.ftp | |
| 556 < | |
| 557 Often, ftp will need to query the user for the userid and password. | |
| 459 | 558 The latter will be done "silently"; ie. asterisks will show up instead of |
| 7 | 559 the actually-typed-in password. Netrw will retain the userid and password |
| 560 for subsequent read/writes from the most recent transfer so subsequent | |
| 561 transfers (read/write) to or from that machine will take place without | |
| 562 additional prompting. | |
| 563 | |
| 564 *netrw-urls* | |
| 565 +=================================+============================+============+ | |
| 1121 | 566 | Reading | Writing | Uses | |
| 7 | 567 +=================================+============================+============+ |
| 1121 | 568 | DAV: | | | |
| 569 | dav://host/path | | cadaver | | |
| 570 | :Nread dav://host/path | :Nwrite dav://host/path | cadaver | | |
| 7 | 571 +---------------------------------+----------------------------+------------+ |
| 1621 | 572 | DAV + SSL: | | | |
| 573 | davs://host/path | | cadaver | | |
| 574 | :Nread davs://host/path | :Nwrite davs://host/path | cadaver | | |
| 575 +---------------------------------+----------------------------+------------+ | |
| 1121 | 576 | FETCH: | | | |
| 577 | fetch://[user@]host/path | | | | |
| 578 | fetch://[user@]host:http/path | Not Available | fetch | | |
| 579 | :Nread fetch://[user@]host/path| | | | |
| 7 | 580 +---------------------------------+----------------------------+------------+ |
| 1121 | 581 | FILE: | | | |
| 582 | file:///* | file:///* | | | |
| 583 | file://localhost/* | file://localhost/* | | | |
| 7 | 584 +---------------------------------+----------------------------+------------+ |
| 1121 | 585 | FTP: (*3) | (*3) | | |
| 586 | ftp://[user@]host/path | ftp://[user@]host/path | ftp (*2) | | |
| 587 | :Nread ftp://host/path | :Nwrite ftp://host/path | ftp+.netrc | | |
| 588 | :Nread host path | :Nwrite host path | ftp+.netrc | | |
| 589 | :Nread host uid pass path | :Nwrite host uid pass path | ftp | | |
| 7 | 590 +---------------------------------+----------------------------+------------+ |
| 1121 | 591 | HTTP: wget is executable: (*4) | | | |
| 592 | http://[user@]host/path | Not Available | wget | | |
| 7 | 593 +---------------------------------+----------------------------+------------+ |
| 1121 | 594 | HTTP: fetch is executable (*4) | | | |
| 595 | http://[user@]host/path | Not Available | fetch | | |
| 7 | 596 +---------------------------------+----------------------------+------------+ |
| 1121 | 597 | RCP: | | | |
| 598 | rcp://[user@]host/path | rcp://[user@]host/path | rcp | | |
| 7 | 599 +---------------------------------+----------------------------+------------+ |
| 1121 | 600 | RSYNC: | | | |
| 601 | rsync://[user@]host/path | rsync://[user@]host/path | rsync | | |
| 602 | :Nread rsync://host/path | :Nwrite rsync://host/path | rsync | | |
| 603 | :Nread rcp://host/path | :Nwrite rcp://host/path | rcp | | |
| 7 | 604 +---------------------------------+----------------------------+------------+ |
| 1121 | 605 | SCP: | | | |
| 606 | scp://[user@]host/path | scp://[user@]host/path | scp | | |
| 607 | :Nread scp://host/path | :Nwrite scp://host/path | scp (*1) | | |
| 7 | 608 +---------------------------------+----------------------------+------------+ |
| 1121 | 609 | SFTP: | | | |
| 610 | sftp://[user@]host/path | sftp://[user@]host/path | sftp | | |
| 611 | :Nread sftp://host/path | :Nwrite sftp://host/path | sftp (*1) | | |
| 7 | 612 +=================================+============================+============+ |
| 613 | |
| 614 (*1) For an absolute path use scp://machine//path. | |
| 615 | |
| 616 (*2) if <.netrc> is present, it is assumed that it will | |
| 617 work with your ftp client. Otherwise the script will | |
| 1121 | 618 prompt for user-id and password. |
| 7 | 619 |
| 1121 | 620 (*3) for ftp, "machine" may be machine#port or machine:port |
| 7 | 621 if a different port is needed than the standard ftp port |
| 622 | |
| 623 (*4) for http:..., if wget is available it will be used. Otherwise, | |
| 624 if fetch is available it will be used. | |
| 625 | |
| 626 Both the :Nread and the :Nwrite ex-commands can accept multiple filenames. | |
| 627 | |
| 628 | |
| 629 NETRC *netrw-netrc* | |
| 630 | |
| 1621 | 631 The <.netrc> file, typically located in your home directory, contains lines |
| 632 therein which map a hostname (machine name) to the user id and password you | |
| 633 prefer to use with it. | |
| 634 | |
| 7 | 635 The typical syntax for lines in a <.netrc> file is given as shown below. |
| 799 | 636 Ftp under Unix usually supports <.netrc>; ftp under Windows usually doesn't. |
| 7 | 637 > |
| 638 machine {full machine name} login {user-id} password "{password}" | |
| 639 default login {user-id} password "{password}" | |
| 640 | |
| 641 Your ftp client must handle the use of <.netrc> on its own, but if the | |
| 642 <.netrc> file exists, an ftp transfer will not ask for the user-id or | |
| 643 password. | |
| 644 | |
| 645 Note: | |
| 646 Since this file contains passwords, make very sure nobody else can | |
| 647 read this file! Most programs will refuse to use a .netrc that is | |
| 648 readable for others. Don't forget that the system administrator can | |
| 1621 | 649 still read the file! Ie. for Linux/Unix: chmod 600 .netrc |
| 7 | 650 |
| 3456 | 651 Even though Windows' ftp clients typically do not support .netrc, netrw has |
| 652 a work-around: see |netrw-windows-s|. | |
| 653 | |
| 7 | 654 |
| 655 PASSWORD *netrw-passwd* | |
| 656 | |
| 657 The script attempts to get passwords for ftp invisibly using |inputsecret()|, | |
|
2432
80229a724a11
Updated runtime files. :TOhtml improvements by Benjamin Fritz.
Bram Moolenaar <bram@vim.org>
parents:
2426
diff
changeset
|
658 a built-in Vim function. See |netrw-userpass| for how to change the password |
| 7 | 659 after one has set it. |
| 660 | |
| 559 | 661 Unfortunately there doesn't appear to be a way for netrw to feed a password to |
| 662 scp. Thus every transfer via scp will require re-entry of the password. | |
| 1621 | 663 However, |netrw-ssh-hack| can help with this problem. |
| 7 | 664 |
| 665 | |
| 666 ============================================================================== | |
| 1621 | 667 5. Activation *netrw-activate* {{{1 |
| 7 | 668 |
| 799 | 669 Network-oriented file transfers are available by default whenever Vim's |
| 1621 | 670 |'nocompatible'| mode is enabled. Netrw's script files reside in your |
| 671 system's plugin, autoload, and syntax directories; just the | |
| 672 plugin/netrwPlugin.vim script is sourced automatically whenever you bring up | |
| 673 vim. The main script in autoload/netrw.vim is only loaded when you actually | |
| 674 use netrw. I suggest that, at a minimum, you have at least the following in | |
| 675 your <.vimrc> customization file: > | |
| 799 | 676 |
| 559 | 677 set nocp |
| 678 if version >= 600 | |
| 679 filetype plugin indent on | |
| 680 endif | |
| 681 < | |
| 7 | 682 |
| 683 ============================================================================== | |
| 2751 | 684 6. Transparent Remote File Editing *netrw-transparent* {{{1 |
| 7 | 685 |
| 686 Transparent file transfers occur whenever a regular file read or write | |
| 1621 | 687 (invoked via an |:autocmd| for |BufReadCmd|, |BufWriteCmd|, or |SourceCmd| |
| 688 events) is made. Thus one may read, write, or source files across networks | |
| 689 just as easily as if they were local files! > | |
| 7 | 690 |
| 691 vim ftp://[user@]machine/path | |
| 692 ... | |
| 693 :wq | |
| 694 | |
| 559 | 695 See |netrw-activate| for more on how to encourage your vim to use plugins |
| 696 such as netrw. | |
| 7 | 697 |
| 799 | 698 |
| 7 | 699 ============================================================================== |
| 1621 | 700 7. Ex Commands *netrw-ex* {{{1 |
| 7 | 701 |
| 799 | 702 The usual read/write commands are supported. There are also a few |
| 1621 | 703 additional commands available. Often you won't need to use Nwrite or |
| 1121 | 704 Nread as shown in |netrw-transparent| (ie. simply use > |
| 705 :e url | |
| 706 :r url | |
| 707 :w url | |
| 708 instead, as appropriate) -- see |netrw-urls|. In the explanations | |
| 709 below, a {netfile} is an url to a remote file. | |
| 7 | 710 |
| 2152 | 711 *:Nwrite* *:Nw* |
| 1621 | 712 :[range]Nw[rite] Write the specified lines to the current |
| 7 | 713 file as specified in b:netrw_lastfile. |
| 2152 | 714 (related: |netrw-nwrite|) |
| 7 | 715 |
| 1621 | 716 :[range]Nw[rite] {netfile} [{netfile}]... |
| 7 | 717 Write the specified lines to the {netfile}. |
| 718 | |
| 2152 | 719 *:Nread* *:Nr* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
720 :Nr[ead] Read the lines from the file specified in b:netrw_lastfile |
| 2152 | 721 into the current buffer. (related: |netrw-nread|) |
| 7 | 722 |
| 1621 | 723 :Nr[ead] {netfile} {netfile}... |
| 7 | 724 Read the {netfile} after the current line. |
| 725 | |
| 2152 | 726 *:Nsource* *:Ns* |
| 1621 | 727 :Ns[ource] {netfile} |
| 1121 | 728 Source the {netfile}. |
| 729 To start up vim using a remote .vimrc, one may use | |
| 730 the following (all on one line) (tnx to Antoine Mechelynck) > | |
| 731 vim -u NORC -N | |
| 732 --cmd "runtime plugin/netrwPlugin.vim" | |
| 733 --cmd "source scp://HOSTNAME/.vimrc" | |
| 2152 | 734 < (related: |netrw-source|) |
| 735 | |
| 736 :call NetUserPass() *NetUserPass()* | |
| 1621 | 737 If g:netrw_uid and s:netrw_passwd don't exist, |
| 738 this function will query the user for them. | |
| 2152 | 739 (related: |netrw-userpass|) |
| 7 | 740 |
| 741 :call NetUserPass("userid") | |
| 1621 | 742 This call will set the g:netrw_uid and, if |
| 7 | 743 the password doesn't exist, will query the user for it. |
| 2152 | 744 (related: |netrw-userpass|) |
| 7 | 745 |
| 746 :call NetUserPass("userid","passwd") | |
| 1621 | 747 This call will set both the g:netrw_uid and s:netrw_passwd. |
| 7 | 748 The user-id and password are used by ftp transfers. One may |
| 1621 | 749 effectively remove the user-id and password by using empty |
| 750 strings (ie. ""). | |
| 2152 | 751 (related: |netrw-userpass|) |
| 7 | 752 |
| 1121 | 753 :NetrwSettings This command is described in |netrw-settings| -- used to |
| 754 display netrw settings and change netrw behavior. | |
| 482 | 755 |
| 7 | 756 |
| 757 ============================================================================== | |
| 3456 | 758 8. Variables and Options *netrw-var* *netrw-settings* {{{1 |
| 3153 | 759 |
| 760 (also see: |netrw-options| |netrw-variables| |netrw-protocol| | |
| 3456 | 761 |netrw-browser-settings| |netrw-browser-options| ) |
| 7 | 762 |
| 1121 | 763 The <netrw.vim> script provides several variables which act as options to |
| 1621 | 764 affect <netrw.vim>'s file transfer behavior. These variables typically may be |
| 765 set in the user's <.vimrc> file: (see also |netrw-settings| |netrw-protocol|) | |
| 3153 | 766 *netrw-options* |
| 1621 | 767 > |
| 1121 | 768 ------------- |
| 769 Netrw Options | |
| 770 ------------- | |
| 9 | 771 Option Meaning |
| 772 -------------- ----------------------------------------------- | |
| 773 < | |
| 1121 | 774 b:netrw_col Holds current cursor position (during NetWrite) |
| 775 g:netrw_cygwin =1 assume scp under windows is from cygwin | |
| 776 (default/windows) | |
| 777 =0 assume scp under windows accepts windows | |
| 778 style paths (default/else) | |
| 779 g:netrw_ftp =0 use default ftp (uid password) | |
| 780 g:netrw_ftpmode ="binary" (default) | |
| 781 ="ascii" (your choice) | |
| 782 g:netrw_ignorenetrc =1 (default) | |
| 783 if you have a <.netrc> file but you don't | |
| 7 | 784 want it used, then set this variable. Its |
| 785 mere existence is enough to cause <.netrc> | |
| 786 to be ignored. | |
| 1121 | 787 b:netrw_lastfile Holds latest method/machine/path. |
| 788 b:netrw_line Holds current line number (during NetWrite) | |
| 789 g:netrw_silent =0 transfers done normally | |
| 790 =1 transfers done silently | |
| 791 g:netrw_uid Holds current user-id for ftp. | |
| 792 g:netrw_use_nt_rcp =0 don't use WinNT/2K/XP's rcp (default) | |
| 793 =1 use WinNT/2K/XP's rcp, binary mode | |
| 794 g:netrw_win95ftp =0 use unix-style ftp even if win95/98/ME/etc | |
| 795 =1 use default method to do ftp > | |
| 9 | 796 ----------------------------------------------------------------------- |
| 797 < | |
| 3153 | 798 *netrw-internal-variables* |
| 7 | 799 The script will also make use of the following variables internally, albeit |
| 800 temporarily. | |
| 9 | 801 > |
| 802 ------------------- | |
| 803 Temporary Variables | |
| 804 ------------------- | |
| 805 Variable Meaning | |
| 806 -------- ------------------------------------ | |
| 807 < | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
808 b:netrw_method Index indicating rcp/ftp+.netrc/ftp |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
809 w:netrw_method (same as b:netrw_method) |
| 7 | 810 g:netrw_machine Holds machine name parsed from input |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
811 b:netrw_fname Holds filename being accessed > |
| 9 | 812 ------------------------------------------------------------ |
| 813 < | |
| 1621 | 814 *netrw-protocol* |
| 7 | 815 |
| 9 | 816 Netrw supports a number of protocols. These protocols are invoked using the |
| 817 variables listed below, and may be modified by the user. | |
| 7 | 818 > |
| 819 ------------------------ | |
| 1121 | 820 Protocol Control Options |
| 7 | 821 ------------------------ |
| 1121 | 822 Option Type Setting Meaning |
| 823 --------- -------- -------------- --------------------------- | |
| 5618 | 824 < netrw_ftp variable =doesn't exist userid set by "user userid" |
| 1121 | 825 =0 userid set by "user userid" |
| 826 =1 userid set by "userid" | |
| 827 NetReadFixup function =doesn't exist no change | |
| 828 =exists Allows user to have files | |
| 829 read via ftp automatically | |
| 830 transformed however they wish | |
| 831 by NetReadFixup() | |
| 5618 | 832 g:netrw_dav_cmd var ="cadaver" if cadaver is executable |
| 833 g:netrw_dav_cmd var ="curl -o" elseif curl is executable | |
| 834 g:netrw_fetch_cmd var ="fetch -o" if fetch is available | |
| 835 g:netrw_ftp_cmd var ="ftp" | |
| 836 g:netrw_http_cmd var ="fetch -o" if fetch is available | |
| 837 g:netrw_http_cmd var ="wget -O" else if wget is available | |
| 838 g:netrw_http_put_cmd var ="curl -T" | |
| 839 g:netrw_list_cmd var ="ssh USEPORT HOSTNAME ls -Fa" | |
| 840 g:netrw_rcp_cmd var ="rcp" | |
| 841 g:netrw_rsync_cmd var ="rsync -a" | |
| 842 g:netrw_scp_cmd var ="scp -q" | |
| 843 g:netrw_sftp_cmd var ="sftp" > | |
| 9 | 844 ------------------------------------------------------------------------- |
| 7 | 845 < |
| 12 | 846 *netrw-ftp* |
| 1121 | 847 |
| 848 The g:netrw_..._cmd options (|g:netrw_ftp_cmd| and |g:netrw_sftp_cmd|) | |
| 849 specify the external program to use handle the ftp protocol. They may | |
|
2420
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
850 include command line options (such as -p for passive mode). Example: > |
|
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
851 |
|
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
852 let g:netrw_ftp_cmd= "ftp -p" |
|
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
853 < |
| 1121 | 854 Browsing is supported by using the |g:netrw_list_cmd|; the substring |
| 855 "HOSTNAME" will be changed via substitution with whatever the current request | |
| 856 is for a hostname. | |
| 7 | 857 |
| 1121 | 858 Two options (|g:netrw_ftp| and |netrw-fixup|) both help with certain ftp's |
| 859 that give trouble . In order to best understand how to use these options if | |
| 860 ftp is giving you troubles, a bit of discussion is provided on how netrw does | |
| 861 ftp reads. | |
| 9 | 862 |
| 863 For ftp, netrw typically builds up lines of one of the following formats in a | |
| 7 | 864 temporary file: |
| 865 > | |
| 866 IF g:netrw_ftp !exists or is not 1 IF g:netrw_ftp exists and is 1 | |
| 867 ---------------------------------- ------------------------------ | |
| 9 | 868 < |
| 1121 | 869 open machine [port] open machine [port] |
| 870 user userid password userid password | |
| 871 [g:netrw_ftpmode] password | |
|
2432
80229a724a11
Updated runtime files. :TOhtml improvements by Benjamin Fritz.
Bram Moolenaar <bram@vim.org>
parents:
2426
diff
changeset
|
872 [g:netrw_ftpextracmd] [g:netrw_ftpmode] |
| 1121 | 873 get filename tempfile [g:netrw_extracmd] |
| 874 get filename tempfile > | |
| 9 | 875 --------------------------------------------------------------------- |
| 7 | 876 < |
|
2432
80229a724a11
Updated runtime files. :TOhtml improvements by Benjamin Fritz.
Bram Moolenaar <bram@vim.org>
parents:
2426
diff
changeset
|
877 The |g:netrw_ftpmode| and |g:netrw_ftpextracmd| are optional. |
| 1121 | 878 |
| 7 | 879 Netrw then executes the lines above by use of a filter: |
| 880 > | |
| 881 :%! {g:netrw_ftp_cmd} -i [-n] | |
| 882 < | |
| 883 where | |
| 884 g:netrw_ftp_cmd is usually "ftp", | |
| 885 -i tells ftp not to be interactive | |
| 886 -n means don't use netrc and is used for Method #3 (ftp w/o <.netrc>) | |
| 887 | |
| 888 If <.netrc> exists it will be used to avoid having to query the user for | |
| 9 | 889 userid and password. The transferred file is put into a temporary file. |
| 7 | 890 The temporary file is then read into the main editing session window that |
| 891 requested it and the temporary file deleted. | |
| 892 | |
| 559 | 893 If your ftp doesn't accept the "user" command and immediately just demands a |
| 894 userid, then try putting "let netrw_ftp=1" in your <.vimrc>. | |
| 7 | 895 |
| 12 | 896 *netrw-cadaver* |
| 897 To handle the SSL certificate dialog for untrusted servers, one may pull | |
| 898 down the certificate and place it into /usr/ssl/cert.pem. This operation | |
| 899 renders the server treatment as "trusted". | |
| 900 | |
| 794 | 901 *netrw-fixup* *netreadfixup* |
| 7 | 902 If your ftp for whatever reason generates unwanted lines (such as AUTH |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
903 messages) you may write a NetReadFixup() function: |
| 7 | 904 > |
| 905 function! NetReadFixup(method,line1,line2) | |
| 906 " a:line1: first new line in current file | |
| 907 " a:line2: last new line in current file | |
| 908 if a:method == 1 "rcp | |
| 909 elseif a:method == 2 "ftp + <.netrc> | |
| 910 elseif a:method == 3 "ftp + machine,uid,password,filename | |
| 911 elseif a:method == 4 "scp | |
| 912 elseif a:method == 5 "http/wget | |
| 913 elseif a:method == 6 "dav/cadaver | |
| 914 elseif a:method == 7 "rsync | |
| 915 elseif a:method == 8 "fetch | |
| 916 elseif a:method == 9 "sftp | |
| 1121 | 917 else " complain |
| 7 | 918 endif |
| 919 endfunction | |
| 920 > | |
| 559 | 921 The NetReadFixup() function will be called if it exists and thus allows you to |
| 922 customize your reading process. As a further example, <netrw.vim> contains | |
| 923 just such a function to handle Windows 95 ftp. For whatever reason, Windows | |
| 924 95's ftp dumps four blank lines at the end of a transfer, and so it is | |
| 925 desirable to automate their removal. Here's some code taken from <netrw.vim> | |
| 926 itself: | |
| 7 | 927 > |
| 928 if has("win95") && g:netrw_win95ftp | |
| 9 | 929 fun! NetReadFixup(method, line1, line2) |
| 7 | 930 if method == 3 " ftp (no <.netrc>) |
| 1121 | 931 let fourblanklines= line2 - 3 |
| 932 silent fourblanklines.",".line2."g/^\s*/d" | |
| 7 | 933 endif |
| 934 endfunction | |
| 935 endif | |
| 936 > | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
937 (Related topics: |ftp| |netrw-userpass| |netrw-start|) |
| 7 | 938 |
| 939 ============================================================================== | |
| 1621 | 940 9. Browsing *netrw-browsing* *netrw-browse* *netrw-help* {{{1 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
941 *netrw-browser* *netrw-dir* *netrw-list* |
| 1621 | 942 |
| 943 INTRODUCTION TO BROWSING *netrw-intro-browse* {{{2 | |
| 944 (Quick References: |netrw-quickmaps| |netrw-quickcoms|) | |
| 945 | |
| 946 Netrw supports the browsing of directories on your local system and on remote | |
| 947 hosts; browsing includes listing files and directories, entering directories, | |
| 948 editing files therein, deleting files/directories, making new directories, | |
| 949 moving (renaming) files and directories, copying files and directories, etc. | |
| 950 One may mark files and execute any system command on them! The Netrw browser | |
| 951 generally implements the previous explorer's maps and commands for remote | |
| 952 directories, although details (such as pertinent global variable names) | |
| 953 necessarily differ. To browse a directory, simply "edit" it! > | |
| 954 | |
| 955 vim /your/directory/ | |
| 956 vim . | |
| 957 vim c:\your\directory\ | |
| 958 < | |
| 959 (Related topics: |netrw-cr| |netrw-o| |netrw-p| |netrw-P| |netrw-t| | |
| 960 |netrw-mf| |netrw-mx| |netrw-D| |netrw-R| |netrw-v| ) | |
| 22 | 961 |
| 962 The Netrw remote file and directory browser handles two protocols: ssh and | |
| 1621 | 963 ftp. The protocol in the url, if it is ftp, will cause netrw also to use ftp |
| 964 in its remote browsing. Specifying any other protocol will cause it to be | |
| 965 used for file transfers; but the ssh protocol will be used to do remote | |
| 966 browsing. | |
| 967 | |
| 968 To use Netrw's remote directory browser, simply attempt to read a "file" with | |
| 969 a trailing slash and it will be interpreted as a request to list a directory: | |
| 970 > | |
| 9 | 971 vim [protocol]://[user@]hostname/path/ |
| 1621 | 972 < |
| 973 where [protocol] is typically scp or ftp. As an example, try: > | |
| 974 | |
| 975 vim ftp://ftp.home.vim.org/pub/vim/ | |
| 719 | 976 < |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
977 For local directories, the trailing slash is not required. Again, because it's |
| 1621 | 978 easy to miss: to browse remote directories, the url must terminate with a |
| 979 slash! | |
| 980 | |
| 981 If you'd like to avoid entering the password repeatedly for remote directory | |
| 982 listings with ssh or scp, see |netrw-ssh-hack|. To avoid password entry with | |
| 983 ftp, see |netrw-netrc| (if your ftp supports it). | |
| 984 | |
| 985 There are several things you can do to affect the browser's display of files: | |
| 986 | |
| 987 * To change the listing style, press the "i" key (|netrw-i|). | |
| 988 Currently there are four styles: thin, long, wide, and tree. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
989 To make that change "permanent", see |g:netrw_liststyle|. |
| 1621 | 990 |
| 991 * To hide files (don't want to see those xyz~ files anymore?) see | |
| 992 |netrw-ctrl-h|. | |
| 993 | |
| 994 * Press s to sort files by name, time, or size. | |
| 995 | |
| 996 See |netrw-browse-cmds| for all the things you can do with netrw! | |
| 997 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
998 *netrw-getftype* *netrw-filigree* *netrw-ftype* |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
999 The |getftype()| function is used to append a bit of filigree to indicate |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1000 filetype to locally listed files: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1001 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1002 directory : / |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1003 executable : * |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1004 fifo : | |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1005 links : @ |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1006 sockets : = |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1007 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1008 The filigree also affects the |g:netrw_sort_sequence|. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1009 |
| 1621 | 1010 |
| 1011 QUICK HELP *netrw-quickhelp* {{{2 | |
| 1012 (Use ctrl-] to select a topic)~ | |
| 1013 Intro to Browsing...............................|netrw-intro-browse| | |
| 1014 Quick Reference: Maps.........................|netrw-quickmap| | |
| 1015 Quick Reference: Commands.....................|netrw-browse-cmds| | |
| 1016 Hiding | |
| 1017 Edit hiding list..............................|netrw-ctrl-h| | |
| 1018 Hiding Files or Directories...................|netrw-a| | |
| 1019 Hiding/Unhiding by suffix.....................|netrw-mh| | |
| 1020 Hiding dot-files.............................|netrw-gh| | |
| 1021 Listing Style | |
| 1022 Select listing style (thin/long/wide/tree)....|netrw-i| | |
| 1023 Associated setting variable...................|g:netrw_liststyle| | |
| 1024 Shell command used to perform listing.........|g:netrw_list_cmd| | |
| 1025 Quick file info...............................|netrw-qf| | |
| 1026 Sorted by | |
| 1027 Select sorting style (name/time/size).........|netrw-s| | |
| 1028 Editing the sorting sequence..................|netrw-S| | |
| 1668 | 1029 Sorting options...............................|g:netrw_sort_options| |
| 1621 | 1030 Associated setting variable...................|g:netrw_sort_sequence| |
| 1031 Reverse sorting order.........................|netrw-r| | |
| 1032 | |
| 1033 | |
| 1034 *netrw-quickmap* *netrw-quickmaps* | |
| 1035 QUICK REFERENCE: MAPS *netrw-browse-maps* {{{2 | |
| 466 | 1036 > |
| 1621 | 1037 --- ----------------- ---- |
| 1038 Map Quick Explanation Link | |
| 1039 --- ----------------- ---- | |
| 1040 < <F1> Causes Netrw to issue help | |
| 1041 <cr> Netrw will enter the directory or read the file |netrw-cr| | |
| 1042 <del> Netrw will attempt to remove the file/directory |netrw-del| | |
| 1043 - Makes Netrw go up one directory |netrw--| | |
| 1044 a Toggles between normal display, |netrw-a| | |
| 1045 hiding (suppress display of files matching g:netrw_list_hide) | |
| 1046 showing (display only files which match g:netrw_list_hide) | |
| 1047 c Make browsing directory the current directory |netrw-c| | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1048 C Setting the editing window |netrw-C| |
| 1621 | 1049 d Make a directory |netrw-d| |
| 1050 D Attempt to remove the file(s)/directory(ies) |netrw-D| | |
| 1051 gb Go to previous bookmarked directory |netrw-gb| | |
| 1052 gh Quick hide/unhide of dot-files |netrw-gh| | |
| 1053 <c-h> Edit file hiding list |netrw-ctrl-h| | |
| 1054 i Cycle between thin, long, wide, and tree listings |netrw-i| | |
| 1055 <c-l> Causes Netrw to refresh the directory listing |netrw-ctrl-l| | |
| 1056 mb Bookmark current directory |netrw-mb| | |
| 1057 mc Copy marked files to marked-file target directory |netrw-mc| | |
| 1058 md Apply diff to marked files (up to 3) |netrw-md| | |
| 1059 me Place marked files on arg list and edit them |netrw-me| | |
| 1060 mf Mark a file |netrw-mf| | |
| 1061 mh Toggle marked file suffices' presence on hiding list |netrw-mh| | |
| 1062 mm Move marked files to marked-file target directory |netrw-mm| | |
| 1063 mp Print marked files |netrw-mp| | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1064 mr Mark files satisfying a shell-style |regexp| |netrw-mr| |
| 1621 | 1065 mt Current browsing directory becomes markfile target |netrw-mt| |
| 1066 mT Apply ctags to marked files |netrw-mT| | |
| 1067 mu Unmark all marked files |netrw-mu| | |
| 1068 mx Apply arbitrary shell command to marked files |netrw-mx| | |
| 1069 mz Compress/decompress marked files |netrw-mz| | |
| 1070 o Enter the file/directory under the cursor in a new |netrw-o| | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1071 browser window. A horizontal split is used. |
| 1621 | 1072 O Obtain a file specified by cursor |netrw-O| |
| 1073 p Preview the file |netrw-p| | |
| 1074 P Browse in the previously used window |netrw-P| | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1075 qb List bookmarked directories and history |netrw-qb| |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1076 qf Display information on file |netrw-qf| |
| 1621 | 1077 r Reverse sorting order |netrw-r| |
| 1078 R Rename the designed file(s)/directory(ies) |netrw-R| | |
| 1079 s Select sorting style: by name, time, or file size |netrw-s| | |
| 1080 S Specify suffix priority for name-sorting |netrw-S| | |
| 1081 t Enter the file/directory under the cursor in a new tab|netrw-t| | |
| 1082 u Change to recently-visited directory |netrw-u| | |
| 1083 U Change to subsequently-visited directory |netrw-U| | |
| 1084 v Enter the file/directory under the cursor in a new |netrw-v| | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1085 browser window. A vertical split is used. |
| 1621 | 1086 x View file with an associated program |netrw-x| |
| 3920 | 1087 X Execute filename under cursor via |system()| |netrw-X| |
| 1621 | 1088 |
| 1668 | 1089 % Open a new file in netrw's current directory |netrw-%| |
| 1090 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1091 *netrw-mouse* *netrw-leftmouse* *netrw-middlemouse* *netrw-rightmouse* |
| 1621 | 1092 <leftmouse> (gvim only) selects word under mouse as if a <cr> |
| 1093 had been pressed (ie. edit file, change directory) | |
| 1094 <middlemouse> (gvim only) same as P selecting word under mouse; | |
| 1095 see |netrw-P| | |
| 1096 <rightmouse> (gvim only) delete file/directory using word under | |
| 1097 mouse | |
| 1098 <2-leftmouse> (gvim only) when: | |
| 1099 * in a netrw-selected file, AND | |
| 1100 * |g:netrw_retmap| == 1 AND | |
| 4339 | 1101 * the user doesn't already have a <2-leftmouse> |
| 1102 mapping defined before netrw is autoloaded, | |
| 1621 | 1103 then a double clicked leftmouse button will return |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1104 to the netrw browser window. See |g:netrw_retmap|. |
| 5618 | 1105 <s-leftmouse> (gvim only) like mf, will mark files. Dragging |
| 1106 the shifted leftmouse will mark multiple files. | |
| 1107 (see |netrw-mf|) | |
| 1621 | 1108 |
| 2152 | 1109 (to disable mouse buttons while browsing: |g:netrw_mousemaps|) |
| 1110 | |
| 1621 | 1111 *netrw-quickcom* *netrw-quickcoms* |
| 1112 QUICK REFERENCE: COMMANDS *netrw-explore-cmds* *netrw-browse-cmds* {{{2 | |
| 5618 | 1113 :NetrwClean[!]............................................|netrw-clean| |
| 1114 :NetrwSettings............................................|netrw-settings| | |
| 1115 :Ntree....................................................|netrw-ntree| | |
| 1621 | 1116 :Explore[!] [dir] Explore directory of current file......|netrw-explore| |
| 1117 :Hexplore[!] [dir] Horizontal Split & Explore.............|netrw-explore| | |
| 5618 | 1118 :Lexplore [dir] Left Explorer Toggle...................|netrw-explore| |
| 1621 | 1119 :Nexplore[!] [dir] Vertical Split & Explore...............|netrw-explore| |
| 1120 :Pexplore[!] [dir] Vertical Split & Explore...............|netrw-explore| | |
| 1121 :Rexplore Return to Explorer.....................|netrw-explore| | |
| 1122 :Sexplore[!] [dir] Split & Explore directory .............|netrw-explore| | |
| 1123 :Texplore[!] [dir] Tab & Explore..........................|netrw-explore| | |
| 1124 :Vexplore[!] [dir] Vertical Split & Explore...............|netrw-explore| | |
| 1125 | |
| 1126 BOOKMARKING A DIRECTORY *netrw-mb* *netrw-bookmark* *netrw-bookmarks* {{{2 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1127 |
| 1621 | 1128 One may easily "bookmark" a directory by using > |
| 1129 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1130 mb |
| 839 | 1131 < |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1132 Bookmarks are retained in between sessions in a $HOME/.netrwbook file, and are |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1133 kept in sorted order. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1134 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1135 Related Topics: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1136 |netrw-gb| how to return (go) to a bookmark |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1137 |netrw-mB| how to delete bookmarks |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1138 |netrw-qb| how to list bookmarks |
| 1621 | 1139 |
| 1140 | |
| 1141 BROWSING *netrw-cr* {{{2 | |
| 12 | 1142 |
| 9 | 1143 Browsing is simple: move the cursor onto a file or directory of interest. |
| 11 | 1144 Hitting the <cr> (the return key) will select the file or directory. |
| 1145 Directories will themselves be listed, and files will be opened using the | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1146 protocol given in the original read request. |
| 559 | 1147 |
| 1621 | 1148 CAVEAT: There are four forms of listing (see |netrw-i|). Netrw assumes that |
| 1149 two or more spaces delimit filenames and directory names for the long and | |
| 1150 wide listing formats. Thus, if your filename or directory name has two or | |
| 1151 more sequential spaces embedded in it, or any trailing spaces, then you'll | |
| 1152 need to use the "thin" format to select it. | |
| 519 | 1153 |
| 650 | 1154 The |g:netrw_browse_split| option, which is zero by default, may be used to |
| 1621 | 1155 cause the opening of files to be done in a new window or tab instead of the |
| 1156 default. When the option is one or two, the splitting will be taken | |
| 1157 horizontally or vertically, respectively. When the option is set to three, a | |
| 1158 <cr> will cause the file to appear in a new tab. | |
| 1159 | |
| 1160 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1161 When using the gui (gvim), one may select a file by pressing the <leftmouse> |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1162 button. In addition, if |
| 1621 | 1163 |
| 1164 *|g:netrw_retmap| == 1 AND (its default value is 0) | |
| 1165 * in a netrw-selected file, AND | |
| 1166 * the user doesn't already have a <2-leftmouse> mapping defined before | |
| 1167 netrw is loaded | |
| 1168 | |
| 1169 then a doubly-clicked leftmouse button will return to the netrw browser | |
| 1170 window. | |
| 1171 | |
| 1172 Netrw attempts to speed up browsing, especially for remote browsing where one | |
| 1173 may have to enter passwords, by keeping and re-using previously obtained | |
| 1174 directory listing buffers. The |g:netrw_fastbrowse| variable is used to | |
| 1175 control this behavior; one may have slow browsing (no buffer re-use), medium | |
| 1176 speed browsing (re-use directory buffer listings only for remote directories), | |
| 1177 and fast browsing (re-use directory buffer listings as often as possible). | |
| 1178 The price for such re-use is that when changes are made (such as new files | |
| 1179 are introduced into a directory), the listing may become out-of-date. One may | |
| 1180 always refresh directory listing buffers by pressing ctrl-L (see | |
| 1181 |netrw-ctrl-l|). | |
| 1182 | |
| 5734 | 1183 *:netrw-s-cr* |
| 1184 Squeezing the Current Tree-Listing Directory~ | |
| 1185 When the tree listing style is enabled (see |netrw-i|) and one is using | |
| 1186 gvim, then the <s-cr> mapping may be used to squeeze (close) the | |
| 1187 directory currently containing the cursor. | |
| 1188 | |
| 1621 | 1189 |
| 1190 Related topics: |netrw-o| |netrw-p| |netrw-P| |netrw-t| |netrw-v| | |
| 1191 Associated setting variables: |g:netrw_browse_split| |g:netrw_fastbrowse| | |
| 1192 |g:netrw_ftp_list_cmd| |g:netrw_ftp_sizelist_cmd| | |
| 1193 |g:netrw_ftp_timelist_cmd| |g:netrw_ssh_cmd| | |
| 1194 |g:netrw_ssh_browse_reject| |g:netrw_use_noswf| | |
| 1195 | |
| 1196 | |
| 1197 BROWSING WITH A HORIZONTALLY SPLIT WINDOW *netrw-o* *netrw-horiz* {{{2 | |
| 1198 | |
| 1199 Normally one enters a file or directory using the <cr>. However, the "o" map | |
| 1200 allows one to open a new window to hold the new directory listing or file. A | |
| 1201 horizontal split is used. (for vertical splitting, see |netrw-v|) | |
| 1202 | |
| 1203 Normally, the o key splits the window horizontally with the new window and | |
| 3153 | 1204 cursor at the top. |
| 1621 | 1205 |
| 1206 Associated setting variables: |g:netrw_alto| |g:netrw_winsize| | |
| 1207 | |
| 4339 | 1208 Related Actions |netrw-cr| |netrw-p| |netrw-t| |netrw-v| |
| 3153 | 1209 Associated setting variables: |
| 1210 |g:netrw_alto| control above/below splitting | |
| 1211 |g:netrw_winsize| control initial sizing | |
| 1621 | 1212 |
| 4339 | 1213 BROWSING WITH A NEW TAB *netrw-t* |
| 1621 | 1214 |
| 1215 Normally one enters a file or directory using the <cr>. The "t" map | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1216 allows one to open a new window holding the new directory listing or file in |
| 4339 | 1217 a new tab. |
| 1218 | |
| 1219 If you'd like to have the new listing in a background tab, use |gT|. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1220 |
| 3153 | 1221 Related Actions |netrw-cr| |netrw-o| |netrw-p| |netrw-v| |
| 1222 Associated setting variables: | |
| 1223 |g:netrw_winsize| control initial sizing | |
| 1621 | 1224 |
| 1225 BROWSING WITH A VERTICALLY SPLIT WINDOW *netrw-v* {{{2 | |
| 1226 | |
| 1227 Normally one enters a file or directory using the <cr>. However, the "v" map | |
| 1228 allows one to open a new window to hold the new directory listing or file. A | |
| 1229 vertical split is used. (for horizontal splitting, see |netrw-o|) | |
| 1230 | |
| 1231 Normally, the v key splits the window vertically with the new window and | |
| 3153 | 1232 cursor at the left. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1233 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1234 There is only one tree listing buffer; using "v" on a displayed subdirectory |
| 1621 | 1235 will split the screen, but the same buffer will be shown twice. |
| 1236 | |
| 1237 Associated setting variable: |g:netrw_altv| |g:netrw_winsize| | |
| 1238 | |
| 4339 | 1239 Related Actions |netrw-cr| |netrw-o| |netrw-t| |netrw-v| |
| 3153 | 1240 Associated setting variables: |
| 1241 |g:netrw_altv| control right/left splitting | |
| 1242 |g:netrw_winsize| control initial sizing | |
| 1243 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1244 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1245 CHANGE LISTING STYLE (THIN LONG WIDE TREE) *netrw-i* {{{2 |
| 519 | 1246 |
| 1121 | 1247 The "i" map cycles between the thin, long, wide, and tree listing formats. |
| 12 | 1248 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1249 The thin listing format gives just the files' and directories' names. |
| 519 | 1250 |
| 15 | 1251 The long listing is either based on the "ls" command via ssh for remote |
| 559 | 1252 directories or displays the filename, file size (in bytes), and the time and |
| 1253 date of last modification for local directories. With the long listing | |
| 1254 format, netrw is not able to recognize filenames which have trailing spaces. | |
| 1255 Use the thin listing format for such files. | |
| 519 | 1256 |
| 1121 | 1257 The wide listing format uses two or more contiguous spaces to delineate |
| 1258 filenames; when using that format, netrw won't be able to recognize or use | |
| 1259 filenames which have two or more contiguous spaces embedded in the name or any | |
| 1260 trailing spaces. The thin listing format will, however, work with such files. | |
| 1261 This listing format is the most compact. | |
| 1262 | |
| 1263 The tree listing format has a top directory followed by files and directories | |
| 1264 preceded by a "|". One may open and close directories by pressing the <cr> | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1265 key while atop the directory name. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1266 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1267 One may make a preferred listing style your default; see |g:netrw_liststyle|. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1268 As an example, by putting the following line in your .vimrc, > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1269 let g:netrw_liststyle= 4 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1270 the tree style will become your default listing style. |
| 15 | 1271 |
| 3456 | 1272 One typical way to use the netrw tree display is to: > |
| 1273 | |
| 1274 vim . | |
| 1275 (use i until a tree display shows) | |
| 1276 navigate to a file | |
| 1277 v (edit as desired in vertically split window) | |
| 1278 ctrl-w h (to return to the netrw listing) | |
| 1279 P (edit newly selected file in the previous window) | |
| 1280 ctrl-w h (to return to the netrw listing) | |
| 1281 P (edit newly selected file in the previous window) | |
| 1282 ...etc... | |
| 1283 < | |
| 1621 | 1284 Associated setting variables: |g:netrw_liststyle| |g:netrw_maxfilenamelen| |
| 1285 |g:netrw_timefmt| |g:netrw_list_cmd| | |
| 1286 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1287 CHANGE FILE PERMISSION *netrw-gp* {{{2 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1288 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1289 "gp" will ask you for a new permission for the file named under the cursor. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1290 Currently, this only works for local files. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1291 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1292 Associated setting variables: |g:netrw_chgperm| |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1293 |
| 1621 | 1294 |
| 1295 CHANGING TO A BOOKMARKED DIRECTORY *netrw-gb* {{{2 | |
| 1296 | |
| 1297 To change directory back to a bookmarked directory, use | |
| 1298 | |
| 1299 {cnt}gb | |
| 1300 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1301 Any count may be used to reference any of the bookmarks. |
| 4339 | 1302 Note that |netrw-qb| shows both bookmarks and history; to go |
| 1303 to a location stored in the history see |netrw-u| and |netrw-U|. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1304 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1305 Related Topics: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1306 |netrw-mB| how to delete bookmarks |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1307 |netrw-mb| how to make a bookmark |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1308 |netrw-qb| how to list bookmarks |
| 1621 | 1309 |
| 1310 | |
| 2152 | 1311 CHANGING TO A PREDECESSOR DIRECTORY *netrw-u* *netrw-updir* {{{2 |
| 36 | 1312 |
| 1313 Every time you change to a new directory (new for the current session), | |
| 1314 netrw will save the directory in a recently-visited directory history | |
| 2751 | 1315 list (unless |g:netrw_dirhistmax| is zero; by default, it's ten). With the |
| 36 | 1316 "u" map, one can change to an earlier directory (predecessor). To do |
| 1317 the opposite, see |netrw-U|. | |
| 1318 | |
| 4339 | 1319 The "u" map also accepts counts to go back in the history several slots. |
| 1320 For your convenience, |netrw-qb| lists the history number which can be | |
| 1321 re-used in that count. | |
| 1322 | |
| 1323 See |g:netrw_dirhistmax| for how to control the quantity of history stack | |
| 1324 slots. | |
| 1325 | |
| 36 | 1326 |
| 1621 | 1327 CHANGING TO A SUCCESSOR DIRECTORY *netrw-U* *netrw-downdir* {{{2 |
| 36 | 1328 |
| 1329 With the "U" map, one can change to a later directory (successor). | |
| 1330 This map is the opposite of the "u" map. (see |netrw-u|) Use the | |
| 1621 | 1331 q map to list both the bookmarks and history. (see |netrw-qb|) |
| 1332 | |
| 4339 | 1333 The "U" map also accepts counts to go forward in the history several slots. |
| 1334 | |
| 1335 See |g:netrw_dirhistmax| for how to control the quantity of history stack | |
| 1336 slots. | |
| 1337 | |
| 1621 | 1338 |
| 5618 | 1339 CHANGING TREE TOP *netrw-ntree* *:Ntree* |
| 1340 | |
| 1341 One may specify a new tree top for tree listings using > | |
| 1342 | |
| 1343 :Ntree [dirname] | |
| 1344 | |
| 1345 Without a "dirname", the current line is used (and any leading depth | |
| 1346 information is elided). | |
| 1347 With a "dirname", the specified directory name is used. | |
| 1348 | |
| 1349 | |
| 1621 | 1350 NETRW CLEAN *netrw-clean* *:NetrwClean* |
| 1351 | |
| 1352 With :NetrwClean one may easily remove netrw from one's home directory; | |
| 1353 more precisely, from the first directory on your |'runtimepath'|. | |
| 1354 | |
| 1355 With :NetrwClean!, netrw will remove netrw from all directories on your | |
| 1356 |'runtimepath'|. | |
| 1357 | |
| 1358 With either form of the command, netrw will first ask for confirmation | |
| 1359 that the removal is in fact what you want to do. If netrw doesn't have | |
| 1360 permission to remove a file, it will issue an error message. | |
| 36 | 1361 |
| 1121 | 1362 *netrw-gx* |
| 1621 | 1363 CUSTOMIZING BROWSING WITH A USER FUNCTION *netrw-x* *netrw-handler* {{{2 |
| 1121 | 1364 (also see |netrw_filehandler|) |
| 650 | 1365 |
| 1366 Certain files, such as html, gif, jpeg, (word/office) doc, etc, files, are | |
| 1367 best seen with a special handler (ie. a tool provided with your computer). | |
| 1368 Netrw allows one to invoke such special handlers by: > | |
| 12 | 1369 |
| 650 | 1370 * when Exploring, hit the "x" key |
| 1371 * when editing, hit gx with the cursor atop the special filename | |
| 1121 | 1372 < (not available if the |g:netrw_nogx| variable exists) |
| 1373 | |
| 650 | 1374 Netrw determines which special handler by the following method: |
| 1375 | |
| 1376 * if |g:netrw_browsex_viewer| exists, then it will be used to attempt to | |
| 1377 view files. Examples of useful settings (place into your <.vimrc>): > | |
| 1378 | |
| 1379 :let g:netrw_browsex_viewer= "kfmclient exec" | |
| 1380 < or > | |
| 1381 :let g:netrw_browsex_viewer= "gnome-open" | |
| 1382 < | |
| 1383 If g:netrw_browsex_viewer == '-', then netrwFileHandler() will be | |
| 1384 invoked first (see |netrw_filehandler|). | |
| 12 | 1385 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1386 * for Windows 32 or 64, the url and FileProtocolHandler dlls are used. |
| 650 | 1387 * for Gnome (with gnome-open): gnome-open is used. |
| 1621 | 1388 * for KDE (with kfmclient) : kfmclient is used. |
| 1389 * for Mac OS X : open is used. | |
| 559 | 1390 * otherwise the netrwFileHandler plugin is used. |
| 482 | 1391 |
| 1392 The file's suffix is used by these various approaches to determine an | |
| 559 | 1393 appropriate application to use to "handle" these files. Such things as |
| 1394 OpenOffice (*.sfx), visualization (*.jpg, *.gif, etc), and PostScript (*.ps, | |
| 1395 *.eps) can be handled. | |
| 482 | 1396 |
| 650 | 1397 *netrw_filehandler* |
| 1121 | 1398 |
| 1399 The "x" map applies a function to a file, based on its extension. Of course, | |
| 1400 the handler function must exist for it to be called! | |
| 12 | 1401 > |
| 1402 Ex. mypgm.html x -> | |
| 1121 | 1403 NFH_html("scp://user@host/some/path/mypgm.html") |
| 12 | 1404 < |
| 1121 | 1405 Users may write their own netrw File Handler functions to support more |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1406 suffixes with special handling. See <autoload/netrwFileHandlers.vim> for |
| 1121 | 1407 examples on how to make file handler functions. As an example: > |
| 12 | 1408 |
| 1121 | 1409 " NFH_suffix(filename) |
| 1410 fun! NFH_suffix(filename) | |
| 1411 ..do something special with filename.. | |
| 1412 endfun | |
| 1413 < | |
| 1414 These functions need to be defined in some file in your .vim/plugin | |
| 1415 (vimfiles\plugin) directory. Vim's function names may not have punctuation | |
| 1416 characters (except for the underscore) in them. To support suffices that | |
| 1417 contain such characters, netrw will first convert the suffix using the | |
| 1418 following table: > | |
| 650 | 1419 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1420 @ -> AT ! -> EXCLAMATION % -> PERCENT |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1421 : -> COLON = -> EQUAL ? -> QUESTION |
| 1121 | 1422 , -> COMMA - -> MINUS ; -> SEMICOLON |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1423 $ -> DOLLAR + -> PLUS ~ -> TILDE |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1424 < |
| 1121 | 1425 So, for example: > |
| 650 | 1426 |
| 1121 | 1427 file.rcs,v -> NFH_rcsCOMMAv() |
| 1428 < | |
| 1429 If more such translations are necessary, please send me email: > | |
| 1430 NdrOchip at ScampbellPfamily.AbizM - NOSPAM | |
| 1431 with a request. | |
| 482 | 1432 |
| 1621 | 1433 Associated setting variable: |g:netrw_browsex_viewer| |
| 1434 | |
| 1435 *netrw-curdir* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1436 DELETING BOOKMARKS *netrw-mB* {{{2 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1437 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1438 To delete a bookmark, use > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1439 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1440 {cnt}mB |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1441 < |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1442 Related Topics: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1443 |netrw-gb| how to return (go) to a bookmark |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1444 |netrw-mb| how to make a bookmark |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1445 |netrw-qb| how to list bookmarks |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1446 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1447 |
| 1621 | 1448 DELETING FILES OR DIRECTORIES *netrw-delete* *netrw-D* *netrw-del* {{{2 |
| 1449 | |
| 1450 If files have not been marked with |netrw-mf|: (local marked file list) | |
| 1451 | |
| 1452 Deleting/removing files and directories involves moving the cursor to the | |
| 1453 file/directory to be deleted and pressing "D". Directories must be empty | |
| 1454 first before they can be successfully removed. If the directory is a | |
| 1455 softlink to a directory, then netrw will make two requests to remove the | |
| 1456 directory before succeeding. Netrw will ask for confirmation before doing | |
| 1457 the removal(s). You may select a range of lines with the "V" command | |
| 1458 (visual selection), and then pressing "D". | |
| 1459 | |
| 1460 If files have been marked with |netrw-mf|: (local marked file list) | |
| 1461 | |
| 1462 Marked files (and empty directories) will be deleted; again, you'll be | |
| 1463 asked to confirm the deletion before it actually takes place. | |
| 1464 | |
| 1465 The |g:netrw_rm_cmd|, |g:netrw_rmf_cmd|, and |g:netrw_rmdir_cmd| variables are | |
| 1466 used to control the attempts to remove files and directories. The | |
| 1467 g:netrw_rm_cmd is used with files, and its default value is: | |
| 1468 | |
| 1469 g:netrw_rm_cmd: ssh HOSTNAME rm | |
| 1470 | |
| 1471 The g:netrw_rmdir_cmd variable is used to support the removal of directories. | |
| 1472 Its default value is: | |
| 1473 | |
| 1474 g:netrw_rmdir_cmd: ssh HOSTNAME rmdir | |
| 1475 | |
| 1476 If removing a directory fails with g:netrw_rmdir_cmd, netrw then will attempt | |
| 1477 to remove it again using the g:netrw_rmf_cmd variable. Its default value is: | |
| 1478 | |
| 1479 g:netrw_rmf_cmd: ssh HOSTNAME rm -f | |
| 1480 | |
| 3153 | 1481 Related topics: |netrw-d| |
| 3456 | 1482 Associated setting variable: |g:netrw_localrmdir| |g:netrw_rm_cmd| |
| 1621 | 1483 |g:netrw_rmdir_cmd| |g:netrw_ssh_cmd| |
| 1484 | |
| 1485 | |
| 1486 *netrw-explore* *netrw-hexplore* *netrw-nexplore* *netrw-pexplore* | |
| 5618 | 1487 *netrw-rexplore* *netrw-sexplore* *netrw-texplore* *netrw-vexplore* *netrw-lexplore* |
| 1621 | 1488 DIRECTORY EXPLORATION COMMANDS {{{2 |
| 1489 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1490 :[N]Explore[!] [dir]... Explore directory of current file *:Explore* |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1491 :[N]Hexplore[!] [dir]... Horizontal Split & Explore *:Hexplore* |
| 5734 | 1492 :Rexplore ... Return to/from Explorer *:Rexplore* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1493 :[N]Sexplore[!] [dir]... Split&Explore current file's directory *:Sexplore* |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1494 :Texplore [dir]... Tab & Explore *:Texplore* |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1495 :[N]Vexplore[!] [dir]... Vertical Split & Explore *:Vexplore* |
| 5618 | 1496 :Lexplore [dir]... Left Explorer Toggle *:Lexplore* |
| 1621 | 1497 |
| 1498 Used with :Explore **/pattern : (also see |netrw-starstar|) | |
| 1499 :Nexplore............. go to next matching file *:Nexplore* | |
| 1500 :Pexplore............. go to previous matching file *:Pexplore* | |
| 1501 | |
| 5734 | 1502 *netrw-:Explore* |
| 1621 | 1503 :Explore will open the local-directory browser on the current file's |
| 1504 directory (or on directory [dir] if specified). The window will be | |
| 1505 split only if the file has been modified, otherwise the browsing | |
| 1506 window will take over that window. Normally the splitting is taken | |
| 1507 horizontally. | |
| 5734 | 1508 Also see: |netrw-:Rexplore| |
| 1621 | 1509 :Explore! is like :Explore, but will use vertical splitting. |
| 5734 | 1510 *netrw-:Lexplore* |
| 5618 | 1511 :Lexplore [dir] toggles an Explorer window on the left hand side |
| 1512 of the current tab It will open a netrw window on the current | |
| 5734 | 1513 directory if [dir] is omitted; a :Lexplore [dir] will show |
| 1514 the specified directory in the left-hand side browser display | |
| 1515 no matter from which window the command is issued. By default, | |
| 1516 :Lexplore will change an uninitialized |g:netrw_chgwin| to 2; | |
| 1517 edits will thus be preferentially made in window#2. | |
| 1518 Also see: |netrw-C|| |g:netrw_chgwin| |g:netrw_winsize| | |
| 1519 |netrw-p| |netrw-P|| |g:netrw_browse_split| | |
| 1520 *netrw-:Sexplore* | |
| 1621 | 1521 :Sexplore will always split the window before invoking the local-directory |
| 1522 browser. As with Explore, the splitting is normally done | |
| 1523 horizontally. | |
| 1524 :Sexplore! [dir] is like :Sexplore, but the splitting will be done vertically. | |
| 5734 | 1525 *netrw-:Hexplore* |
| 1621 | 1526 :Hexplore [dir] does an :Explore with |:belowright| horizontal splitting. |
| 1527 :Hexplore! [dir] does an :Explore with |:aboveleft| horizontal splitting. | |
| 5734 | 1528 *netrw-:Vexplore* |
| 1621 | 1529 :Vexplore [dir] does an :Explore with |:leftabove| vertical splitting. |
| 1530 :Vexplore! [dir] does an :Explore with |:rightbelow| vertical splitting. | |
| 5734 | 1531 *netrw-:Texplore* |
| 5618 | 1532 :Texplore [dir] does a |:tabnew| before generating the browser window |
| 1621 | 1533 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1534 By default, these commands use the current file's directory. However, one may |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1535 explicitly provide a directory (path) to use. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1536 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1537 The [N] will override |g:netrw_winsize| to specify the quantity of rows and/or |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1538 columns the new explorer window should have. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1539 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1540 Otherwise, the |g:netrw_winsize| variable, if it has been specified by the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1541 user, is used to control the quantity of rows and/or columns new explorer |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1542 windows should have. |
| 1621 | 1543 |
| 5734 | 1544 *netrw-:Rexplore* |
| 1545 :Rexplore This command is a little different from the others as it doesn't | |
| 1546 necessarily open an Explorer window. | |
| 1547 | |
| 1548 Return to Explorer~ | |
| 1549 When one edits a file, for example by pressing <cr> when the | |
| 1550 cursor is atop a file in a netrw browser window, :Rexplore will | |
| 1551 return the display to that of the last netrw browser window. | |
| 1552 | |
| 1553 Return from Explorer~ | |
| 1554 Conversely, when one is editing a directory, issuing a :Rexplore | |
| 1555 will return to editing the last file being edited in that | |
| 1556 window. | |
| 1557 | |
| 1558 The <2-leftmouse> map (which is only available under gvim and | |
| 1559 cooperative terms) does the same as :Rexplore. | |
| 1621 | 1560 |
| 5618 | 1561 Also see: |g:netrw_alto| |g:netrw_altv| |g:netrw_winsize| |
| 1562 | |
| 1621 | 1563 |
| 1564 *netrw-star* *netrw-starpat* *netrw-starstar* *netrw-starstarpat* | |
| 1565 EXPLORING WITH STARS AND PATTERNS | |
| 1566 | |
| 1567 When Explore, Sexplore, Hexplore, or Vexplore are used with one of the | |
| 1568 following four styles, Explore generates a list of files which satisfy | |
| 1569 the request. > | |
| 1570 | |
| 1571 */filepat files in current directory which satisfy filepat | |
| 1572 **/filepat files in current directory or below which satisfy the | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1573 file pattern |
| 1621 | 1574 *//pattern files in the current directory which contain the |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1575 pattern (vimgrep is used) |
| 1621 | 1576 **//pattern files in the current directory or below which contain |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1577 the pattern (vimgrep is used) |
| 464 | 1578 < |
| 1621 | 1579 The cursor will be placed on the first file in the list. One may then |
| 1580 continue to go to subsequent files on that list via |:Nexplore| or to | |
| 1581 preceding files on that list with |:Pexplore|. Explore will update the | |
| 1582 directory and place the cursor appropriately. | |
| 1583 | |
| 1584 A plain > | |
| 1585 :Explore | |
| 1586 will clear the explore list. | |
| 1587 | |
| 1588 If your console or gui produces recognizable shift-up or shift-down sequences, | |
| 1589 then you'll likely find using shift-downarrow and shift-uparrow convenient. | |
| 1590 They're mapped by netrw: | |
| 1591 | |
| 1592 <s-down> == Nexplore, and | |
| 1593 <s-up> == Pexplore. | |
| 1594 | |
| 1595 As an example, consider | |
| 1596 > | |
| 1597 :Explore */*.c | |
| 1598 :Nexplore | |
| 1599 :Nexplore | |
| 1600 :Pexplore | |
| 1601 < | |
| 1602 The status line will show, on the right hand side of the status line, a | |
| 1603 message like "Match 3 of 20". | |
| 1604 | |
| 5734 | 1605 Associated setting variables: |
| 1606 |g:netrw_keepdir| |g:netrw_browse_split| | |
| 1607 |g:netrw_fastbrowse| |g:netrw_ftp_browse_reject| | |
| 1608 |g:netrw_ftp_list_cmd| |g:netrw_ftp_sizelist_cmd| | |
| 1609 |g:netrw_ftp_timelist_cmd| |g:netrw_list_cmd| | |
| 1610 |g:netrw_liststyle| | |
| 1621 | 1611 |
| 1612 | |
| 1613 DISPLAYING INFORMATION ABOUT FILE *netrw-qf* {{{2 | |
| 1614 | |
| 1615 With the cursor atop a filename, pressing "qf" will reveal the file's size | |
| 1616 and last modification timestamp. Currently this capability is only available | |
| 1617 for local files. | |
| 1618 | |
| 1619 | |
| 1620 EDIT FILE OR DIRECTORY HIDING LIST *netrw-ctrl-h* *netrw-edithide* {{{2 | |
| 1621 | |
| 1622 The "<ctrl-h>" map brings up a requestor allowing the user to change the | |
| 1623 file/directory hiding list contained in |g:netrw_list_hide|. The hiding list | |
| 1624 consists of one or more patterns delimited by commas. Files and/or | |
| 1625 directories satisfying these patterns will either be hidden (ie. not shown) or | |
| 1626 be the only ones displayed (see |netrw-a|). | |
| 1627 | |
| 1628 The "gh" mapping (see |netrw-gh|) quickly alternates between the usual | |
| 1629 hiding list and the hiding of files or directories that begin with ".". | |
| 1630 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1631 As an example, > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1632 let g:netrw_list_hide= '\(^\|\s\s\)\zs\.\S\+' |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1633 Effectively, this makes the effect of a |netrw-gh| command the initial setting. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1634 What it means: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1635 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1636 \(^\|\s\s\) : if the line begins with the following, -or- |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1637 two consecutive spaces are encountered |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1638 \zs : start the hiding match now |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1639 \. : if it now begins with a dot |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1640 \S\+ : and is followed by one or more non-whitespace |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1641 characters |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1642 |
| 1621 | 1643 Associated setting variables: |g:netrw_hide| |g:netrw_list_hide| |
| 1644 Associated topics: |netrw-a| |netrw-gh| |netrw-mh| | |
| 1645 | |
| 3153 | 1646 *netrw-sort-sequence* |
| 1621 | 1647 EDITING THE SORTING SEQUENCE *netrw-S* *netrw-sortsequence* {{{2 |
| 1648 | |
| 1649 When "Sorted by" is name, one may specify priority via the sorting sequence | |
| 1650 (g:netrw_sort_sequence). The sorting sequence typically prioritizes the | |
| 1651 name-listing by suffix, although any pattern will do. Patterns are delimited | |
| 1652 by commas. The default sorting sequence is (all one line): | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1653 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1654 For Unix: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1655 '[\/]$,\<core\%(\.\d\+\)\=,\.[a-np-z]$,\.h$,\.c$,\.cpp$,*,\.o$,\.obj$, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1656 \.info$,\.swp$,\.bak$,\~$' |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1657 < |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1658 Otherwise: > |
| 1621 | 1659 '[\/]$,\.[a-np-z]$,\.h$,\.c$,\.cpp$,*,\.o$,\.obj$,\.info$, |
| 1660 \.swp$,\.bak$,\~$' | |
| 1661 < | |
| 1662 The lone * is where all filenames not covered by one of the other patterns | |
| 1663 will end up. One may change the sorting sequence by modifying the | |
| 1664 g:netrw_sort_sequence variable (either manually or in your <.vimrc>) or by | |
| 1665 using the "S" map. | |
| 1666 | |
| 1668 | 1667 Related topics: |netrw-s| |netrw-S| |
| 1668 Associated setting variables: |g:netrw_sort_sequence| |g:netrw_sort_options| | |
| 1621 | 1669 |
| 1670 | |
| 3920 | 1671 EXECUTING FILE UNDER CURSOR VIA SYSTEM() *netrw-X* |
| 1672 | |
| 1673 Pressing X while the cursor is atop an executable file will yield a prompt | |
| 1674 using the filename asking for any arguments. Upon pressing a [return], netrw | |
| 1675 will then call |system()| with that command and arguments. The result will | |
| 1676 be displayed by |:echomsg|, and so |:messages| will repeat display of the | |
| 1677 result. Ansi escape sequences will be stripped out. | |
| 1678 | |
| 1679 | |
| 2751 | 1680 FORCING TREATMENT AS A FILE OR DIRECTORY *netrw-gd* *netrw-gf* {{{2 |
| 1681 | |
| 1682 Remote symbolic links (ie. those listed via ssh or ftp) are problematic | |
| 1683 in that it is difficult to tell whether they link to a file or to a | |
| 1684 directory. | |
| 1685 | |
| 1686 To force treatment as a file: use > | |
| 3920 | 1687 gf |
| 2751 | 1688 < |
| 1689 To force treatment as a directory: use > | |
| 3920 | 1690 gd |
| 2751 | 1691 < |
| 1692 | |
| 1621 | 1693 GOING UP *netrw--* {{{2 |
| 1694 | |
| 1695 To go up a directory, press "-" or press the <cr> when atop the ../ directory | |
| 1696 entry in the listing. | |
| 1697 | |
| 1698 Netrw will use the command in |g:netrw_list_cmd| to perform the directory | |
| 1699 listing operation after changing HOSTNAME to the host specified by the | |
| 5734 | 1700 user-prpvided url. By default netrw provides the command as: > |
| 1621 | 1701 |
| 1702 ssh HOSTNAME ls -FLa | |
| 5734 | 1703 < |
| 1621 | 1704 where the HOSTNAME becomes the [user@]hostname as requested by the attempt to |
| 1705 read. Naturally, the user may override this command with whatever is | |
| 1706 preferred. The NetList function which implements remote browsing | |
| 1707 expects that directories will be flagged by a trailing slash. | |
| 1708 | |
| 1709 | |
| 1710 HIDING FILES OR DIRECTORIES *netrw-a* *netrw-hiding* {{{2 | |
| 1711 | |
| 1712 Netrw's browsing facility allows one to use the hiding list in one of three | |
| 1713 ways: ignore it, hide files which match, and show only those files which | |
| 1714 match. | |
| 1715 | |
| 1716 If no files have been marked via |netrw-mf|: | |
| 1717 | |
| 1718 The "a" map allows the user to cycle through the three hiding modes. | |
| 1719 | |
| 1720 The |g:netrw_list_hide| variable holds a comma delimited list of patterns | |
| 1721 based on regular expressions (ex. ^.*\.obj$,^\.) which specify the hiding list. | |
| 1722 (also see |netrw-ctrl-h|) To set the hiding list, use the <c-h> map. As an | |
| 1723 example, to hide files which begin with a ".", one may use the <c-h> map to | |
| 1724 set the hiding list to '^\..*' (or one may put let g:netrw_list_hide= '^\..*' | |
| 1725 in one's <.vimrc>). One may then use the "a" key to show all files, hide | |
| 1726 matching files, or to show only the matching files. | |
| 1727 | |
| 1728 Example: \.[ch]$ | |
| 1729 This hiding list command will hide/show all *.c and *.h files. | |
| 1730 | |
| 1731 Example: \.c$,\.h$ | |
| 1732 This hiding list command will also hide/show all *.c and *.h | |
| 1733 files. | |
| 1734 | |
| 1735 Don't forget to use the "a" map to select the mode (normal/hiding/show) you | |
| 1736 want! | |
| 1737 | |
| 1738 If files have been marked using |netrw-mf|, then this command will: | |
| 1739 | |
| 1740 if showing all files or non-hidden files: | |
| 1741 modify the g:netrw_list_hide list by appending the marked files to it | |
| 1742 and showing only non-hidden files. | |
| 1743 | |
| 1744 else if showing hidden files only: | |
| 1745 modify the g:netrw_list_hide list by removing the marked files from it | |
| 1746 and showing only non-hidden files. | |
| 1747 endif | |
| 1748 | |
| 1749 *netrw-gh* *netrw-hide* | |
| 1750 As a quick shortcut, one may press > | |
| 1751 gh | |
| 1752 to toggle between hiding files which begin with a period (dot) and not hiding | |
| 1753 them. | |
| 1754 | |
| 5618 | 1755 Associated setting variables: |g:netrw_list_hide| |g:netrw_hide| |
| 1621 | 1756 Associated topics: |netrw-a| |netrw-ctrl-h| |netrw-mh| |
| 1757 | |
| 5618 | 1758 *netrw-gitignore* |
| 1759 Netrw provides a helper function 'netrw_gitignore#Hide()' that, when used with | |
| 1760 |g:netrw_list_hide| automatically hides all git-ignored files. | |
| 1761 | |
| 1762 'netrw_gitignore#Hide' searches for patterns in the following files: | |
| 1763 './.gitignore' | |
| 1764 './.git/info/exclude' | |
| 1765 global gitignore file: `git config --global core.excludesfile` | |
| 1766 system gitignore file: `git config --system core.excludesfile` | |
| 1767 | |
| 1768 Files that do not exist, are ignored. | |
| 1769 Git-ignore patterns are taken from existing files, and converted to patterns for | |
| 1770 hiding files. For example, if you had '*.log' in your '.gitignore' file, it | |
| 1771 would be converted to '.*\.log'. | |
| 1772 | |
| 1773 To use this function, simply assign it's output to |g:netrw_list_hide| option. | |
| 1774 | |
| 1775 Example: let g:netrw_list_hide= netrw_gitignore#Hide() | |
| 1776 Git-ignored files are hidden in Netrw. | |
| 1777 | |
| 1778 Example: let g:netrw_list_hide= netrw_gitignore#Hide('my_gitignore_file') | |
| 1779 Function can take additional files with git-ignore patterns. | |
| 1780 | |
| 1781 Example: g:netrw_list_hide= netrw_gitignore#Hide() . '.*\.swp$' | |
| 1782 Combining 'netrw_gitignore#Hide' with custom patterns. | |
| 1783 | |
| 1784 | |
| 1621 | 1785 IMPROVING BROWSING *netrw-listhack* *netrw-ssh-hack* {{{2 |
| 12 | 1786 |
| 1787 Especially with the remote directory browser, constantly entering the password | |
| 1788 is tedious. | |
| 1789 | |
| 1121 | 1790 For Linux/Unix systems, the book "Linux Server Hacks - 100 industrial strength |
| 1209 | 1791 tips & tools" by Rob Flickenger (O'Reilly, ISBN 0-596-00461-3) gives a tip |
| 1792 for setting up no-password ssh and scp and discusses associated security | |
| 1121 | 1793 issues. It used to be available at http://hacks.oreilly.com/pub/h/66 , |
| 1794 but apparently that address is now being redirected to some "hackzine". | |
| 1698 | 1795 I'll attempt a summary based on that article and on a communication from |
| 1796 Ben Schmidt: | |
| 1797 | |
| 1798 1. Generate a public/private key pair on the local machine | |
| 1799 (ssh client): > | |
| 1800 ssh-keygen -t rsa | |
| 1801 (saving the file in ~/.ssh/id_rsa as prompted) | |
| 1802 < | |
| 1803 2. Just hit the <CR> when asked for passphrase (twice) for no | |
| 1804 passphrase. If you do use a passphrase, you will also need to use | |
| 1805 ssh-agent so you only have to type the passphrase once per session. | |
| 1806 If you don't use a passphrase, simply logging onto your local | |
| 1807 computer or getting access to the keyfile in any way will suffice | |
| 1808 to access any ssh servers which have that key authorized for login. | |
| 1809 | |
| 1810 3. This creates two files: > | |
| 1811 ~/.ssh/id_rsa | |
| 1812 ~/.ssh/id_rsa.pub | |
| 1813 < | |
| 1814 4. On the target machine (ssh server): > | |
| 1815 cd | |
| 1816 mkdir -p .ssh | |
| 1817 chmod 0700 .ssh | |
| 1818 < | |
| 1819 5. On your local machine (ssh client): (one line) > | |
| 1820 ssh {serverhostname} | |
| 1821 cat '>>' '~/.ssh/authorized_keys2' < ~/.ssh/id_rsa.pub | |
| 1822 < | |
| 1823 or, for OpenSSH, (one line) > | |
| 1824 ssh {serverhostname} | |
| 1825 cat '>>' '~/.ssh/authorized_keys' < ~/.ssh/id_rsa.pub | |
| 1826 < | |
| 1827 You can test it out with > | |
| 1828 ssh {serverhostname} | |
| 1829 and you should be log onto the server machine without further need to type | |
| 1830 anything. | |
| 1831 | |
| 1832 If you decided to use a passphrase, do: > | |
| 1833 ssh-agent $SHELL | |
| 1834 ssh-add | |
| 1835 ssh {serverhostname} | |
| 1836 You will be prompted for your key passphrase when you use ssh-add, but not | |
| 1837 subsequently when you use ssh. For use with vim, you can use > | |
| 1838 ssh-agent vim | |
| 1839 and, when next within vim, use > | |
| 1840 :!ssh-add | |
| 1841 Alternatively, you can apply ssh-agent to the terminal you're planning on | |
| 1842 running vim in: > | |
| 1843 ssh-agent xterm & | |
| 1844 and do ssh-add whenever you need. | |
| 9 | 1845 |
| 1121 | 1846 For Windows, folks on the vim mailing list have mentioned that Pageant helps |
| 1847 with avoiding the constant need to enter the password. | |
| 794 | 1848 |
| 1621 | 1849 Kingston Fung wrote about another way to avoid constantly needing to enter |
| 1850 passwords: | |
| 1851 | |
| 1852 In order to avoid the need to type in the password for scp each time, you | |
| 1853 provide a hack in the docs to set up a non password ssh account. I found a | |
| 1854 better way to do that: I can use a regular ssh account which uses a | |
| 1855 password to access the material without the need to key-in the password | |
| 1856 each time. It's good for security and convenience. I tried ssh public key | |
| 1857 authorization + ssh-agent, implementing this, and it works! Here are two | |
| 1858 links with instructions: | |
| 1859 | |
| 1860 http://www.ibm.com/developerworks/library/l-keyc2/ | |
| 1861 http://sial.org/howto/openssh/publickey-auth/ | |
| 1862 | |
| 1863 | |
| 5618 | 1864 Ssh hints: |
| 1865 | |
| 1866 Thomer Gil has provided a hint on how to speed up netrw+ssh: | |
| 1867 http://thomer.com/howtos/netrw_ssh.html | |
| 1868 | |
| 1869 Alex Young has several hints on speeding ssh up: | |
| 1870 http://usevim.com/2012/03/16/editing-remote-files/ | |
| 1871 | |
| 1872 | |
| 1621 | 1873 LISTING BOOKMARKS AND HISTORY *netrw-qb* *netrw-listbookmark* {{{2 |
| 1874 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1875 Pressing "qb" (query bookmarks) will list both the bookmarked directories and |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1876 directory traversal history. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1877 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1878 Related Topics: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1879 |netrw-gb| how to return (go) to a bookmark |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1880 |netrw-mb| how to make a bookmark |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1881 |netrw-mB| how to delete bookmarks |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1882 |netrw-u| change to a predecessor directory via the history stack |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1883 |netrw-U| change to a successor directory via the history stack |
| 1621 | 1884 |
| 1885 MAKING A NEW DIRECTORY *netrw-d* {{{2 | |
| 1886 | |
| 1887 With the "d" map one may make a new directory either remotely (which depends | |
| 1888 on the global variable g:netrw_mkdir_cmd) or locally (which depends on the | |
| 3456 | 1889 global variable g:netrw_localmkdir). Netrw will issue a request for the new |
| 1621 | 1890 directory's name. A bare <CR> at that point will abort the making of the |
| 1891 directory. Attempts to make a local directory that already exists (as either | |
| 1892 a file or a directory) will be detected, reported on, and ignored. | |
| 1893 | |
| 3153 | 1894 Related topics: |netrw-D| |
| 5618 | 1895 Associated setting variables: |g:netrw_localmkdir| |g:netrw_mkdir_cmd| |
| 1896 |g:netrw_remote_mkdir| |netrw-%| | |
| 1621 | 1897 |
| 1898 | |
| 1899 MAKING THE BROWSING DIRECTORY THE CURRENT DIRECTORY *netrw-c* {{{2 | |
| 1900 | |
| 1901 By default, |g:netrw_keepdir| is 1. This setting means that the current | |
| 4339 | 1902 directory will not track the browsing directory. (done for backwards |
| 1903 compatibility with v6's file explorer). | |
| 1904 | |
| 1905 Setting g:netrw_keepdir to 0 tells netrw to make vim's current directory | |
| 1621 | 1906 track netrw's browsing directory. |
| 1907 | |
| 1908 However, given the default setting for g:netrw_keepdir of 1 where netrw | |
| 1909 maintains its own separate notion of the current directory, in order to make | |
| 1910 the two directories the same, use the "c" map (just type c). That map will | |
| 1911 set Vim's notion of the current directory to netrw's current browsing | |
| 1912 directory. | |
| 1913 | |
| 1914 Associated setting variable: |g:netrw_keepdir| | |
| 1915 | |
| 5734 | 1916 MARKING FILES *netrw-:MF* *netrw-mf* {{{2 |
| 1621 | 1917 (also see |netrw-mr|) |
| 1918 | |
| 5734 | 1919 Netrw has several ways of marking files: |
| 1920 | |
| 1921 * One may mark files with the cursor atop a filename and | |
| 1922 then pressing "mf". | |
| 1923 | |
| 1924 * With gvim, in addition one may mark files with | |
| 1925 <s-leftmouse>. | |
| 1926 | |
| 1927 * One may use the :MF command, which takes a list of | |
| 1928 files (for local directories, the list may include | |
| 1929 wildcards -- see |glob()|) > | |
| 1930 | |
| 1931 :MF *.c | |
| 1932 < | |
| 1933 * Note that :MF uses |<f-args>| to break the line | |
| 1934 at spaces. | |
| 1935 | |
| 1936 The following netrw maps make use of marked files: | |
| 1621 | 1937 |
| 1938 |netrw-a| Hide marked files/directories | |
| 1939 |netrw-D| Delete marked files/directories | |
| 1940 |netrw-mc| Copy marked files to target | |
| 1941 |netrw-md| Apply vimdiff to marked files | |
| 1942 |netrw-me| Edit marked files | |
| 4339 | 1943 |netrw-mF| Unmark marked files |
| 1621 | 1944 |netrw-mg| Apply vimgrep to marked files |
| 5734 | 1945 |netrw-mm| Move marked files to target |
| 1621 | 1946 |netrw-mp| Print marked files |
| 1947 |netrw-mt| Set target for |netrw-mm| and |netrw-mc| | |
| 1948 |netrw-mT| Generate tags using marked files | |
| 1949 |netrw-mx| Apply shell command to marked files | |
| 1950 |netrw-mz| Compress/Decompress marked files | |
| 4339 | 1951 |netrw-qF| Mark files using quickfix list |
| 1621 | 1952 |netrw-O| Obtain marked files |
| 1953 |netrw-R| Rename marked files | |
| 1954 | |
| 1955 One may unmark files one at a time the same way one marks them; ie. place | |
| 1956 the cursor atop a marked file and press "mf". This process also works | |
| 1957 with <s-leftmouse> using gvim. One may unmark all files by pressing | |
| 1958 "mu" (see |netrw-mu|). | |
| 1959 | |
| 2751 | 1960 Marked files are highlighted using the "netrwMarkFile" highlighting group, |
| 1961 which by default is linked to "Identifier" (see Identifier under | |
| 1962 |group-name|). You may change the highlighting group by putting something | |
| 1963 like > | |
| 1964 | |
| 1965 highlight clear netrwMarkFile | |
| 1966 hi link netrwMarkFile ..whatever.. | |
| 1967 < | |
| 1968 into $HOME/.vim/after/syntax/netrw.vim . | |
| 1969 | |
| 5618 | 1970 If the mouse is enabled and works with your vim, you may use <s-leftmouse> to |
| 1971 mark one or more files. You may mark multiple files by dragging the shifted | |
| 1972 leftmouse. (see |netrw-mouse|) | |
| 1973 | |
| 1621 | 1974 *markfilelist* *global_markfilelist* *local_markfilelist* |
| 1975 All marked files are entered onto the global marked file list; there is only | |
| 1976 one such list. In addition, every netrw buffer also has its own local marked | |
| 1977 file list; since netrw buffers are associated with specific directories, this | |
| 1978 means that each directory has its own local marked file list. The various | |
| 1979 commands which operate on marked files use one or the other of the marked file | |
| 1980 lists. | |
| 1981 | |
| 5734 | 1982 Known Problem: if one is using tree mode (|g:netrw_liststyle|) and several |
| 1983 directories have files with the same name, then marking such a file will | |
| 1984 result in all such files being highlighted as if they were all marked. The | |
| 1985 |markfilelist|, however, will only have the selected file in it. This problem | |
| 1986 is unlikely to be fixed. | |
| 1987 | |
| 1621 | 1988 |
| 4339 | 1989 UNMARKING FILES *netrw-mF* {{{2 |
| 1990 (also see |netrw-mf|) | |
| 1991 | |
| 1992 This command will unmark all files in the current buffer. One may also use | |
| 1993 mf (|netrw-mf|) on a specific file to unmark just that file. | |
| 1994 | |
| 1995 | |
| 1996 MARKING FILES BY QUICKFIX LIST *netrw-qF* | |
| 1997 (also see |netrw-mf|) | |
| 1998 | |
| 1999 One may convert the |quickfix-error-lists| into a marked file list using | |
| 2000 "qF". You may then proceed with commands such as me (|netrw-me|) to | |
| 2001 edit them. Quickfix error lists are generated, for example, by calls | |
| 2002 to |:vimgrep|. | |
| 2003 | |
| 2004 | |
| 1621 | 2005 MARKING FILES BY REGULAR EXPRESSION *netrw-mr* {{{2 |
| 2006 (also see |netrw-mf|) | |
| 2007 | |
| 2008 One may also mark files by pressing "mr"; netrw will then issue a prompt, | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2009 "Enter regexp: ". You may then enter a shell-style regular expression such |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2010 as *.c$ (see |glob()|). For remote systems, glob() doesn't work -- so netrw |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2011 converts "*" into ".*" (see |regexp|) and marks files based on that. In the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2012 future I may make it possible to use |regexp|s instead of glob()-style |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2013 expressions (yet-another-option). |
| 1621 | 2014 |
| 2015 | |
| 2016 MARKED FILES: ARBITRARY COMMAND *netrw-mx* {{{2 | |
| 2017 (See |netrw-mf| and |netrw-mr| for how to mark files) | |
| 2018 (uses the local marked-file list) | |
| 2019 | |
| 2020 Upon activation of the "mx" map, netrw will query the user for some (external) | |
| 2021 command to be applied to all marked files. All "%"s in the command will be | |
| 2022 substituted with the name of each marked file in turn. If no "%"s are in the | |
| 2023 command, then the command will be followed by a space and a marked filename. | |
| 2024 | |
| 2025 | |
| 2026 MARKED FILES: COMPRESSION AND DECOMPRESSION *netrw-mz* {{{2 | |
| 2027 (See |netrw-mf| and |netrw-mr| for how to mark files) | |
| 2028 (uses the local marked file list) | |
| 2029 | |
| 2030 If any marked files are compressed, then "mz" will decompress them. | |
| 2031 If any marked files are decompressed, then "mz" will compress them | |
| 2032 using the command specified by |g:netrw_compress|; by default, | |
| 2033 that's "gzip". | |
| 2034 | |
| 2035 For decompression, netrw provides a |Dictionary| of suffices and their | |
| 2036 associated decompressing utilities; see |g:netrw_decompress|. | |
| 2037 | |
| 2038 Associated setting variables: |g:netrw_compress| |g:netrw_decompress| | |
| 2039 | |
| 2040 MARKED FILES: COPYING *netrw-mc* {{{2 | |
| 2041 (See |netrw-mf| and |netrw-mr| for how to mark files) | |
| 2042 (Uses the global marked file list) | |
| 2043 | |
| 2044 Select a target directory with mt (|netrw-mt|). Then change directory, | |
| 2751 | 2045 select file(s) (see |netrw-mf|), and press "mc". The copy is done |
| 2046 from the current window (where one does the mf) to the target. | |
| 1621 | 2047 |
| 2048 Associated setting variable: |g:netrw_localcopycmd| |g:netrw_ssh_cmd| | |
| 2049 | |
| 2050 MARKED FILES: DIFF *netrw-md* {{{2 | |
| 2051 (See |netrw-mf| and |netrw-mr| for how to mark files) | |
| 2052 (uses the global marked file list) | |
| 2053 | |
| 2054 Use |vimdiff| to visualize difference between selected files (two or | |
| 2055 three may be selected for this). Uses the global marked file list. | |
| 2056 | |
| 2057 MARKED FILES: EDITING *netrw-me* {{{2 | |
| 2058 (See |netrw-mf| and |netrw-mr| for how to mark files) | |
| 2059 (uses the global marked file list) | |
| 2060 | |
| 2061 This command will place the marked files on the |arglist| and commence | |
| 2062 editing them. One may return the to explorer window with |:Rexplore|. | |
| 4339 | 2063 (use |:n| and |:p| to edit next and previous files in the arglist) |
| 1621 | 2064 |
| 2065 MARKED FILES: GREP *netrw-mg* {{{2 | |
| 2066 (See |netrw-mf| and |netrw-mr| for how to mark files) | |
| 2067 (uses the global marked file list) | |
| 2068 | |
| 4339 | 2069 This command will apply |:vimgrep| to the marked files. |
| 2070 The command will ask for the requested pattern; one may then enter: > | |
| 2071 | |
| 1621 | 2072 /pattern/[g][j] |
| 2073 ! /pattern/[g][j] | |
| 2074 pattern | |
| 2075 < | |
| 4339 | 2076 In the cases of "j" option usage as shown above, "mg" will winnow the current |
| 2077 marked file list to just those possessing the specified pattern. | |
| 2078 Thus, one may use > | |
| 2079 mr ...file-pattern | |
| 2080 mg ..contents-pattern | |
| 2081 to have a marked file list satisfying the file-pattern but containing the | |
| 2082 desried contents-pattern. | |
| 2083 | |
| 1621 | 2084 MARKED FILES: HIDING AND UNHIDING BY SUFFIX *netrw-mh* {{{2 |
| 2085 (See |netrw-mf| and |netrw-mr| for how to mark files) | |
| 2086 (uses the local marked file list) | |
| 2087 | |
| 2088 This command extracts the suffices of the marked files and toggles their | |
| 2089 presence on the hiding list. Please note that marking the same suffix | |
| 2090 this way multiple times will result in the suffix's presence being toggled | |
| 2091 for each file (so an even quantity of marked files having the same suffix | |
| 2092 is the same as not having bothered to select them at all). | |
| 2093 | |
| 2094 Related topics: |netrw-a| |g:netrw_list_hide| | |
| 2095 | |
| 2096 MARKED FILES: MOVING *netrw-mm* {{{2 | |
| 2097 (See |netrw-mf| and |netrw-mr| for how to mark files) | |
| 2098 (uses the global marked file list) | |
| 2099 | |
| 1698 | 2100 WARNING: moving files is more dangerous than copying them. |
| 2101 A file being moved is first copied and then deleted; if the | |
| 2102 copy operation fails and the delete succeeds, you will lose | |
| 2103 the file. Either try things out with unimportant files | |
| 2104 first or do the copy and then delete yourself using mc and D. | |
| 2105 Use at your own risk! | |
| 2106 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2107 Select a target directory with mt (|netrw-mt|). Then change directory, |
| 2751 | 2108 select file(s) (see |netrw-mf|), and press "mm". The move is done |
| 2109 from the current window (where one does the mf) to the target. | |
| 1621 | 2110 |
| 2111 Associated setting variable: |g:netrw_localmovecmd| |g:netrw_ssh_cmd| | |
| 2112 | |
| 2113 MARKED FILES: PRINTING *netrw-mp* {{{2 | |
| 2114 (See |netrw-mf| and |netrw-mr| for how to mark files) | |
| 2115 (uses the local marked file list) | |
| 2116 | |
| 2117 Netrw will apply the |:hardcopy| command to marked files. What it does | |
| 2118 is open each file in a one-line window, execute hardcopy, then close the | |
| 2119 one-line window. | |
| 2120 | |
| 2121 | |
| 2122 MARKED FILES: SOURCING *netrw-ms* {{{2 | |
| 2123 (See |netrw-mf| and |netrw-mr| for how to mark files) | |
| 2124 (uses the local marked file list) | |
| 2125 | |
| 2126 Netrw will source the marked files (using vim's |:source| command) | |
| 2127 | |
| 2128 | |
| 4339 | 2129 MARKED FILES: SETTING THE TARGET DIRECTORY *netrw-mt* {{{2 |
| 2130 (See |netrw-mf| and |netrw-mr| for how to mark files) | |
| 2131 | |
| 2132 Set the marked file copy/move-to target (see |netrw-mc| and |netrw-mm|): | |
| 2133 | |
| 2134 * If the cursor is atop a file name, then the netrw window's currently | |
| 2135 displayed directory is used for the copy/move-to target. | |
| 2136 | |
| 2137 * Also, if the cursor is in the banner, then the netrw window's currently | |
| 2138 displayed directory is used for the copy/move-to target. | |
| 2139 Unless the target already is the current directory. In which case, | |
| 2140 remove the target. | |
| 2141 | |
| 2142 * However, if the cursor is atop a directory name, then that directory is | |
| 2143 used for the copy/move-to target | |
| 2144 | |
| 5734 | 2145 * One may use the :MT [directory] command to set the target *netrw-:MT* |
| 2146 This command uses |<q-args>|, so spaces in the directory name are | |
| 2147 permitted without escaping. | |
| 2148 | |
| 4339 | 2149 There is only one copy/move-to target per vim session; ie. the target is a |
| 2150 script variable (see |s:var|) and is shared between all netrw windows (in an | |
| 2151 instance of vim). | |
| 2152 | |
| 2153 When using menus and gvim, netrw provides a "Targets" entry which allows one | |
| 2154 to pick a target from the list of bookmarks and history. | |
| 2155 | |
| 2156 Related topics: | |
| 2157 Marking Files......................................|netrw-mf| | |
| 2158 Marking Files by Regular Expression................|netrw-mr| | |
| 2159 Marked Files: Target Directory Using Bookmarks.....|netrw-Tb| | |
| 2160 Marked Files: Target Directory Using History.......|netrw-Th| | |
| 2161 | |
| 2162 | |
| 1621 | 2163 MARKED FILES: TAGGING *netrw-mT* {{{2 |
| 2164 (See |netrw-mf| and |netrw-mr| for how to mark files) | |
| 2165 (uses the global marked file list) | |
| 2166 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2167 The "mT" mapping will apply the command in |g:netrw_ctags| (by default, it is |
| 1621 | 2168 "ctags") to marked files. For remote browsing, in order to create a tags file |
| 2169 netrw will use ssh (see |g:netrw_ssh_cmd|), and so ssh must be available for | |
| 2170 this to work on remote systems. For your local system, see |ctags| on how to | |
| 2171 get a version. I myself use hdrtags, currently available at | |
| 3920 | 2172 http://www.drchip.org/astronaut/src/index.html , and have > |
| 1621 | 2173 |
| 2174 let g:netrw_ctags= "hdrtag" | |
| 2175 < | |
| 2176 in my <.vimrc>. | |
| 2177 | |
| 2178 When a remote set of files are tagged, the resulting tags file is "obtained"; | |
| 5734 | 2179 ie. a copy is transferred to the local system's directory. The now local tags |
| 1621 | 2180 file is then modified so that one may use it through the network. The |
| 5734 | 2181 modification made concerns the names of the files in the tags; each filename is |
| 1621 | 2182 preceded by the netrw-compatible url used to obtain it. When one subsequently |
| 2183 uses one of the go to tag actions (|tags|), the url will be used by netrw to | |
| 2184 edit the desired file and go to the tag. | |
| 2185 | |
| 1668 | 2186 Associated setting variables: |g:netrw_ctags| |g:netrw_ssh_cmd| |
| 1621 | 2187 |
| 4339 | 2188 MARKED FILES: TARGET DIRECTORY USING BOOKMARKS *netrw-Tb* {{{2 |
| 2189 | |
| 5734 | 2190 Sets the marked file copy/move-to target. |
| 4339 | 2191 |
| 2192 The |netrw-qb| map will give you a list of bookmarks (and history). | |
| 2193 One may choose one of the bookmarks to become your marked file | |
| 2194 target by using [count]Tb (default count: 1). | |
| 2195 | |
| 2196 Related topics: | |
| 5734 | 2197 Copying files to target............................|netrw-mc| |
| 4339 | 2198 Listing Bookmarks and History......................|netrw-qb| |
| 2199 Marked Files: Setting The Target Directory.........|netrw-mt| | |
| 2200 Marked Files: Target Directory Using History.......|netrw-Th| | |
| 2201 Marking Files......................................|netrw-mf| | |
| 2202 Marking Files by Regular Expression................|netrw-mr| | |
| 5734 | 2203 Moving files to target.............................|netrw-mm| |
| 4339 | 2204 |
| 2205 | |
| 2206 MARKED FILES: TARGET DIRECTORY USING HISTORY *netrw-Th* {{{2 | |
| 2207 | |
| 5734 | 2208 Sets the marked file copy/move-to target. |
| 4339 | 2209 |
| 2210 The |netrw-qb| map will give you a list of history (and bookmarks). | |
| 2211 One may choose one of the history entries to become your marked file | |
| 2212 target by using [count]Th (default count: 0; ie. the current directory). | |
| 2213 | |
| 2214 Related topics: | |
| 5734 | 2215 Copying files to target............................|netrw-mc| |
| 4339 | 2216 Listing Bookmarks and History......................|netrw-qb| |
| 2217 Marked Files: Setting The Target Directory.........|netrw-mt| | |
| 2218 Marked Files: Target Directory Using Bookmarks.....|netrw-Tb| | |
| 2219 Marking Files......................................|netrw-mf| | |
| 2220 Marking Files by Regular Expression................|netrw-mr| | |
| 5734 | 2221 Moving files to target.............................|netrw-mm| |
| 4339 | 2222 |
| 1621 | 2223 |
| 2224 MARKED FILES: UNMARKING *netrw-mu* {{{2 | |
| 2225 (See |netrw-mf| and |netrw-mr| for how to mark files) | |
| 2226 | |
| 2227 The "mu" mapping will unmark all currently marked files. | |
| 2228 | |
| 3153 | 2229 *netrw-browser-settings* |
| 1621 | 2230 NETRW BROWSER VARIABLES *netrw-browser-options* *netrw-browser-var* {{{2 |
| 2231 | |
| 3153 | 2232 (if you're interested in the netrw file transfer settings, see |netrw-options| |
| 2233 and |netrw-protocol|) | |
| 1621 | 2234 |
| 2235 The <netrw.vim> browser provides settings in the form of variables which | |
| 2236 you may modify; by placing these settings in your <.vimrc>, you may customize | |
| 2237 your browsing preferences. (see also: |netrw-settings|) | |
| 2238 > | |
| 2239 --- ----------- | |
| 2240 Var Explanation | |
| 2241 --- ----------- | |
| 5618 | 2242 < *g:netrw_altfile* some like |CTRL-^| to return to the last |
| 2243 edited file. Choose that by setting this | |
| 2244 parameter to 1. | |
| 2245 Others like |CTRL-^| to return to the | |
| 2246 netrw browsing buffer. Choose that by setting | |
| 2247 this parameter to 0. | |
| 2248 default: =0 | |
| 2249 | |
| 2250 *g:netrw_alto* change from above splitting to below splitting | |
| 1621 | 2251 by setting this variable (see |netrw-o|) |
| 2252 default: =&sb (see |'sb'|) | |
| 2253 | |
| 4339 | 2254 *g:netrw_altv* change from left splitting to right splitting |
| 1621 | 2255 by setting this variable (see |netrw-v|) |
| 2256 default: =&spr (see |'spr'|) | |
| 2257 | |
| 4339 | 2258 *g:netrw_banner* enable/suppress the banner |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2259 =0: suppress the banner |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2260 =1: banner is enabled (default) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2261 NOTE: suppressing the banner is a new feature |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2262 which may cause problems. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2263 |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
2264 *g:netrw_bannerbackslash* if this variable exists and is not zero, the |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
2265 banner will be displayed with backslashes |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
2266 rather than forward slashes. |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
2267 |
| 4339 | 2268 *g:netrw_browse_split* when browsing, <cr> will open the file by: |
| 1621 | 2269 =0: re-using the same window |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2270 =1: horizontally splitting the window first |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2271 =2: vertically splitting the window first |
| 1621 | 2272 =3: open file in new tab |
| 2273 =4: act like "P" (ie. open previous window) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2274 Note that |g:netrw_preview| may be used |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2275 to get vertical splitting instead of |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2276 horizontal splitting. |
| 1621 | 2277 |
| 5618 | 2278 Related topics: |
| 2279 |netrw-cr| |netrw-C| | |
| 2280 |g:netrw_alto| |g:netrw_altv| | |
| 2281 | |
| 4339 | 2282 *g:netrw_browsex_viewer* specify user's preference for a viewer: > |
| 1621 | 2283 "kfmclient exec" |
| 2284 "gnome-open" | |
| 2285 < If > | |
| 2286 "-" | |
| 2287 < is used, then netrwFileHandler() will look for | |
| 2288 a script/function to handle the given | |
| 2289 extension. (see |netrw_filehandler|). | |
| 2290 | |
| 4339 | 2291 *g:netrw_chgperm* Unix/Linux: "chmod PERM FILENAME" |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2292 Windows: "cacls FILENAME /e /p PERM" |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2293 Used to change access permission for a file. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2294 |
| 4339 | 2295 *g:netrw_compress* ="gzip" |
| 1621 | 2296 Will compress marked files with this |
| 2297 command | |
| 2298 | |
| 4339 | 2299 *g:Netrw_corehandler* Allows one to specify something additional |
| 3153 | 2300 to do when handling <core> files via netrw's |
| 2301 browser's "x" command (see |netrw-x|). If | |
| 2302 present, g:Netrw_corehandler specifies | |
| 2303 either one or more function references | |
| 2304 (see |Funcref|). (the capital g:Netrw... | |
| 2305 is required its holding a function reference) | |
| 2306 | |
| 2307 | |
| 4339 | 2308 *g:netrw_ctags* ="ctags" |
| 2309 The default external program used to create | |
| 2310 tags | |
| 2311 | |
| 2312 *g:netrw_cursor* = 2 (default) | |
| 2751 | 2313 This option controls the use of the |
| 2314 |'cursorline'| (cul) and |'cursorcolumn'| | |
| 2315 (cuc) settings by netrw: | |
| 2316 | |
| 2317 Value Thin-Long-Tree Wide | |
| 2318 =0 u-cul u-cuc u-cul u-cuc | |
| 2319 =1 u-cul u-cuc cul u-cuc | |
| 2320 =2 cul u-cuc cul u-cuc | |
| 2321 =3 cul u-cuc cul cuc | |
| 2322 =4 cul cuc cul cuc | |
| 2323 | |
| 2324 Where | |
| 2325 u-cul : user's |'cursorline'| setting used | |
| 2326 u-cuc : user's |'cursorcolumn'| setting used | |
| 2327 cul : |'cursorline'| locally set | |
| 2328 cuc : |'cursorcolumn'| locally set | |
| 2329 | |
| 4339 | 2330 *g:netrw_decompress* = { ".gz" : "gunzip" , |
| 1621 | 2331 ".bz2" : "bunzip2" , |
| 2332 ".zip" : "unzip" , | |
| 2333 ".tar" : "tar -xf"} | |
| 2334 A dictionary mapping suffices to | |
| 2335 decompression programs. | |
| 2336 | |
| 2751 | 2337 *g:netrw_dirhistmax* =10: controls maximum quantity of past |
| 2338 history. May be zero to supppress | |
| 2339 history. | |
| 2340 (related: |netrw-qb| |netrw-u| |netrw-U|) | |
| 2341 | |
| 3920 | 2342 *g:netrw_dynamic_maxfilenamelen* =32: enables dynamic determination of |
| 2343 |g:netrw_maxfilenamelen|, which affects | |
| 2344 local file long listing. | |
| 5734 | 2345 |
| 3456 | 2346 *g:netrw_errorlvl* =0: error levels greater than or equal to |
| 2347 this are permitted to be displayed | |
| 2348 0: notes | |
| 2349 1: warnings | |
| 2350 2: errors | |
| 2351 | |
| 4339 | 2352 *g:netrw_fastbrowse* =0: slow speed directory browsing; |
| 1621 | 2353 never re-uses directory listings, |
| 2354 always obtains directory listings. | |
| 2355 =1: medium speed directory browsing; | |
| 2356 re-use directory listings only | |
| 2357 when remote directory browsing. | |
| 2358 (default value) | |
| 2359 =2: fast directory browsing; | |
| 2360 only obtains directory listings when the | |
| 2361 directory hasn't been seen before | |
| 2362 (or |netrw-ctrl-l| is used). | |
| 2363 | |
| 2364 Fast browsing retains old directory listing | |
| 2365 buffers so that they don't need to be | |
| 2366 re-acquired. This feature is especially | |
| 2367 important for remote browsing. However, if | |
| 2368 a file is introduced or deleted into or from | |
| 2369 such directories, the old directory buffer | |
| 2370 becomes out-of-date. One may always refresh | |
| 2371 such a directory listing with |netrw-ctrl-l|. | |
| 2372 This option gives the user the choice of | |
| 2373 trading off accuracy (ie. up-to-date listing) | |
| 2374 versus speed. | |
| 2375 | |
| 4339 | 2376 *g:netrw_fname_escape* =' ?&;%' |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2377 Used on filenames before remote reading/writing |
| 1621 | 2378 |
| 4339 | 2379 *g:netrw_ftp_browse_reject* ftp can produce a number of errors and warnings |
| 1621 | 2380 that can show up as "directories" and "files" |
| 2381 in the listing. This pattern is used to | |
| 2382 remove such embedded messages. By default its | |
| 2383 value is: | |
| 2384 '^total\s\+\d\+$\| | |
| 2385 ^Trying\s\+\d\+.*$\| | |
| 2386 ^KERBEROS_V\d rejected\| | |
| 2387 ^Security extensions not\| | |
| 2388 No such file\| | |
| 2389 : connect to address [0-9a-fA-F:]* | |
| 2390 : No route to host$' | |
| 2391 | |
| 4339 | 2392 *g:netrw_ftp_list_cmd* options for passing along to ftp for directory |
| 1621 | 2393 listing. Defaults: |
| 2394 unix or g:netrw_cygwin set: : "ls -lF" | |
| 2395 otherwise "dir" | |
| 2396 | |
| 2397 | |
| 4339 | 2398 *g:netrw_ftp_sizelist_cmd* options for passing along to ftp for directory |
| 1621 | 2399 listing, sorted by size of file. |
| 2400 Defaults: | |
| 2401 unix or g:netrw_cygwin set: : "ls -slF" | |
| 2402 otherwise "dir" | |
| 2403 | |
| 4339 | 2404 *g:netrw_ftp_timelist_cmd* options for passing along to ftp for directory |
| 1621 | 2405 listing, sorted by time of last modification. |
| 2406 Defaults: | |
| 2407 unix or g:netrw_cygwin set: : "ls -tlF" | |
| 2408 otherwise "dir" | |
| 2409 | |
| 3456 | 2410 *g:netrw_glob_escape* ='[]*?`{~$' (unix) |
| 2152 | 2411 ='[]*?`{$' (windows |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2412 These characters in directory names are |
| 1621 | 2413 escaped before applying glob() |
| 2414 | |
| 4339 | 2415 *g:netrw_hide* Controlled by the "a" map (see |netrw-a|) |
| 2416 =0 : show all | |
| 2417 =1 : show not-hidden files | |
| 2418 =2 : show hidden files only | |
| 1621 | 2419 default: =0 |
| 2420 | |
| 4339 | 2421 *g:netrw_home* The home directory for where bookmarks and |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2422 history are saved (as .netrwbook and |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2423 .netrwhist). |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2424 default: the first directory on the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2425 |'runtimepath'| |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2426 |
| 4339 | 2427 *g:netrw_keepdir* =1 (default) keep current directory immune from |
| 1621 | 2428 the browsing directory. |
| 2429 =0 keep the current directory the same as the | |
| 2430 browsing directory. | |
| 2431 The current browsing directory is contained in | |
| 2432 b:netrw_curdir (also see |netrw-c|) | |
| 2433 | |
| 4339 | 2434 *g:netrw_list_cmd* command for listing remote directories |
| 1621 | 2435 default: (if ssh is executable) |
| 2436 "ssh HOSTNAME ls -FLa" | |
| 2437 | |
| 4339 | 2438 *g:netrw_liststyle* Set the default listing style: |
| 1621 | 2439 = 0: thin listing (one file per line) |
| 2440 = 1: long listing (one file per line with time | |
| 2441 stamp information and file size) | |
| 2442 = 2: wide listing (multiple files in columns) | |
| 2443 = 3: tree style listing | |
| 5618 | 2444 |
| 4339 | 2445 *g:netrw_list_hide* comma separated pattern list for hiding files |
| 1621 | 2446 Patterns are regular expressions (see |regexp|) |
| 5618 | 2447 There's some special support for git-ignore |
| 2448 files: you may add the output from the helper | |
| 2449 function 'netrw_gitignore#Hide() automatically | |
| 2450 hiding all gitignored files. | |
| 2451 For more details see |netrw-gitignore|. | |
| 2452 | |
| 2453 Examples: | |
| 2454 let g:netrw_list_hide= '.*\.swp$' | |
| 2455 let g:netrw_list_hide= netrw_gitignore#Hide().'.*\.swp$' | |
| 2456 default: "" | |
| 1621 | 2457 |
| 4339 | 2458 *g:netrw_localcopycmd* ="cp" Linux/Unix/MacOS/Cygwin |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2459 ="copy" Windows |
| 1621 | 2460 Copies marked files (|netrw-mf|) to target |
| 2461 directory (|netrw-mt|, |netrw-mc|) | |
| 2462 | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
2463 *g:netrw_localmkdir* command for making a local directory |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
2464 default: "mkdir" |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
2465 |
| 4339 | 2466 *g:netrw_localmovecmd* ="mv" Linux/Unix/MacOS/Cygwin |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2467 ="move" Windows |
| 1621 | 2468 Moves marked files (|netrw-mf|) to target |
| 2469 directory (|netrw-mt|, |netrw-mm|) | |
| 2470 | |
| 4339 | 2471 *g:netrw_localrmdir* remove directory command (rmdir) |
| 1621 | 2472 default: "rmdir" |
| 2473 | |
| 4339 | 2474 *g:netrw_maxfilenamelen* =32 by default, selected so as to make long |
| 1621 | 2475 listings fit on 80 column displays. |
| 2476 If your screen is wider, and you have file | |
| 2477 or directory names longer than 32 bytes, | |
| 2478 you may set this option to keep listings | |
| 2479 columnar. | |
| 2480 | |
| 4339 | 2481 *g:netrw_mkdir_cmd* command for making a remote directory |
| 3153 | 2482 via ssh (also see |g:netrw_remote_mkdir|) |
| 1621 | 2483 default: "ssh USEPORT HOSTNAME mkdir" |
| 2484 | |
| 2908 | 2485 *g:netrw_mousemaps* =1 (default) enables mouse buttons while |
| 2486 browsing to: | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2487 leftmouse : open file/directory |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2488 shift-leftmouse : mark file |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2489 middlemouse : same as P |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2490 rightmouse : remove file/directory |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2491 =0: disables mouse maps |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2492 |
| 3153 | 2493 *g:netrw_nobeval* doesn't exist (default) |
| 2494 If this variable exists, then balloon | |
| 2495 evaluation will be suppressed | |
| 2496 (see |'ballooneval'|) | |
| 2497 | |
| 5734 | 2498 *g:netrw_remote_mkdir* command for making a remote directory |
| 3153 | 2499 via ftp (also see |g:netrw_mkdir_cmd|) |
| 2500 default: "mkdir" | |
| 2501 | |
| 4339 | 2502 *g:netrw_retmap* if it exists and is set to one, then: |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2503 * if in a netrw-selected file, AND |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2504 * no normal-mode <2-leftmouse> mapping exists, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2505 then the <2-leftmouse> will be mapped for easy |
| 1621 | 2506 return to the netrw browser window. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2507 example: click once to select and open a file, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2508 double-click to return. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2509 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2510 Note that one may instead choose to: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2511 * let g:netrw_retmap= 1, AND |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2512 * nmap <silent> YourChoice <Plug>NetrwReturn |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2513 and have another mapping instead of |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2514 <2-leftmouse> to invoke the return. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2515 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2516 You may also use the |:Rexplore| command to do |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2517 the same thing. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2518 |
| 1621 | 2519 default: =0 |
| 2520 | |
| 4339 | 2521 *g:netrw_rm_cmd* command for removing files |
| 1621 | 2522 default: "ssh USEPORT HOSTNAME rm" |
| 2523 | |
| 4339 | 2524 *g:netrw_rmdir_cmd* command for removing directories |
| 1621 | 2525 default: "ssh USEPORT HOSTNAME rmdir" |
| 2526 | |
| 4339 | 2527 *g:netrw_rmf_cmd* command for removing softlinks |
| 1621 | 2528 default: "ssh USEPORT HOSTNAME rm -f" |
| 2529 | |
| 4339 | 2530 *g:netrw_sort_by* sort by "name", "time", or "size" |
| 1621 | 2531 default: "name" |
| 2532 | |
| 4339 | 2533 *g:netrw_sort_direction* sorting direction: "normal" or "reverse" |
| 1621 | 2534 default: "normal" |
| 2535 | |
| 4339 | 2536 *g:netrw_sort_options* sorting is done using |:sort|; this |
| 1668 | 2537 variable's value is appended to the |
| 2538 sort command. Thus one may ignore case, | |
| 2539 for example, with the following in your | |
| 2540 .vimrc: > | |
| 2541 let g:netrw_sort_options="i" | |
| 2542 < default: "" | |
| 2543 | |
| 4339 | 2544 *g:netrw_sort_sequence* when sorting by name, first sort by the |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2545 comma-separated pattern sequence. Note that |
| 5734 | 2546 any filigree added to indicate filetypes |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2547 should be accounted for in your pattern. |
| 1621 | 2548 default: '[\/]$,*,\.bak$,\.o$,\.h$, |
| 2549 \.info$,\.swp$,\.obj$' | |
| 2550 | |
| 4339 | 2551 *g:netrw_special_syntax* If true, then certain files will be shown |
| 3456 | 2552 using special syntax in the browser: |
| 1621 | 2553 |
| 2554 netrwBak : *.bak | |
| 2555 netrwCompress: *.gz *.bz2 *.Z *.zip | |
| 2556 netrwData : *.dat | |
| 2557 netrwHdr : *.h | |
| 2558 netrwLib : *.a *.so *.lib *.dll | |
| 2559 netrwMakefile: [mM]akefile *.mak | |
| 2560 netrwObj : *.o *.obj | |
| 2561 netrwTags : tags ANmenu ANtags | |
| 5734 | 2562 netrwTilde : * |
| 1621 | 2563 netrwTmp : tmp* *tmp |
| 2564 | |
| 2565 These syntax highlighting groups are linked | |
| 2566 to Folded or DiffChange by default | |
| 2567 (see |hl-Folded| and |hl-DiffChange|), but | |
| 2568 one may put lines like > | |
| 2569 hi link netrwCompress Visual | |
| 2570 < into one's <.vimrc> to use one's own | |
| 5734 | 2571 preferences. Alternatively, one may |
| 2572 put such specifications into | |
| 2573 .vim/after/syntax/netrw.vim. | |
| 2574 | |
| 2575 As an example, I myself use a dark-background | |
| 2576 colorscheme with the following in | |
| 2577 .vim/after/syntax/netrw.vim: > | |
| 2578 | |
| 2579 hi netrwCompress term=NONE cterm=NONE gui=NONE ctermfg=10 guifg=green ctermbg=0 guibg=black | |
| 2580 hi netrwData term=NONE cterm=NONE gui=NONE ctermfg=9 guifg=blue ctermbg=0 guibg=black | |
| 2581 hi netrwHdr term=NONE cterm=NONE,italic gui=NONE guifg=SeaGreen1 | |
| 2582 hi netrwLex term=NONE cterm=NONE,italic gui=NONE guifg=SeaGreen1 | |
| 2583 hi netrwYacc term=NONE cterm=NONE,italic gui=NONE guifg=SeaGreen1 | |
| 2584 hi netrwLib term=NONE cterm=NONE gui=NONE ctermfg=14 guifg=yellow | |
| 2585 hi netrwObj term=NONE cterm=NONE gui=NONE ctermfg=12 guifg=red | |
| 2586 hi netrwTilde term=NONE cterm=NONE gui=NONE ctermfg=12 guifg=red | |
| 2587 hi netrwTmp term=NONE cterm=NONE gui=NONE ctermfg=12 guifg=red | |
| 2588 hi netrwTags term=NONE cterm=NONE gui=NONE ctermfg=12 guifg=red | |
| 2589 hi netrwDoc term=NONE cterm=NONE gui=NONE ctermfg=220 ctermbg=27 guifg=yellow2 guibg=Blue3 | |
| 2590 hi netrwSymLink term=NONE cterm=NONE gui=NONE ctermfg=220 ctermbg=27 guifg=grey60 | |
| 2591 < | |
| 4339 | 2592 *g:netrw_ssh_browse_reject* ssh can sometimes produce unwanted lines, |
| 1621 | 2593 messages, banners, and whatnot that one doesn't |
| 2594 want masquerading as "directories" and "files". | |
| 2595 Use this pattern to remove such embedded | |
| 2596 messages. By default its value is: | |
| 2597 '^total\s\+\d\+$' | |
| 2598 | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
2599 *g:netrw_ssh_cmd* One may specify an executable command |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
2600 to use instead of ssh for remote actions |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
2601 such as listing, file removal, etc. |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
2602 default: ssh |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
2603 |
| 1621 | 2604 |
| 4339 | 2605 *g:netrw_tmpfile_escape* =' &;' |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2606 escape() is applied to all temporary files |
| 1621 | 2607 to escape these characters. |
| 2608 | |
| 4339 | 2609 *g:netrw_timefmt* specify format string to vim's strftime(). |
| 1621 | 2610 The default, "%c", is "the preferred date |
| 2611 and time representation for the current | |
| 2612 locale" according to my manpage entry for | |
| 2613 strftime(); however, not all are satisfied | |
| 2614 with it. Some alternatives: | |
| 2615 "%a %d %b %Y %T", | |
| 2616 " %a %Y-%m-%d %I-%M-%S %p" | |
| 2617 default: "%c" | |
| 2618 | |
| 4339 | 2619 *g:netrw_use_noswf* netrw normally avoids writing swapfiles |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2620 for browser buffers. However, under some |
| 1621 | 2621 systems this apparently is causing nasty |
| 2622 ml_get errors to appear; if you're getting | |
| 2623 ml_get errors, try putting | |
| 2624 let g:netrw_use_noswf= 0 | |
| 2625 in your .vimrc. | |
| 5734 | 2626 default: 1 |
| 1621 | 2627 |
| 4339 | 2628 *g:netrw_winsize* specify initial size of new windows made with |
| 1621 | 2629 "o" (see |netrw-o|), "v" (see |netrw-v|), |
| 2908 | 2630 |:Hexplore| or |:Vexplore|. The g:netrw_winsize |
| 2631 is an integer describing the percentage of the | |
| 2632 current netrw buffer's window to be used for | |
| 2633 the new window. | |
| 3153 | 2634 If g:netrw_winsize is less than zero, then |
| 2635 the absolute value of g:netrw_winsize lines | |
| 2636 or columns will be used for the new window. | |
| 2908 | 2637 default: 50 (for 50%) |
| 1621 | 2638 |
| 4339 | 2639 *g:netrw_xstrlen* Controls how netrw computes string lengths, |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2640 including multi-byte characters' string |
| 1621 | 2641 length. (thanks to N Weibull, T Mechelynck) |
| 2642 =0: uses Vim's built-in strlen() | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2643 =1: number of codepoints (Latin a + combining |
| 1621 | 2644 circumflex is two codepoints) (DEFAULT) |
| 2645 =2: number of spacing codepoints (Latin a + | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2646 combining circumflex is one spacing |
| 1621 | 2647 codepoint; a hard tab is one; wide and |
| 2648 narrow CJK are one each; etc.) | |
| 2649 =3: virtual length (counting tabs as anything | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2650 between 1 and |'tabstop'|, wide CJK as 2 |
| 1621 | 2651 rather than 1, Arabic alif as zero when |
| 2652 immediately preceded by lam, one | |
| 2653 otherwise, etc) | |
| 2654 | |
| 4339 | 2655 *g:NetrwTopLvlMenu* This variable specifies the top level |
| 1621 | 2656 menu name; by default, it's "Netrw.". If |
| 2657 you wish to change this, do so in your | |
| 2658 .vimrc. | |
| 2659 | |
| 2660 NETRW BROWSING AND OPTION INCOMPATIBILITIES *netrw-incompatible* {{{2 | |
| 2661 | |
| 2662 Netrw has been designed to handle user options by saving them, setting the | |
| 2663 options to something that's compatible with netrw's needs, and then restoring | |
| 2664 them. However, the autochdir option: > | |
| 2665 :set acd | |
| 5734 | 2666 is problematic. Autochdir sets the current directory to that containing the |
| 1621 | 2667 file you edit; this apparently also applies to directories. In other words, |
| 2668 autochdir sets the current directory to that containing the "file" (even if | |
| 2669 that "file" is itself a directory). | |
| 2670 | |
| 3153 | 2671 NETRW SETTINGS WINDOW *netrw-settings-window* {{{2 |
| 482 | 2672 |
| 2673 With the NetrwSettings.vim plugin, > | |
| 2674 :NetrwSettings | |
| 2675 will bring up a window with the many variables that netrw uses for its | |
| 559 | 2676 settings. You may change any of their values; when you save the file, the |
| 2677 settings therein will be used. One may also press "?" on any of the lines for | |
| 2678 help on what each of the variables do. | |
| 482 | 2679 |
| 3456 | 2680 (also see: |netrw-browser-var| |netrw-protocol| |netrw-variables|) |
| 1121 | 2681 |
| 482 | 2682 |
| 9 | 2683 ============================================================================== |
| 1621 | 2684 OBTAINING A FILE *netrw-O* {{{2 |
| 2685 | |
| 2686 If there are no marked files: | |
| 2687 | |
| 2688 When browsing a remote directory, one may obtain a file under the cursor | |
| 2689 (ie. get a copy on your local machine, but not edit it) by pressing the O | |
| 2690 key. | |
| 2691 | |
| 2692 If there are marked files: | |
| 2693 | |
| 2694 The marked files will be obtained (ie. a copy will be transferred to your | |
| 2695 local machine, but not set up for editing). | |
| 2696 | |
| 2697 Only ftp and scp are supported for this operation (but since these two are | |
| 2698 available for browsing, that shouldn't be a problem). The status bar will | |
| 2699 then show, on its right hand side, a message like "Obtaining filename". The | |
| 2700 statusline will be restored after the transfer is complete. | |
| 2701 | |
| 2702 Netrw can also "obtain" a file using the local browser. Netrw's display | |
| 2703 of a directory is not necessarily the same as Vim's "current directory", | |
| 2704 unless |g:netrw_keepdir| is set to 0 in the user's <.vimrc>. One may select | |
| 2705 a file using the local browser (by putting the cursor on it) and pressing | |
| 2706 "O" will then "obtain" the file; ie. copy it to Vim's current directory. | |
| 2707 | |
| 2708 Related topics: | |
| 2709 * To see what the current directory is, use |:pwd| | |
| 2710 * To make the currently browsed directory the current directory, see |netrw-c| | |
| 2711 * To automatically make the currently browsed directory the current | |
| 2712 directory, see |g:netrw_keepdir|. | |
| 2713 | |
| 2751 | 2714 *netrw-createfile* |
| 1668 | 2715 OPEN A NEW FILE IN NETRW'S CURRENT DIRECTORY *netrw-%* |
| 2716 | |
| 5734 | 2717 To open a new file in netrw's current directory, press "%". This map |
| 2718 will query the user for a new filename; an empty file by that name will | |
| 2719 be placed in the netrw's current directory (ie. b:netrw_curdir). | |
| 1668 | 2720 |
| 5618 | 2721 Related topics: |netrw-d| |
| 2722 | |
| 1668 | 2723 |
| 1621 | 2724 PREVIEW WINDOW *netrw-p* *netrw-preview* {{{2 |
| 2725 | |
| 2726 One may use a preview window by using the "p" key when the cursor is atop the | |
| 2727 desired filename to be previewed. The display will then split to show both | |
| 2728 the browser (where the cursor will remain) and the file (see |:pedit|). | |
| 2729 By default, the split will be taken horizontally; one may use vertical | |
| 2730 splitting if one has set |g:netrw_preview| first. | |
| 2731 | |
| 2152 | 2732 An interesting set of netrw settings is: > |
| 2733 | |
| 2734 let g:netrw_preview = 1 | |
| 2735 let g:netrw_liststyle = 3 | |
| 2736 let g:netrw_winsize = 30 | |
| 2737 | |
| 2738 These will: | |
| 2739 1. Make vertical splitting the default for previewing files | |
| 2740 2. Make the default listing style "tree" | |
| 2741 3. When a vertical preview window is opened, the directory listing | |
| 3456 | 2742 will use only 30% of the columns available; the rest of the window |
| 2743 is used for the preview window. | |
| 1621 | 2744 |
| 5734 | 2745 Also see: |g:netrw_chgwin| |netrw-P| |
| 2746 | |
| 2747 | |
| 1621 | 2748 PREVIOUS WINDOW *netrw-P* *netrw-prvwin* {{{2 |
| 2749 | |
| 2750 To edit a file or directory in the previously used (last accessed) window (see | |
| 2751 :he |CTRL-W_p|), press a "P". If there's only one window, then the one window | |
| 3153 | 2752 will be horizontally split (by default). |
| 1621 | 2753 |
| 2754 If there's more than one window, the previous window will be re-used on | |
| 2755 the selected file/directory. If the previous window's associated buffer | |
| 2756 has been modified, and there's only one window with that buffer, then | |
| 2757 the user will be asked if s/he wishes to save the buffer first (yes, | |
| 2758 no, or cancel). | |
| 2759 | |
| 4339 | 2760 Related Actions |netrw-cr| |netrw-o| |netrw-t| |netrw-v| |
| 3153 | 2761 Associated setting variables: |
| 2762 |g:netrw_alto| control above/below splitting | |
| 2763 |g:netrw_altv| control right/left splitting | |
| 2764 |g:netrw_preview| control horizontal vs vertical splitting | |
| 2765 |g:netrw_winsize| control initial sizing | |
| 2766 | |
| 5734 | 2767 Also see: |g:netrw_chgwin| |netrw-p| |
| 2768 | |
| 1621 | 2769 |
| 2770 REFRESHING THE LISTING *netrw-ctrl-l* *netrw-ctrl_l* {{{2 | |
| 2771 | |
| 2772 To refresh either a local or remote directory listing, press ctrl-l (<c-l>) or | |
| 2773 hit the <cr> when atop the ./ directory entry in the listing. One may also | |
| 2774 refresh a local directory by using ":e .". | |
| 2775 | |
| 2776 | |
| 4339 | 2777 REVERSING SORTING ORDER *netrw-r* *netrw-reverse* {{{2 |
| 2778 | |
| 2779 One may toggle between normal and reverse sorting order by pressing the | |
| 2780 "r" key. | |
| 2781 | |
| 2782 Related topics: |netrw-s| | |
| 2783 Associated setting variable: |g:netrw_sort_direction| | |
| 2784 | |
| 2785 | |
| 1621 | 2786 RENAMING FILES OR DIRECTORIES *netrw-move* *netrw-rename* *netrw-R* {{{2 |
| 2787 | |
| 2788 If there are no marked files: (see |netrw-mf|) | |
| 2789 | |
| 2790 Renaming/moving files and directories involves moving the cursor to the | |
| 2791 file/directory to be moved (renamed) and pressing "R". You will then be | |
| 2792 queried for where you want the file/directory to be moved. You may select | |
| 2793 a range of lines with the "V" command (visual selection), and then | |
| 2794 pressing "R". | |
| 2795 | |
| 2796 If there are marked files: (see |netrw-mf|) | |
| 2797 | |
| 2798 Marked files will be renamed (moved). You will be queried as above in | |
| 2799 order to specify where you want the file/directory to be moved. | |
| 2800 | |
| 2801 WARNING:~ | |
| 2802 | |
| 2803 Note that moving files is a dangerous operation; copies are safer. That's | |
| 2804 because a "move" for remote files is actually a copy + delete -- and if | |
| 2805 the copy fails and the delete does not, you may lose the file. | |
| 5734 | 2806 Use at your own risk. |
| 1621 | 2807 |
| 2808 The g:netrw_rename_cmd variable is used to implement renaming. By default its | |
| 2809 value is: | |
| 2810 | |
| 2811 ssh HOSTNAME mv | |
| 2812 | |
| 2813 One may rename a block of files and directories by selecting them with | |
| 2814 the V (|linewise-visual|). | |
| 2815 | |
| 2816 | |
| 2817 SELECTING SORTING STYLE *netrw-s* *netrw-sort* {{{2 | |
| 2818 | |
| 2819 One may select the sorting style by name, time, or (file) size. The "s" map | |
| 2820 allows one to circulate amongst the three choices; the directory listing will | |
| 2821 automatically be refreshed to reflect the selected style. | |
| 2822 | |
| 2823 Related topics: |netrw-r| |netrw-S| | |
| 2824 Associated setting variables: |g:netrw_sort_by| |g:netrw_sort_sequence| | |
| 2825 | |
| 2826 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2827 SETTING EDITING WINDOW *netrw-C* {{{2 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2828 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2829 One may select a netrw window for editing with the "C" mapping, or by setting |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2830 g:netrw_chgwin to the selected window number. Subsequent selection of a file |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2831 to edit (|netrw-cr|) will use that window. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2832 |
| 5618 | 2833 Related topics: |netrw-cr| |g:netrw_browse_split| |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2834 Associated setting variables: |g:netrw_chgwin| |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2835 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2836 |
| 1621 | 2837 10. Problems and Fixes *netrw-problems* {{{1 |
| 24 | 2838 |
| 2839 (This section is likely to grow as I get feedback) | |
| 2840 (also see |netrw-debug|) | |
| 477 | 2841 *netrw-p1* |
| 24 | 2842 P1. I use windows 95, and my ftp dumps four blank lines at the |
| 2843 end of every read. | |
| 2844 | |
| 2845 See |netrw-fixup|, and put the following into your | |
| 2846 <.vimrc> file: | |
| 2847 | |
| 2848 let g:netrw_win95ftp= 1 | |
| 466 | 2849 |
| 477 | 2850 *netrw-p2* |
| 1121 | 2851 P2. I use Windows, and my network browsing with ftp doesn't sort by |
| 2852 time or size! -or- The remote system is a Windows server; why | |
| 2853 don't I get sorts by time or size? | |
| 24 | 2854 |
| 2855 Windows' ftp has a minimal support for ls (ie. it doesn't | |
| 2856 accept sorting options). It doesn't support the -F which | |
| 2857 gives an explanatory character (ABC/ for "ABC is a directory"). | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2858 Netrw then uses "dir" to get both its thin and long listings. |
| 1121 | 2859 If you think your ftp does support a full-up ls, put the |
| 2860 following into your <.vimrc>: > | |
| 24 | 2861 |
| 1121 | 2862 let g:netrw_ftp_list_cmd = "ls -lF" |
| 2863 let g:netrw_ftp_timelist_cmd= "ls -tlF" | |
| 2864 let g:netrw_ftp_sizelist_cmd= "ls -slF" | |
| 2865 < | |
| 24 | 2866 Alternatively, if you have cygwin on your Windows box, put |
| 1121 | 2867 into your <.vimrc>: > |
| 24 | 2868 |
| 2869 let g:netrw_cygwin= 1 | |
| 1121 | 2870 < |
| 2871 This problem also occurs when the remote system is Windows. | |
| 2872 In this situation, the various g:netrw_ftp_[time|size]list_cmds | |
| 2873 are as shown above, but the remote system will not correctly | |
| 2874 modify its listing behavior. | |
| 2875 | |
| 24 | 2876 |
| 477 | 2877 *netrw-p3* |
| 24 | 2878 P3. I tried rcp://user@host/ (or protocol other than ftp) and netrw |
| 2879 used ssh! That wasn't what I asked for... | |
| 2880 | |
| 2881 Netrw has two methods for browsing remote directories: ssh | |
| 2882 and ftp. Unless you specify ftp specifically, ssh is used. | |
| 2883 When it comes time to do download a file (not just a directory | |
| 2884 listing), netrw will use the given protocol to do so. | |
| 2885 | |
| 477 | 2886 *netrw-p4* |
| 24 | 2887 P4. I would like long listings to be the default. |
| 2888 | |
| 1621 | 2889 Put the following statement into your |.vimrc|: > |
| 2890 | |
| 1121 | 2891 let g:netrw_liststyle= 1 |
| 1621 | 2892 < |
| 2893 Check out |netrw-browser-var| for more customizations that | |
| 26 | 2894 you can set. |
| 24 | 2895 |
| 477 | 2896 *netrw-p5* |
| 24 | 2897 P5. My times come up oddly in local browsing |
| 2898 | |
| 2899 Does your system's strftime() accept the "%c" to yield dates | |
| 4339 | 2900 such as "Sun Apr 27 11:49:23 1997"? If not, do a |
| 2901 "man strftime" and find out what option should be used. Then | |
| 2902 put it into your |.vimrc|: > | |
| 1621 | 2903 |
| 24 | 2904 let g:netrw_timefmt= "%X" (where X is the option) |
| 1621 | 2905 < |
| 477 | 2906 *netrw-p6* |
| 26 | 2907 P6. I want my current directory to track my browsing. |
| 2908 How do I do that? | |
| 24 | 2909 |
| 1621 | 2910 Put the following line in your |.vimrc|: |
| 2911 > | |
| 794 | 2912 let g:netrw_keepdir= 0 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2913 < |
| 1121 | 2914 *netrw-p7* |
| 2915 P7. I use Chinese (or other non-ascii) characters in my filenames, and | |
| 2916 netrw (Explore, Sexplore, Hexplore, etc) doesn't display them! | |
| 466 | 2917 |
| 1121 | 2918 (taken from an answer provided by Wu Yongwei on the vim |
| 2919 mailing list) | |
| 5734 | 2920 I now see the problem. Your code page is not 936, right? Vim |
| 1121 | 2921 seems only able to open files with names that are valid in the |
| 2922 current code page, as are many other applications that do not | |
| 2923 use the Unicode version of Windows APIs. This is an OS-related | |
| 2924 issue. You should not have such problems when the system | |
| 2925 locale uses UTF-8, such as modern Linux distros. | |
| 2926 | |
| 2927 (...it is one more reason to recommend that people use utf-8!) | |
| 2928 | |
| 2929 *netrw-p8* | |
| 2930 P8. I'm getting "ssh is not executable on your system" -- what do I | |
| 2931 do? | |
| 2932 | |
| 2933 (Dudley Fox) Most people I know use putty for windows ssh. It | |
| 2934 is a free ssh/telnet application. You can read more about it | |
| 2935 here: | |
| 2936 | |
| 2937 http://www.chiark.greenend.org.uk/~sgtatham/putty/ Also: | |
| 2938 | |
| 2939 (Marlin Unruh) This program also works for me. It's a single | |
| 2940 executable, so he/she can copy it into the Windows\System32 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2941 folder and create a shortcut to it. |
| 1121 | 2942 |
| 2943 (Dudley Fox) You might also wish to consider plink, as it | |
| 2944 sounds most similar to what you are looking for. plink is an | |
| 2945 application in the putty suite. | |
| 2946 | |
| 2947 http://the.earth.li/~sgtatham/putty/0.58/htmldoc/Chapter7.html#plink | |
| 2948 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2949 (Vissale Neang) Maybe you can try OpenSSH for windows, which |
| 1121 | 2950 can be obtained from: |
| 2951 | |
| 2952 http://sshwindows.sourceforge.net/ | |
| 2953 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2954 It doesn't need the full Cygwin package. |
| 1121 | 2955 |
| 2956 (Antoine Mechelynck) For individual Unix-like programs needed | |
| 2957 for work in a native-Windows environment, I recommend getting | |
| 2958 them from the GnuWin32 project on sourceforge if it has them: | |
| 2959 | |
| 2960 http://gnuwin32.sourceforge.net/ | |
| 2961 | |
| 2962 Unlike Cygwin, which sets up a Unix-like virtual machine on | |
| 2963 top of Windows, GnuWin32 is a rewrite of Unix utilities with | |
| 2964 Windows system calls, and its programs works quite well in the | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2965 cmd.exe "Dos box". |
| 1121 | 2966 |
| 2967 (dave) Download WinSCP and use that to connect to the server. | |
| 2968 In Preferences > Editors, set gvim as your editor: | |
| 2969 | |
| 2970 - Click "Add..." | |
| 2971 - Set External Editor (adjust path as needed, include | |
| 2972 the quotes and !.! at the end): | |
| 2973 "c:\Program Files\Vim\vim70\gvim.exe" !.! | |
| 2974 - Check that the filetype in the box below is | |
| 2975 {asterisk}.{asterisk} (all files), or whatever types | |
| 2976 you want (cec: change {asterisk} to * ; I had to | |
| 2977 write it that way because otherwise the helptags | |
| 1621 | 2978 system thinks it's a tag) |
| 2979 - Make sure it's at the top of the listbox (click it, | |
| 2980 then click "Up" if it's not) | |
| 1121 | 2981 If using the Norton Commander style, you just have to hit <F4> |
| 2982 to edit a file in a local copy of gvim. | |
| 2983 | |
| 2984 (Vit Gottwald) How to generate public/private key and save | |
| 2985 public key it on server: > | |
|
2420
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
2986 http://www.chiark.greenend.org.uk/~sgtatham/putty/0.60/htmldoc/Chapter8.html#pubkey-gettingready |
|
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
2987 (8.3 Getting ready for public key authentication) |
| 1121 | 2988 < |
| 1621 | 2989 How to use a private key with 'pscp': > |
| 2990 | |
|
2420
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
2991 http://www.chiark.greenend.org.uk/~sgtatham/putty/0.60/htmldoc/Chapter5.html |
|
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
2992 (5.2.4 Using public key authentication with PSCP) |
| 1121 | 2993 < |
| 1621 | 2994 (Ben Schmidt) I find the ssh included with cwRsync is |
| 2995 brilliant, and install cwRsync or cwRsyncServer on most | |
| 2996 Windows systems I come across these days. I guess COPSSH, | |
| 2997 packed by the same person, is probably even better for use as | |
| 2998 just ssh on Windows, and probably includes sftp, etc. which I | |
| 2999 suspect the cwRsync doesn't, though it might | |
| 3000 | |
| 1121 | 3001 (cec) To make proper use of these suggestions above, you will |
| 3002 need to modify the following user-settable variables in your | |
| 3003 .vimrc: | |
| 3004 | |
| 1621 | 3005 |g:netrw_ssh_cmd| |g:netrw_list_cmd| |g:netrw_mkdir_cmd| |
| 3006 |g:netrw_rm_cmd| |g:netrw_rmdir_cmd| |g:netrw_rmf_cmd| | |
| 1121 | 3007 |
| 3008 The first one (|g:netrw_ssh_cmd|) is the most important; most | |
| 3009 of the others will use the string in g:netrw_ssh_cmd by | |
| 3010 default. | |
| 3011 *netrw-p9* *netrw-ml_get* | |
| 3012 P9. I'm browsing, changing directory, and bang! ml_get errors | |
| 3013 appear and I have to kill vim. Any way around this? | |
| 3014 | |
| 3015 Normally netrw attempts to avoid writing swapfiles for | |
| 3016 its temporary directory buffers. However, on some systems | |
| 3017 this attempt appears to be causing ml_get errors to | |
| 3018 appear. Please try setting |g:netrw_use_noswf| to 0 | |
| 3019 in your <.vimrc>: > | |
| 3020 let g:netrw_use_noswf= 0 | |
| 3021 < | |
| 1621 | 3022 *netrw-p10* |
| 3023 P10. I'm being pestered with "[something] is a directory" and | |
| 3024 "Press ENTER or type command to continue" prompts... | |
| 3025 | |
| 3026 The "[something] is a directory" prompt is issued by Vim, | |
| 3027 not by netrw, and there appears to be no way to work around | |
| 3028 it. Coupled with the default cmdheight of 1, this message | |
| 3029 causes the "Press ENTER..." prompt. So: read |hit-enter|; | |
| 3030 I also suggest that you set your |'cmdheight'| to 2 (or more) in | |
| 3031 your <.vimrc> file. | |
| 3032 | |
| 3033 *netrw-p11* | |
| 3034 P11. I want to have two windows; a thin one on the left and my editing | |
| 2908 | 3035 window on the right. How may I accomplish this? |
| 1621 | 3036 |
| 3037 * Put the following line in your <.vimrc>: | |
| 3038 let g:netrw_altv = 1 | |
| 3039 * Edit the current directory: :e . | |
| 3040 * Select some file, press v | |
| 3041 * Resize the windows as you wish (see |CTRL-W_<| and | |
| 3042 |CTRL-W_>|). If you're using gvim, you can drag | |
| 3043 the separating bar with your mouse. | |
| 3044 * When you want a new file, use ctrl-w h to go back to the | |
| 3045 netrw browser, select a file, then press P (see |CTRL-W_h| | |
| 3046 and |netrw-P|). If you're using gvim, you can press | |
| 3047 <leftmouse> in the browser window and then press the | |
| 3048 <middlemouse> to select the file. | |
| 24 | 3049 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3050 *netrw-p12* |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3051 P12. My directory isn't sorting correctly, or unwanted letters are |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3052 appearing in the listed filenames, or things aren't lining |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3053 up properly in the wide listing, ... |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3054 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3055 This may be due to an encoding problem. I myself usually use |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3056 utf-8, but really only use ascii (ie. bytes from 32-126). |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3057 Multibyte encodings use two (or more) bytes per character. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3058 You may need to change |g:netrw_sepchr| and/or |g:netrw_xstrlen|. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3059 |
| 2152 | 3060 *netrw-p13* |
| 3061 P13. I'm a Windows + putty + ssh user, and when I attempt to browse, | |
| 3062 the directories are missing trailing "/"s so netrw treats them | |
| 3063 as file transfers instead of as attempts to browse | |
| 3064 subdirectories. How may I fix this? | |
| 3065 | |
| 3066 (mikeyao) If you want to use vim via ssh and putty under Windows, | |
| 3067 try combining the use of pscp/psftp with plink. pscp/psftp will | |
| 3068 be used to connect and plink will be used to execute commands on | |
| 3069 the server, for example: list files and directory using 'ls'. | |
| 3070 | |
| 3071 These are the settings I use to do this: | |
| 3072 > | |
| 3073 " list files, it's the key setting, if you haven't set, | |
| 3074 " you will get a blank buffer | |
| 3075 let g:netrw_list_cmd = "plink HOSTNAME ls -Fa" | |
| 3076 " if you haven't add putty directory in system path, you should | |
| 3077 " specify scp/sftp command. For examples: | |
| 3078 "let g:netrw_sftp_cmd = "d:\\dev\\putty\\PSFTP.exe" | |
| 3079 "let g:netrw_scp_cmd = "d:\\dev\\putty\\PSCP.exe" | |
| 3080 < | |
| 2908 | 3081 *netrw-p14* |
| 3082 P14. I'd would like to speed up writes using Nwrite and scp/ssh | |
| 3083 style connections. How? (Thomer M. Gil) | |
| 3084 | |
| 3085 Try using ssh's ControlMaster and ControlPath (see the ssh_config | |
| 3086 man page) to share multiple ssh connections over a single network | |
| 3087 connection. That cuts out the cryptographic handshake on each | |
| 3088 file write, sometimes speeding it up by an order of magnitude. | |
| 3089 (see http://thomer.com/howtos/netrw_ssh.html) | |
| 3090 (included by permission) | |
| 3091 | |
| 3092 Add the following to your ~/.ssh/config: > | |
| 3093 | |
| 3094 # you change "*" to the hostname you care about | |
| 3095 Host * | |
| 3096 ControlMaster auto | |
| 3097 ControlPath /tmp/%r@%h:%p | |
| 3098 | |
| 3099 < Then create an ssh connection to the host and leave it running: > | |
| 3100 | |
| 3101 ssh -N host.domain.com | |
| 3102 | |
| 3103 < Now remotely open a file with Vim's Netrw and enjoy the | |
| 3104 zippiness: > | |
| 3105 | |
| 3106 vim scp://host.domain.com//home/user/.bashrc | |
| 3107 < | |
| 3108 *netrw-p15* | |
| 3109 P15. How may I use a double-click instead of netrw's usual single click | |
| 3110 to open a file or directory? (Ben Fritz) | |
| 3111 | |
| 3112 First, disable netrw's mapping with > | |
| 3113 let g:netrw_mousemaps= 0 | |
| 3114 < and then create a netrw buffer only mapping in | |
| 3115 $HOME/.vim/after/ftplugin/netrw.vim: > | |
| 3116 nmap <buffer> <2-leftmouse> <CR> | |
| 3117 < Note that setting g:netrw_mousemaps to zero will turn off | |
| 3118 all netrw's mouse mappings, not just the <leftmouse> one. | |
| 3119 (see |g:netrw_mousemaps|) | |
| 2152 | 3120 |
| 24 | 3121 ============================================================================== |
| 1621 | 3122 11. Debugging Netrw Itself *netrw-debug* {{{1 |
| 7 | 3123 |
| 2751 | 3124 The <netrw.vim> script is typically available as something like: |
| 477 | 3125 > |
| 2751 | 3126 /usr/local/share/vim/vim7x/plugin/netrwPlugin.vim |
| 3127 /usr/local/share/vim/vim7x/autoload/netrw.vim | |
| 477 | 3128 < |
| 7 | 3129 which is loaded automatically at startup (assuming :set nocp). |
| 3130 | |
| 3131 1. Get the <Decho.vim> script, available as: | |
| 3132 | |
| 3920 | 3133 http://www.drchip.org/astronaut/vim/index.html#DECHO |
| 7 | 3134 or |
| 534 | 3135 http://vim.sourceforge.net/scripts/script.php?script_id=120 |
| 7 | 3136 |
| 5734 | 3137 Decho.vim is provided as a "vimball"; see |vimball-intro|. |
| 1621 | 3138 |
| 3139 2. Edit the <netrw.vim> file by typing: > | |
| 22 | 3140 |
| 3141 vim netrw.vim | |
| 7 | 3142 :DechoOn |
| 22 | 3143 :wq |
| 1621 | 3144 < |
| 3145 To restore to normal non-debugging behavior, re-edit <netrw.vim> | |
| 3146 and type > | |
| 7 | 3147 |
| 22 | 3148 vim netrw.vim |
| 3149 :DechoOff | |
| 3150 :wq | |
| 1621 | 3151 < |
| 22 | 3152 This command, provided by <Decho.vim>, will comment out all |
| 3153 Decho-debugging statements (Dfunc(), Dret(), Decho(), Dredir()). | |
| 3154 | |
| 1621 | 3155 3. Then bring up vim and attempt to evoke the problem by doing a |
| 3156 transfer or doing some browsing. A set of messages should appear | |
| 3157 concerning the steps that <netrw.vim> took in attempting to | |
| 3158 read/write your file over the network in a separate tab. | |
| 7 | 3159 |
| 1121 | 3160 To save the file, use > |
| 5618 | 3161 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3162 :tabnext |
| 1121 | 3163 :set bt= |
| 3164 :w! DBG | |
| 5618 | 3165 |
| 3166 < Furthermore, it'd be helpful if you would type > | |
| 5734 | 3167 :Dsep <command> |
| 3168 < where <command> is the command you're about to type next, | |
| 3169 thereby making it easier to associate which part of the | |
| 3170 debugging trace is due to which command. | |
| 3171 | |
| 3172 Please send that information to <netrw.vim>'s maintainer along | |
| 3173 with the o/s you're using and vim version you're using | |
| 3174 (see |:version|) > | |
| 36 | 3175 NdrOchip at ScampbellPfamily.AbizM - NOSPAM |
| 1121 | 3176 < |
| 7 | 3177 ============================================================================== |
| 1121 | 3178 12. History *netrw-history* {{{1 |
| 7 | 3179 |
| 5734 | 3180 v151: Jan 22, 2014 * extended :Rexplore to return to buffer |
| 3181 prior to Explore or editing a directory | |
| 3182 * (Ken Takata) netrw gave error when | |
| 3183 clipboard was disabled. Sol'n: Placed | |
| 3184 several if has("clipboard") tests in. | |
| 3185 * Fixed ftp://X@Y@Z// problem; X@Y now | |
| 3186 part of user id, and only Z is part of | |
| 3187 hostname. | |
| 3188 * (A Loumiotis) reported that completion | |
| 3189 using a directory name containing spaces | |
| 3190 did not work. Fixed with a retry in | |
| 3191 netrw#Explore() which removes the | |
| 3192 backslashes vim inserted. | |
| 3193 Feb 26, 2014 * :Rexplore now records the current file | |
| 3194 using w:netrw_rexfile when returning via | |
| 3195 |:Rexplore| | |
| 3196 Mar 08, 2014 * (David Kotchan) provided some patches | |
| 3197 allowing netrw to work properly with | |
| 3198 windows shares. | |
| 3199 * Multiple one-liner help messages available | |
| 3200 by pressing <cr> while atop the "Quick | |
| 3201 Help" line | |
| 3202 * worked on ShellCmdPost, FocusGained event | |
| 3203 handling. | |
| 3204 * |:Lexplore| path: will be used to update | |
| 3205 a left-side netrw browsing directory. | |
| 3206 Mar 12, 2014 * |:netrw-s-cr|: use <s-cr> to close | |
| 3207 tree directory implemented | |
| 3208 Mar 13, 2014 * (Tony Mechylynck) reported that using | |
| 3209 the browser with ftp on a directory, | |
| 3210 and selecting a gzipped txt file, that | |
| 3211 an E19 occurred (which was issued by | |
| 3212 gzip.vim). Fixed. | |
| 3213 Mar 14, 2014 * Implemented :MF and :MT (see |netrw-:MF| | |
| 3214 and |netrw-:MT|, respectively) | |
| 3215 Mar 17, 2014 * |:Ntree| [dir] wasn't working properly; fixed | |
| 3216 Mar 18, 2014 * Changed all uses of set to setl | |
| 3217 Mar 18, 2014 * Commented the netrw_btkeep line in | |
| 3218 s:NetrwOptionSave(); the effect is that | |
| 3219 netrw buffers will remain as |'bt'|=nofile. | |
| 3220 This should prevent swapfiles being created | |
| 3221 for netrw buffers. | |
| 3222 Mar 20, 2014 * Changed all uses of lcd to use s:NetrwLcd() | |
| 3223 instead. Consistent error handling results | |
| 3224 and it also handles Window's shares | |
| 3225 * Fixed |netrw-d| command when applied with ftp | |
| 3226 * https: support included for netrw#NetRead() | |
| 5618 | 3227 v150: Jul 12, 2013 * removed a "keepalt" to allow ":e #" to |
| 3228 return to the netrw directory listing | |
| 3229 Jul 13, 2013 * (Jonas Diemer) suggested changing | |
| 3230 a <cWORD> to <cfile>. | |
| 3231 Jul 21, 2013 * (Yuri Kanivetsky) reported that netrw's | |
| 3232 use of mkdir did not produce directories | |
| 5734 | 3233 following the user's umask. |
| 5618 | 3234 Aug 27, 2013 * introduced |g:netrw_altfile| option |
| 3235 Sep 05, 2013 * s:Strlen() now uses |strdisplaywidth()| | |
| 3236 when available, by default | |
| 3237 Sep 12, 2013 * (Selyano Baldo) reported that netrw wasn't | |
| 3238 opening some directories properly from the | |
| 3239 command line. | |
| 3240 Nov 09, 2013 * |:Lexplore| introduced | |
| 3241 * (Ondrej Platek) reported an issue with | |
| 3242 netrw's trees (P15). Fixed. | |
| 3243 * (Jorge Solis) reported that "t" in | |
| 3244 tree mode caused netrw to forget its | |
| 3245 line position. | |
| 3246 Dec 05, 2013 * Added <s-leftmouse> file marking | |
| 3247 (see |netrw-mf|) | |
| 3248 Dec 05, 2013 * (Yasuhiro Matsumoto) Explore should use | |
| 3249 strlen() instead s:Strlen() when handling | |
| 3250 multibyte chars with strpart() | |
| 3251 (ie. strpart() is byte oriented, not | |
| 3252 display-width oriented). | |
| 3253 Dec 09, 2013 * (Ken Takata) Provided a patch; File sizes | |
| 3254 and a portion of timestamps were wrongly | |
| 3255 highlighted with the directory color when | |
| 3256 setting `:let g:netrw_liststyle=1` on Windows. | |
| 3257 * (Paul Domaskis) noted that sometimes | |
| 3258 cursorline was activating in non-netrw | |
| 3259 windows. All but one setting of cursorline | |
| 3260 was done via setl; there was one that was | |
| 3261 overlooked. Fixed. | |
| 3262 Dec 24, 2013 * (esquifit) asked that netrw allow the | |
| 3263 /cygdrive prefix be a user-alterable | |
| 3264 parameter. | |
| 3265 Jan 02, 2014 * Fixed a problem with netrw-based ballon | |
| 3266 evaluation (ie. netrw#NetrwBaloonHelp() | |
| 3267 not having been loaded error messages) | |
| 3268 Jan 03, 2014 * Fixed a problem with tree listings | |
| 3269 * New command installed: |:Ntree| | |
| 3270 Jan 06, 2014 * (Ivan Brennan) reported a problem with | |
| 3271 |netrw-P|. Fixed. | |
| 3272 Jan 06, 2014 * Fixed a problem with |netrw-P| when the | |
| 3273 modified file was to be abandoned. | |
| 3274 Jan 15, 2014 * (Matteo Cavalleri) reported that when the | |
| 3275 banner is suppressed and tree listing is | |
| 3276 used, a blank line was left at the top of | |
| 3277 the display. Fixed. | |
| 3278 Jan 20, 2014 * (Gideon Go) reported that, in tree listing | |
| 3279 style, with a previous window open, that | |
| 3280 the wrong directory was being used to open | |
| 3281 a file. Fixed. (P21) | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
3282 v149: Apr 18, 2013 * in wide listing format, now have maps for |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
3283 w and b to move to next/previous file |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
3284 Apr 26, 2013 * one may now copy files in the same |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
3285 directory; netrw will issue requests for |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
3286 what names the files should be copied under |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
3287 Apr 29, 2013 * Trying Benzinger's problem again. Seems |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
3288 that commenting out the BufEnter and |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
3289 installing VimEnter (only) works. Weird |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
3290 problem! (tree listing, vim -O Dir1 Dir2) |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
3291 May 01, 2013 * :Explore ftp://... wasn't working. Fixed. |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
3292 May 02, 2013 * introduced |g:netrw_bannerbackslash| as |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4339
diff
changeset
|
3293 requested by Paul Domaskis. |
| 5618 | 3294 Jul 03, 2013 * Explore now avoids splitting when a buffer |
| 3295 will be hidden. | |
| 4339 | 3296 v148: Apr 16, 2013 * changed Netrw's Style menu to allow direct |
| 3297 choice of listing style, hiding style, and | |
| 3298 sorting style | |
| 3299 v147: Nov 24, 2012 * (James McCoy) Even with g:netrw_dirhistmax | |
| 3300 at zero, the .vim/ directory would be | |
| 3301 created to support history/bookmarks. I've | |
| 3302 gone over netrw to suppress history and | |
| 3303 bookmarking when g:netrw_dirhistmax is zero. | |
| 3304 For instance, the menus will display | |
| 3305 (disabled) when attempts to use | |
| 3306 bookmarks/history are made. | |
| 3307 Nov 29, 2012 * (Kim Jang-hwan) reported that with | |
| 3308 g:Align_xstrlen set to 3 that the cursor was | |
| 3309 moved (linewise) after invocation. This | |
| 3310 problem also afflicted netrw. | |
| 3311 (see |g:netrw_xstrlen|) Fixed. | |
| 3312 Jan 21, 2013 * (mattn) provided a patch to insert some | |
| 3313 endifs needed with the code implementing | |
| 3314 |netrw-O|. | |
| 3315 Jan 24, 2013 * (John Szakmeister) found that remote file | |
| 3316 editing resulted in filetype options being | |
| 3317 overwritten by NetrwOptionRestore(). I | |
| 3318 moved filetype detect from NetrwGetFile() | |
| 3319 to NetrwOptionRestore. | |
| 3320 Feb 17, 2013 * (Yukhiro Nakadaira) provided a patch | |
| 3321 correcting some syntax errors. | |
| 3322 Feb 28, 2013 * (Ingo Karkat) provided a patch preventing | |
| 3323 receipt of an |E95| when revisiting a | |
| 3324 file://... style url. | |
| 3325 Mar 18, 2013 * (Gary Johnson) pointed out that changing | |
| 3326 cedit to <Esc> caused problems with visincr; | |
| 3327 the cedit setting is now bypassed in netrw too. | |
| 3328 Apr 02, 2013 * (Paul Domaskis) reported an undefined | |
| 3329 variable error (s:didstarstar) was | |
| 3330 occurring. It is now defined at | |
| 3331 initialization. | |
| 3332 * included additional sanity checking for the | |
| 3333 marked file functions. | |
| 3334 * included |netrw-qF| and special "j" option | |
| 3335 handling for |netrw-mg| | |
| 3336 Apr 12, 2013 * |netrw-u| and |netrw-U| now handle counts | |
| 3337 * the former mapping for "T" has been removed; | |
| 3338 in its place are new maps, |netrw-Tb| and |netrw-Th|. | |
| 3339 * the menu now supports a "Targets" entry for | |
| 3340 easier target selection. (see |netrw-mt|) | |
| 3341 * (Paul Domaskis) reported some problems with | |
| 3342 moving/copying files under Windows' gvim | |
| 3343 (ie. not cygwin). Fixed. | |
| 3344 * (Paul Mueller) provided a patch to get | |
| 3345 start and rundll working via |netrw-gx| | |
| 3346 by bypassing the user's |'shellslash'| option. | |
| 3920 | 3347 v146: Oct 20, 2012 * (David Kotchan) reported that under Windows, |
| 3348 directories named with unusual characters | |
| 3349 such as "#" or "$" were not being listed | |
| 3350 properly. | |
| 3351 * (Kenny Lee) reported that the buffer list | |
| 3352 was being populated by netrw buffers. | |
| 3353 Netrw will now |:bwipe| netrw buffers | |
| 3354 upon editing a file if g:netrw_fastbrowse | |
| 3355 is zero and its not in tree listing style. | |
| 4339 | 3356 * fixed a bug with s:NetrwInit() that |
| 3357 prevented initialization with |Lists| and | |
| 3358 |Dictionaries|. | |
| 3359 * |netrw-mu| now unmarks marked-file lists | |
| 3920 | 3360 v145: Apr 05, 2012 * moved some command from a g:netrw_local_... |
| 3361 format to g:netwr_local... format | |
| 3362 * included some NOTE level messages about | |
| 3363 commands that aren't executable | |
| 3364 * |g:netrw_errorlvl| (default: NOTE=0) | |
| 3365 option introduced | |
| 3366 May 18, 2012 * (Ilya Dogolazky) a scenario where a | |
| 3367 |g:netrw_fastbrowse| of zero did not | |
| 3368 have a local directory refreshed fixed. | |
| 3369 Jul 10, 2012 * (Donatas) |netrw-gb| wasn't working due | |
| 3370 to an incorrectly used variable. | |
| 3371 Aug 09, 2012 * (Bart Baker) netrw was doubling | |
| 3372 of entries after a split. | |
| 3373 * (code by Takahiro Yoshihara) implemented | |
| 3374 |g:netrw_dynamic_maxfilenamelen| | |
| 3375 Aug 31, 2012 * (Andrew Wong) netrw refresh overwriting | |
| 3376 the yank buffer. | |
| 3377 v144: Mar 12, 2012 * when |CTRL-W_s| or |CTRL-W_v| are used, | |
| 3378 or their wincmd equivalents, on a netrw | |
| 3379 buffer, the netrw's w: variables were | |
| 3380 not copied over. Fixed. | |
| 3381 Mar 13, 2012 * nbcd_curpos_{bufnr('%')} was commented | |
| 3382 out, and was mistakenly used during | |
| 3383 RestorePosn. Unfortunately, I'm not | |
| 3384 sure why it was commented out, so this | |
| 3385 "fix" may re-introduce an earlier problem. | |
| 3386 Mar 21, 2012 * included s:rexposn internally to make | |
| 3387 :Rex return the cursor to the same pos'n | |
| 3388 upon restoration of netrw buffer | |
| 3389 Mar 27, 2012 * (sjbesse) s:NetrwGetFile() needs to remove | |
| 3390 "/" from the netrw buffer's usual |'isk'| | |
| 3391 in order to allow "filetype detect" to work | |
| 3392 properly for scripts. | |
| 3393 v143: Jun 01, 2011 * |g:netrw_winsize| will accept a negative | |
| 3394 number; the absolute value of it will then | |
| 3395 be used to specify lines/columns instead of | |
| 3396 a percentage. | |
| 3397 Jul 05, 2011 * the "d" map now supports mkdir via ftp | |
| 3398 See |netrw-d| and |g:netrw_remote_mkdir| | |
| 3399 Jul 11, 2011 * Changed Explore!, Sexplore!, and Vexplore | |
| 3400 to use a percentage of |winwidth()| instead | |
| 3401 of a percentage of |winheight()|. | |
| 3402 Jul 11, 2011 * included support for https://... I'm just | |
| 3403 beginning to test this, however. | |
| 3404 Aug 01, 2011 * changed RestoreOptions to also restore | |
| 3405 cursor position in netrw buffers. | |
| 3406 Aug 12, 2011 * added a note about "%" to the balloon | |
| 3407 Aug 30, 2011 * if |g:netrw_nobeval| exists, then balloon | |
| 3408 evaluation is suppressed. | |
| 3409 Aug 31, 2011 * (Benjamin R Haskell) provided a patch that | |
| 3410 implements non-standard port handling for | |
| 3411 files opened via the remote browser. | |
| 3412 Aug 31, 2011 * Fixed a **//pattern Explorer bug | |
| 3413 Sep 15, 2011 * (reported by Francesco Campana) netrw | |
| 3414 now permits the "@" to be part of the | |
| 3415 user id (if there's an @ that appears | |
| 3416 to the right). | |
| 3417 Nov 21, 2011 * New option: |g:netrw_ftp_options| | |
| 3418 Dec 07, 2011 * (James Sinclair) provided a fix handling | |
| 3419 attempts to use a uid and password when | |
| 3420 they weren't defined. This affected | |
| 3421 NetWrite (NetRead already had that fix). | |
| 7 | 3422 |
| 3423 | |
| 3424 ============================================================================== | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3425 13. Todo *netrw-todo* {{{1 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3426 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3427 07/29/09 : banner :|g:netrw_banner| can be used to suppress the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3428 suppression banner. This feature is new and experimental, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3429 so its in the process of being debugged. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3430 09/04/09 : "gp" : See if it can be made to work for remote systems. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3431 : See if it can be made to work with marked files. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3432 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3433 ============================================================================== |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
3434 14. Credits *netrw-credits* {{{1 |
| 7 | 3435 |
| 3436 Vim editor by Bram Moolenaar (Thanks, Bram!) | |
| 3437 dav support by C Campbell | |
| 3438 fetch support by Bram Moolenaar and C Campbell | |
| 534 | 3439 ftp support by C Campbell <NdrOchip@ScampbellPfamily.AbizM> |
| 7 | 3440 http support by Bram Moolenaar <bram@moolenaar.net> |
| 3441 rcp | |
| 3442 rsync support by C Campbell (suggested by Erik Warendorph) | |
| 3443 scp support by raf <raf@comdyn.com.au> | |
| 3444 sftp support by C Campbell | |
| 3445 | |
| 3446 inputsecret(), BufReadCmd, BufWriteCmd contributed by C Campbell | |
| 3447 | |
| 3448 Jérôme Augé -- also using new buffer method with ftp+.netrc | |
| 534 | 3449 Bram Moolenaar -- obviously vim itself, :e and v:cmdarg use, |
| 1209 | 3450 fetch,... |
| 7 | 3451 Yasuhiro Matsumoto -- pointing out undo+0r problem and a solution |
| 3452 Erik Warendorph -- for several suggestions (g:netrw_..._cmd | |
| 3453 variables, rsync etc) | |
| 534 | 3454 Doug Claar -- modifications to test for success with ftp |
| 1209 | 3455 operation |
| 7 | 3456 |
| 3457 ============================================================================== | |
| 1621 | 3458 Modelines: {{{1 |
| 459 | 3459 vim:tw=78:ts=8:ft=help:norl:fdm=marker |