FM / doc

/usr/share/vim/vim80/doc

Name	Size	Mode	Actions
arabic.txt	11936	0644	edit dl rm
autocmd.txt	65402	0644	edit dl rm
change.txt	74877	0644	edit dl rm
channel.txt	30819	0644	edit dl rm
cmdline.txt	47283	0644	edit dl rm
debug.txt	7182	0644	edit dl rm
debugger.txt	5744	0644	edit dl rm
develop.txt	22344	0644	edit dl rm
diff.txt	16525	0644	edit dl rm
digraph.txt	62123	0644	edit dl rm
editing.txt	73176	0644	edit dl rm
eval.txt	444462	0644	edit dl rm
farsi.txt	9703	0644	edit dl rm
filetype.txt	26647	0644	edit dl rm
fold.txt	23694	0644	edit dl rm
ft_ada.txt	18247	0644	edit dl rm
ft_rust.txt	9526	0644	edit dl rm
ft_sql.txt	30694	0644	edit dl rm
gui.txt	45592	0644	edit dl rm
gui_w32.txt	18916	0644	edit dl rm
gui_x11.txt	29480	0644	edit dl rm
hangulin.txt	3291	0644	edit dl rm
hebrew.txt	5714	0644	edit dl rm
help.txt	8578	0644	edit dl rm
helphelp.txt	14338	0644	edit dl rm
howto.txt	2911	0644	edit dl rm
if_cscop.txt	19361	0644	edit dl rm
if_lua.txt	14642	0644	edit dl rm
if_mzsch.txt	11823	0644	edit dl rm
if_ole.txt	7405	0644	edit dl rm
if_perl.txt	11149	0644	edit dl rm
if_pyth.txt	37944	0644	edit dl rm
if_ruby.txt	8014	0644	edit dl rm
if_sniff.txt	266	0644	edit dl rm
if_tcl.txt	23026	0644	edit dl rm
indent.txt	39427	0644	edit dl rm
index.txt	76443	0644	edit dl rm
insert.txt	83156	0644	edit dl rm
intro.txt	39226	0644	edit dl rm
map.txt	64668	0644	edit dl rm
mbyte.txt	59306	0644	edit dl rm
message.txt	31230	0644	edit dl rm
mlang.txt	7850	0644	edit dl rm
motion.txt	51602	0644	edit dl rm
netbeans.txt	36998	0644	edit dl rm
options.txt	389116	0644	edit dl rm
os_390.txt	4753	0644	edit dl rm
os_amiga.txt	5461	0644	edit dl rm
os_beos.txt	10983	0644	edit dl rm
os_dos.txt	12021	0644	edit dl rm
os_mac.txt	6851	0644	edit dl rm
os_mint.txt	1402	0644	edit dl rm
os_msdos.txt	518	0644	edit dl rm
os_os2.txt	294	0644	edit dl rm
os_qnx.txt	4071	0644	edit dl rm
os_risc.txt	323	0644	edit dl rm
os_unix.txt	2595	0644	edit dl rm
os_vms.txt	32100	0644	edit dl rm
os_win32.txt	13348	0644	edit dl rm
pattern.txt	59321	0644	edit dl rm
pi_getscript.txt	21078	0644	edit dl rm
pi_gzip.txt	1321	0644	edit dl rm
pi_logipat.txt	4186	0644	edit dl rm
pi_netrw.txt	175550	0644	edit dl rm
pi_paren.txt	2269	0644	edit dl rm
pi_spec.txt	4122	0644	edit dl rm
pi_tar.txt	6223	0644	edit dl rm
pi_vimball.txt	11853	0644	edit dl rm
pi_zip.txt	7229	0644	edit dl rm
print.txt	31158	0644	edit dl rm
quickfix.txt	69021	0644	edit dl rm
quickref.txt	71256	0644	edit dl rm
quotes.txt	12743	0644	edit dl rm
recover.txt	10694	0644	edit dl rm
remote.txt	8420	0644	edit dl rm
repeat.txt	39573	0644	edit dl rm
rileft.txt	4976	0644	edit dl rm
russian.txt	3090	0644	edit dl rm
scroll.txt	14071	0644	edit dl rm
sign.txt	6891	0644	edit dl rm
spell.txt	62781	0644	edit dl rm
sponsor.txt	7198	0644	edit dl rm
starting.txt	73622	0644	edit dl rm
syntax.txt	217471	0644	edit dl rm
tabpage.txt	16720	0644	edit dl rm
tags	328832	0644	edit dl rm
tagsrch.txt	36636	0644	edit dl rm
term.txt	45416	0644	edit dl rm
terminal.txt	33567	0644	edit dl rm
tips.txt	20556	0644	edit dl rm
todo.txt	296268	0644	edit dl rm
uganda.txt	14024	0644	edit dl rm
undo.txt	16539	0644	edit dl rm
usr_01.txt	7090	0644	edit dl rm
usr_02.txt	24339	0644	edit dl rm
usr_03.txt	23605	0644	edit dl rm
usr_04.txt	19082	0644	edit dl rm
usr_05.txt	23824	0644	edit dl rm
usr_06.txt	9587	0644	edit dl rm
usr_07.txt	15984	0644	edit dl rm
usr_08.txt	19374	0644	edit dl rm
usr_09.txt	11450	0644	edit dl rm
usr_10.txt	29180	0644	edit dl rm
usr_11.txt	12611	0644	edit dl rm
usr_12.txt	13424	0644	edit dl rm
usr_20.txt	13703	0644	edit dl rm
usr_21.txt	18373	0644	edit dl rm
usr_22.txt	14297	0644	edit dl rm
usr_23.txt	12588	0644	edit dl rm
usr_24.txt	20869	0644	edit dl rm
usr_25.txt	19114	0644	edit dl rm
usr_26.txt	8254	0644	edit dl rm
usr_27.txt	17723	0644	edit dl rm
usr_28.txt	16015	0644	edit dl rm
usr_29.txt	20116	0644	edit dl rm
usr_30.txt	22656	0644	edit dl rm
usr_31.txt	10394	0644	edit dl rm
usr_32.txt	5373	0644	edit dl rm
usr_40.txt	23184	0644	edit dl rm
usr_41.txt	89301	0644	edit dl rm
usr_42.txt	13798	0644	edit dl rm
usr_43.txt	7404	0644	edit dl rm
usr_44.txt	29211	0644	edit dl rm
usr_45.txt	17912	0644	edit dl rm
usr_90.txt	17661	0644	edit dl rm
usr_toc.txt	9218	0644	edit dl rm
various.txt	28852	0644	edit dl rm
version4.txt	13906	0644	edit dl rm
version5.txt	308543	0644	edit dl rm
version6.txt	577052	0644	edit dl rm
version7.txt	674766	0644	edit dl rm
version8.txt	684252	0644	edit dl rm
visual.txt	21843	0644	edit dl rm
vi_diff.txt	42812	0644	edit dl rm
windows.txt	53030	0644	edit dl rm
workshop.txt	4631	0644	edit dl rm

