Vim Help

https://vimhelp.org
Admin
Vim Help is the comprehensive documentation for Vim, providing complete reference manuals,...
Tokens:866,467
Snippets:13,418
Trust Score:9.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Vim installer command-line switches

Source: https://vimhelp.org/os_win32.txt.html

Usage examples for the Win32 Vim installer executable.

```text
    gvim_<version>.exe /S           -> silent install without any dialogues
    gvim_<version>.exe /D=C:\vim    -> Install into directory c:\vim
                                    -> /D must be the last argument
    gvim_<version>.exe /S /D=c:\vim -> silent install into c:\vim
```

--------------------------------

### Example Debugging Workflow

Source: https://vimhelp.org/terminal.txt.html

Commands to build and start a debugging session for the Vim source code.

```bash
% make
```

```bash
% ./vim
```

```vim
:packadd termdebug
:Termdebug vim
```

```gdb
break ex_help
run
```

--------------------------------

### System-Wide Vim Installation Setup

Source: https://vimhelp.org/os_vms.txt.html

Configure Vim and TMP logicals system-wide by adding definitions to SYS$STARTUP:SYLOGICALS.COM and creating aliases in SYS$STARTUP:SYLOGIN.COM.

```dcl
$ define/nolog/sys VIM device:<path>
$ define/nolog/sys TMP SYS$SCRATCH
```

```dcl
$ vi*m :== mcr VIM:VIM.EXE
$ gv*im:== spawn/nowait/input=NLA0 mcr VIM:VIM.EXE -g -GEOMETRY 80x40
```

--------------------------------

### Start gVim with a file

Source: https://vimhelp.org/usr_09.txt.html

Use these commands to launch gVim and open a file. If these do not work, your Vim installation may not have GUI support.

```bash
gvim file.txt
```

```bash
vim -g file.txt
```

--------------------------------

### Start-of-line Anchor Examples

Source: https://vimhelp.org/pattern.txt.html

Demonstrates using ^ to match the start of a line and \^ for a literal caret.

```vim
^beep(
```

--------------------------------

### Toolbar Configuration Example

Source: https://vimhelp.org/todo.txt.html

Example usage for configuring a toolbar in a terminal window.

```vim
Use tb_set(winid, [{'text': 'stop', 'cb': callback, 'hi': 'Green'}])
    tb_highlight(winid, 'ToolBar')
    tb_get(winid)
```

--------------------------------

### Manual Uninstallation Example (Unix)

Source: https://vimhelp.org/usr_90.txt.html

Example commands for manually removing Vim files when installed under /usr/local. This is a last resort if 'make uninstall' is not possible.

```bash
rm -rf /usr/local/share/vim/vim82
	rm /usr/local/bin/eview
	rm /usr/local/bin/evim
	rm /usr/local/bin/ex
	rm /usr/local/bin/gview
	rm /usr/local/bin/gvim
	rm /usr/local/bin/gvim
	rm /usr/local/bin/gvimdiff
	rm /usr/local/bin/rgview
	rm /usr/local/bin/rgvim
	rm /usr/local/bin/rview
	rm /usr/local/bin/rvim
	rm /usr/local/bin/rvim
	rm /usr/local/bin/view
	rm /usr/local/bin/vim
	rm /usr/local/bin/vimdiff
	rm /usr/local/bin/vimtutor
	rm /usr/local/bin/xxd
	rm /usr/local/man/man1/eview.1
	rm /usr/local/man/man1/evim.1
	rm /usr/local/man/man1/ex.1
	rm /usr/local/man/man1/gview.1
	rm /usr/local/man/man1/gvim.1
	rm /usr/local/man/man1/gvimdiff.1
	rm /usr/local/man/man1/rgview.1
	rm /usr/local/man/man1/rgvim.1
	rm /usr/local/man/man1/rview.1
	rm /usr/local/man/man1/rvim.1
	rm /usr/local/man/man1/view.1
	rm /usr/local/man/man1/vim.1
	rm /usr/local/man/man1/vimdiff.1
	rm /usr/local/man/man1/vimtutor.1
	rm /usr/local/man/man1/xxd.1
```

--------------------------------

### Start and manage jobs

Source: https://vimhelp.org/channel.txt.html

Functions for starting jobs, retrieving channels, and handling output callbacks.

```vim
let job = job_start(command, {options})
```

```vim
let channel = job_getchannel(job)
```

```vim
let job = job_start(command, {"out_cb": "MyHandler"})
```

```vim
func MyHandler(channel, msg)
```

```vim
let job = job_start(command, {"out_cb": "MyHandler",
	    \			  "err_cb": "ErrHandler"})
```

```vim
let job = job_start(command, {"callback": "MyHandler"})
```

--------------------------------

### Install GetLatestVimScripts on Windows

Source: https://vimhelp.org/pi_getscript.txt.html

Commands to install the plugin and initialize the data file on Windows systems.

```bash
vim getscript.vmb
:so %
:q
cd **path-to-vimfiles**/GetLatest
mv GetLatestVimScripts.dist GetLatestVimScripts.dat
```

--------------------------------

### Install GetLatestVimScripts on Unix

Source: https://vimhelp.org/pi_getscript.txt.html

Commands to install the plugin and initialize the data file on Unix-based systems.

```bash
vim getscript.vmb
:so %
:q
cd ~/.vim/GetLatest
mv GetLatestVimScripts.dist GetLatestVimScripts.dat
```

--------------------------------

### Check install command without overwriting

Source: https://vimhelp.org/usr_90.txt.html

Preview the files that would be affected by 'make install' without actually performing the installation.

```bash
make -n install
```

--------------------------------

### Wildcard Expansion Examples

Source: https://vimhelp.org/cmdline.txt.html

Examples of how wildcards and file name references are expanded in commands.

```vim
	command		expands to  
	:e #		:e ?readme?
	:e `ls #`	:e {files matching "?readme?"}
	:e #.*		:e {files matching "?readme?.*"}
	:cd <cfile>	:cd {file name under cursor}
	:cd <cfile>*	:cd {file name under cursor plus "*" and then expanded}
```

--------------------------------

### Complete Plugin Example

Source: https://vimhelp.org/usr_51.txt.html

A full example of a Vim9 script plugin implementing abbreviations, mappings, and user commands.

```vim
  1	vim9script noclear
  2	# Vim global plugin for correcting typing mistakes
  3	# Last Change:	2021 Dec 30
  4	# Maintainer:	Bram Moolenaar <Bram@vim.org>
  5	# License:	This file is placed in the public domain.
  6
  7	if exists("g:loaded_typecorrect")
  8	  finish
  9	endif
 10	g:loaded_typecorrect = 1
 11
 12	iabbrev teh the
 13	iabbrev otehr other
 14	iabbrev wnat want
 15	iabbrev synchronisation
 16		\ synchronization
 17	var count = 4
 18
 19	if !hasmapto('<Plug>(TypecorrAdd)')
 20	  map <unique> <Leader>a  <Plug>(TypecorrAdd)
 21	endif
 22	noremap <unique> <script> <Plug>(TypecorrAdd)  <SID>Add
 23
 24	noremenu <script> Plugin.Add\ Correction      <SID>Add
 25
 26	noremap <SID>Add  :call <SID>Add(expand("<cword>"), true)<CR>
 27
 28	def Add(from: string, correct: bool)
 29	  var to = input($"type the correction for {from}: ")
 30	  exe $":iabbrev {from} {to}"
 31	  if correct | exe "normal viws\<C-R>\" \b\e" | endif
 32	  count += 1
 33	  echo "you now have " .. count .. " corrections"
 34	enddef
 35
 36	if !exists(":Correct")
 37	  command -nargs=1  Correct  call Add(<q-args>, false)
 38	endif
```

--------------------------------

### Example vimrc file path

Source: https://vimhelp.org/usr_05.txt.html

Location of the example vimrc file provided with the Vim distribution.

```text
$VIMRUNTIME/vimrc_example.vim
```

--------------------------------

### Wildcard Expansion Examples

Source: https://vimhelp.org/editing.txt.html

Examples of using the ** wildcard to search for files in directory trees.

```vim
:n **/*.txt
```

```text
aaa.txt 
subdir/bbb.txt 
a/b/c/d/ccc.txt 
```

```vim
:n /usr/inc**/types.h
```

```text
/usr/include/types.h 
/usr/include/sys/types.h 
/usr/inc/old/types.h 
```

--------------------------------

### Configure Vim installation prefix

Source: https://vimhelp.org/usr_90.txt.html

Specify the top-level directory for Vim installation during configuration.

```bash
./configure --prefix={directory}
```

--------------------------------

### gF Command Examples

Source: https://vimhelp.org/editing.txt.html

Examples of file paths with line numbers that can be opened using the gF command.

```text
eval.c:10 
eval.c @ 20 
eval.c (30) 
eval.c 40 
eval.c line 50 
```

--------------------------------

### Create a Listening Channel

Source: https://vimhelp.org/channel.txt.html

Demonstrates how to define an accept callback and start a server on a specific port.

```vim
func OnAccept(channel, clientaddr)
  " Log the connection
  echomsg "Accepted connection from " .. a:clientaddr

  " Get current time and send it to the client
  let current_time = strftime("%Y-%m-%d %H:%M:%S")
  call ch_sendraw(a:channel, "Vim Server Time: " .. current_time .. "\n")

  " Optional: close immediately if you only want to provide the time
  call ch_close(a:channel)
endfunc

" Start listening on port 8765
let server = ch_listen('8765', {"callback": "OnAccept"})
```

--------------------------------

### Install a local plugin and help file

Source: https://vimhelp.org/usr_05.txt.html

Commands to copy plugin files and generate tags for local help documentation.

```vim
:!mkdir ~/.vim
:!mkdir ~/.vim/plugin
:!cp /tmp/doit.vim ~/.vim/plugin
```

```vim
:!mkdir ~/.vim/doc
```

```vim
:!cp /tmp/doit.txt ~/.vim/doc
```

```vim
:helptags ~/.vim/doc
```

```vim
:help doit
```

```vim
:help local-additions
```

--------------------------------

### Modeline examples (first form)

Source: https://vimhelp.org/options.txt.html

Examples of the first modeline format used to set options at the start or end of a file.

```vim
vi:noai:sw=3 ts=6 
vim: tw=77
```

--------------------------------

### Install Vim System-Wide

Source: https://vimhelp.org/usr_90.txt.html

Install Vim for all users on the system. This typically requires root privileges.

```bash
make install
```

--------------------------------

### Unix Makefile Example

Source: https://vimhelp.org/quickfix.txt.html

An example Makefile snippet demonstrating how to handle directory changes and print messages for entering and leaving directories.

```makefile
libs:
		for dn in $(LIBDIRS); do\				\
			(cd $$dn; echo "Entering dir '$$(pwd)'"; make); \				\
			echo "Leaving dir";\				\
		done
```

--------------------------------

### Substitute at Start of Line in Vim

Source: https://vimhelp.org/usr_10.txt.html

Use a pattern to specify where the substitution should occur. This example replaces 'the' only when it appears at the start of a line.

```vim
:s/^the/these/
```

--------------------------------

### getqflist() and getloclist() Examples

Source: https://vimhelp.org/quickfix.txt.html

Examples demonstrating how to use getqflist() and getloclist() to retrieve information about quickfix and location lists, such as window IDs, titles, identifiers, items, and context.

```APIDOC
## getqflist() and getloclist() Examples

### Description
Demonstrates retrieving various attributes of quickfix and location lists using the `getqflist()` and `getloclist()` functions. This includes obtaining window IDs, list identifiers, items, context, and other properties.

### Usage
These functions are used to query the state and content of quickfix and location lists.

### Examples

#### Retrieving Window IDs
```vim
" Get the window ID of the quickfix window
echo getqflist({'winid' : 0}).winid

" Get the window ID of the location list window for the third window
echo getloclist(3, {'winid' : 0}).winid
```

#### Retrieving List Identifiers
```vim
" Get the identifier of the current quickfix list
let qfid = getqflist({'id' : 0}).id

" Get the identifier of the fourth quickfix list in the stack
let qfid = getqflist({'nr' : 4, 'id' : 0}).id
```

#### Retrieving List Items
```vim
" Get the items of a quickfix list specified by an identifier
echo getqflist({'id' : qfid, 'items' : 0}).items

" Parse text from a List of lines and return a quickfix list
let myList = ["a.java:10:L10", "b.java:20:L20"]
echo getqflist({'lines' : myList}).items

" Parse text using a custom 'efm' and return a quickfix list
echo getqflist({'lines' : ['a.c#10#Line 10'], 'efm':'%f#%l#%m'}).items
```

#### Retrieving Context
```vim
" Get the context of the current location list
echo getloclist(0, {'context' : 0}).context
```

#### Retrieving Other Attributes
```vim
" Get the title of the current quickfix list
echo getqflist({'title' : 0}).title

" Get the number of entries in a quickfix list specified by an id
echo getqflist({'id' : qfid, 'size' : 0}).size

" Get the current entry in a quickfix list specified by an identifier
echo getqflist({'id' : qfid, 'idx' : 0}).idx
```
```

--------------------------------

### Get previous buffer in MzScheme

Source: https://vimhelp.org/if_mzsch.txt.html

Retrieve the previous buffer in the buffer list. If a buffer is specified, it starts from there; otherwise, it starts from the current buffer. Returns `#f` if there are no more buffers.

```MzScheme
(get-prev-buff [buffer])
```

--------------------------------

### setqflist() and setloclist() Examples

Source: https://vimhelp.org/quickfix.txt.html

Examples demonstrating how to use setqflist() and setloclist() to create and modify quickfix and location lists, including setting titles, contexts, and list items.

```APIDOC
## setqflist() and setloclist() Examples

### Description
Demonstrates how to use the `setqflist()` and `setloclist()` functions to create and modify quickfix and location lists. This includes setting titles, contexts, identifiers, and populating lists with items.

### Usage
These functions are used to programmatically create or update quickfix and location lists.

### Examples

#### Creating an Empty Quickfix List
```vim
" Create an empty quickfix list with a title and a context
let t = 'Search results'
let c = {'cmd' : 'grep'}
call setqflist([], ' ', {'title' : t, 'context' : c})
```

#### Setting List Titles and Contexts
```vim
" Set the title of the current quickfix list
call setqflist([], 'a', {'title' : 'Mytitle'})

" Set the context of a quickfix list specified by an identifier
call setqflist([], 'a', {'id' : qfid, 'context' : {'val' : 100}})
```

#### Modifying List Entries
```vim
" Change the current entry in the list specified by an identifier
call setqflist([], 'a', {'id' : qfid, 'idx' : 10})
```

#### Creating a List from Command Output
```vim
" Create a new quickfix list from a command output
call setqflist([], ' ', {'lines' : systemlist('grep -Hn main *.c')})
```
```

--------------------------------

### Get next buffer in MzScheme

Source: https://vimhelp.org/if_mzsch.txt.html

Retrieve the next buffer in the buffer list. If a buffer is specified, it starts from there; otherwise, it starts from the current buffer. Returns `#f` if there are no more buffers.

```MzScheme
(get-next-buff [buffer])
```

--------------------------------

