comparison runtime/doc/pi_netrw.txt @ 1668:0b796e045c42 v7.2b.000

updated for version 7.2b-000
author vimboss
date Sun, 13 Jul 2008 17:41:49 +0000
parents 82b5078be2dd
children f4f8014d516e
comparison
equal deleted inserted replaced
1667:131dbd3d2a4b 1668:0b796e045c42
1 *pi_netrw.txt* For Vim version 7.2a. Last change: 2008 Jun 21 1 *pi_netrw.txt* For Vim version 7.2b. Last change: 2008 Jul 13
2 2
3 ----------------------------------------------------- 3 -----------------------------------------------------
4 NETRW REFERENCE MANUAL by Charles E. Campbell, Jr. 4 NETRW REFERENCE MANUAL by Charles E. Campbell, Jr.
5 ----------------------------------------------------- 5 -----------------------------------------------------
6 6
312 split window 312 split window
313 =1 preview window shown in a vertically split window. 313 =1 preview window shown in a vertically split window.
314 Also affects the "previous window" (see |netrw-P|) in 314 Also affects the "previous window" (see |netrw-P|) in
315 the same way. 315 the same way.
316 316
317 *g:netrw_shq* = "'" for Unix/Linux systems (ie. a single quote)
318 = "'" for Windows + cygwin systems (ie. a single quote)
319 = '"' for Windows systems, not using cygwin
320 (ie. a double quote)
321 Controls the quoting character used during scp and ftp
322 commands.
323
324 *g:netrw_scpport* = "-P" : option to use to set port for scp 317 *g:netrw_scpport* = "-P" : option to use to set port for scp
325 *g:netrw_sshport* = "-p" : option to use to set port for ssh 318 *g:netrw_sshport* = "-p" : option to use to set port for ssh
326 319
327 *g:netrw_silent* =0 : transfers done normally 320 *g:netrw_silent* =0 : transfers done normally
328 =1 : transfers done silently 321 =1 : transfers done silently
862 Shell command used to perform listing.........|g:netrw_list_cmd| 855 Shell command used to perform listing.........|g:netrw_list_cmd|
863 Quick file info...............................|netrw-qf| 856 Quick file info...............................|netrw-qf|
864 Sorted by 857 Sorted by
865 Select sorting style (name/time/size).........|netrw-s| 858 Select sorting style (name/time/size).........|netrw-s|
866 Editing the sorting sequence..................|netrw-S| 859 Editing the sorting sequence..................|netrw-S|
860 Sorting options...............................|g:netrw_sort_options|
867 Associated setting variable...................|g:netrw_sort_sequence| 861 Associated setting variable...................|g:netrw_sort_sequence|
868 Reverse sorting order.........................|netrw-r| 862 Reverse sorting order.........................|netrw-r|
869 863
870 864
871 *netrw-quickmap* *netrw-quickmaps* 865 *netrw-quickmap* *netrw-quickmaps*
919 U Change to subsequently-visited directory |netrw-U| 913 U Change to subsequently-visited directory |netrw-U|
920 v Enter the file/directory under the cursor in a new |netrw-v| 914 v Enter the file/directory under the cursor in a new |netrw-v|
921 browser window. A vertical split is used. 915 browser window. A vertical split is used.
922 x View file with an associated program |netrw-x| 916 x View file with an associated program |netrw-x|
923 917
918 % Open a new file in netrw's current directory |netrw-%|
919
924 <leftmouse> (gvim only) selects word under mouse as if a <cr> 920 <leftmouse> (gvim only) selects word under mouse as if a <cr>
925 had been pressed (ie. edit file, change directory) 921 had been pressed (ie. edit file, change directory)
926 <middlemouse> (gvim only) same as P selecting word under mouse; 922 <middlemouse> (gvim only) same as P selecting word under mouse;
927 see |netrw-P| 923 see |netrw-P|
928 <rightmouse> (gvim only) delete file/directory using word under 924 <rightmouse> (gvim only) delete file/directory using word under
1360 The lone * is where all filenames not covered by one of the other patterns 1356 The lone * is where all filenames not covered by one of the other patterns
1361 will end up. One may change the sorting sequence by modifying the 1357 will end up. One may change the sorting sequence by modifying the
1362 g:netrw_sort_sequence variable (either manually or in your <.vimrc>) or by 1358 g:netrw_sort_sequence variable (either manually or in your <.vimrc>) or by
1363 using the "S" map. 1359 using the "S" map.
1364 1360
1365 Related topics: |netrw-s| 1361 Related topics: |netrw-s| |netrw-S|
1366 Associated setting variable: |g:netrw_sort_sequence| 1362 Associated setting variables: |g:netrw_sort_sequence| |g:netrw_sort_options|
1367 1363
1368 1364
1369 GOING UP *netrw--* {{{2 1365 GOING UP *netrw--* {{{2
1370 1366
1371 To go up a directory, press "-" or press the <cr> when atop the ../ directory 1367 To go up a directory, press "-" or press the <cr> when atop the ../ directory
1655 1651
1656 MARKED FILES: TAGGING *netrw-mT* {{{2 1652 MARKED FILES: TAGGING *netrw-mT* {{{2
1657 (See |netrw-mf| and |netrw-mr| for how to mark files) 1653 (See |netrw-mf| and |netrw-mr| for how to mark files)
1658 (uses the global marked file list) 1654 (uses the global marked file list)
1659 1655
1660 The "mt" mapping will apply the command in g:netrw_ctags (by default, its 1656 The "mt" mapping will apply the command in |g:netrw_ctags| (by default, its
1661 "ctags") to marked files. For remote browsing, in order to create a tags file 1657 "ctags") to marked files. For remote browsing, in order to create a tags file
1662 netrw will use ssh (see |g:netrw_ssh_cmd|), and so ssh must be available for 1658 netrw will use ssh (see |g:netrw_ssh_cmd|), and so ssh must be available for
1663 this to work on remote systems. For your local system, see |ctags| on how to 1659 this to work on remote systems. For your local system, see |ctags| on how to
1664 get a version. I myself use hdrtags, currently available at 1660 get a version. I myself use hdrtags, currently available at
1665 http://mysite.verizon.net/astronaut/src/index.html , and have > 1661 http://mysite.verizon.net/astronaut/src/index.html , and have >
1674 modification is concerns the names of the files in the tags; each filename is 1670 modification is concerns the names of the files in the tags; each filename is
1675 preceded by the netrw-compatible url used to obtain it. When one subsequently 1671 preceded by the netrw-compatible url used to obtain it. When one subsequently
1676 uses one of the go to tag actions (|tags|), the url will be used by netrw to 1672 uses one of the go to tag actions (|tags|), the url will be used by netrw to
1677 edit the desired file and go to the tag. 1673 edit the desired file and go to the tag.
1678 1674
1679 Associated setting variables: |g:netrw_ssh_cmd| 1675 Associated setting variables: |g:netrw_ctags| |g:netrw_ssh_cmd|
1680 1676
1681 1677
1682 MARKED FILES: SETTING THE TARGET DIRECTORY *netrw-mt* {{{2 1678 MARKED FILES: SETTING THE TARGET DIRECTORY *netrw-mt* {{{2
1683 (See |netrw-mf| and |netrw-mr| for how to mark files) 1679 (See |netrw-mf| and |netrw-mr| for how to mark files)
1684 1680
1736 "-" 1732 "-"
1737 < is used, then netrwFileHandler() will look for 1733 < is used, then netrwFileHandler() will look for
1738 a script/function to handle the given 1734 a script/function to handle the given
1739 extension. (see |netrw_filehandler|). 1735 extension. (see |netrw_filehandler|).
1740 1736
1741 *g:netrw_cd_escape* ="[]#*$%'\" ?`!&();<>\\"
1742 This option is used to escape directory names
1743 before changing directory to them.
1744
1745 *g:netrw_compress* ="gzip" 1737 *g:netrw_compress* ="gzip"
1746 Will compress marked files with this 1738 Will compress marked files with this
1747 command 1739 command
1740
1741 *g:netrw_ctags* ="ctags"
1742 The default external program used to create tags
1748 1743
1749 *g:netrw_decompress* = { ".gz" : "gunzip" , 1744 *g:netrw_decompress* = { ".gz" : "gunzip" ,
1750 ".bz2" : "bunzip2" , 1745 ".bz2" : "bunzip2" ,
1751 ".zip" : "unzip" , 1746 ".zip" : "unzip" ,
1752 ".tar" : "tar -xf"} 1747 ".tar" : "tar -xf"}
1885 *g:netrw_sort_by* sort by "name", "time", or "size" 1880 *g:netrw_sort_by* sort by "name", "time", or "size"
1886 default: "name" 1881 default: "name"
1887 1882
1888 *g:netrw_sort_direction* sorting direction: "normal" or "reverse" 1883 *g:netrw_sort_direction* sorting direction: "normal" or "reverse"
1889 default: "normal" 1884 default: "normal"
1885
1886 *g:netrw_sort_options* sorting is done using |:sort|; this
1887 variable's value is appended to the
1888 sort command. Thus one may ignore case,
1889 for example, with the following in your
1890 .vimrc: >
1891 let g:netrw_sort_options="i"
1892 < default: ""
1890 1893
1891 *g:netrw_sort_sequence* when sorting by name, first sort by the 1894 *g:netrw_sort_sequence* when sorting by name, first sort by the
1892 comma-separated pattern sequence 1895 comma-separated pattern sequence
1893 default: '[\/]$,*,\.bak$,\.o$,\.h$, 1896 default: '[\/]$,*,\.bak$,\.o$,\.h$,
1894 \.info$,\.swp$,\.obj$' 1897 \.info$,\.swp$,\.obj$'
2029 * To make the currently browsed directory the current directory, see |netrw-c| 2032 * To make the currently browsed directory the current directory, see |netrw-c|
2030 * To automatically make the currently browsed directory the current 2033 * To automatically make the currently browsed directory the current
2031 directory, see |g:netrw_keepdir|. 2034 directory, see |g:netrw_keepdir|.
2032 2035
2033 2036
2037 OPEN A NEW FILE IN NETRW'S CURRENT DIRECTORY *netrw-%*
2038
2039 To open a file in netrw's current directory, press "%". This map will
2040 query the user for a new filename; an empty file by that name will be
2041 placed in the netrw's current directory (ie. b:netrw_curdir).
2042
2043
2034 PREVIEW WINDOW *netrw-p* *netrw-preview* {{{2 2044 PREVIEW WINDOW *netrw-p* *netrw-preview* {{{2
2035 2045
2036 One may use a preview window by using the "p" key when the cursor is atop the 2046 One may use a preview window by using the "p" key when the cursor is atop the
2037 desired filename to be previewed. The display will then split to show both 2047 desired filename to be previewed. The display will then split to show both
2038 the browser (where the cursor will remain) and the file (see |:pedit|). 2048 the browser (where the cursor will remain) and the file (see |:pedit|).
2375 NdrOchip at ScampbellPfamily.AbizM - NOSPAM 2385 NdrOchip at ScampbellPfamily.AbizM - NOSPAM
2376 < 2386 <
2377 ============================================================================== 2387 ==============================================================================
2378 12. History *netrw-history* {{{1 2388 12. History *netrw-history* {{{1
2379 2389
2390 v126: Jun 30, 2008 * after having gone to a remote directory,
2391 <f1> was no longer taking one to the correct
2392 entry in the help (|netrw-quickhelp|). Fixed.
2393 Jul 01, 2008 * extracting the last filename from a wide listing
2394 missed the last letter when |'virtualedit'| not
2395 enabled.
2396 Jul 01, 2008 * vim foo/bar was creating [Scratch] buffers,
2397 where bar was also a directory
2398 Jul 01, 2008 * numerous additional changes were made to netrw
2399 to use fnameescape() and shellescape() instead
2400 of escape(). Not all changes have been tested
2401 as yet...
2402 Jul 01, 2008 * (James Vega reported) some problems with
2403 :NetrwSettings (due to no longer used setting
2404 variables).
2405 Jul 07, 2008 * Additional numerous changes to support security;
2406 shellescape(arg,1), etc.
2380 v125: Apr 07, 2008 * (Cristian Rigamonti) CR provides a patch; he 2407 v125: Apr 07, 2008 * (Cristian Rigamonti) CR provides a patch; he
2381 noted that gx was failing since its call to 2408 noted that gx was failing since its call to
2382 netrw#NetBrowseX() wasn't updated to 2409 netrw#NetBrowseX() wasn't updated to
2383 netrw#NetrwBrowseX(). 2410 netrw#NetrwBrowseX().
2384 * (Stanis Trendelenburg) ST provides a patch to 2411 * (Stanis Trendelenburg) ST provides a patch to
2568 made to maps for a D O and R to support 2595 made to maps for a D O and R to support
2569 marked files. 2596 marked files.
2570 v110: May 10, 2007 * added [ and ] maps to NetrwTreeListing 2597 v110: May 10, 2007 * added [ and ] maps to NetrwTreeListing
2571 May 25, 2007 * |g:netrw_preview| included 2598 May 25, 2007 * |g:netrw_preview| included
2572 May 29, 2007 * modifed netrw#NetBrowseX to consistently use 2599 May 29, 2007 * modifed netrw#NetBrowseX to consistently use
2573 |g:netrw_shq| instead of hardcoded quotes, 2600 g:netrw_shq instead of hardcoded quotes,
2574 and modified the snippet that sets up redir 2601 and modified the snippet that sets up redir
2575 so Windows machines use "nul" instead of 2602 so Windows machines use "nul" instead of
2576 "/dev/null". 2603 "/dev/null".
2577 Jun 01, 2007 * fixed bug -- NetGetBuffer() wasn't always 2604 Jun 01, 2007 * fixed bug -- NetGetBuffer() wasn't always
2578 recognizing a buffer name match when it should, 2605 recognizing a buffer name match when it should,