comparison runtime/doc/pi_netrw.txt @ 25700:d4faa2c5211b

Update runtime files Commit: https://github.com/vim/vim/commit/89a9c159f23fb7b3e24e6d09068adfc24a73afcb Author: Bram Moolenaar <Bram@vim.org> Date: Sun Aug 29 21:55:35 2021 +0200 Update runtime files
author Bram Moolenaar <Bram@vim.org>
date Sun, 29 Aug 2021 22:00:05 +0200
parents fd37be6dc258
children d19b7aee1925
comparison
equal deleted inserted replaced
25699:8088e687c3d7 25700:d4faa2c5211b
1 *pi_netrw.txt* For Vim version 8.2. Last change: 2020 Sep 19 1 *pi_netrw.txt* For Vim version 8.2. Last change: 2021 Aug 16
2 2
3 ------------------------------------------------ 3 ------------------------------------------------
4 NETRW REFERENCE MANUAL by Charles E. Campbell 4 NETRW REFERENCE MANUAL by Charles E. Campbell
5 ------------------------------------------------ 5 ------------------------------------------------
6 Author: Charles E. Campbell <NcampObell@SdrPchip.AorgM-NOSPAM> 6 Author: Charles E. Campbell <NcampObell@SdrPchip.AorgM-NOSPAM>
52 Browsing............................................|netrw-cr| 52 Browsing............................................|netrw-cr|
53 Squeezing the Current Tree-Listing Directory........|netrw-s-cr| 53 Squeezing the Current Tree-Listing Directory........|netrw-s-cr|
54 Browsing With A Horizontally Split Window...........|netrw-o| 54 Browsing With A Horizontally Split Window...........|netrw-o|
55 Browsing With A New Tab.............................|netrw-t| 55 Browsing With A New Tab.............................|netrw-t|
56 Browsing With A Vertically Split Window.............|netrw-v| 56 Browsing With A Vertically Split Window.............|netrw-v|
57 Change File Permission..............................|netrw-gp|
57 Change Listing Style.(thin wide long tree)..........|netrw-i| 58 Change Listing Style.(thin wide long tree)..........|netrw-i|
58 Changing To A Bookmarked Directory..................|netrw-gb| 59 Changing To A Bookmarked Directory..................|netrw-gb|
59 Changing To A Predecessor Directory.................|netrw-u| 60 Changing To A Predecessor Directory.................|netrw-u|
60 Changing To A Successor Directory...................|netrw-U| 61 Changing To A Successor Directory...................|netrw-U|
61 Customizing Browsing With A Special Handler.........|netrw-x| 62 Customizing Browsing With A Special Handler.........|netrw-x|
1093 gb Go to previous bookmarked directory |netrw-gb| 1094 gb Go to previous bookmarked directory |netrw-gb|
1094 gd Force treatment as directory |netrw-gd| 1095 gd Force treatment as directory |netrw-gd|
1095 gf Force treatment as file |netrw-gf| 1096 gf Force treatment as file |netrw-gf|
1096 gh Quick hide/unhide of dot-files |netrw-gh| 1097 gh Quick hide/unhide of dot-files |netrw-gh|
1097 gn Make top of tree the directory below the cursor |netrw-gn| 1098 gn Make top of tree the directory below the cursor |netrw-gn|
1099 gp Change local-only file permissions |netrw-gp|
1098 i Cycle between thin, long, wide, and tree listings |netrw-i| 1100 i Cycle between thin, long, wide, and tree listings |netrw-i|
1099 I Toggle the displaying of the banner |netrw-I| 1101 I Toggle the displaying of the banner |netrw-I|
1100 mb Bookmark current directory |netrw-mb| 1102 mb Bookmark current directory |netrw-mb|
1101 mc Copy marked files to marked-file target directory |netrw-mc| 1103 mc Copy marked files to marked-file target directory |netrw-mc|
1102 md Apply diff to marked files (up to 3) |netrw-md| 1104 md Apply diff to marked files (up to 3) |netrw-md|
1508 :let g:netrw_browsex_viewer= "xdg-open" 1510 :let g:netrw_browsex_viewer= "xdg-open"
1509 < 1511 <
1510 If g:netrw_browsex_viewer == '-', then netrwFileHandlers#Invoke() will be 1512 If g:netrw_browsex_viewer == '-', then netrwFileHandlers#Invoke() will be
1511 used instead (see |netrw_filehandler|). 1513 used instead (see |netrw_filehandler|).
1512 1514
1515 If the viewer you wish to use does not support handling of a remote URL
1516 directory, set |g:netrw_browsex_support_remote| to 0.
1513 * for Windows 32 or 64, the URL and FileProtocolHandler dlls are used. 1517 * for Windows 32 or 64, the URL and FileProtocolHandler dlls are used.
1514 * for Gnome (with gnome-open): gnome-open is used. 1518 * for Gnome (with gnome-open): gnome-open is used.
1515 * for KDE (with kfmclient) : kfmclient is used 1519 * for KDE (with kfmclient) : kfmclient is used
1516 * for Mac OS X : open is used. 1520 * for Mac OS X : open is used.
1517 * otherwise the netrwFileHandler plugin is used. 1521 * otherwise the netrwFileHandler plugin is used.
2102 maintains its own separate notion of the current directory, in order to make 2106 maintains its own separate notion of the current directory, in order to make
2103 the two directories the same, use the "cd" map (type cd). That map will 2107 the two directories the same, use the "cd" map (type cd). That map will
2104 set Vim's notion of the current directory to netrw's current browsing 2108 set Vim's notion of the current directory to netrw's current browsing
2105 directory. 2109 directory.
2106 2110
2107 |netrw-cd|: This map's name was changed from "c" to cd (see |netrw-cd|). 2111 |netrw-cd| : This map's name was changed from "c" to cd (see |netrw-cd|).
2108 This change was done to allow for |netrw-cb| and |netrw-cB| maps. 2112 This change was done to allow for |netrw-cb| and |netrw-cB| maps.
2109 2113
2110 Associated setting variable: |g:netrw_keepdir| 2114 Associated setting variable: |g:netrw_keepdir|
2111 2115
2112 MARKING FILES *netrw-:MF* *netrw-mf* {{{2 2116 MARKING FILES *netrw-:MF* *netrw-mf* {{{2
2113 (also see |netrw-mr|) 2117 (also see |netrw-mr|)
2605 "-" 2609 "-"
2606 < is used, then netrwFileHandler() will look for 2610 < is used, then netrwFileHandler() will look for
2607 a script/function to handle the given 2611 a script/function to handle the given
2608 extension. (see |netrw_filehandler|). 2612 extension. (see |netrw_filehandler|).
2609 2613
2614 *g:netrw_browsex_support_remote*
2615 specify if the specified viewer supports a
2616 remote URL. (see |netrw-handler|).
2617
2610 *g:netrw_chgperm* Unix/Linux: "chmod PERM FILENAME" 2618 *g:netrw_chgperm* Unix/Linux: "chmod PERM FILENAME"
2611 Windows: "cacls FILENAME /e /p PERM" 2619 Windows: "cacls FILENAME /e /p PERM"
2612 Used to change access permission for a file. 2620 Used to change access permission for a file.
2613 2621
2622 *g:netrw_clipboard* =1
2623 By default, netrw will attempt to insure that
2624 the clipboard's values will remain unchanged.
2625 However, some users report that they have
2626 speed problems with this; consequently, this
2627 option, when set to zero, lets such users
2628 prevent netrw from saving and restoring the
2629 clipboard (the latter is done only as needed).
2630 That means that if the clipboard is changed
2631 (inadvertently) by normal netrw operation that
2632 it will not be restored to its prior state.
2633
2614 *g:netrw_compress* ="gzip" 2634 *g:netrw_compress* ="gzip"
2615 Will compress marked files with this 2635 Will compress marked files with this
2616 command 2636 command
2617 2637
2618 *g:Netrw_corehandler* Allows one to specify something additional 2638 *g:Netrw_corehandler* Allows one to specify something additional
2619 to do when handling <core> files via netrw's 2639 to do when handling <core> files via netrw's
2620 browser's "x" command (see |netrw-x|). If 2640 browser's "x" command (see |netrw-x|). If
2621 present, g:Netrw_corehandler specifies 2641 present, g:Netrw_corehandler specifies
2637 =0 u-cul u-cuc u-cul u-cuc 2657 =0 u-cul u-cuc u-cul u-cuc
2638 =1 u-cul u-cuc cul u-cuc 2658 =1 u-cul u-cuc cul u-cuc
2639 =2 cul u-cuc cul u-cuc 2659 =2 cul u-cuc cul u-cuc
2640 =3 cul u-cuc cul cuc 2660 =3 cul u-cuc cul cuc
2641 =4 cul cuc cul cuc 2661 =4 cul cuc cul cuc
2662 =5 U-cul U-cuc U-cul U-cuc
2663 =6 U-cul U-cuc cul U-cuc
2664 =7 cul U-cuc cul U-cuc
2665 =8 cul U-cuc cul cuc
2642 2666
2643 Where 2667 Where
2644 u-cul : user's |'cursorline'| setting used 2668 u-cul : user's |'cursorline'| initial setting used
2645 u-cuc : user's |'cursorcolumn'| setting used 2669 u-cuc : user's |'cursorcolumn'| initial setting used
2646 cul : |'cursorline'| locally set 2670 U-cul : user's |'cursorline'| current setting used
2647 cuc : |'cursorcolumn'| locally set 2671 U-cuc : user's |'cursorcolumn'| current setting used
2672 cul : |'cursorline'| will be locally set
2673 cuc : |'cursorcolumn'| will be locally set
2674
2675 The "initial setting" means the values of
2676 the |'cuc'| and |'cul'| settings in effect when
2677 netrw last saw |g:netrw_cursor| >= 5 or when
2678 netrw was initially run.
2648 2679
2649 *g:netrw_decompress* = { ".gz" : "gunzip" , 2680 *g:netrw_decompress* = { ".gz" : "gunzip" ,
2650 ".bz2" : "bunzip2" , 2681 ".bz2" : "bunzip2" ,
2651 ".zip" : "unzip" , 2682 ".zip" : "unzip" ,
2652 ".tar" : "tar -xf"} 2683 ".tar" : "tar -xf"}
2653 A dictionary mapping suffices to 2684 A dictionary mapping suffices to
2654 decompression programs. 2685 decompression programs.
2655 2686
2656 *g:netrw_dirhistmax* =10: controls maximum quantity of past 2687 *g:netrw_dirhistmax* =10: controls maximum quantity of past
2657 history. May be zero to supppress 2688 history. May be zero to suppress
2658 history. 2689 history.
2659 (related: |netrw-qb| |netrw-u| |netrw-U|) 2690 (related: |netrw-qb| |netrw-u| |netrw-U|)
2660 2691
2661 *g:netrw_dynamic_maxfilenamelen* =32: enables dynamic determination of 2692 *g:netrw_dynamic_maxfilenamelen* =32: enables dynamic determination of
2662 |g:netrw_maxfilenamelen|, which affects 2693 |g:netrw_maxfilenamelen|, which affects
3140 3171
3141 To open a new file in netrw's current directory, press "%". This map 3172 To open a new file in netrw's current directory, press "%". This map
3142 will query the user for a new filename; an empty file by that name will 3173 will query the user for a new filename; an empty file by that name will
3143 be placed in the netrw's current directory (ie. b:netrw_curdir). 3174 be placed in the netrw's current directory (ie. b:netrw_curdir).
3144 3175
3176 If Lexplore (|netrw-:Lexplore|) is in use, the new file will be generated
3177 in the |g:netrw_chgwin| window.
3178
3145 Related topics: |netrw-d| 3179 Related topics: |netrw-d|
3146 3180
3147 3181
3148 PREVIEW WINDOW *netrw-p* *netrw-preview* {{{2 3182 PREVIEW WINDOW *netrw-p* *netrw-preview* {{{2
3149 3183
3807 http://vim.sourceforge.net/scripts/script.php?script_id=120 3841 http://vim.sourceforge.net/scripts/script.php?script_id=120
3808 3842
3809 Decho.vim is provided as a "vimball"; see |vimball-intro|. You 3843 Decho.vim is provided as a "vimball"; see |vimball-intro|. You
3810 should edit the Decho.vba.gz file and source it in: > 3844 should edit the Decho.vba.gz file and source it in: >
3811 3845
3812 vim Decho.vba.gz 3846 vim Decho.vba.gz
3813 :so % 3847 :so %
3814 :q 3848 :q
3815 < 3849 <
3816 2. To turn on debug tracing in netrw, then edit the <netrw.vim> 3850 2. To turn on debug tracing in netrw, then edit the <netrw.vim>
3817 file by typing: > 3851 file by typing: >
3875 NcampObell@SdrPchip.AorgM-NOSPAM 3909 NcampObell@SdrPchip.AorgM-NOSPAM
3876 < 3910 <
3877 ============================================================================== 3911 ==============================================================================
3878 12. History *netrw-history* {{{1 3912 12. History *netrw-history* {{{1
3879 3913
3914 v171: Oct 09, 2020 * included code in s:NetrwOptionsSafe()
3915 to allow |'bh'| to be set to delete when
3916 rather than hide when g:netrw_fastbrowse
3917 was zero.
3918 * Installed |g:netrw_clipboard| setting
3919 * Installed option bypass for |'guioptions'|
3920 a/A settings
3921 * Changed popup_beval() to |popup_atcursor|()
3922 in netrw#ErrorMsg (lacygoill). Apparently
3923 popup_beval doesn't reliably close the
3924 popup when the mouse is moved.
3925 * VimEnter() now using win_execute to examine
3926 buffers for an attempt to open a directory.
3927 Avoids issues with popups/terminal from
3928 command line. (lacygoill)
3929 Jun 28, 2021 * (zeertzjq) provided a patch for use of
3930 xmap,xno instead of vmap,vno in
3931 netrwPlugin.vim. Avoids entanglement with
3932 select mode.
3933 Jul 14, 2021 * Fixed problem addressed by tst976; opening
3934 a file using tree mode, going up a
3935 directory, and opening a file there was
3936 opening the file in the wrong directory.
3937 Jul 28, 2021 * (Ingo Karkat) provided a patch fixing an
3938 E488 error with netrwPlugin.vim
3939 (occurred for vim versions < 8.02)
3880 v170: Mar 11, 2020 * (reported by Reiner Herrmann) netrw+tree 3940 v170: Mar 11, 2020 * (reported by Reiner Herrmann) netrw+tree
3881 would not hide with the ^\..* pattern 3941 would not hide with the ^\..* pattern
3882 correctly. 3942 correctly.
3883 * (Marcin Szamotulski) NetrwOptionRestore 3943 * (Marcin Szamotulski) NetrwOptionRestore
3884 did not restore options correctly that 3944 did not restore options correctly that
3891 but will emit an |E37| (although one cannot 3951 but will emit an |E37| (although one cannot
3892 add an ! to override) 3952 add an ! to override)
3893 Jun 07, 2020 * (reported by Jo Totland) repeatedly invoking 3953 Jun 07, 2020 * (reported by Jo Totland) repeatedly invoking
3894 :Lexplore and quitting it left unused 3954 :Lexplore and quitting it left unused
3895 hidden buffers. Netrw will now set netrw 3955 hidden buffers. Netrw will now set netrw
3896 buffers created by :Lexplore to |bh|=wipe. 3956 buffers created by :Lexplore to |'bh'|=wipe.
3897 v169: Dec 20, 2019 * (reported by amkarthik) that netrw's x 3957 v169: Dec 20, 2019 * (reported by amkarthik) that netrw's x
3898 (|netrw-x|) would throw an error when 3958 (|netrw-x|) would throw an error when
3899 attempting to open a local directory. 3959 attempting to open a local directory.
3900 v168: Dec 12, 2019 * scp timeout error message not reported, 3960 v168: Dec 12, 2019 * scp timeout error message not reported,
3901 hopefully now fixed (Shane Xb Qian) 3961 hopefully now fixed (Shane Xb Qian)