### Start Vim server

Source: https://vimhelp.org/builtin.txt.html

Register the current instance as a server with a specific name.

```vim
ServerName()->remote_startserver()
```

--------------------------------

### Display Hello World in MzScheme

Source: https://vimhelp.org/if_mzsch.txt.html

A basic example demonstrating how to execute a simple MzScheme command to display text. This requires the +mzscheme feature.

```vim
:mzscheme (display "Hello")
```

--------------------------------

### Copy Example Vimrc File (Unix)

Source: https://vimhelp.org/usr_01.txt.html

Copies the example vimrc file to your home directory on Unix-like systems. This helps ensure a good Vim setup by disabling compatibility mode.

```vim
:!cp -i $VIMRUNTIME/vimrc_example.vim ~/.vimrc
```

--------------------------------

### Manual Package Installation

Source: https://vimhelp.org/usr_05.txt.html

Steps to manually create a package directory and unpack an archive.

```bash
mkdir -p ~/.vim/pack/fancy
```

```bash
cd ~/.vim/pack/fancy
unzip /tmp/fancy.zip
```

--------------------------------

### Sample clipboard provider implementation

Source: https://vimhelp.org/eval.txt.html

A complete example defining available, copy, and paste callbacks for a custom clipboard provider.

```vim
func Available()
    return v:true
endfunc

func Copy(reg, type, str)
    echom "Register: " .. a:reg
    echom "Register type: " .. a:type
    echom "Contents: " .. string(a:str)
endfunc

func Paste(reg)
    return ("b40", ["this", "is", "the", a:reg, "register!"])
endfunc

let v:clipproviders["test"] = {
    \ "available": function("Available"),
    \ "copy": {
    \     "+": function("Copy"),
    \     "*": function("Copy")
    \	},
    \ "paste": {
    \     "+": function("Paste"),
    \     "*": function("Paste")
    \	}
    \ }
set clipmethod^=test
```

--------------------------------

### Get range start/end in MzScheme

Source: https://vimhelp.org/if_mzsch.txt.html

Retrieve the start and end of a range passed to a Scheme command.

```MzScheme
(range-start)
```

```MzScheme
(range-end)
```

--------------------------------

### Example LOGIN.COM Configuration

Source: https://vimhelp.org/os_vms.txt.html

A comprehensive example of a LOGIN.COM file, including logical definitions for Vim and GUI mode, terminal settings, and display creation.

```dcl
$ define/nolog VIM DKA0:[UTIL.VIM81]
$ vi*m :== mcr VIM:VIM.EXE
$ gv*im:== spawn/nowait/input=NLA0 mcr VIM:VIM.EXE -g -GEOMETRY 80x40
$ set term/inq/ins ! inquire the terminal capabilities
$ set disp/create/node=192.168.10.202/trans=tcpip
```

--------------------------------

### Verify Vim Installation

Source: https://vimhelp.org/usr_90.txt.html

Check if Vim is installed correctly and can find its runtime files by running :help and :syntax enable.

```vim
:help
:syntax enable
```

--------------------------------

### Create New Buffer for Tutorial

Source: https://vimhelp.org/ft_sql.txt.html

Opens a new buffer named 'tutorial.sql' to begin the SQL completion plugin tutorial. This is a standard Vim command.

```vim
:e tutorial.sql
```

--------------------------------

### prop_add() Example

Source: https://vimhelp.org/textprop.txt.html

Attaches a text property at a specified line and column. Column is byte-indexed, starting from one.

```APIDOC
## `prop_add({lnum}, {col}, {props})`

### Description
Attach a text property at position {lnum}, {col}. {col} is counted in bytes, use one for the first column.
If {lnum} is invalid an error is given. E966
If {col} is invalid an error is given. E964

### Parameters
- `{lnum}` (number) - The line number where the property starts.
- `{col}` (number) - The column number (byte index, 1-based) where the property starts.
- `{props}` (dictionary) - A dictionary containing properties like `type`, `highlight`, `length`, etc.
```

--------------------------------

### Open File Browser Starting at a Specific Directory

Source: https://vimhelp.org/usr_31.txt.html

Prepend a directory path to ':browse split' to make the file browser start in that specific location. For example, ':browse split /etc' will open the browser in the '/etc' directory.

```vim
:browse split /etc
```

--------------------------------

### Vim command-line execution example

Source: https://vimhelp.org/os_win32.txt.html

Demonstrates opening a file with spaces and executing line mode commands.

```text
vim "C:\My Music\freude" +"set ignorecase" +/"\"foo\\" +\"bar\"
```

--------------------------------

### Access Plugin Help

Source: https://vimhelp.org/usr_05.txt.html

Use the help command to view documentation for installed plugins.

```vim
:help matchit
```

```vim
:h editorconfig.txt
```

```vim
:h comment.txt
```

```vim
:h osc52.txt
```

--------------------------------

### Example Fold Markers with Levels

Source: https://vimhelp.org/fold.txt.html

This demonstrates using markers with included fold levels for defining folds. '{{{' starts a fold, and the following number indicates its level. A matching level ends the previous fold and starts a new one.

```c
/* global variables {{{1 */
int varA, varB;

/* functions {{{1 */
/* funcA() {{{2 */
void funcA() {}

/* funcB() {{{2 */
void funcB() {}
```

--------------------------------

### Configure LSP channel mode

Source: https://vimhelp.org/channel.txt.html

Examples for opening channels or starting jobs with LSP mode enabled for JSON-RPC communication.

```vim
let ch = ch_open(..., #{mode: 'lsp'})
```

```vim
let cmd = ['clangd', '--background-index', '--clang-tidy']
    let opts = {}
    let opts.in_mode = 'lsp'
    let opts.out_mode = 'lsp'
    let opts.err_mode = 'nl'
    let opts.out_cb = function('LspOutCallback')
    let opts.err_cb = function('LspErrCallback')
    let opts.exit_cb = function('LspExitCallback')
    let job = job_start(cmd, opts)
```

--------------------------------

### Configure Netrw Preview Settings

Source: https://vimhelp.org/pi_netrw.txt.html

Example configuration to enable vertical preview splits, tree listing style, and specific window sizing.

```vim
let g:netrw_preview   = 1
	let g:netrw_liststyle = 3
	let g:netrw_winsize   = 30
```

--------------------------------

### Start a job with shell commands

Source: https://vimhelp.org/channel.txt.html

Demonstrates how to execute commands through a shell using job_start.

```vim
let job = job_start(["/bin/sh", "-c", "echo hello"])
```

```vim
let job = job_start('/bin/sh -c "echo hello"')
```

--------------------------------

### Get window layout

Source: https://vimhelp.org/builtin.txt.html

Retrieves the nested list structure of windows in a tab page, shown with various examples and as a method.

```vim
:echo winlayout()
['leaf', 1000]
:echo winlayout()
['col', [['leaf', 1000], ['leaf', 1001]]]
:echo winlayout(2)
['col', [['leaf', 1002], ['row', [['leaf', 1003],
			    ['leaf', 1001]]], ['leaf', 1000]]]
```

```vim
GetTabnr()->winlayout()
```

--------------------------------

### Create Directories with mkdir

Source: https://vimhelp.org/builtin.txt.html

Demonstrates creating directories with specific flags and permissions, including scheduling for deletion.

```vim
call mkdir('subdir/tmp/autoload', 'pR')
```

```vim
defer delete('subdir/tmp', 'rf')
```

```vim
:call mkdir($HOME .. "/tmp/foo/bar", "p", 0o700)
```

```vim
:if exists("*mkdir")
```

```vim
GetName()->mkdir()
```

--------------------------------

### Vim Blockwise Insert Example

Source: https://vimhelp.org/visual.txt.html

Inserting text at the start of a blockwise selection in Vim. The string is inserted on each line that extends into the block.

```vim
I{string}<ESC>
```

--------------------------------

### VHDL Full-Line Comment Indentation Example

Source: https://vimhelp.org/indent.txt.html

Illustrates how full-line comments starting with '-- ' are aligned with the previous line's comment.

```vhdl
sig_a <= sig_b; -- start of a comment
                  -- continuation of the comment
                  -- more of the same comment
```

--------------------------------

### Prepare Vim Build Directory

Source: https://vimhelp.org/usr_90.txt.html

Create a directory for building Vim from source and navigate into it.

```bash
mkdir ~/vim
cd ~/vim
```

--------------------------------

### Conditional Setup for Diff Mode

Source: https://vimhelp.org/diff.txt.html

Use a conditional check in your .vimrc to apply specific configurations when Vim starts in diff mode.

```vimscript
if &diff
   setup for diff mode
else
   setup for non-diff mode
endif
```

--------------------------------

### Start Vim Tutor (Unix)

Source: https://vimhelp.org/usr_01.txt.html

Launches the interactive Vim tutor from the Unix shell. This is a 30-minute tutorial for learning basic Vim commands hands-on.

```shell
vimtutor
```

--------------------------------

### Run Vim Tutor on OpenVMS

Source: https://vimhelp.org/usr_01.txt.html

On OpenVMS systems, if Vim is installed, you can start the tutor using the '@VIM:vimtutor' command. Language codes can be appended.

```vms
@VIM:vimtutor
```

--------------------------------

### Substitute Between Patterns in Vim

Source: https://vimhelp.org/usr_10.txt.html

Use search patterns in ranges to define the start and end points for substitution. This example substitutes 'grey' with 'gray' between chapter markers.

```vim
:?^Chapter?,/^Chapter/s=grey=gray=g
```

--------------------------------

### Create and Use Partials

Source: https://vimhelp.org/eval.txt.html

Shows how to bind arguments and Dictionaries to functions using partials.

```vim
let Cb = function('Callback', ['foo'], myDict)
call Cb('bar')
```

```vim
call myDict.Callback('foo', 'bar')
```

--------------------------------

### Configure Vim startup using aliases (Unix example)

Source: https://vimhelp.org/starting.txt.html

On Unix systems, you can create aliases for different Vim startup commands if you don't have separate executables or links.

```bash
alias view   vim -R
```

```bash
alias gvim   vim -g
```

--------------------------------

### Define Operator-Pending Mapping with Visual Mode

