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_mzsch.txt (11823B)

*if_mzsch.txt*  For Vim version 8.0.  Last change: 2017 Oct 08

VIM REFERENCE MANUAL    by Sergey Khorev

The MzScheme Interface to Vim				*mzscheme* *MzScheme*

{Vi does not have any of these commands}

The MzScheme interface is available only if Vim was compiled with the
|+mzscheme| feature.

Based on the work of Brent Fulgham.
Dynamic loading added by Sergey Khorev

MzScheme and PLT Scheme names have been rebranded as Racket. For more
information please check http://racket-lang.org

Futures and places of Racket version 5.x up to and including 5.3.1 do not
work correctly with processes created by Vim.
The simplest solution is to build Racket on your own with these features
disabled: >
  ./configure --disable-futures --disable-places --prefix=your-install-prefix

To speed up the process, you might also want to use --disable-gracket and
--disable-docs

==============================================================================
1. Commands						*mzscheme-commands*

*:mzscheme* *:mz*
:[range]mz[scheme] {stmt}
			Execute MzScheme statement {stmt}.  {not in Vi}

:[range]mz[scheme] << {endmarker}
{script}
{endmarker}
			Execute inlined MzScheme script {script}.
			Note: This command doesn't work if the MzScheme
			feature wasn't compiled in.  To avoid errors, see
			|script-here|.

*:mzfile* *:mzf*
:[range]mzf[ile] {file}	Execute the MzScheme script in {file}.  {not in Vi}

All of these commands do essentially the same thing - they execute a piece of
MzScheme code, with the "current range" set to the given line
range.

In the case of :mzscheme, the code to execute is in the command-line.
In the case of :mzfile, the code to execute is the contents of the given file.

MzScheme interface defines exception exn:vim, derived from exn.
It is raised for various Vim errors.

