Mercurial > vim

comparison runtime/doc/netbeans.txt @ 236:4707450c2b33

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
updated for version 7.0066
author vimboss
date Fri, 15 Apr 2005 21:00:38 +0000
parents 19670b05ee32
children d6a69271cb9a
comparison
equal deleted inserted replaced
235:23d380e32c95 236:4707450c2b33
1 *netbeans.txt* For Vim version 7.0aa. Last change: 2005 Jan 31 1 *netbeans.txt* For Vim version 7.0aa. Last change: 2005 Apr 04
2 2
3 3
4 VIM REFERENCE MANUAL by Gordon Prieur 4 VIM REFERENCE MANUAL by Gordon Prieur
5 5
6 6
36 Sun Microsystems, Inc. also ships NetBeans under the name Sun ONE Studio. 36 Sun Microsystems, Inc. also ships NetBeans under the name Sun ONE Studio.
37 Visit http://www.sun.com for more information regarding the Sun ONE Studio 37 Visit http://www.sun.com for more information regarding the Sun ONE Studio
38 product line. 38 product line.
39 39
40 Current releases of NetBeans provide full support for Java and limited support 40 Current releases of NetBeans provide full support for Java and limited support
41 for C, C++, and Fortran. Current releases of Sun ONE Studio provide full 41 for C, C++, and Fortran. Current releases of Sun ONE Studio provide full
42 support for Java, C, C++, and Fortran. 42 support for Java, C, C++, and Fortran.
43 43
44 The interface to NetBeans is also supported by Agide, the A-A-P GUI IDE. 44 The interface to NetBeans is also supported by Agide, the A-A-P GUI IDE.
45 Agide is very different from NetBeans: 45 Agide is very different from NetBeans:
46 - Based on Python instead of Java, much smaller footprint and fast startup. 46 - Based on Python instead of Java, much smaller footprint and fast startup.
48 See the A-A-P website for information: http://www.A-A-P.org. 48 See the A-A-P website for information: http://www.A-A-P.org.
49 49
50 ============================================================================== 50 ==============================================================================
51 2. NetBeans Key Bindings *netbeans-keybindings* 51 2. NetBeans Key Bindings *netbeans-keybindings*
52 52
53 Vim understands a number of key bindings that execute NetBeans commands. These 53 Vim understands a number of key bindings that execute NetBeans commands.
54 are typically all the Function key combinations. To execute a NetBeans command, 54 These are typically all the Function key combinations. To execute a NetBeans
55 the user must press the Pause key followed by a NetBeans key binding. For 55 command, the user must press the Pause key followed by a NetBeans key binding.
56 example, in order to compile a Java file, the NetBeans key binding is "F9". So, 56 For example, in order to compile a Java file, the NetBeans key binding is
57 while in vim, press "Pause F9" to compile a java file. To toggle a breakpoint 57 "F9". So, while in vim, press "Pause F9" to compile a java file. To toggle a
58 at the current line, press "Pause Shift F8". 58 breakpoint at the current line, press "Pause Shift F8".
59 59
60 The Pause key is Function key 21. If you don't have a working Pause key and 60 The Pause key is Function key 21. If you don't have a working Pause key and
61 want to use F8 instead, use: > 61 want to use F8 instead, use: >
62 62
63 :map <F8> <F21> 63 :map <F8> <F21>
79 79
80 In case you do not want the NetBeans interface you can disable it by 80 In case you do not want the NetBeans interface you can disable it by
81 uncommenting a line with "--disable-netbeans" in the Makefile. 81 uncommenting a line with "--disable-netbeans" in the Makefile.
82 82
83 Currently, only gvim is supported in this integration as NetBeans does not 83 Currently, only gvim is supported in this integration as NetBeans does not
84 have means to supply a terminal emulator for the vim command. Furthermore, 84 have means to supply a terminal emulator for the vim command. Furthermore,
85 there is only GUI support for GTK, GNOME, and Motif. 85 there is only GUI support for GTK, GNOME, and Motif.
86 86
87 If Motif support is required the user must supply XPM libraries. See 87 If Motif support is required the user must supply XPM libraries. See
88 |workshop-xpm| for details on obtaining the latest version of XPM. 88 |workshop-xpm| for details on obtaining the latest version of XPM.
89 89
90 90
91 On MS-Windows 91 On MS-Windows
92 92
97 (for MS Visual C++) or http://gnuwin32.sourceforge.net (for MinGW). 97 (for MS Visual C++) or http://gnuwin32.sourceforge.net (for MinGW).
98 98
99 ============================================================================== 99 ==============================================================================
100 4. Downloading NetBeans *netbeans-download* 100 4. Downloading NetBeans *netbeans-download*
101 101
102 The NetBeans IDE is available for download from netbeans.org. You can download 102 The NetBeans IDE is available for download from netbeans.org. You can download
103 a released version, download sources, or use CVS to download the current 103 a released version, download sources, or use CVS to download the current
104 source tree. If you choose to download sources, follow directions from 104 source tree. If you choose to download sources, follow directions from
105 netbeans.org on building NetBeans. 105 netbeans.org on building NetBeans.
106 106
107 Depending on the version of NetBeans you download, you may need to do further 107 Depending on the version of NetBeans you download, you may need to do further
108 work to get the required External Editor module. This is the module which lets 108 work to get the required External Editor module. This is the module which lets
109 NetBeans work with gvim (or xemacs :-). See http://externaleditor.netbeans.org 109 NetBeans work with gvim (or xemacs :-). See http://externaleditor.netbeans.org
110 for details on downloading this module if your NetBeans release does not have 110 for details on downloading this module if your NetBeans release does not have
111 it. 111 it.
112 112
113 For C, C++, and Fortran support you will also need the cpp module. See 113 For C, C++, and Fortran support you will also need the cpp module. See
114 http://cpp.netbeans.org for information regarding this module. 114 http://cpp.netbeans.org for information regarding this module.
115 115
116 You can also download Sun ONE Studio from Sun Microsystems, Inc for a 30 day 116 You can also download Sun ONE Studio from Sun Microsystems, Inc for a 30 day
117 free trial. See http://www.sun.com for further details. 117 free trial. See http://www.sun.com for further details.
118 118
119 ============================================================================== 119 ==============================================================================
120 5. Preparing NetBeans for Vim *netbeans-preparation* 120 5. Preparing NetBeans for Vim *netbeans-preparation*
121 121
122 In order for NetBeans to work with vim, the NetBeans External Editor module 122 In order for NetBeans to work with vim, the NetBeans External Editor module
123 must be loaded and enabled. If you have a Sun ONE Studio Enterprise Edition 123 must be loaded and enabled. If you have a Sun ONE Studio Enterprise Edition
124 then this module should be loaded and enabled. If you have a NetBeans release 124 then this module should be loaded and enabled. If you have a NetBeans release
125 you may need to find another way of obtaining this open source module. 125 you may need to find another way of obtaining this open source module.
126 126
127 You can check if you have this module by opening the Tools->Options dialog 127 You can check if you have this module by opening the Tools->Options dialog
128 and drilling down to the "Modules" list (IDE Configuration->System->Modules). 128 and drilling down to the "Modules" list (IDE Configuration->System->Modules).
129 If your Modules list has an entry for "External Editor" you must make sure 129 If your Modules list has an entry for "External Editor" you must make sure
130 it is enabled (the "Enabled" property should have the value "True"). If your 130 it is enabled (the "Enabled" property should have the value "True"). If your
131 Modules list has no External Editor see the next section on |obtaining-exted|. 131 Modules list has no External Editor see the next section on |obtaining-exted|.
132 132
133 ============================================================================== 133 ==============================================================================
134 6. Obtaining the External Editor Module *obtaining-exted* 134 6. Obtaining the External Editor Module *obtaining-exted*
135 135
136 There are 2 ways of obtaining the External Editor module. The easiest way 136 There are 2 ways of obtaining the External Editor module. The easiest way
137 is to use the NetBeans Update Center to download and install the module. 137 is to use the NetBeans Update Center to download and install the module.
138 Unfortunately, some versions do not have this module in their update 138 Unfortunately, some versions do not have this module in their update
139 center. If you cannot download via the update center you will need to 139 center. If you cannot download via the update center you will need to
140 download sources and build the module. I will try and get the module 140 download sources and build the module. I will try and get the module
141 available from the NetBeans Update Center so building will be unnecessary. 141 available from the NetBeans Update Center so building will be unnecessary.
142 Also check http://externaleditor.netbeans.org for other availability options. 142 Also check http://externaleditor.netbeans.org for other availability options.
143 143
144 To download the External Editor sources via CVS and build your own module, 144 To download the External Editor sources via CVS and build your own module,
145 see http://externaleditor.netbeans.org and http://www.netbeans.org. 145 see http://externaleditor.netbeans.org and http://www.netbeans.org.
150 150
151 Assuming you have loaded and enabled the NetBeans External Editor module 151 Assuming you have loaded and enabled the NetBeans External Editor module
152 as described in |netbeans-preparation| all you need to do is verify that 152 as described in |netbeans-preparation| all you need to do is verify that
153 the gvim command line is properly configured for your environment. 153 the gvim command line is properly configured for your environment.
154 154
155 Open the Tools->Options dialog and open the Editing category. Select the 155 Open the Tools->Options dialog and open the Editing category. Select the
156 External Editor. The right hand pane should contain a Properties tab and 156 External Editor. The right hand pane should contain a Properties tab and
157 an Expert tab. In the Properties tab make sure the "Editor Type" is set 157 an Expert tab. In the Properties tab make sure the "Editor Type" is set
158 to "Vim". In the Expert tab make sure the "Vim Command" is correct. 158 to "Vim". In the Expert tab make sure the "Vim Command" is correct.
159 159
160 You should be careful if you change the "Vim Command". There are command 160 You should be careful if you change the "Vim Command". There are command
161 line options there which must be there for the connection to be properly 161 line options there which must be there for the connection to be properly
162 set up. You can change the command name but thats about it. If your gvim 162 set up. You can change the command name but that's about it. If your gvim
163 can be found by your $PATH then the VIM Command can start with "gvim". If 163 can be found by your $PATH then the VIM Command can start with "gvim". If
164 you don't want gvim searched from your $PATH then hard code in the full 164 you don't want gvim searched from your $PATH then hard code in the full
165 Unix path name. At this point you should get a gvim for any source file 165 Unix path name. At this point you should get a gvim for any source file
166 you open in NetBeans. 166 you open in NetBeans.
167 167
168 If some files come up in gvim and others (with different file suffixes) come 168 If some files come up in gvim and others (with different file suffixes) come
169 up in the default NetBeans editor you should verify the MIME type in the 169 up in the default NetBeans editor you should verify the MIME type in the
170 Expert tab MIME Type property. NetBeans is MIME oriented and the External 170 Expert tab MIME Type property. NetBeans is MIME oriented and the External
171 Editor will only open MIME types specified in this property. 171 Editor will only open MIME types specified in this property.
172 172
173 ============================================================================== 173 ==============================================================================
174 8. Messages *netbeans-messages* 174 8. Messages *netbeans-messages*
175 175
192 192
193 *E658* 193 *E658*
194 NetBeans connection lost for this buffer 194 NetBeans connection lost for this buffer
195 NetBeans has become confused about the state of this file. 195 NetBeans has become confused about the state of this file.
196 Rather than risc data corruption, NetBeans has severed the 196 Rather than risc data corruption, NetBeans has severed the
197 connection for this file. Vim will take over responsibility 197 connection for this file. Vim will take over responsibility
198 for saving changes to this file and NetBeans will no longer 198 for saving changes to this file and NetBeans will no longer
199 know of these changes. 199 know of these changes.
200 200
201 *E744* 201 *E744*
202 NetBeans does not allow changes in read-only files 202 NetBeans does not allow changes in read-only files
246 protocol was first designed to work with the external editor module of 246 protocol was first designed to work with the external editor module of
247 NetBeans (see http://externaleditor.netbeans.org). Later it was extended to 247 NetBeans (see http://externaleditor.netbeans.org). Later it was extended to
248 work with Agide (A-A-P GUI IDE, see http://www.a-a-p.org). The extensions are 248 work with Agide (A-A-P GUI IDE, see http://www.a-a-p.org). The extensions are
249 marked with "version 2.1". 249 marked with "version 2.1".
250 250
251 Version 2.2 of the protocol has several minor changes which should only 251 Version 2.2 of the protocol has several minor changes which should only affect
252 affect NetBeans users (ie, not Agide users). However, a bug was fixed which 252 NetBeans users (ie, not Agide users). However, a bug was fixed which could
253 could cause confusion. The netbeans_saved() function sent a "save" protocol 253 cause confusion. The netbeans_saved() function sent a "save" protocol
254 command. In protocol version 2.1 and earlier this was incorrectly interpreted 254 command. In protocol version 2.1 and earlier this was incorrectly interpreted
255 as a notification that a write had taken place. In reality, it told NetBeans 255 as a notification that a write had taken place. In reality, it told NetBeans
256 to save the file so multiple writes were being done. This caused various 256 to save the file so multiple writes were being done. This caused various
257 problems and has been fixed in 2.2. To decrease the likelihood of this 257 problems and has been fixed in 2.2. To decrease the likelihood of this
258 confusion happening again, netbeans_saved() has been renamed to 258 confusion happening again, netbeans_saved() has been renamed to
259 netbeans_save_buffer(). 259 netbeans_save_buffer().
260 260
261 The messages are currently sent over a socket. Since the messages are in 261 The messages are currently sent over a socket. Since the messages are in
262 plain UTF-8 text this protocol could also be used with any other communication 262 plain UTF-8 text this protocol could also be used with any other communication
426 initDone Mark the buffer as ready for use. Implicitly makes the buffer 426 initDone Mark the buffer as ready for use. Implicitly makes the buffer
427 the current buffer. Fires the BufReadPost autocommand event. 427 the current buffer. Fires the BufReadPost autocommand event.
428 428
429 insertDone 429 insertDone
430 Sent by NetBeans to tell vim an initial file insert is done. 430 Sent by NetBeans to tell vim an initial file insert is done.
431 This triggers a read message being printed. Prior to version 431 This triggers a read message being printed. Prior to version
432 2.3, no read messages were displayed after opening a file. 432 2.3, no read messages were displayed after opening a file.
433 New in version 2.3. 433 New in version 2.3.
434 434
435 moveAnnoToFront serNum 435 moveAnnoToFront serNum
436 Not implemented. 436 Not implemented.
464 - the buffer does not have a file name 464 - the buffer does not have a file name
465 - 'buftype' disallows writing 465 - 'buftype' disallows writing
466 New in version 2.2. 466 New in version 2.2.
467 467
468 saveDone 468 saveDone
469 Sent by NetBeans to tell vim a save is done. This triggers 469 Sent by NetBeans to tell vim a save is done. This triggers
470 a save message being printed. Prior to version 2.3, no save 470 a save message being printed. Prior to version 2.3, no save
471 messages were displayed after a save. 471 messages were displayed after a save.
472 New in version 2.3. 472 New in version 2.3.
473 473
474 setAsUser Not implemented. 474 setAsUser Not implemented.
475 475
537 disappear when the mouse is moved more than a few pixels. 537 disappear when the mouse is moved more than a few pixels.
538 New in version 2.1. 538 New in version 2.1.
539 539
540 specialKeys 540 specialKeys
541 Map a set of keys (mostly function keys) to be passed back 541 Map a set of keys (mostly function keys) to be passed back
542 to NetBeans for processing. This lets NetBeans hotkeys be 542 to NetBeans for processing. This lets NetBeans hotkeys be
543 used from vim. 543 used from vim.
544 Implemented in version 2.3. 544 Implemented in version 2.3.
545 545
546 startAtomic Begin an atomic operation. The screen will not be updated 546 startAtomic Begin an atomic operation. The screen will not be updated
547 until "endAtomic" is given. 547 until "endAtomic" is given.
650 buttonRelease button lnum col 650 buttonRelease button lnum col
651 Report which button was pressed and the location of the cursor 651 Report which button was pressed and the location of the cursor
652 at the time of the release. Only for buffers that are owned 652 at the time of the release. Only for buffers that are owned
653 by NetBeans. This event is not sent if the button was 653 by NetBeans. This event is not sent if the button was
654 released while the mouse was in the status line or in a 654 released while the mouse was in the status line or in a
655 separator line. If col is less than 1 the button release was 655 separator line. If col is less than 1 the button release was
656 in the sign area. 656 in the sign area.
657 New in version 2.2. 657 New in version 2.2.
658 658
659 disconnect 659 disconnect
660 Tell NetBeans that vim is exiting and not to try and read or 660 Tell NetBeans that vim is exiting and not to try and read or
770 11. NetBeans Commands *netbeans-commands* 770 11. NetBeans Commands *netbeans-commands*
771 771
772 *:nbkey* 772 *:nbkey*
773 :nbkey key Pass the key to NetBeans for processing 773 :nbkey key Pass the key to NetBeans for processing
774 774
775 Pass the key to NetBeans for hot-key processing. You should not need to use 775 Pass the key to NetBeans for hot-key processing. You should not need to use
776 this command directly. However, NetBeans passes a list of hot-keys to Vim at 776 this command directly. However, NetBeans passes a list of hot-keys to Vim at
777 startup and when one of these keys is pressed, this command is generated to 777 startup and when one of these keys is pressed, this command is generated to
778 send the key press back to NetBeans. 778 send the key press back to NetBeans.
779 779
780 ============================================================================== 780 ==============================================================================
781 12. Known problems *netbeans-problems* 781 12. Known problems *netbeans-problems*