Source: https://vimhelp.org/map.txt.html

Defines an operator-pending mapping that starts Visual mode to select text. This example maps a key to select a function name.

```vim
onoremap <silent> F :<C-U>normal! 0f(hviw<CR>
```

--------------------------------

### Setup Basic Command-Line Autocompletion

Source: https://vimhelp.org/cmdline.txt.html

Standard configuration to enable popup menu suggestions for command-line operations.

```vim
autocmd CmdlineChanged [:\/\?] call wildtrigger()
set wildmode=noselect:lastused,full
set wildoptions=pum
```

--------------------------------

### Store Buffer-Local Option Value

Source: https://vimhelp.org/vim_faq.txt.html

Use the 'l:' prefix with '&' to explicitly store a buffer-local option's value into a variable. This example gets the buffer-local 'textwidth' option.

```vimscript
:let old_tw = &l:tw
```

--------------------------------

### Start Terminal via Method

Source: https://vimhelp.org/terminal.txt.html

Initialize a terminal window using the method syntax on a command string.

```vim
GetCommand()->term_start()
```

--------------------------------

### Set Location List Title

Source: https://vimhelp.org/quickfix.txt.html

Examples of setting and getting the title for a location list using setloclist() and getloclist(). The title is initially set to the command that created the list.

```vim
call setloclist(3, [], 'a', {'title' : 'Cmd output'})
```

```vim
echo getloclist(3, {'title' : 1})
```

--------------------------------

### Set Quickfix List Title

Source: https://vimhelp.org/quickfix.txt.html

Examples of setting and getting the title for a quickfix list using setqflist() and getqflist(). The title is initially set to the command that created the list.

```vim
call setqflist([], 'a', {'title' : 'Cmd output'})
```

```vim
echo getqflist({'title' : 1})
```

--------------------------------

### Define Vim Server and Paths

Source: https://vimhelp.org/os_vms.txt.html

Sets up the VIM server and defines aliases for launching Vim, including a graphical version.

```dcl
$ if (p1 .eqs. "") .OR. (p2 .eqs. "") then goto usage
$ set disp/create/node=<your_IP_here>/trans=tcpip
$ define "VIM "<vim_server>""''p1'' ''p2'':"<device>:<vim_path>"
$  vi*m :== "mcr VIM:VIM.EXE"
$ gv*im :== "spawn/nowait mcr VIM:VIM.EXE -g"
$ goto end
$ usage:
$ write sys$output " Please enter username and password as a parameter."
$ write sys$output " Example: @SETVIM.COM username passwd"
$ end:
```

--------------------------------

### Get Visually Selected Text into Variable

Source: https://vimhelp.org/vim_faq.txt.html

Yank visually selected text into a register and then assign the register's content to a variable. This example yanks text and stores it in 'myvar'.

```vimscript
:normal! gvy
:let myvar = @"
```

--------------------------------

### Example Fold Expression for C Comments

Source: https://vimhelp.org/fold.txt.html

This snippet demonstrates how to define a fold expression to handle multi-line C comments. It returns 'a1' for the start of a comment ('/*') and 's1' for the end ('*/').

```vimscript
if match(thisline, '/\*') >= 0
  return 'a1'
elseif match(thisline, '\*/') >= 0
  return 's1'
else
  return '='
endif
```

--------------------------------

### Vim Expression Mapping Example

Source: https://vimhelp.org/map.txt.html

Demonstrates using <expr> with getchar() to consume typeahead. The first mapping uses getchar() to get the next character, while the second mapping is triggered if 'x' follows <C-L>.

```vim
inoremap <expr> <C-L> nr2char(getchar())
inoremap <expr> <C-L>x "foo"
```

--------------------------------

### Dictionary creation examples

Source: https://vimhelp.org/eval.txt.html

Methods for initializing Dictionaries, including standard curly brace syntax and the legacy #{} literal shorthand.

```vim
:let mydict = {'one': 1, 'two': 2, 'three': 3}
:let emptydict = {}
```

```vim
:let mydict = #{zero: 0, one_key: 1, two-key: 2, 333: 3}
```

```vim
:let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}}
```

--------------------------------

### Use Filename Modifiers in Compiler Command

Source: https://vimhelp.org/usr_30.txt.html

Vim's filename modifiers can be used in the 'makeprg' option. For example, '%' expands to the current filename, and ':r' gets the filename without the extension. ':S' is used for path separation.

```vim
:set makeprg=make\ %:S
```

```vim
:set makeprg=make\ %:r:S.o
```

--------------------------------

### Install a global plugin on Unix

Source: https://vimhelp.org/usr_05.txt.html

Commands to create the necessary directory structure and copy a plugin file into the global plugin directory.

```bash
mkdir ~/.vim
mkdir ~/.vim/plugin
cp /tmp/yourplugin.vim ~/.vim/plugin
```

--------------------------------

### Define Region with Start and End Offsets

Source: https://vimhelp.org/usr_44.txt.html

Use 'ms' and 'me' offsets to define a region that excludes the start and end patterns. 'ms=e+1' starts the match after the end of the start pattern, and 'me=s-1' ends the match before the start of the end pattern.