During compilation, the MzScheme interface will remember the current MzScheme
collection path. If you want to specify additional paths use the
'current-library-collection-paths' parameter. E.g., to cons the user-local
MzScheme collection path: >
    :mz << EOF
    (current-library-collection-paths
	(cons
	    (build-path (find-system-path 'addon-dir) (version) "collects")
	    (current-library-collection-paths)))
    EOF
<

All functionality is provided through module vimext.

The exn:vim is available without explicit import.

To avoid clashes with MzScheme, consider using prefix when requiring module,
e.g.: >
	:mzscheme (require (prefix vim- vimext))
<
All the examples below assume this naming scheme.

*mzscheme-sandbox*
When executed in the |sandbox|, access to some filesystem and Vim interface
procedures is restricted.

==============================================================================
2. Examples						*mzscheme-examples*
>
	:mzscheme (display "Hello")
	:mz (display (string-append "Using MzScheme version " (version)))
	:mzscheme (require (prefix vim- vimext)) ; for MzScheme < 4.x
	:mzscheme (require (prefix-in vim- 'vimext)) ; MzScheme 4.x
	:mzscheme (vim-set-buff-line 10 "This is line #10")

To see what version of MzScheme you have: >
	:mzscheme (display (version))
<
Inline script usage: >
	function! <SID>SetFirstLine()
	    :mz << EOF
	    (display "!!!")
	    (require (prefix vim- vimext))
	    ; for newer versions (require (prefix-in vim- 'vimext))
	    (vim-set-buff-line 1 "This is line #1")
	    (vim-beep)
	EOF
	endfunction

nmap <F9> :call <SID>SetFirstLine() <CR>
<
File execution: >
	:mzfile supascript.scm
<
Vim exception handling: >
	:mz << EOF
	(require (prefix vim- vimext))
	; for newer versions (require (prefix-in vim- 'vimext))
	(with-handlers
	  ([exn:vim? (lambda (e) (display (exn-message e)))])
	  (vim-eval "nonsense-string"))
	EOF
<
Auto-instantiation of vimext module (can be placed in your |vimrc|): >
    function! MzRequire()
	:redir => l:mzversion
	:mz (version)
	:redir END
	if strpart(l:mzversion, 1, 1) < "4"
	    " MzScheme versions < 4.x:
	    :mz (require (prefix vim- vimext))
	else
	    " newer versions:
	    :mz (require (prefix-in vim- 'vimext))
	endif
    endfunction

if has("mzscheme")
	silent call MzRequire()
    endif
<
==============================================================================
3. Threads						*mzscheme-threads*

The MzScheme interface supports threads. They are independent from OS threads,
thus scheduling is required. The option 'mzquantum' determines how often
Vim should poll for available MzScheme threads.
NOTE
Thread scheduling in the console version of Vim is less reliable than in the
GUI version.

==============================================================================
4. Vim access from MzScheme				*mzscheme-vim*

*mzscheme-vimext*
The 'vimext' module provides access to procedures defined in the MzScheme
interface.

Common
------
    (command {command-string})	    Perform the vim ":Ex" style command.
    (eval {expr-string})	    Evaluate the vim expression into
				    respective MzScheme object: |Lists| are
				    represented as Scheme lists,
				    |Dictionaries| as hash tables,
				    |Funcref|s as functions (see also
				    |mzscheme-funcref|)
				    NOTE the name clashes with MzScheme eval,
				    use module qualifiers to overcome this.
    (range-start)		    Start/End of the range passed with
    (range-end)			    the Scheme command.
    (beep)			    beep
    (get-option {option-name} [buffer-or-window]) Get Vim option value (either
				    local or global, see set-option).
    (set-option {string} [buffer-or-window])
				    Set a Vim option. String must have option
				    setting form (like optname=optval, or
				    optname+=optval, etc.) When called with
				    {buffer} or {window} the local option will
				    be set. The symbol 'global can be passed
				    as {buffer-or-window}. Then |:setglobal|
				    will be used.

Buffers							 *mzscheme-buffer*
-------
    (buff? {object})		    Is object a buffer?
    (buff-valid? {object})	    Is object a valid buffer? (i.e.
				    corresponds to the real Vim buffer)
    (get-buff-line {linenr} [buffer])
				    Get line from a buffer.
    (set-buff-line {linenr} {string} [buffer])
				    Set a line in a buffer. If {string} is #f,
				    the line gets deleted.  The [buffer]
				    argument is optional. If omitted, the
				    current buffer will be used.
    (get-buff-line-list {start} {end} [buffer])
				    Get a list of lines in a buffer. {Start}
				    and {end} are 1-based and inclusive.
    (set-buff-line-list {start} {end} {string-list} [buffer])
				    Set a list of lines in a buffer. If
				    string-list is #f or null, the lines get
				    deleted. If a list is shorter than
				    {end}-{start} the remaining lines will
				    be deleted.
    (get-buff-name [buffer])	    Get a buffer's text name.
    (get-buff-num [buffer])	    Get a buffer's number.
    (get-buff-size [buffer])	    Get buffer line count.
    (insert-buff-line-list {linenr} {string/string-list} [buffer])
				    Insert a list of lines into a buffer after
				    {linenr}. If {linenr} is 0, lines will be
				    inserted at start.
    (curr-buff)			    Get the current buffer. Use other MzScheme
				    interface procedures to change it.
    (buff-count)		    Get count of total buffers in the editor.
    (get-next-buff [buffer])	    Get next buffer.
    (get-prev-buff [buffer])	    Get previous buffer. Return #f when there
				    are no more buffers.
    (open-buff {filename})	    Open a new buffer (for file "name")
    (get-buff-by-name {buffername}) Get a buffer by its filename or #f
					if there is no such buffer.
    (get-buff-by-num {buffernum})   Get a buffer by its number (return #f if
				    there is no buffer with this number).

Windows							    *mzscheme-window*
------
    (win? {object})		    Is object a window?
    (win-valid? {object})	    Is object a valid window (i.e. corresponds
				    to the real Vim window)?
    (curr-win)			    Get the current window.
    (win-count)			    Get count of windows.
    (get-win-num [window])	    Get window number.
    (get-win-by-num {windownum})    Get window by its number.
    (get-win-buffer	[window])   Get the buffer for a given window.
    (get-win-height [window])
    (set-win-height {height} [window])  Get/Set height of window.
    (get-win-width [window])
    (set-win-width {width} [window])Get/Set width of window.
    (get-win-list [buffer])	    Get list of windows for a buffer.
    (get-cursor [window])	    Get cursor position in a window as
				    a pair (linenr . column).
    (set-cursor (line . col) [window])  Set cursor position.

==============================================================================
5. mzeval() Vim function				    *mzscheme-mzeval*

To facilitate bi-directional interface, you can use |mzeval()| function to
evaluate MzScheme expressions and pass their values to Vim script.

==============================================================================
6. Using Function references				    *mzscheme-funcref*

MzScheme interface allows use of |Funcref|s so you can call Vim functions
directly from Scheme. For instance: >
    function! MyAdd2(arg)
	return a:arg + 2
    endfunction
    mz (define f2 (vim-eval "function(\"MyAdd2\")"))
    mz (f2 7)
< or : >
    :mz (define indent (vim-eval "function('indent')"))
    " return Vim indent for line 12
    :mz (indent 12)
<

==============================================================================
7. Dynamic loading				*mzscheme-dynamic* *E815*

On MS-Windows the MzScheme libraries can be loaded dynamically. The |:version|
output then includes |+mzscheme/dyn|.

This means that Vim will search for the MzScheme DLL files only when needed.
When you don't use the MzScheme interface you don't need them, thus you can
use Vim without these DLL files.
NOTE: Newer version of MzScheme (Racket) require earlier (trampolined)
initialisation via scheme_main_setup.  So Vim always loads the MzScheme DLL at
startup if possible.  This may make Vim startup slower.

To use the MzScheme interface the MzScheme DLLs must be in your search path.
In a console window type "path" to see what directories are used.

On MS-Windows the options 'mzschemedll' and 'mzschemegcdll' are used for the
name of the library to load.  The initial value is specified at build time.

The version of the DLL must match the MzScheme version Vim was compiled with.
For MzScheme version 209 they will be "libmzsch209_000.dll" and
"libmzgc209_000.dll". To know for sure look at the output of the ":version"
command, look for -DDYNAMIC_MZSCH_DLL="something" and
-DDYNAMIC_MZGC_DLL="something" in the "Compilation" info.

For example, if MzScheme (Racket) is installed at C:\Racket63, you may need
to set the environment variable as the following: >

PATH=%PATH%;C:\Racket63\lib
  PLTCOLLECTS=C:\Racket63\collects
  PLTCONFIGDIR=C:\Racket63\etc
<
==============================================================================
8. MzScheme setup				    *mzscheme-setup* *E895*

Vim requires "racket/base" module for if_mzsch core (fallback to "scheme/base"
if it doesn't exist), "r5rs" module for test and "raco ctool" command for
building Vim.  If MzScheme did not have them, you can install them with
MzScheme's raco command:
>
  raco pkg install scheme-lib       # scheme/base module
  raco pkg install r5rs-lib         # r5rs module
  raco pkg install cext-lib         # raco ctool command
<
======================================================================
  vim:tw=78:ts=8:sts=4:ft=help:norl:

cmd: