aboutsummaryrefslogtreecommitdiff
path: root/vim/.vim/plugged/fzf.vim/doc
diff options
context:
space:
mode:
authorKumar Damani <damani.kumar@gmail.com>2019-05-16 22:16:09 +0000
committerKumar Damani <damani.kumar@gmail.com>2019-05-16 22:16:09 +0000
commit12564a8f73ebe721d415a04d36f7aac7091bea9d (patch)
treebbc8a6bf6aabe832b3ee435eaa605dcac655fc5f /vim/.vim/plugged/fzf.vim/doc
parent1241da7ab7a4e91248391ee9b045267bcbbeee4f (diff)
updating vimrc
Diffstat (limited to 'vim/.vim/plugged/fzf.vim/doc')
-rw-r--r--vim/.vim/plugged/fzf.vim/doc/fzf-vim.txt378
-rw-r--r--vim/.vim/plugged/fzf.vim/doc/tags25
2 files changed, 0 insertions, 403 deletions
diff --git a/vim/.vim/plugged/fzf.vim/doc/fzf-vim.txt b/vim/.vim/plugged/fzf.vim/doc/fzf-vim.txt
deleted file mode 100644
index 457e8a4..0000000
--- a/vim/.vim/plugged/fzf.vim/doc/fzf-vim.txt
+++ /dev/null
@@ -1,378 +0,0 @@
-fzf-vim.txt fzf-vim Last change: August 31 2018
-FZF-VIM - TABLE OF CONTENTS *fzf-vim* *fzf-vim-toc*
-==============================================================================
-
- fzf :heart: vim
- Rationale
- Why you should use fzf on Vim
- Installation
- Using vim-plug
- Commands
- Customization
- Global options
- Command-local options
- Advanced customization
- Mappings
- Usage
- Completion helper
- Reducer example
- Status line of terminal buffer
- Hide statusline
- Custom statusline
- License
-
-FZF :HEART: VIM *fzf-vim-fzf-heart-vim*
-==============================================================================
-
-Things you can do with {fzf}{1} and Vim.
-
- {1} https://github.com/junegunn/fzf
-
-
-RATIONALE *fzf-vim-rationale*
-==============================================================================
-
-{fzf}{1} in itself is not a Vim plugin, and the official repository only
-provides the {basic wrapper function}{2} for Vim and it's up to the users to
-write their own Vim commands with it. However, I've learned that many users of
-fzf are not familiar with Vimscript and are looking for the "default"
-implementation of the features they can find in the alternative Vim plugins.
-
-This repository is a bundle of fzf-based commands and mappings extracted from
-my {.vimrc}{3} to address such needs. They are not designed to be flexible or
-configurable, and there's no guarantee of backward-compatibility.
-
- {1} https://github.com/junegunn/fzf
- {2} https://github.com/junegunn/fzf#usage-as-vim-plugin
- {3} https://github.com/junegunn/dotfiles/blob/master/vimrc
-
-
-WHY YOU SHOULD USE FZF ON VIM *fzf-vim-why-you-should-use-fzf-on-vim*
-==============================================================================
-
-Because you can and you love fzf.
-
-fzf runs asynchronously and can be orders of magnitude faster than similar Vim
-plugins. However, the benefit may not be noticeable if the size of the input
-is small, which is the case for many of the commands provided here.
-Nevertheless I wrote them anyway since it's really easy to implement custom
-selector with fzf.
-
-
-INSTALLATION *fzf-vim-installation*
-==============================================================================
-
-fzf.vim depends on the basic Vim plugin of {the main fzf repository}{1}, which
-means you need to set up both "fzf" and "fzf.vim" on Vim. To learn more about
-fzf/Vim integration, see {README-VIM}{4}.
-
- {1} https://github.com/junegunn/fzf
- {4} https://github.com/junegunn/fzf/blob/master/README-VIM.md#configuration
-
-
-< Using vim-plug >____________________________________________________________~
- *fzf-vim-using-vim-plug*
-
-If you already installed fzf using {Homebrew}{5}, the following should
-suffice:
->
- Plug '/usr/local/opt/fzf'
- Plug 'junegunn/fzf.vim'
-<
-But if you want to install fzf as well using vim-plug:
->
- Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' }
- Plug 'junegunn/fzf.vim'
-<
- - `dir` and `do` options are not mandatory
- - Use `./install --bin` instead if you don't need fzf outside of Vim
- - Make sure to use Vim 7.4 or above
-
- {5} https://brew.sh/
-
-
-COMMANDS *fzf-vim-commands*
-==============================================================================
-
-
- -----------------+-----------------------------------------------------------------------
- Command | List ~
- -----------------+-----------------------------------------------------------------------
- `Files [PATH]` | Files (similar to `:FZF` )
- `GFiles [OPTS]` | Git files ( `git ls-files` )
- `GFiles?` | Git files ( `git status` )
- `Buffers` | Open buffers
- `Colors` | Color schemes
- `Ag [PATTERN]` | {ag}{6} search result ( `ALT-A` to select all, `ALT-D` to deselect all)
- `Rg [PATTERN]` | {rg}{7} search result ( `ALT-A` to select all, `ALT-D` to deselect all)
- `Lines [QUERY]` | Lines in loaded buffers
- `BLines [QUERY]` | Lines in the current buffer
- `Tags [QUERY]` | Tags in the project ( `ctags -R` )
- `BTags [QUERY]` | Tags in the current buffer
- `Marks` | Marks
- `Windows` | Windows
- `Locate PATTERN` | `locate` command output
- `History` | `v:oldfiles` and open buffers
- `History:` | Command history
- `History/` | Search history
- `Snippets` | Snippets ({UltiSnips}{8})
- `Commits` | Git commits (requires {fugitive.vim}{9})
- `BCommits` | Git commits for the current buffer
- `Commands` | Commands
- `Maps` | Normal mode mappings
- `Helptags` | Help tags [1]
- `Filetypes` | File types
- -----------------+-----------------------------------------------------------------------
-
- *g:fzf_command_prefix*
-
- - Most commands support CTRL-T / CTRL-X / CTRL-V key bindings to open in a new
- tab, a new split, or in a new vertical split
- - Bang-versions of the commands (e.g. `Ag!`) will open fzf in fullscreen
- - You can set `g:fzf_command_prefix` to give the same prefix to the commands
- - e.g. `let g:fzf_command_prefix = 'Fzf'` and you have `FzfFiles`, etc.
-
-(1: `Helptags` will shadow the command of the same name from {pathogen}{10}.
-But its functionality is still available via `call pathogen#helptags()`.)
-
- {6} https://github.com/ggreer/the_silver_searcher
- {7} https://github.com/BurntSushi/ripgrep
- {8} https://github.com/SirVer/ultisnips
- {9} https://github.com/tpope/vim-fugitive
- {10} https://github.com/tpope/vim-pathogen
-
-
-< Customization >_____________________________________________________________~
- *fzf-vim-customization*
-
-
-Global options~
- *fzf-vim-global-options*
-
-See {README-VIM.md}{4} of the main fzf repository for details.
->
- " This is the default extra key bindings
- let g:fzf_action = {
- \ 'ctrl-t': 'tab split',
- \ 'ctrl-x': 'split',
- \ 'ctrl-v': 'vsplit' }
-
- " Default fzf layout
- " - down / up / left / right
- let g:fzf_layout = { 'down': '~40%' }
-
- " In Neovim, you can set up fzf window using a Vim command
- let g:fzf_layout = { 'window': 'enew' }
- let g:fzf_layout = { 'window': '-tabnew' }
- let g:fzf_layout = { 'window': '10split enew' }
-
- " Customize fzf colors to match your color scheme
- let g:fzf_colors =
- \ { 'fg': ['fg', 'Normal'],
- \ 'bg': ['bg', 'Normal'],
- \ 'hl': ['fg', 'Comment'],
- \ 'fg+': ['fg', 'CursorLine', 'CursorColumn', 'Normal'],
- \ 'bg+': ['bg', 'CursorLine', 'CursorColumn'],
- \ 'hl+': ['fg', 'Statement'],
- \ 'info': ['fg', 'PreProc'],
- \ 'border': ['fg', 'Ignore'],
- \ 'prompt': ['fg', 'Conditional'],
- \ 'pointer': ['fg', 'Exception'],
- \ 'marker': ['fg', 'Keyword'],
- \ 'spinner': ['fg', 'Label'],
- \ 'header': ['fg', 'Comment'] }
-
- " Enable per-command history.
- " CTRL-N and CTRL-P will be automatically bound to next-history and
- " previous-history instead of down and up. If you don't like the change,
- " explicitly bind the keys to down and up in your $FZF_DEFAULT_OPTS.
- let g:fzf_history_dir = '~/.local/share/fzf-history'
-<
- {4} https://github.com/junegunn/fzf/blob/master/README-VIM.md#configuration
-
-
-Command-local options~
- *fzf-vim-command-local-options*
-
- *g:fzf_buffers_jump* *g:fzf_commits_log_options* *g:fzf_tags_command*
- *g:fzf_commands_expect*
->
- " [Buffers] Jump to the existing window if possible
- let g:fzf_buffers_jump = 1
-
- " [[B]Commits] Customize the options used by 'git log':
- let g:fzf_commits_log_options = '--graph --color=always --format="%C(auto)%h%d %s %C(black)%C(bold)%cr"'
-
- " [Tags] Command to generate tags file
- let g:fzf_tags_command = 'ctags -R'
-
- " [Commands] --expect expression for directly executing the command
- let g:fzf_commands_expect = 'alt-enter,ctrl-x'
-<
-
-Advanced customization~
- *fzf-vim-advanced-customization*
-
-You can use autoload functions to define your own commands.
->
- " Command for git grep
- " - fzf#vim#grep(command, with_column, [options], [fullscreen])
- command! -bang -nargs=* GGrep
- \ call fzf#vim#grep(
- \ 'git grep --line-number '.shellescape(<q-args>), 0,
- \ { 'dir': systemlist('git rev-parse --show-toplevel')[0] }, <bang>0)
-
- " Override Colors command. You can safely do this in your .vimrc as fzf.vim
- " will not override existing commands.
- command! -bang Colors
- \ call fzf#vim#colors({'left': '15%', 'options': '--reverse --margin 30%,0'}, <bang>0)
-
- " Augmenting Ag command using fzf#vim#with_preview function
- " * fzf#vim#with_preview([[options], [preview window], [toggle keys...]])
- " * For syntax-highlighting, Ruby and any of the following tools are required:
- " - Highlight: http://www.andre-simon.de/doku/highlight/en/highlight.php
- " - CodeRay: http://coderay.rubychan.de/
- " - Rouge: https://github.com/jneen/rouge
- "
- " :Ag - Start fzf with hidden preview window that can be enabled with "?" key
- " :Ag! - Start fzf in fullscreen and display the preview window above
- command! -bang -nargs=* Ag
- \ call fzf#vim#ag(<q-args>,
- \ <bang>0 ? fzf#vim#with_preview('up:60%')
- \ : fzf#vim#with_preview('right:50%:hidden', '?'),
- \ <bang>0)
-
- " Similarly, we can apply it to fzf#vim#grep. To use ripgrep instead of ag:
- command! -bang -nargs=* Rg
- \ call fzf#vim#grep(
- \ 'rg --column --line-number --no-heading --color=always --smart-case '.shellescape(<q-args>), 1,
- \ <bang>0 ? fzf#vim#with_preview('up:60%')
- \ : fzf#vim#with_preview('right:50%:hidden', '?'),
- \ <bang>0)
-
- " Likewise, Files command with preview window
- command! -bang -nargs=? -complete=dir Files
- \ call fzf#vim#files(<q-args>, fzf#vim#with_preview(), <bang>0)
-<
-
-MAPPINGS *fzf-vim-mappings*
-==============================================================================
-
- ---------------------------------+------------------------------------------
- Mapping | Description ~
- ---------------------------------+------------------------------------------
- <plug>(fzf-maps-n) | Normal mode mappings
- <plug>(fzf-maps-i) | Insert mode mappings
- <plug>(fzf-maps-x) | Visual mode mappings
- <plug>(fzf-maps-o) | Operator-pending mappings
- <plug>(fzf-complete-word) | `cat /usr/share/dict/words`
- <plug>(fzf-complete-path) | Path completion using `find` (file + dir)
- <plug>(fzf-complete-file) | File completion using `find`
- <plug>(fzf-complete-file-ag) | File completion using `ag`
- <plug>(fzf-complete-line) | Line completion (all open buffers)
- <plug>(fzf-complete-buffer-line) | Line completion (current buffer only)
- ---------------------------------+------------------------------------------
-
-
-< Usage >_____________________________________________________________________~
- *fzf-vim-usage*
->
- " Mapping selecting mappings
- nmap <leader><tab> <plug>(fzf-maps-n)
- xmap <leader><tab> <plug>(fzf-maps-x)
- omap <leader><tab> <plug>(fzf-maps-o)
-
- " Insert mode completion
- imap <c-x><c-k> <plug>(fzf-complete-word)
- imap <c-x><c-f> <plug>(fzf-complete-path)
- imap <c-x><c-j> <plug>(fzf-complete-file-ag)
- imap <c-x><c-l> <plug>(fzf-complete-line)
-
- " Advanced customization using autoload functions
- inoremap <expr> <c-x><c-k> fzf#vim#complete#word({'left': '15%'})
-<
-
-< Completion helper >_________________________________________________________~
- *fzf-vim-completion-helper*
-
-`fzf#vim#complete` is a helper function for creating custom fuzzy completion
-using fzf. If the first parameter is a command string or a Vim list, it will
-be used as the source.
->
- " Replace the default dictionary completion with fzf-based fuzzy completion
- inoremap <expr> <c-x><c-k> fzf#vim#complete('cat /usr/share/dict/words')
-<
-For advanced uses, you can pass an options dictionary to the function. The set
-of options is pretty much identical to that for `fzf#run` only with the
-following exceptions:
-
- - `reducer` (funcref)
- - Reducer transforms the output lines of fzf into a single string value
- - `prefix` (string or funcref; default: `\k*$`)
- - Regular expression pattern to extract the completion prefix
- - Or a function to extract completion prefix
- - Both `source` and `options` can be given as funcrefs that take the completion
- prefix as the argument and return the final value
- - `sink` or `sink*` are ignored
->
- " Global line completion (not just open buffers. ripgrep required.)
- inoremap <expr> <c-x><c-l> fzf#vim#complete(fzf#wrap({
- \ 'prefix': '^.*$',
- \ 'source': 'rg -n ^ --color always',
- \ 'options': '--ansi --delimiter : --nth 3..',
- \ 'reducer': { lines -> join(split(lines[0], ':\zs')[2:], '') }}))
-<
-
-Reducer example~
- *fzf-vim-reducer-example*
->
- function! s:make_sentence(lines)
- return substitute(join(a:lines), '^.', '\=toupper(submatch(0))', '').'.'
- endfunction
-
- inoremap <expr> <c-x><c-s> fzf#vim#complete({
- \ 'source': 'cat /usr/share/dict/words',
- \ 'reducer': function('<sid>make_sentence'),
- \ 'options': '--multi --reverse --margin 15%,0',
- \ 'left': 20})
-<
-
-STATUS LINE OF TERMINAL BUFFER *fzf-vim-status-line-of-terminal-buffer*
-==============================================================================
-
-When fzf starts in a terminal buffer (see {fzf/README-VIM.md}{11}), you may
-want to customize the statusline of the containing buffer.
-
-{11} https://github.com/junegunn/fzf/blob/master/README-VIM.md#fzf-inside-terminal-buffer
-
-
-< Hide statusline >___________________________________________________________~
- *fzf-vim-hide-statusline*
->
- autocmd! FileType fzf
- autocmd FileType fzf set laststatus=0 noshowmode noruler
- \| autocmd BufLeave <buffer> set laststatus=2 showmode ruler
-<
-
-< Custom statusline >_________________________________________________________~
- *fzf-vim-custom-statusline*
->
- function! s:fzf_statusline()
- " Override statusline as you like
- highlight fzf1 ctermfg=161 ctermbg=251
- highlight fzf2 ctermfg=23 ctermbg=251
- highlight fzf3 ctermfg=237 ctermbg=251
- setlocal statusline=%#fzf1#\ >\ %#fzf2#fz%#fzf3#f
- endfunction
-
- autocmd! User FzfStatusLine call <SID>fzf_statusline()
-<
-
-LICENSE *fzf-vim-license*
-==============================================================================
-
-MIT
-
-
-==============================================================================
-vim:tw=78:sw=2:ts=2:ft=help:norl:nowrap:
diff --git a/vim/.vim/plugged/fzf.vim/doc/tags b/vim/.vim/plugged/fzf.vim/doc/tags
deleted file mode 100644
index ff2c2ff..0000000
--- a/vim/.vim/plugged/fzf.vim/doc/tags
+++ /dev/null
@@ -1,25 +0,0 @@
-fzf-vim fzf-vim.txt /*fzf-vim*
-fzf-vim-advanced-customization fzf-vim.txt /*fzf-vim-advanced-customization*
-fzf-vim-command-local-options fzf-vim.txt /*fzf-vim-command-local-options*
-fzf-vim-commands fzf-vim.txt /*fzf-vim-commands*
-fzf-vim-completion-helper fzf-vim.txt /*fzf-vim-completion-helper*
-fzf-vim-custom-statusline fzf-vim.txt /*fzf-vim-custom-statusline*
-fzf-vim-customization fzf-vim.txt /*fzf-vim-customization*
-fzf-vim-fzf-heart-vim fzf-vim.txt /*fzf-vim-fzf-heart-vim*
-fzf-vim-global-options fzf-vim.txt /*fzf-vim-global-options*
-fzf-vim-hide-statusline fzf-vim.txt /*fzf-vim-hide-statusline*
-fzf-vim-installation fzf-vim.txt /*fzf-vim-installation*
-fzf-vim-license fzf-vim.txt /*fzf-vim-license*
-fzf-vim-mappings fzf-vim.txt /*fzf-vim-mappings*
-fzf-vim-rationale fzf-vim.txt /*fzf-vim-rationale*
-fzf-vim-reducer-example fzf-vim.txt /*fzf-vim-reducer-example*
-fzf-vim-status-line-of-terminal-buffer fzf-vim.txt /*fzf-vim-status-line-of-terminal-buffer*
-fzf-vim-toc fzf-vim.txt /*fzf-vim-toc*
-fzf-vim-usage fzf-vim.txt /*fzf-vim-usage*
-fzf-vim-using-vim-plug fzf-vim.txt /*fzf-vim-using-vim-plug*
-fzf-vim-why-you-should-use-fzf-on-vim fzf-vim.txt /*fzf-vim-why-you-should-use-fzf-on-vim*
-g:fzf_buffers_jump fzf-vim.txt /*g:fzf_buffers_jump*
-g:fzf_command_prefix fzf-vim.txt /*g:fzf_command_prefix*
-g:fzf_commands_expect fzf-vim.txt /*g:fzf_commands_expect*
-g:fzf_commits_log_options fzf-vim.txt /*g:fzf_commits_log_options*
-g:fzf_tags_command fzf-vim.txt /*g:fzf_tags_command*