```vim
:syntax region xCond start=/if\s*(/ms=e+1 end=/)/me=s-1
```

--------------------------------

### Move to Start of Current Open Fold

Source: https://vimhelp.org/fold.txt.html

Use '[z' to move to the start of the current open fold. If already at the start, moves to the containing fold's start. Repeats with a count.

```vim
[z
```

--------------------------------

### Open path usage examples

Source: https://vimhelp.org/eval.txt.html

Demonstrates different ways to invoke the open functionality in Vim.

```vim
:call dist#vim9#Open(<path>)
:Open <path>
:URLOpen <path>
```

--------------------------------

### Move Forward to Start of Next Function

Source: https://vimhelp.org/usr_29.txt.html

Use ]] to move forward to the start of the next function. The start is defined by a '{' in the first column.

```vim
]]
```

--------------------------------

### Vim Swap File Listing Example

Source: https://vimhelp.org/usr_11.txt.html

This is an example output of the `vim -r` command, showing found swap files, their ownership, modification dates, and associated original file paths.

```text
Swap files found: 
   In current directory: 
1.    .main.c.swp 
	  owned by: mool   dated: Tue May 29 21:00:25 2001 
	 file name: ~mool/vim/vim6/src/main.c 
	  modified: YES 
	 user name: mool   host name: masaka.moolenaar.net 
	process ID: 12525 
   In directory ~/tmp: 
	      -- none -- 
   In directory /var/tmp: 
	      -- none -- 
   In directory /tmp: 
	      -- none -- 
```

--------------------------------

### View all configure options

Source: https://vimhelp.org/usr_90.txt.html

Display all available configuration options for Vim compilation.

```bash
./configure --help
```

--------------------------------

### Install a Vimball Plugin

Source: https://vimhelp.org/pi_vimball.txt.html

To install a plugin, simply open the .vba file with Vim and source it. The plugin and its components will be installed into the appropriate directories.

```vim
vim someplugin.vba
:so %
:q
```

--------------------------------

### Netrw Quick Help Overview

Source: https://vimhelp.org/usr_22.txt.html

This section displays the initial help screen provided by the netrw plugin when the <F1> key is pressed. It outlines how to access further help and lists key mappings.

```vim
QUICK HELP					     netrw-quickhelp
               (Use ctrl-] to select a topic)
	Intro to Browsing...............................netrw-intro-browse
	  Quick Reference: Maps.........................netrw-quickmap
	  Quick Reference: Commands.....................netrw-browse-cmds
```

--------------------------------

### Start New Shell in Vim

Source: https://vimhelp.org/usr_21.txt.html

Start a new shell session from within Vim using the :shell command. This is similar to suspending Vim but starts a fresh shell.

```vim
:shell
```

--------------------------------

### remote_startserver({name})

Source: https://vimhelp.org/builtin.txt.html

Registers the current Vim instance as a server with the given name.

```APIDOC
## remote_startserver({name})

### Description
Registers the current instance as a server named {name}. Fails if already running as a server.

### Parameters
- **name** (String) - Required - The name for the server.

### Return Type
void
```

--------------------------------

### Logical and Unary Operator Examples

Source: https://vimhelp.org/eval.txt.html

Examples of logical NOT and unary sign operators.

```vim
!-1	    == 0
!!8	    == 1
--9	    == 9
```

--------------------------------

### Compile and Install Vim on Haiku (GUI)

Source: https://vimhelp.org/os_haiku.txt.html

Standard build commands for installing Vim with Haiku GUI support, setting specific system directories.

```bash
  ./configure --prefix=`finddir B_SYSTEM_NONPACKAGED_DIRECTORY` \
    --datarootdir=`finddir B_SYSTEM_NONPACKAGED_DATA_DIRECTORY` \
    --mandir=`finddir B_SYSTEM_NONPACKAGED_DIRECTORY`/documentation/man \
    --with-tlib=ncurses
  make clean
  make install

```

--------------------------------

### Configure backup directory

Source: https://vimhelp.org/options.txt.html

Example of setting the 'backupdir' option with complex path requirements including spaces and commas.

```vim
:set bdir=c:\\tmp,\ dir\,with\,commas,\\\ dir\ with\ spaces
```

--------------------------------

### Script-local printexpr examples

Source: https://vimhelp.org/print.txt.html

Examples of using s: or <SID> prefixes for script-local print functions.

```vim
set printexpr=s:MyPrintFile()
set printexpr=<SID>SomePrintFile()
```

--------------------------------

### Profile Vim Startup Time

Source: https://vimhelp.org/vim_faq.txt.html

Use the '--startuptime' argument to log Vim's startup timings to a file, aiding in the identification of performance bottlenecks.

```shell
$ vim --startuptime vim_startup.log
```

--------------------------------

### Starting GUI Vim from Command Line

Source: https://vimhelp.org/os_mac.txt.html

Shows how to launch the Vim GUI application from the command line on macOS.

```bash
open /Applications/Vim.app
```

```bash
/Applications/Vim.app/Contents/MacOS/Vim -g  {arguments}
```

--------------------------------

### Display All Configure Script Options

Source: https://vimhelp.org/vim_faq.txt.html

Run the configure script with the --help flag to list all available options for customizing Vim's build.

```shell
$ configure --help
```

--------------------------------

### Vim Command Count Examples

Source: https://vimhelp.org/cmdline.txt.html

Examples of using counts with commands that accept ranges.

```vim
:s/x/X/g 5
:23d 4
```

--------------------------------

### job_start({command} [, {options}])

Source: https://vimhelp.org/builtin.txt.html

Starts a new job in Vim.

```APIDOC
## job_start({command} [, {options}])

### Description
Starts a job executing the specified command.

### Parameters
- **command** (String) - The command to execute
- **options** (Dict) - Optional configuration for the job

### Returns
- **Job** - The started job object
```

--------------------------------

### Query Quickfix List Information

Source: https://vimhelp.org/builtin.txt.html

Examples of retrieving specific quickfix list properties using a dictionary argument.

```vim
:echo getqflist({'all': 1})
:echo getqflist({'nr': 2, 'title': 1})
:echo getqflist({'lines' : ["F1:10:L10"]})
```

--------------------------------

### Open Netrw on Vim Startup

Source: https://vimhelp.org/pi_netrw.txt.html

Use an autocommand in .vimrc to automatically open a directory listing when starting GVim without arguments.

```vim
augroup VimStartup
  au!
  au VimEnter * if expand("%") == "" && argc() == 0 &&
  \ (v:servername =~ 'GVIM\d*' || v:servername == "")
  \ | e . | endif
augroup END
```

--------------------------------

### Modeline examples (second form)

Source: https://vimhelp.org/options.txt.html

Examples of the second modeline format, compatible with some versions of Vi.

```vim
/* vim: set ai tw=75: */ 
/* Vim: set ai tw=75: */
```

--------------------------------

### Configure Window Title String and Length

Source: https://vimhelp.org/options.txt.html

Examples for setting the window title format and length constraints.

```vim
:auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
:set title titlestring=%<%F%=%l/%L-%P titlelen=70
```

```vim
:set titlestring=%t%(\ %M%)%(\ (%{expand("%:~:.:h")})%)%(\ %a%)
```

--------------------------------

### WinResized Event Example

Source: https://vimhelp.org/windows.txt.html

Example of the list of window IDs provided in the v:event.windows variable.

```vim
	[1003, 1006]
```

--------------------------------

### JSON API command examples

Source: https://vimhelp.org/terminal.txt.html

Examples of JSON-encoded commands sent from a terminal job to Vim.

```json
<Esc>]51;["drop", "README.md"]<07>
```

```json
["call", "Tapi_Impression", ["play", 14]]
```

```json
["drop", "path/file.txt", {"ff": "dos"}]
```

--------------------------------

### Define X resources for xterm

Source: https://vimhelp.org/syntax.txt.html

Example X resources for ~/.Xdefaults to define color palettes and cursor behavior.

```text
XTerm*color0:			#000000
XTerm*color1:			#c00000
XTerm*color2:			#008000
XTerm*color3:			#808000
XTerm*color4:			#0000c0
XTerm*color5:			#c000c0
XTerm*color6:			#008080
XTerm*color7:			#c0c0c0
XTerm*color8:			#808080
XTerm*color9:			#ff6060
XTerm*color10:			#00ff00
XTerm*color11:			#ffff00
XTerm*color12:			#8080ff
XTerm*color13:			#ff40ff
XTerm*color14:			#00ffff
XTerm*color15:			#ffffff
Xterm*cursorColor:		Black
```

--------------------------------

### Pattern-based Autocommand Examples

Source: https://vimhelp.org/autocmd.txt.html

Various examples of using autocommands with different file patterns and events.

```vim
:autocmd BufRead   *		set tw=79 nocin ic infercase fo=2croq
  :autocmd BufRead   .letter	set tw=72 fo=2tcrq
  :autocmd BufEnter  .letter	set dict=/usr/lib/dict/words
  :autocmd BufLeave  .letter	set dict=
  :autocmd BufRead,BufNewFile   *.c,*.h	set tw=0 cin noic
  :autocmd BufEnter  *.c,*.h	abbr FOR for (i = 0; i < 3; ++i)<CR>{<CR>}<Esc>O
  :autocmd BufLeave  *.c,*.h	unabbr FOR
```

--------------------------------

### Compile and Install Vim on Haiku (GUI-less)

Source: https://vimhelp.org/os_haiku.txt.html

Build and install the GUI-less Vim binary for seamless integration into Haiku, complementing the GUI version.

```bash
  ./configure --prefix=`finddir B_SYSTEM_NONPACKAGED_DIRECTORY`  \
    --datarootdir=`finddir B_SYSTEM_NONPACKAGED_DATA_DIRECTORY` \
    --mandir=`finddir B_SYSTEM_NONPACKAGED_DIRECTORY`/documentation/man \
    --with-tlib=ncurses \
    --disable-gui
  make clean
  make install

```

--------------------------------

### Nested Autocommand Example

Source: https://vimhelp.org/autocmd.txt.html

Example of using the ++nested flag to allow autocommands to trigger other autocommands.

```vim
:autocmd FileChangedShell *.c ++nested e!
```
Tokens:
Raw