diff options
author | Bram Moolenaar <Bram@vim.org> | 2005-11-23 21:25:05 +0000 |
---|---|---|
committer | Bram Moolenaar <Bram@vim.org> | 2005-11-23 21:25:05 +0000 |
commit | a5792f58905da28f0ab37e1c4c3cfd8171b2e602 (patch) | |
tree | 258ddcfde89bbf98b90d42dd6c297e1b22a20d09 /runtime/doc | |
parent | af289d333a2985051948a53d510fa345df1ddeb3 (diff) |
updated for version 7.0158v7.0158
Diffstat (limited to 'runtime/doc')
-rw-r--r-- | runtime/doc/autocmd.txt | 6 | ||||
-rw-r--r-- | runtime/doc/cmdline.txt | 14 | ||||
-rw-r--r-- | runtime/doc/eval.txt | 5 | ||||
-rw-r--r-- | runtime/doc/if_perl.txt | 21 | ||||
-rw-r--r-- | runtime/doc/if_pyth.txt | 20 | ||||
-rw-r--r-- | runtime/doc/if_ruby.txt | 22 | ||||
-rw-r--r-- | runtime/doc/if_tcl.txt | 20 | ||||
-rw-r--r-- | runtime/doc/insert.txt | 121 | ||||
-rw-r--r-- | runtime/doc/map.txt | 13 | ||||
-rw-r--r-- | runtime/doc/mbyte.txt | 8 | ||||
-rw-r--r-- | runtime/doc/options.txt | 20 | ||||
-rw-r--r-- | runtime/doc/pi_netrw.txt | 349 | ||||
-rw-r--r-- | runtime/doc/tags | 26 | ||||
-rw-r--r-- | runtime/doc/tagsrch.txt | 4 | ||||
-rw-r--r-- | runtime/doc/tar.txt | 37 | ||||
-rw-r--r-- | runtime/doc/todo.txt | 105 | ||||
-rw-r--r-- | runtime/doc/uganda.txt | 37 | ||||
-rw-r--r-- | runtime/doc/various.txt | 17 | ||||
-rw-r--r-- | runtime/doc/version6.txt | 69 | ||||
-rw-r--r-- | runtime/doc/version7.txt | 22 | ||||
-rw-r--r-- | runtime/doc/zip.txt | 13 |
21 files changed, 649 insertions, 300 deletions
diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt index e2ca67a48e..390afadd47 100644 --- a/runtime/doc/autocmd.txt +++ b/runtime/doc/autocmd.txt @@ -1,4 +1,4 @@ -*autocmd.txt* For Vim version 7.0aa. Last change: 2005 Oct 10 +*autocmd.txt* For Vim version 7.0aa. Last change: 2005 Nov 21 VIM REFERENCE MANUAL by Bram Moolenaar @@ -812,6 +812,10 @@ option will not cause any commands to be executed. autocommands for that group. Note: if you use an undefined group name, Vim gives you an error message. + After applying the autocommands the modelines are + processed, so that their overrule the settings from + autocommands, like what happens when editing a file. + *:doautoa* *:doautoall* :doautoa[ll] [group] {event} [fname] Like ":doautocmd", but apply the autocommands to each diff --git a/runtime/doc/cmdline.txt b/runtime/doc/cmdline.txt index 1ea512e607..ec354ec9df 100644 --- a/runtime/doc/cmdline.txt +++ b/runtime/doc/cmdline.txt @@ -1,4 +1,4 @@ -*cmdline.txt* For Vim version 7.0aa. Last change: 2005 Sep 17 +*cmdline.txt* For Vim version 7.0aa. Last change: 2005 Nov 21 VIM REFERENCE MANUAL by Bram Moolenaar @@ -562,7 +562,7 @@ argument for the command, which has a different meaning. For example: "name" ============================================================================== -4. Ex command-line ranges *cmdline-ranges* *[range]* *E16* *E493* +4. Ex command-line ranges *cmdline-ranges* *[range]* *E16* Some Ex commands accept a line range in front of them. This is noted as [range]. It consists of one or more line specifiers, separated with ',' or @@ -648,11 +648,15 @@ When folds are active the line numbers are rounded off to include the whole closed fold. See |fold-behavior|. -Reverse Range +Reverse Range *E493* A range should have the lower line number first. If this is not the case, Vim -will ask you if it should swap the line numbers. This is not done within the -global command ":g". +will ask you if it should swap the line numbers. + Backwards range given, OK to swap ~ +This is not done within the global command ":g". + +You can use ":silent" before a command to avoid the question, the range will +always be swapped then. Count and Range *N:* diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt index cb7ed6eb59..adcf451872 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -1,4 +1,4 @@ -*eval.txt* For Vim version 7.0aa. Last change: 2005 Oct 12 +*eval.txt* For Vim version 7.0aa. Last change: 2005 Nov 20 VIM REFERENCE MANUAL by Bram Moolenaar @@ -5050,6 +5050,9 @@ This also works when reading a variable that has not been set yet: > :let l = foo#bar#lvar +However, when the autoload script was already loaded it won't be loaded again +for an unknown variable. + When assigning a value to such a variable nothing special happens. This can be used to pass settings to the autoload script before it's loaded: > diff --git a/runtime/doc/if_perl.txt b/runtime/doc/if_perl.txt index ef0763d04a..6e0a3e4147 100644 --- a/runtime/doc/if_perl.txt +++ b/runtime/doc/if_perl.txt @@ -1,4 +1,4 @@ -*if_perl.txt* For Vim version 7.0aa. Last change: 2005 Mar 29 +*if_perl.txt* For Vim version 7.0aa. Last change: 2005 Oct 14 VIM REFERENCE MANUAL by Sven Verdoolaege @@ -9,6 +9,7 @@ Perl and Vim *perl* *Perl* 1. Editing Perl files |perl-editing| 2. Compiling VIM with Perl interface |perl-compiling| 3. Using the Perl interface |perl-using| +4. Dynamic loading |perl-dynamic| {Vi does not have any of these commands} @@ -259,4 +260,22 @@ function: > endif Note that "EOF" must be at the start of the line. +============================================================================== +4. Dynamic loading *perl-dynamic* + +On MS-Windows the Perl library can be loaded dynamically. The |:version| +output then includes |+perl/dyn|. + +This means that Vim will search for the Perl DLL file only when needed. When +you don't use the Perl interface you don't need it, thus you can use Vim +without this DLL file. + +To use the Perl interface the Perl DLL must be in your search path. In a +console window type "path" to see what directories are used. + +The name of the DLL must match the Perl version Vim was compiled with. +Currently the name is "perl58.dll". That is for Perl 5.8. To know for +sure edit "gvim.exe" and search for "perl\d*.dll\c". + +============================================================================== vim:tw=78:ts=8:ft=help:norl: diff --git a/runtime/doc/if_pyth.txt b/runtime/doc/if_pyth.txt index 1a2a33de5a..3ceeff88e2 100644 --- a/runtime/doc/if_pyth.txt +++ b/runtime/doc/if_pyth.txt @@ -1,4 +1,4 @@ -*if_pyth.txt* For Vim version 7.0aa. Last change: 2005 Mar 29 +*if_pyth.txt* For Vim version 7.0aa. Last change: 2005 Oct 14 VIM REFERENCE MANUAL by Paul Moore @@ -11,6 +11,7 @@ The Python Interface to Vim *python* *Python* 3. Buffer objects |python-buffer| 4. Range objects |python-range| 5. Window objects |python-window| +6. Dynamic loading |python-dynamic| {Vi does not have any of these commands} @@ -300,4 +301,21 @@ The height attribute is writable only if the screen is split horizontally. The width attribute is writable only if the screen is split vertically. ============================================================================== +6. Dynamic loading *python-dynamic* + +On MS-Windows the Python library can be loaded dynamically. The |:version| +output then includes |+python/dyn|. + +This means that Vim will search for the Python DLL file only when needed. +When you don't use the Python interface you don't need it, thus you can use +Vim without this DLL file. + +To use the Python interface the Python DLL must be in your search path. In a +console window type "path" to see what directories are used. + +The name of the DLL must match the Python version Vim was compiled with. +Currently the name is "python24.dll". That is for Python 2.4. To know for +sure edit "gvim.exe" and search for "python\d*.dll\c". + +============================================================================== vim:tw=78:ts=8:ft=help:norl: diff --git a/runtime/doc/if_ruby.txt b/runtime/doc/if_ruby.txt index 1efb6ce785..a70d32a7bb 100644 --- a/runtime/doc/if_ruby.txt +++ b/runtime/doc/if_ruby.txt @@ -1,4 +1,4 @@ -*if_ruby.txt* For Vim version 7.0aa. Last change: 2005 Aug 31 +*if_ruby.txt* For Vim version 7.0aa. Last change: 2005 Oct 14 VIM REFERENCE MANUAL by Shugo Maeda @@ -11,6 +11,7 @@ The Ruby Interface to Vim *ruby* *Ruby* 3. VIM::Buffer objects |ruby-buffer| 4. VIM::Window objects |ruby-window| 5. Global variables |ruby-globals| +6. Dynamic loading |ruby-dynamic| {Vi does not have any of these commands} *E266* *E267* *E268* *E269* *E270* *E271* *E272* *E273* @@ -166,7 +167,7 @@ cursor = [{row}, {col}] Sets the cursor position to {row} and {col}. ============================================================================== -4. Global variables *ruby-globals* +5. Global variables *ruby-globals* There are two global variables. @@ -174,4 +175,21 @@ $curwin The current window object. $curbuf The current buffer object. ============================================================================== +6. Dynamic loading *ruby-dynamic* + +On MS-Windows the Ruby library can be loaded dynamically. The |:version| +output then includes |+ruby/dyn|. + +This means that Vim will search for the Ruby DLL file only when needed. When +you don't use the Ruby interface you don't need it, thus you can use Vim +without this DLL file. + +To use the Ruby interface the Ruby DLL must be in your search path. In a +console window type "path" to see what directories are used. + +The name of the DLL must match the Ruby version Vim was compiled with. +Currently the name is "ruby18.dll". That is for Ruby 1.8. To know for sure +edit "gvim.exe" and search for "ruby\d*.dll\c". + +============================================================================== vim:tw=78:ts=8:ft=help:norl: diff --git a/runtime/doc/if_tcl.txt b/runtime/doc/if_tcl.txt index 1195ed5ac9..79c43f5cb0 100644 --- a/runtime/doc/if_tcl.txt +++ b/runtime/doc/if_tcl.txt @@ -1,4 +1,4 @@ -*if_tcl.txt* For Vim version 7.0aa. Last change: 2005 Mar 29 +*if_tcl.txt* For Vim version 7.0aa. Last change: 2005 Oct 14 VIM REFERENCE MANUAL by Ingo Wilken @@ -14,6 +14,7 @@ The Tcl Interface to Vim *tcl* *Tcl* *TCL* 6. Miscellaneous; Output from Tcl |tcl-misc| |tcl-output| 7. Known bugs & problems |tcl-bugs| 8. Examples |tcl-examples| +9. Dynamic loading |tcl-dynamic| {Vi does not have any of these commands} *E280* *E281* @@ -509,4 +510,21 @@ startup file (usually "~/.vimrc" on Unix): endif ============================================================================== +9. Dynamic loading *tcl-dynamic* + +On MS-Windows the Tcl library can be loaded dynamically. The |:version| +output then includes |+tcl/dyn|. + +This means that Vim will search for the Tcl DLL file only when needed. When +you don't use the Tcl interface you don't need it, thus you can use Vim +without this DLL file. + +To use the Tcl interface the Tcl DLL must be in your search path. In a +console window type "path" to see what directories are used. + +The name of the DLL must match the Tcl version Vim was compiled with. +Currently the name is "tcl83.dll". That is for Tcl 8.3. To know for sure +edit "gvim.exe" and search for "tcl\d*.dll\c". + +============================================================================== vim:tw=78:ts=8:ft=help:norl: diff --git a/runtime/doc/insert.txt b/runtime/doc/insert.txt index 4b6d0eb6f5..9d8e4e609a 100644 --- a/runtime/doc/insert.txt +++ b/runtime/doc/insert.txt @@ -1,4 +1,4 @@ -*insert.txt* For Vim version 7.0aa. Last change: 2005 Oct 02 +*insert.txt* For Vim version 7.0aa. Last change: 2005 Nov 22 VIM REFERENCE MANUAL by Bram Moolenaar @@ -975,6 +975,7 @@ PmenuThumb thumb of the scrollbar |hl-PmenuThumb| Filetype-specific remarks for omni completion *compl-omni-filetypes* + C *ft-c-omni* Completion of C code requires a tags file. You should use Exuberant ctags, @@ -1007,7 +1008,14 @@ When the same structure name appears in multiple places all possible members are included. +CSS *ft-css-omni* + +Complete properties and their appropriate values according to CSS 2.1 +specification. + + (X)HTML *ft-html-omni* + *ft-xhtml-omni* CTRL-X CTRL-O provides completion of various elements of (X)HTML files. It is designed to support writing of XHTML 1.0 Strict files but will @@ -1019,23 +1027,124 @@ also works for other versions of HTML. Features: a tag) - when attribute has limited number of possible values help to complete them +- complete names of entities - complete values of "class" and "id" attributes with data obtained from style tag and included CSS files - when completing "style" attribute or working inside of "style" tag switch to |ft-css-omni| completion - when used after "</" CTRL-X CTRL-O will close the last opened tag -File htmlcomplete.vim provides through |autoload| mechanism +Note: When used first time completion menu will be shown with little delay +- this is time needed for loading of data file. + + +XML *ft-xml-omni* + +Vim 7 provides mechanism to context aware completion of XML files. It depends +on special |xml-data-file| and two commands: |:XMLns| and |:XMLent|. Features +are: + +- after "<" complete tag name depending on context (no div suggest + inside of an a tag) +- inside of tag complete proper attributes (no width attribute for an + a tag) +- when attribute has limited number of possible values help to complete + them +- complete names of entities (defined in |xml-data-file| and in current file + with "<!ENTITY" declarations +- when used after "</" CTRL-X CTRL-O will close the last opened tag + +Format of XML data file *xml-omni-datafile* + +Vim distribution provides two data files as examples (xhtml10s.vim, xsl.vim) + +XML data files are stored in "autoload/xml" directory in 'runtimepath'. They +have meaningful name which will be used in commands. It should be unique name +which will not create conflicts in future. For example name xhtml10s.vim means +it is data file for XHTML 1.0 Strict. + +File contains one variable with fixed name: g:xmldata_xhtml10s . It is +compound from two parts: + +1. "g:xmldata_" general prefix +2. "xhtml10s" name of file and name of described XML dialect + +Part two must be exactly the same as name of file. + +Variable is data structure in form of |Dictionary|. Keys are tag names and +values are two element |List|. First element of List is also List with +names of possible children, second element is |Dictionary| with names of +attributes as keys and possible values of attributes as values. Example: > + + let g:xmldata_crippledhtml = { + \ "html": + \ [ ["body", "head"], {"id": [], "xmlns": ["http://www.w3.org/1999/xhtml"], + \ "lang": [], "xml:lang": [], "dir": ["ltr", "rtl"]}], + \ "script": + \ [ [], {"id": [], "charset": [], "type": ["text/javascript"], "src": [], + \ "defer": ["BOOL"], "xml:space": ["preserve"]}], + \ "meta": + \ [ [], {"id": [], "http-equiv": [], "name": [], "content": [], "scheme": + \ [], "lang": [], "xml:lang": [], "dir": ["ltr", "rtl"]}] + \ "vimxmlentities": ["amp", "lt", "gt", "apos", "quot"]} + +This example should be put in "autoload/xml/crippledhtml.vim" file. + +In example are visible two special elements: + +1. "vimxmlentities" - special key with List containing entities of this XML + dialect. +2. "BOOL" - value of attribute key showing if attribute should be inserted + bare ("defer" vs. 'defer="'). It can be the only element of List of + attribute values. + +Note: Tag names in data file MUST not contain namespace description. Check +xsl.vim for example. + +Commands + +:XMLns {name} [{namespace}] *:XMLns* + +Vim has to know which data file should be used and with which namespace. For +loading of data file and connecting data with prope namespace use |:XMLns| +command. First (obligatory) argument is name of data (xhtml10s, xsl). Second +argument is code of namespace (h, xsl). When used without second argument +dialect will be used as default - without namespace declaration. For example +to use XML completion in .xsl files: > + + :XMLns xhtml10s + :XMLns xsl xsl + + +:XMLent {name} *:XMLent* + +By default entities will be completed from data file of default +namespace. XMLent command should be used in case when there is no +default namespace: > + + :XMLent xhtml10s + +Usage + +While used in situation (after declarations from previous part, | is +cursor position): > + + <| + +Will complete to appropriate XHTML tag, and in this situation: > + + <xsl:| + +Will complete to appropriate XSL tag. + +File xmlcomplete.vim provides through |autoload| mechanism GetLastOpenTag function which can be used in XML files to get name of last open tag with (b:unaryTagsStack has to be defined): > - :echo htmlcomplete#GetLastOpenTag("b:unaryTagsStack") + :echo xmlcomplete#GetLastOpenTag("b:unaryTagsStack") -CSS *ft-css-omni* -Complete properties and their appropriate values according to CSS 2.1 -specification. ============================================================================== diff --git a/runtime/doc/map.txt b/runtime/doc/map.txt index 618c76712e..a5f6d0c621 100644 --- a/runtime/doc/map.txt +++ b/runtime/doc/map.txt @@ -1,4 +1,4 @@ -*map.txt* For Vim version 7.0aa. Last change: 2005 Sep 22 +*map.txt* For Vim version 7.0aa. Last change: 2005 Oct 14 VIM REFERENCE MANUAL by Bram Moolenaar @@ -966,8 +966,10 @@ completion can be enabled: -complete=custom,{func} custom completion, defined via {func} -complete=customlist,{func} custom completion, defined via {func} -Custom completion *:command-completion-custom* - *E467* *E468* + +Custom completion *:command-completion-custom* + *:command-completion-customlist* + *E467* *E468* It is possible to define customized completion schemes via the "custom,{func}" or the "customlist,{func}" completion argument. The {func} part should be a function with the following prototype > @@ -981,13 +983,13 @@ For the "custom" argument, the function should return the completion candidates one per line in a newline separated string. For the "customlist" argument, the function should return the completion -candidates as a Vim List. Non-string items in the list are ignored. +candidates as a Vim List. Non-string items in the list are ignored. The function arguments are: ArgLead the leading portion of the argument currently being completed on CmdLine the entire command line - CursorPos the cursor position in it + CursorPos the cursor position in it (byte index) The function may use these for determining context. For the "custom" argument, it is not necessary to filter candidates against the (implicit pattern in) ArgLead. Vim will do filter the candidates with its regexp engine @@ -1009,6 +1011,7 @@ the 'path' option: > : return split(globpath(&path, a:ArgLead), "\n") :endfun < + Range handling *E177* *E178* By default, user-defined commands do not accept a line number range. However, diff --git a/runtime/doc/mbyte.txt b/runtime/doc/mbyte.txt index 7f6a972b0a..ead91abd32 100644 --- a/runtime/doc/mbyte.txt +++ b/runtime/doc/mbyte.txt @@ -1,4 +1,4 @@ -*mbyte.txt* For Vim version 7.0aa. Last change: 2005 Jul 09 +*mbyte.txt* For Vim version 7.0aa. Last change: 2005 Oct 14 VIM REFERENCE MANUAL by Bram Moolenaar et al. @@ -484,6 +484,12 @@ conversion needs to be done. These conversions are supported: request a very large buffer, more than Vim is willing to provide). Try getting another iconv() implementation. + *iconv-dynamic* +On MS-Windows Vim can be compiled with the |+iconv/dyn| feature. This means +Vim will search for the "iconv.dll" and "libiconv.dll" libraries. When +neither of them can be found Vim will still work but some conversions won't be +possible. + ============================================================================== 4. Using a terminal *mbyte-terminal* diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index fcbd445717..0631d454ce 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1,4 +1,4 @@ -*options.txt* For Vim version 7.0aa. Last change: 2005 Oct 05 +*options.txt* For Vim version 7.0aa. Last change: 2005 Nov 23 VIM REFERENCE MANUAL by Bram Moolenaar @@ -76,10 +76,8 @@ achieve special effects. These options come in three forms: comma separated list, a comma is added, unless the value was empty. If the option is a list of flags, superfluous flags - are removed. Otherwise there is no check for doubled - values. You can avoid this by removing a value first. - Example: > - :set guioptions-=T guioptions+=T + are removed. When adding a flag that was already + present the option value doesn't change. < Also see |:set-args| above. {not in Vi} @@ -988,6 +986,9 @@ A jump table for the options with a short description can be found at |Q_op|. Watch out for special characters, see |option-backslash|. When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the default value. "/tmp/*" is only used for Unix. + Note that the default also makes sure that "crontab -e" works (when a + backup would be made by renaming the original file crontab won't see + the newly created file). Also see 'backupcopy' and |crontab|. *'balloondelay'* *'bdlay'* 'balloondelay' 'bdlay' number (default: 600) @@ -2927,10 +2928,11 @@ A jump table for the options with a short description can be found at |Q_op|. The name of an external program that will be used to format the lines selected with the "gq" command. The program must take the input on stdin and produce the output on stdout. The Unix program "fmt" is - such a program. If this option is an empty string, the internal - format function will be used |C-indenting|. Environment variables are - expanded |:set_env|. See |option-backslash| about including spaces - and backslashes. + such a program. + If this option is an empty string, the internal format function will + be used |C-indenting|. + Environment variables are expanded |:set_env|. See |option-backslash| + about including spaces and backslashes. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. diff --git a/runtime/doc/pi_netrw.txt b/runtime/doc/pi_netrw.txt index 5bce52c14b..850dccb3cc 100644 --- a/runtime/doc/pi_netrw.txt +++ b/runtime/doc/pi_netrw.txt @@ -1,7 +1,7 @@ -*pi_netrw.txt* For Vim version 7.0. Last change: Oct 03, 2005 +*pi_netrw.txt* For Vim version 7.0. Last change: Aug 31, 2005 - VIM REFERENCE MANUAL by Charles E. Campbell, Jr. + VIM REFERENCE MANUAL by Charles E. Campbell, Jr. *dav* *http* *network* *rcp* *scp* *fetch* *netrw* *Nread* *rsync* *sftp* @@ -25,7 +25,7 @@ 4. Transparent File Transfer............................|netrw-transparent| 5. Ex Commands..........................................|netrw-ex| 6. Variables and Options................................|netrw-var| -7. Directory Browsing...................................|netrw-browse| {{{1 +7. Directory Browser....................................|netrw-browse| {{{1 Maps...............................................|netrw-maps| Exploring..........................................|netrw-explore-cmds| Quick Reference Commands Table.....................|netrw-browse-cmds| @@ -194,8 +194,8 @@ file using root-relative paths, use the full path: 2. Network-Oriented File Transfer *netrw-xfer* Network-oriented file transfer under Vim is implemented by a VimL-based script -(<netrw.vim>) using plugin techniques. It currently supports both reading and -writing across networks using rcp, scp, ftp or ftp+<.netrc>, scp, fetch, +(<netrw.vim>) using plugin techniques. It currently supports both reading +and writing across networks using rcp, scp, ftp or ftp+<.netrc>, scp, fetch, dav/cadaver, rsync, or sftp. http is currently supported read-only via use of wget or fetch. @@ -206,23 +206,24 @@ FileReadCmd, BufWriteCmd) to intercept reads/writes with url-like filenames. > ex. vim ftp://hostname/path/to/file < -The characters preceding the colon specify the protocol to use; in the -example, its ftp. The <netrw.vim> script then formulates a command or a -series of commands (typically ftp) which it issues to an external program -(ftp, scp, etc) which does the actual file transfer/protocol. Files are read -from/written to a temporary file (under Unix/Linux, /tmp/...) which the -<netrw.vim> script will clean up. - -One may modify any protocol's implementing external application by setting a -variable (ex. scp uses the variable g:netrw_scp_cmd, which is defaulted to -"scp -q"). +The characters preceding the colon specify the protocol to use; +in the example, its ftp. The <netrw.vim> script then formulates +a command or a series of commands (typically ftp) which it issues +to an external program (ftp, scp, etc) which does the actual file +transfer/protocol. Files are read from/written to a temporary file +(under Unix/Linux, /tmp/...) which the <netrw.vim> script will +clean up. + +One may modify any protocol's implementing external application +by setting a variable (ex. scp uses the variable g:netrw_scp_cmd, +which is defaulted to "scp -q"). Ftp, an old protocol, seems to be blessed by numerous implementations. -Unfortunately, some implementations are noisy (ie., add junk to the end of the -file). Thus, concerned users may decide to write a NetReadFixup() function -that will clean up after reading with their ftp. Some Unix systems (ie., -FreeBSD) provide a utility called "fetch" which uses the ftp protocol but is -not noisy and more convenient, actually, for <netrw.vim> to use. +Unfortunately, some implementations are noisy (ie., add junk to the end +of the file). Thus, concerned users may decide to write a NetReadFixup() +function that will clean up after reading with their ftp. Some Unix systems +(ie., FreeBSD) provide a utility called "fetch" which uses the ftp protocol +but is not noisy and more convenient, actually, for <netrw.vim> to use. Consequently, if "fetch" is executable, it will be used to do reads for ftp://... (and http://...) . See |netrw-var| for more about this. @@ -331,9 +332,8 @@ The script attempts to get passwords for ftp invisibly using |inputsecret()|, a built-in Vim function. See |netrw-uidpass| for how to change the password after one has set it. -Unfortunately there doesn't appear to be a way for netrw to feed a password to -scp. Thus every transfer via scp will require re-entry of the password. -However, |netrw-listhack| can help with this problem. +Unfortunately there doesn't appear to be a way for netrw to feed a password +to scp. Thus every transfer via scp will require re-entry of the password. ============================================================================== @@ -341,28 +341,21 @@ However, |netrw-listhack| can help with this problem. Network-oriented file transfers are available by default whenever |'nocompatible'| mode is enabled. The <netrw.vim> file resides in your -system's vim-plugin directory and is sourced automatically whenever you bring -up vim. I suggest that, at a minimum, you have at least the following in your -<.vimrc> customization file: > - set nocp - if version >= 600 - filetype plugin indent on - endif -< +system's vim-plugin directory and is sourced automatically whenever you +bring up vim. + ============================================================================== 4. Transparent File Transfer *netrw-transparent* Transparent file transfers occur whenever a regular file read or write (invoked via an |:autocmd| for |BufReadCmd| or |BufWriteCmd| events) is made. -Thus one may use files across networks just as simply as if they were local. > +Thus one may use files across networks as if they were local. > vim ftp://[user@]machine/path ... :wq -See |netrw-activate| for more on how to encourage your vim to use plugins -such as netrw. ============================================================================== 5. Ex Commands *netrw-ex* @@ -376,7 +369,8 @@ additional commands available. :[range]Nw {netfile} [{netfile}]... Write the specified lines to the {netfile}. -:Nread Read the specified lines into the current +:Nread + Read the specified lines into the current buffer from the file specified in b:netrw_lastfile. @@ -407,11 +401,10 @@ additional commands available. The script <netrw.vim> uses several variables which can affect <netrw.vim>'s behavior. These variables typically may be set in the user's <.vimrc> file: -(also see |netrw-settings|) > - - ------------- - Netrw Options - ------------- +> + ------------- + Netrw Options + ------------- Option Meaning -------------- ----------------------------------------------- < @@ -488,12 +481,12 @@ variables listed below, and may be modified by the user. ------------------------------------------------------------------------- < *netrw-ftp* -The first two options both help with certain ftp's that give trouble -otherwise. In order to best understand how to use these options if ftp is -giving you troubles, a bit of discussion follows on how netrw does ftp reads. +The first two options both help with certain ftp's that give trouble otherwise. +In order to best understand how to use these options if ftp is giving you +troubles, a bit of discussion follows on how netrw does ftp reads. -The g:netrw_..._cmd variables specify the external program to use handle the -associated protocol (rcp, ftp, etc), plus any options. +The g:netrw_..._cmd variables specify the external program to use handle +the associated protocol (rcp, ftp, etc), plus any options. The g:netrw_list_cmd's HOSTNAME entry will be changed via substitution with whatever the current request is for a hostname. @@ -526,8 +519,8 @@ userid and password. The transferred file is put into a temporary file. The temporary file is then read into the main editing session window that requested it and the temporary file deleted. -If your ftp doesn't accept the "user" command and immediately just demands a -userid, then try putting "let netrw_ftp=1" in your <.vimrc>. +If your ftp doesn't accept the "user" command and immediately just demands +a userid, then try putting "let netrw_ftp=1" in your <.vimrc>. *netrw-cadaver* To handle the SSL certificate dialog for untrusted servers, one may pull @@ -554,12 +547,12 @@ messages) you may write a NetReadFixup(tmpfile) function: endif endfunction > -The NetReadFixup() function will be called if it exists and thus allows you to -customize your reading process. As a further example, <netrw.vim> contains -just such a function to handle Windows 95 ftp. For whatever reason, Windows -95's ftp dumps four blank lines at the end of a transfer, and so it is -desirable to automate their removal. Here's some code taken from <netrw.vim> -itself: +The NetReadFixup() function will be called if it exists and thus allows +you to customize your reading process. As a further example, <netrw.vim> +contains just such a function to handle Windows 95 ftp. For whatever +reason, Windows 95's ftp dumps four blank lines at the end of a transfer, +and so it is desirable to automate their removal. Here's some code taken +from <netrw.vim> itself: > if has("win95") && g:netrw_win95ftp fun! NetReadFixup(method, line1, line2) @@ -572,7 +565,7 @@ itself: > ============================================================================== -7. Directory Browsing *netrw-browse* *netrw-dir* *netrw-list* *netrw-help* +7. Directory Browser *netrw-browse* *netrw-dir* *netrw-list* *netrw-help* MAPS *netrw-maps* ?................Help.......................................|netrw-help| @@ -663,13 +656,12 @@ NETRW BROWSER VARIABLES *netrw-browse-var* : connect to address [0-9a-fA-F:]* : No route to host$' - *g:netrw_ftp_list_cmd* options for passing along to ftp for directory - listing. Defaults: - unix or g:netrw_cygwin set: : "ls -lF" - otherwise "dir" - - *g:netrw_hide* if true, the hiding list is used - default: =0 + *g:netrw_ssh_browse_reject* ssh can sometimes produce unwanted lines, + messages, banners, and whatnot that one doesn't + want masquerading as "directories" and "files". + Use this pattern to remove such embedded + messages. By default its value is: + '^total\s\+\d\+$' *g:netrw_keepdir* =1 (default) keep current directory immune from the browsing directory. @@ -684,11 +676 |