Edit: /usr/share/vim/vim80/doc/if_ole.txt (7405B)

*if_ole.txt*    For Vim version 8.0.  Last change: 2008 Aug 16

VIM REFERENCE MANUAL    by Paul Moore

The OLE Interface to Vim				*ole-interface*

{Vi does not have any of these commands}

OLE is only available when compiled with the |+ole| feature.  See
src/if_ole.INSTALL.
An alternative is using the client-server communication |clientserver|.

==============================================================================
1. Activation						*ole-activation*

Vim acts as an OLE automation server, accessible from any automation client,
for example, Visual Basic, Python, or Perl.  The Vim application "name" (its
"ProgID", in OLE terminology) is "Vim.Application".

Hence, in order to start a Vim instance (or connect to an already running
instance), code similar to the following should be used:

[Visual Basic] >
	Dim Vim As Object
	Set Vim = CreateObject("Vim.Application")

[Python] >
	from win32com.client.dynamic import Dispatch
	vim = Dispatch('Vim.Application')

[Perl] >
	use Win32::OLE;
	$vim = new Win32::OLE 'Vim.Application';

[C#] >
        // Add a reference to Vim in your project. 
        // Choose the COM tab.
        // Select "Vim Ole Interface 1.1 Type Library"
	Vim.Vim vimobj = new Vim.Vim();

Vim does not support acting as a "hidden" OLE server, like some other OLE
Automation servers.  When a client starts up an instance of Vim, that instance
is immediately visible.  Simply closing the OLE connection to the Vim instance
is not enough to shut down the Vim instance - it is necessary to explicitly
execute a quit command (for example, :qa!, :wqa).

==============================================================================
2. Methods						*ole-methods*

Vim exposes four methods for use by clients.

*ole-sendkeys*
SendKeys(keys)		Execute a series of keys.

This method takes a single parameter, which is a string of keystrokes.  These
keystrokes are executed exactly as if they had been types in at the keyboard.
Special keys can be given using their <..> names, as for the right hand side
of a mapping.  Note: Execution of the Ex "normal" command is not supported -
see below |ole-normal|.

Examples (Visual Basic syntax) >
	Vim.SendKeys "ihello<Esc>"
	Vim.SendKeys "ma1GV4jy`a"

These examples assume that Vim starts in Normal mode.  To force Normal mode,
start the key sequence with CTRL-\ CTRL-N as in >

Vim.SendKeys "<C-\><C-N>ihello<Esc>"

CTRL-\ CTRL-N returns Vim to Normal mode, when in Insert or Command-line mode.
Note that this doesn't work halfway a Vim command

*ole-eval*
Eval(expr)		Evaluate an expression.

This method takes a single parameter, which is an expression in Vim's normal
format (see |expression|).  It returns a string, which is the result of
evaluating the expression.  A |List| is turned into a string by joining the
items and inserting line breaks.

Examples (Visual Basic syntax) >
	Line20 = Vim.Eval("getline(20)")
	Twelve = Vim.Eval("6 + 6")		' Note this is a STRING
	Font = Vim.Eval("&guifont")
<
							*ole-setforeground*
SetForeground()		Make the Vim window come to the foreground

This method takes no arguments.  No value is returned.

Example (Visual Basic syntax) >
	Vim.SetForeground
<

*ole-gethwnd*
GetHwnd()		Return the handle of the Vim window.

This method takes no arguments.  It returns the hwnd of the main Vimwindow.
You can use this if you are writing something which needs to manipulate the
Vim window, or to track it in the z-order, etc.

Example (Visual Basic syntax) >
	Vim_Hwnd = Vim.GetHwnd
<

==============================================================================
3. The "normal" command					*ole-normal*

Due to the way Vim processes OLE Automation commands, combined with the method
of implementation of the Ex command :normal, it is not possible to execute the
:normal command via OLE automation.  Any attempt to do so will fail, probably
harmlessly, although possibly in unpredictable ways.

There is currently no practical way to trap this situation, and users must
simply be aware of the limitation.
==============================================================================
4. Registration					*ole-registration* *E243*

Before Vim will act as an OLE server, it must be registered in the system
registry.  In order to do this, Vim should be run with a single parameter of
"-register".
							*-register*  >
	gvim -register

If gvim with OLE support is run and notices that no Vim OLE server has been
registered, it will present a dialog and offers you the choice to register by
clicking "Yes".

In some situations registering is not possible.  This happens when the
registry is not writable.  If you run into this problem you need to run gvim
as "Administrator".

Once vim is registered, the application path is stored in the registry.
Before moving, deleting, or upgrading Vim, the registry entries should be
removed using the "-unregister" switch.
							*-unregister*  >
	gvim -unregister

The OLE mechanism will use the first registered Vim it finds.  If a Vim is
already running, this one will be used.  If you want to have (several) Vim
sessions open that should not react to OLE commands, use the non-OLE version,
and put it in a different directory.  The OLE version should then be put in a
directory that is not in your normal path, so that typing "gvim" will start
the non-OLE version.

*-silent*
To avoid the message box that pops up to report the result, prepend "-silent":
>
	gvim -silent -register
	gvim -silent -unregister

==============================================================================
5. MS Visual Studio integration			*MSVisualStudio* *VisVim*

The OLE version can be used to run Vim as the editor in Microsoft Visual
Studio.  This is called "VisVim".  It is included in the archive that contains
the OLE version.  The documentation can be found in the runtime directory, the
README_VisVim.txt file.

Using Vim with Visual Studio .Net~

With .Net you no longer really need VisVim, since .Net studio has support for
external editors.  Follow these directions:

In .Net Studio choose from the menu Tools->External Tools...
Add
     Title     - Vim
     Command   - c:\vim\vim63\gvim.exe
     Arguments - --servername VS_NET --remote-silent "+call cursor($(CurLine), $(CurCol))" $(ItemPath)
     Init Dir  - Empty

Now, when you open a file in .Net, you can choose from the .Net menu:
Tools->Vim

That will open the file in Vim.
You can then add this external command as an icon and place it anywhere you
like.  You might also be able to set this as your default editor.

If you refine this further, please post back to the Vim maillist so we have a
record of it.

--servername VS_NET
This will create a new instance of vim called VS_NET.  So if you open multiple
files from VS, they will use the same instance of Vim.  This allows you to
have multiple copies of Vim running, but you can control which one has VS
files in it.

--remote-silent "+call cursor(10, 27)"
	      - Places the cursor on line 10 column 27
In Vim >
   :h --remote-silent for more details

[.Net remarks provided by Dave Fishburn and Brian Sturk]

==============================================================================
 vim:tw=78:ts=8:ft=help:norl:

cmd: