提交 b9dacf31 编写于 作者: C Cosmin Popescu

updated vim help documentation

上级 56a726dd
......@@ -980,6 +980,9 @@ and
you set this to 1, then the commands will be executed asynchronous
* `g:sw_vim_exe`: the default VIM executable location; this is used in
conjunction with the asynchronous mode; default value: `vim`
* `g:sw_delete_tmp`: if true, then delete the temporary files created to
execute any command. Useful for debugging. You can set it to 0 and check all
the generated files
Screen shots
========================================
......
......@@ -30,9 +30,10 @@ CONTENTS
5. Searching ................................................ |sw-search|
6. Exporting ................................................ |sw-export|
7. Sessions ............................................... |sw-sessions|
8. Commands ............................................... |sw-commands|
9. Settings ............................................... |sw-settings|
10. Missing features .............................. |sw-missing-features|
8. Asynchronous ....................................... |sw-asynchronous|
9. Commands ............................................... |sw-commands|
10. Settings .............................................. |sw-settings|
11. Missing features .............................. |sw-missing-features|
==============================================================================
REQUIREMENTS *sw-requirements*
......@@ -501,6 +502,49 @@ that executing statements against the DBMS will produce vim errors. Before
executing any statement, you have to call the |SWSqlBufferRestore|. This will
also restore the autocomplete list, so you will also have the autocomplete.
==============================================================================
Asynchronous *sw-asynchronous*
By default, VIM SQL workbench works in synchronous mode. This means that you
launch a command, then you will see on the screen the command being executed
and you have to wait for it to finish to execute another one.
If you set the variable |g:sw_asynchronious| to 1, then VIM SQL Workbench will
switch to work in asynchronous mode. This means that once you launch a
command, the control is returned back immediately, and when the command is
finished, you will see the output. The advantages of this approach are
evident: you can launch more than one command at the same time from different
SQL buffers, you can continue working if the command takes too much time etc.
For example, when you want to activate the intellisense. This can take more
than one minute. You can continue working in all this time.
In order to use the asynchronous mode on Windows, you have to have the [VIM
Dispatch] plugin installed. This is because in Windows I cannot launch a
command as daemon.
Another requirement to run VIM in asynchronous mode is to have the server
option installed and activated (see :help |client-server|). This is the way in
which VIM SQL Workbench will know that a command is finished.
If VIM is not in your *PATH* variable, or you are using other executable (like
gvim or vim.exe or gvim.exe on Windows), you have to set the
|g:sw_vim_exe| variable in order to use the asynchronous mode. The default
value is vim. This should work on most GNU/Linux distributions if you are
using vim in console mode. If you are using gvim or macvim, just set the
the variable to whatever you are using. On Windows, you will probably have to
set the variable with full path.
If the command takes to much and you want to launch another command from the
same buffer, by default you will have an error message telling you that
another command is in progress. You can use the |SWKillCurrentCommand|
command. This is mapped by default to <C-c>. You can change the mapping
or you can use it directly in command mode.
Please note that killing a command does not mean that the command will not be
sent to the DBMS. This only means that once it's finished, vim will simply
ignore its output. This is not a way to stop a wrongly sent *update*
statement. The statement will get execute anyway.
==============================================================================
COMMANDS *sw-commands*
......@@ -811,7 +855,11 @@ buffer using the default list of tables, fields and procedures.
This command will restore the properties of the sql buffer following a vim
session restore. This includes the autocomplete intellisense of the buffer, if
this was active when mksession was executed.
this was active when `mksession` was executed.
*SWKillCurrentCommand*
This command will kill the current command being executed in asynchronous mode.
==============================================================================
SETTINGS *sw-settings*
......@@ -878,6 +926,13 @@ the bottom left and bottom right panels)
*sw_exe*: the location of the SQL Workbench executable; default value:
"sqlwbconsole.sh"
*g:sw_tmp*: the location of your temporary folder; default value: "/tmp"
*g:sw_asynchronious*: by default, the commands are executed synchronous; if
you set this to 1, then the commands will be executed asynchronous
*g:sw_vim_exe*: the default VIM executable location; this is used in
conjunction with the asynchronous mode; default value: `vim`
**g:sw_delete_tmp*: if true, then delete the temporary files created to
execute any command. Useful for debugging. You can set it to 0 and check all
the generated files
==============================================================================
MISSING FEATURES *sw-missing-features*
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册