diff options
Diffstat (limited to 'runtime/doc')
32 files changed, 704 insertions, 337 deletions
diff --git a/runtime/doc/cmdline.txt b/runtime/doc/cmdline.txt index fd18e6720e..bc6bbd74db 100644 --- a/runtime/doc/cmdline.txt +++ b/runtime/doc/cmdline.txt @@ -1,4 +1,4 @@ -*cmdline.txt* For Vim version 7.1. Last change: 2008 Jan 04 +*cmdline.txt* For Vim version 7.2a. Last change: 2008 Jun 21 VIM REFERENCE MANUAL by Bram Moolenaar @@ -62,7 +62,7 @@ Notes: old one is removed (to avoid repeated commands moving older commands out of the history). - Only commands that are typed are remembered. Ones that completely come from - mappings are not put in the history + mappings are not put in the history. - All searches are put in the search history, including the ones that come from commands like "*" and "#". But for a mapping, only the last search is remembered (to avoid that long mappings trash the history). @@ -226,6 +226,8 @@ CTRL-J *c_CTRL-J* *c_<NL>* *c_<CR>* <Esc> When typed and 'x' not present in 'cpoptions', quit Command-line mode without executing. In macros or when 'x' present in 'cpoptions', start entered command. + Note: If your <Esc> key is hard to hit on your keyboard, train + yourself to use CTRL-[. *c_CTRL-C* CTRL-C quit command-line without executing @@ -482,7 +484,7 @@ argument. line. If you want to use '|' in an argument, precede it with '\'. These commands see the '|' as their argument, and can therefore not be -followed by another command: +followed by another Vim command: :argdo :autocmd :bufdo @@ -718,6 +720,9 @@ to insert special things while typing you can use the CTRL-R command. For example, "%" stands for the current file name, while CTRL-R % inserts the current file name right away. See |c_CTRL-R|. +Note: If you want to avoid the special characters in a Vim script you may want +to use |fnameescape()|. + In Ex commands, at places where a file name can be used, the following characters have a special meaning. These can also be used in the expression @@ -893,10 +898,10 @@ Examples: (alternate file name is "?readme?") :cd <cfile>* :cd {file name under cursor plus "*" and then expanded} When the expanded argument contains a "!" and it is used for a shell command -(":!cmd", ":r !cmd" or ":w !cmd"), it is escaped with a backslash to avoid it -being expanded into a previously used command. When the 'shell' option -contains "sh", this is done twice, to avoid the shell trying to expand the -"!". +(":!cmd", ":r !cmd" or ":w !cmd"), the "!" is escaped with a backslash to +avoid it being expanded into a previously used command. When the 'shell' +option contains "sh", this is done twice, to avoid the shell trying to expand +the "!". *filename-backslash* For filesystems that use a backslash as directory separator (MS-DOS, Windows, diff --git a/runtime/doc/debugger.txt b/runtime/doc/debugger.txt index 26bc966def..0a152a61d5 100644 --- a/runtime/doc/debugger.txt +++ b/runtime/doc/debugger.txt @@ -1,4 +1,4 @@ -*debugger.txt* For Vim version 7.1. Last change: 2005 Mar 29 +*debugger.txt* For Vim version 7.2a. Last change: 2005 Mar 29 VIM REFERENCE MANUAL by Gordon Prieur diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt index a6e9e026f9..67adcb8f94 100644 --- a/runtime/doc/develop.txt +++ b/runtime/doc/develop.txt @@ -1,4 +1,4 @@ -*develop.txt* For Vim version 7.1. Last change: 2007 May 11 +*develop.txt* For Vim version 7.2a. Last change: 2007 May 11 VIM REFERENCE MANUAL by Bram Moolenaar diff --git a/runtime/doc/digraph.txt b/runtime/doc/digraph.txt index 904142ace8..f5b5ce7422 100644 --- a/runtime/doc/digraph.txt +++ b/runtime/doc/digraph.txt @@ -1,4 +1,4 @@ -*digraph.txt* For Vim version 7.1. Last change: 2006 Jul 18 +*digraph.txt* For Vim version 7.2a. Last change: 2007 Sep 10 VIM REFERENCE MANUAL by Bram Moolenaar @@ -130,10 +130,10 @@ a standard meaning: Exclamation mark ! Grave Apostrophe ' Acute accent Greater-Than sign > Circumflex accent - Question Mark ? tilde + Question mark ? Tilde Hyphen-Minus - Macron Left parenthesis ( Breve - Full Stop . Dot Above + Full stop . Dot above Colon : Diaeresis Comma , Cedilla Underline _ Underline diff --git a/runtime/doc/editing.txt b/runtime/doc/editing.txt index 0df39dc4f9..2ef3f96bcf 100644 --- a/runtime/doc/editing.txt +++ b/runtime/doc/editing.txt @@ -1,4 +1,4 @@ -*editing.txt* For Vim version 7.1. Last change: 2007 May 11 +*editing.txt* For Vim version 7.2a. Last change: 2008 Apr 29 VIM REFERENCE MANUAL by Bram Moolenaar @@ -364,6 +364,9 @@ all over again. The ":e" command is only useful if you have changed the current file name. *:filename* *{file}* +Besides the things mentioned here, more special items for where a filename is +expected are mentioned at |cmdline-special|. + Note for systems other than Unix and MS-DOS: When using a command that accepts a single file name (like ":edit file") spaces in the file name are allowed, but trailing spaces are ignored. This is useful on systems that @@ -888,8 +891,10 @@ Note: When the 'write' option is off, you are not able to write any file. the previous command |:!|. The default [range] for the ":w" command is the whole buffer (1,$). If you -write the whole buffer, it is no longer considered changed. Also when you -write it to a different file with ":w somefile"! +write the whole buffer, it is no longer considered changed. When you +write it to a different file with ":w somefile" it depends on the "+" flag in +'cpoptions'. When included, the write command will reset the 'modified' flag, +even though the buffer itself may still be different from its file. If a file name is given with ":w" it becomes the alternate file. This can be used, for example, when the write fails and you want to try again later with @@ -1105,6 +1110,8 @@ MULTIPLE WINDOWS AND BUFFERS *window-exit* changed. See |:confirm|. {not in Vi} :qa[ll]! Exit Vim. Any changes to buffers are lost. {not in Vi} + Also see |:cquit|, it does the same but exits with a non-zero + value. *:quita* *:quitall* :quita[ll][!] Same as ":qall". {not in Vi} @@ -1478,7 +1485,9 @@ There are three different types of searching: supported by your operating system. '*' and '**' are handled inside Vim, so they work on all operating systems. - The usage of '*' is quite simple: It matches 0 or more characters. + The usage of '*' is quite simple: It matches 0 or more characters. In a + search pattern this would be ".*". Note that the "." is not used for file + searching. '**' is more sophisticated: - It ONLY matches directories. @@ -1498,7 +1507,7 @@ There are three different types of searching: levels. The allowed number range is 0 ('**0' is removed) to 255. If the given number is smaller than 0 it defaults to 30, if it's - bigger than 255 it defaults to 255. + bigger than 255 then 255 is used. - '**' can only be at the end of the path or be followed by a path separator or by a number and a path separator. diff --git a/runtime/doc/gui_w16.txt b/runtime/doc/gui_w16.txt index 50c5f29775..954e138d9d 100644 --- a/runtime/doc/gui_w16.txt +++ b/runtime/doc/gui_w16.txt @@ -1,4 +1,4 @@ -*gui_w16.txt* For Vim version 7.1. Last change: 2005 Mar 29 +*gui_w16.txt* For Vim version 7.2a. Last change: 2005 Mar 29 VIM REFERENCE MANUAL by Bram Moolenaar diff --git a/runtime/doc/gui_w32.txt b/runtime/doc/gui_w32.txt index 17ed69a60c..78d696e0c1 100644 --- a/runtime/doc/gui_w32.txt +++ b/runtime/doc/gui_w32.txt @@ -1,4 +1,4 @@ -*gui_w32.txt* For Vim version 7.1. Last change: 2007 Aug 14 +*gui_w32.txt* For Vim version 7.2a. Last change: 2007 Aug 30 VIM REFERENCE MANUAL by Bram Moolenaar diff --git a/runtime/doc/if_mzsch.txt b/runtime/doc/if_mzsch.txt index e4cf247754..dd538accc2 100644 --- a/runtime/doc/if_mzsch.txt +++ b/runtime/doc/if_mzsch.txt @@ -1,4 +1,4 @@ -*if_mzsch.txt* For Vim version 7.1. Last change: 2007 May 03 +*if_mzsch.txt* For Vim version 7.2a. Last change: 2007 May 03 VIM REFERENCE MANUAL by Sergey Khorev diff --git a/runtime/doc/if_ole.txt b/runtime/doc/if_ole.txt index 830c56ee16..08b4c492dc 100644 --- a/runtime/doc/if_ole.txt +++ b/runtime/doc/if_ole.txt @@ -1,4 +1,4 @@ -*if_ole.txt* For Vim version 7.1. Last change: 2007 May 10 +*if_ole.txt* For Vim version 7.2a. Last change: 2007 May 10 VIM REFERENCE MANUAL by Paul Moore diff --git a/runtime/doc/if_perl.txt b/runtime/doc/if_perl.txt index 0819ace822..675ed37f2d 100644 --- a/runtime/doc/if_perl.txt +++ b/runtime/doc/if_perl.txt @@ -1,4 +1,4 @@ -*if_perl.txt* For Vim version 7.1. Last change: 2006 Mar 06 +*if_perl.txt* For Vim version 7.2a. Last change: 2006 Mar 06 VIM REFERENCE MANUAL by Sven Verdoolaege diff --git a/runtime/doc/if_pyth.txt b/runtime/doc/if_pyth.txt index 4c53f593b5..f8b0f86832 100644 --- a/runtime/doc/if_pyth.txt +++ b/runtime/doc/if_pyth.txt @@ -1,4 +1,4 @@ -*if_pyth.txt* For Vim version 7.1. Last change: 2006 Apr 30 +*if_pyth.txt* For Vim version 7.2a. Last change: 2006 Apr 30 VIM REFERENCE MANUAL by Paul Moore diff --git a/runtime/doc/indent.txt b/runtime/doc/indent.txt index d755957376..8e5b7a3972 100644 --- a/runtime/doc/indent.txt +++ b/runtime/doc/indent.txt @@ -1,4 +1,4 @@ -*indent.txt* For Vim version 7.1. Last change: 2007 May 11 +*indent.txt* For Vim version 7.2a. Last change: 2008 Jun 21 VIM REFERENCE MANUAL by Bram Moolenaar @@ -6,22 +6,27 @@ This file is about indenting C programs and other files. -1. Indenting C programs |C-indenting| +1. Indenting C style programs |C-indenting| 2. Indenting by expression |indent-expression| ============================================================================== -1. Indenting C programs *C-indenting* +1. Indenting C style programs *C-indenting* -The basics for C indenting are explained in section |30.2| of the user manual. +The basics for C style indenting are explained in section |30.2| of the user +manual. -Vim has options for automatically indenting C program files. These options -affect only the indent and do not perform other formatting. For comment -formatting, see |format-comments|. +Vim has options for automatically indenting C style program files. Many +programming languages including Java and C++ follow very closely the +formatting conventions established with C. These options affect only the +indent and do not perform other formatting. There are additional options that +affect other kinds of formatting as well as indenting, see |format-comments|, +|fo-table|, |gq| and |formatting| for the main ones. Note that this will not work when the |+smartindent| or |+cindent| features have been disabled at compile time. -There are in fact four methods available for indentation: +There are in fact four main methods available for indentation, each one +overrides the previous if it is enabled, or non-empty for 'indentexpr': 'autoindent' uses the indent from the previous line. 'smartindent' is like 'autoindent' but also recognizes some C syntax to increase/reduce the indent where appropriate. @@ -572,6 +577,115 @@ In addition, you can turn the verbose mode for debug issue: > Make sure to do ":set cmdheight=2" first to allow the display of the message. +VHDL *ft-vhdl-indent* + +Alignment of generic/port mapping statements are performed by default. This +causes the following alignment example: > + + ENTITY sync IS + PORT ( + clk : IN STD_LOGIC; + reset_n : IN STD_LOGIC; + data_input : IN STD_LOGIC; + data_out : OUT STD_LOGIC + ); + END ENTITY sync; + +To turn this off, add > + + let g:vhdl_indent_genportmap = 0 + +to the .vimrc file, which causes the previous alignment example to change: > + + ENTITY sync IS + PORT ( + clk : IN STD_LOGIC; + reset_n : IN STD_LOGIC; + data_input : IN STD_LOGIC; + data_out : OUT STD_LOGIC + ); + END ENTITY sync; + +---------------------------------------- + +Alignment of right-hand side assignment "<=" statements are performed by +default. This causes the following alignment example: > + + sig_out <= (bus_a(1) AND + (sig_b OR sig_c)) OR + (bus_a(0) AND sig_d); + +To turn this off, add > + + let g:vhdl_indent_rhsassign = 0 + +to the .vimrc file, which causes the previous alignment example to change: > + + sig_out <= (bus_a(1) AND + (sig_b OR sig_c)) OR + (bus_a(0) AND sig_d); + +---------------------------------------- + +Full-line comments (lines that begin with "--") are indented to be aligned with +the very previous line's comment, PROVIDED that a whitespace follows after +"--". + +For example: > + + sig_a <= sig_b; -- start of a comment + -- continuation of the comment + -- more of the same comment + +While in Insert mode, after typing "-- " (note the space " "), hitting CTRL-F +will align the current "-- " with the previous line's "--". + +If the very previous line does not contain "--", THEN the full-line comment +will be aligned with the start of the next non-blank line that is NOT a +full-line comment. + +Indenting the following code: > + + sig_c <= sig_d; -- comment 0 + -- comment 1 + -- comment 2 + --debug_code: + --PROCESS(debug_in) + --BEGIN + -- FOR i IN 15 DOWNTO 0 LOOP + -- debug_out(8*i+7 DOWNTO 8*i) <= debug_in(15-i); + -- END LOOP; + --END PROCESS debug_code; + + -- comment 3 + sig_e <= sig_f; -- comment 4 + -- comment 5 + +results in: > + + sig_c <= sig_d; -- comment 0 + -- comment 1 + -- comment 2 + --debug_code: + --PROCESS(debug_in) + --BEGIN + -- FOR i IN 15 DOWNTO 0 LOOP + -- debug_out(8*i+7 DOWNTO 8*i) <= debug_in(15-i); + -- END LOOP; + --END PROCESS debug_code; + + -- comment 3 + sig_e <= sig_f; -- comment 4 + -- comment 5 + +Notice that "--debug_code:" does not align with "-- comment 2" +because there is no whitespace that follows after "--" in "--debug_code:". + +Given the dynamic nature of indenting comments, indenting should be done TWICE. +On the first pass, code will be indented. On the second pass, full-line +comments will be indented according to the correctly indented code. + + VIM *ft-vim-indent* For indenting Vim scripts there is one variable that specifies the amount of diff --git a/runtime/doc/insert.txt b/runtime/doc/insert.txt index b5a6650db4..db0ba0e650 100644 --- a/runtime/doc/insert.txt +++ b/runtime/doc/insert.txt @@ -1,4 +1,4 @@ -*insert.txt* For Vim version 7.1. Last change: 2007 May 07 +*insert.txt* For Vim version 7.2a. Last change: 2008 Jun 21 VIM REFERENCE MANUAL by Bram Moolenaar @@ -882,12 +882,12 @@ a Vim script. CTRL-X CTRL-V Guess what kind of item is in front of the cursor and find the first match for it. Note: When CTRL-V is mapped you can often use CTRL-Q - instead |i_CTRL-Q|. + instead of |i_CTRL-Q|. CTRL-V or CTRL-N Search forwards for next match. This match replaces the previous one. - CTRL-P Search backward for previous match. This match + CTRL-P Search backwards for previous match. This match replaces the previous one. CTRL-X CTRL-V Further use of CTRL-X CTRL-V will do the same as diff --git a/runtime/doc/netbeans.txt b/runtime/doc/netbeans.txt index 3ac503ad79..3539111666 100644 --- a/runtime/doc/netbeans.txt +++ b/runtime/doc/netbeans.txt @@ -1,23 +1,28 @@ -*netbeans.txt* For Vim version 7.1. Last change: 2006 Nov 14 +*netbeans.txt* For Vim version 7.2a. Last change: 2008 Jun 22 - VIM REFERENCE MANUAL by Gordon Prieur + VIM REFERENCE MANUAL by Gordon Prieur et al. -NetBeans ExternalEditor Integration Features *netbeans* - *netbeans-support* + *socket-interface* *netbeans* *netbeans-support* + +Vim NetBeans Protocol: a socket interface for Vim integration into an IDE. + 1. Introduction |netbeans-intro| -2. NetBeans Key Bindings |netbeans-keybindings| +2. Integration features |netbeans-integration| 3. Configuring Vim for NetBeans |netbeans-configure| -4. Downloading NetBeans |netbeans-download| -5. Preparing NetBeans for Vim |netbeans-preparation| -6. Obtaining the External Editor Module |obtaining-exted| -7. Setting up NetBeans to run with Vim |netbeans-setup| -8. Messages |netbeans-messages| -9. Running Vim from NetBeans |netbeans-run| -10. NetBeans protocol |netbeans-protocol| -11. NetBeans commands |netbeans-commands| -12. Known problems |netbeans-problems| +4. Error Messages |netbeans-messages| +5. Running Vim in NetBeans mode |netbeans-run| +6. NetBeans protocol |netbeans-protocol| +7. NetBeans key |netbeans-key| +8. Known problems |netbeans-problems| +9. Debugging NetBeans protocol |netbeans-debugging| +10. NetBeans External Editor + 10.1. Downloading NetBeans |netbeans-download| + 10.2. NetBeans Key Bindings |netbeans-keybindings| + 10.3. Preparing NetBeans for Vim |netbeans-preparation| + 10.4. Obtaining the External Editor Module |obtaining-exted| + 10.5. Setting up NetBeans to run with Vim |netbeans-setup| {Vi does not have any of these features} {only available when compiled with the |+netbeans_intg| feature} @@ -25,13 +30,47 @@ NetBeans ExternalEditor Integration Features *netbeans* ============================================================================== 1. Introduction *netbeans-intro* +The NetBeans interface was initially developed to integrate Vim into the +NetBeans Java IDE, using the external editor plugin. This NetBeans plugin no +longer exists for recent versions of NetBeans but the protocol was developed +in such a way that any IDE can use it to integrate Vim. + +The NetBeans protocol of Vim is a text based communication protocol, over a +classical TCP socket. There is no dependency on Java or NetBeans. Any language +or environment providing a socket interface can control Vim using this +protocol. There are existing implementations in C, C++, Python and Java. The +name NetBeans is kept today for historical reasons. + +Current projects using the NetBeans protocol of Vim are: +- VimIntegration, description of various projects doing Vim Integration: + http://www.freehackers.org/VimIntegration +- Agide, an IDE for the AAP project, written in Python: + http://www.a-a-p.org +- Clewn, a gdb integration into Vim, written in C: + http://clewn.sourceforge.net/ +- VimPlugin, integration of Vim inside Eclipse: + http://vimplugin.sourceforge.net/wiki/pmwiki.php +- PIDA, IDE written in Python integrating Vim: + http://pida.co.uk/ +- VimWrapper, library to easy Vim integration into IDE: + http://www.freehackers.org/VimWrapper + +Check the specific project pages to see how to use Vim with these projects. + +In the rest of this help page, we will use the term "Vim Controller" to +describe the program controlling Vim through the NetBeans socket interface. + + +About the NetBeans IDE ~ + NetBeans is an open source Integrated Development Environment developed jointly by Sun Microsystems, Inc. and the netbeans.org developer community. Initially just a Java IDE, NetBeans has had C, C++, and Fortran support added in recent releases. -For more information visit the main NetBeans web site http://www.netbeans.org -or the NetBeans External Editor site at http://externaleditor.netbeans.org. +For more information visit the main NetBeans web site http://www.netbeans.org. +The External Editor is now, unfortunately, declared Obsolte. See + http://externaleditor.netbeans.org. Sun Microsystems, Inc. also ships NetBeans under the name Sun ONE Studio. Visit http://www.sun.com for more information regarding the Sun ONE Studio @@ -41,37 +80,32 @@ Current releases of NetBeans provide full support for Java and limited support for C, C++, and Fortran. Current releases of Sun ONE Studio provide full support for Java, C, C++, and Fortran. -The interface to NetBeans is also supported by Agide, the A-A-P GUI IDE. -Agide is very different from NetBeans: -- Based on Python instead of Java, much smaller footprint and fast startup. -- Agide is a framework in which many different tools can work together. -See the A-A-P website for information: http://www.A-A-P.org. - ============================================================================== -2. NetBeans Key Bindings *netbeans-keybindings* +2. Integration features *netbeans-integration* -Vim understands a number of key bindings that execute NetBeans commands. -These are typically all the Function key combinations. To execute a NetBeans -command, the user must press the Pause key followed by a NetBeans key binding. -For example, in order to compile a Java file, the NetBeans key binding is -"F9". So, while in vim, press "Pause F9" to compile a java file. To toggle a -breakpoint at the current line, press "Pause Shift F8". +The NetBeans socket interface of Vim allows to get information from Vim or to +ask Vim to perform specific actions: +- get information about buffer: buffer name, cursor position, buffer content, + etc. +- be notified when buffers are open or closed +- be notified of how the buffer content is modified +- load and save files +- modify the buffer content +- installing special key bindings +- raise the window, control the window geometry -The Pause key is Function key 21. If you don't have a working Pause key and -want to use F8 instead, use: > +For sending key strokes to Vim or for evaluating functions in Vim, you must +use the |clientserver| interface. - :map <F8> <F21> - -The External Editor module dynamically reads the NetBeans key bindings so vim -should always have the latest key bindings, even when NetBeans changes them. ============================================================================== 3. Configuring Vim for NetBeans *netbeans-configure* -For more help installing vim, please read |usr_90.txt| in the Vim User Manual. +For more help installing Vim, please read |usr_90.txt| in the Vim User Manual. -On Unix +On Unix: +-------- When running configure without arguments the NetBeans interface should be included. That is, if the configure check to find out if your system supports @@ -80,15 +114,16 @@ the required features succeeds. In case you do not want the NetBeans interface you can disable it by uncommenting a line with "--disable-netbeans" in the Makefile. -Currently, only gvim is supported in this integration as NetBeans does not -have means to supply a terminal emulator for the vim command. Furthermore, +Currently, only GVim is supported in this integration as NetBeans does not +have means to supply a terminal emulator for the Vim command. Furthermore, there is only GUI support for GTK, GNOME, and Motif. If Motif support is required the user must supply XPM libraries. See |workshop-xpm| for details on obtaining the latest version of XPM. -On MS-Windows +On MS-Windows: +-------------- The Win32 support is now in beta stage. @@ -96,121 +131,56 @@ To use XPM signs on Win32 (e.g. when using with NetBeans) you can compile XPM by yourself or use precompiled libraries from http://iamphet.nm.ru/misc/ (for MS Visual C++) or http://gnuwin32.sourceforge.net (for MinGW). -============================================================================== -4. Downloading NetBeans *netbeans-download* +Enable debugging: +----------------- -The NetBeans IDE is available for download from netbeans.org. You can download -a released version, download sources, or use CVS to download the current -source tree. If you choose to download sources, follow directions from -netbeans.org on building NetBeans. - -Depending on the version of NetBeans you download, you may need to do further -work to get the required External Editor module. This is the module which lets -NetBeans work with gvim (or xemacs :-). See http://externaleditor.netbeans.org -for details on downloading this module if your NetBeans release does not have -it. - -For C, C++, and Fortran support you will also need the cpp module. See -http://cpp.netbeans.org for information regarding this module. - -You can also download Sun ONE Studio from Sun Microsystems, Inc for a 30 day -free trial. See http://www.sun.com for further details. +To enable debugging of Vim and of the NetBeans protocol, the "NBDEBUG" macro +needs to be defined. Search in the Makefile of the platform you are using for +"NBDEBUG" to see what line needs to be uncommented. This effectively adds +"-DNBDEBUG" to the compile command. Also see |netbeans-debugging| ============================================================================== -5. Preparing NetBeans for Vim *netbeans-preparation* - -In order for NetBeans to work with vim, the NetBeans External Editor module -must be loaded and enabled. If you have a Sun ONE Studio Enterprise Edition -then this module should be loaded and enabled. If you have a NetBeans release -you may need to find another way of obtaining this open source module. +4. Error Messages *netbeans-messages* -You can check if you have this module by opening the Tools->Options dialog -and drilling down to the "Modules" list (IDE Configuration->System->Modules). -If your Modules list has an entry for "External Editor" you must make sure -it is enabled (the "Enabled" property should have the value "True"). If your -Modules list has no External Editor see the next section on |obtaining-exted|. - -============================================================================== -6. Obtaining the External Editor Module *obtaining-exted* - -There are 2 ways of obtaining the External Editor module. The easiest way -is to use the NetBeans Update Center to download and install the module. -Unfortunately, some versions do not have this module in their update -center. If you cannot download via the update center you will need to -download sources and build the module. I will try and get the module -available from the NetBeans Update Center so building will be unnecessary. -Also check http://externaleditor.netbeans.org for other availability options. - -To download the External Editor sources via CVS and build your own module, -see http://externaleditor.netbeans.org and http://www.netbeans.org. -Unfortunately, this is not a trivial procedure. - -============================================================================== -7. Setting up NetBeans to run with Vim *netbeans-setup* - -Assuming you have loaded and enabled the NetBeans External Editor module -as described in |netbeans-preparation| all you need to do is verify that -the gvim command line is properly configured for your environment. - -Open the Tools->Options dialog and open the Editing category. Select the -External Editor. The right hand pane should contain a Properties tab and -an Expert tab. In the Properties tab make sure the "Editor Type" is set -to "Vim". In the Expert tab make sure the "Vim Command" is correct. - -You should be careful if you change the "Vim Command". There are command -line options there which must be there for the connection to be properly -set up. You can change the command name but that's about it. If your gvim -can be found by your $PATH then the VIM Command can start with "gvim". If -you don't want gvim searched from your $PATH then hard code in the full -Unix path name. At this point you should get a gvim for any source file -you open in NetBeans. - -If some files come up in gvim and others (with different file suffixes) come -up in the default NetBeans editor you should verify the MIME type in the -Expert tab MIME Type property. NetBeans is MIME oriented and the External -Editor will only open MIME types specified in this property. - -============================================================================== -8. Messages *netbeans-messages* - -These messages are specific for NetBeans: +These error messages are specific to NetBeans socket protocol: *E463* Region is guarded, cannot modify - NetBeans defines guarded areas in the text, which you cannot - change. - Also sets the current buffer, if necessary. + The Vim Controller has defined guarded areas in the text, + which you cannot change. Also sets the current buffer, if + necessary. *E656* -NetBeans disallows writes of unmodified buffers - NetBeans does not support writes of unmodified buffers that - were opened from NetBeans. +Writes of unmodified buffers forbidden + Writes of unmodified buffers that were opened from the + Vim Controller are not possible. *E657* -Partial writes disallowed for NetBeans buffers - NetBeans does not support partial writes for buffers that were - opened from NetBeans. +Partial writes disallowed + Partial writes for buffers that were opened from the + Vim Controller are not allowed. *E658* -NetBeans connection lost for this buffer - NetBeans has become confused about the state of this file. - Rather than risk data corruption, NetBeans has severed the - connection for this file. Vim will take over responsibility - for saving changes to this file and NetBeans will no l |