Skip to content

Commit 9ef7f0d

Browse files
lucerionlucerion
committed
Documentation added
1 parent 712b712 commit 9ef7f0d

File tree

5 files changed

+137
-9
lines changed

5 files changed

+137
-9
lines changed

‎autoload/executor.vim

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
" ===========================================================================
2-
" Description: Vim plugin that executes shell command and redirects output
2+
" Description: Vim plugin that execute shell command and redirect output
33
" to a new buffer
44
" Author: Alexander Skachko <[email protected]>
55
" Homepage: https://github.com/lucerion/vim-executor
6-
" Version: 0.2
6+
" Version: 0.2.0 (2016-12-20)
77
" Licence: BSD-3-Clause
88
" ===========================================================================
99

‎autoload/executor/async.vim

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
" ===========================================================================
2-
" Description: Vim plugin that executes shell command and redirects output
2+
" Description: Vim plugin that execute shell command and redirect output
33
" to a new buffer
44
" Author: Alexander Skachko <[email protected]>
55
" Homepage: https://github.com/lucerion/vim-executor
6-
" Version: 0.2
6+
" Version: 0.2.0 (2016-12-20)
77
" Licence: BSD-3-Clause
88
" ===========================================================================
99

‎autoload/executor/default.vim

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
" ===========================================================================
2-
" Description: Vim plugin that executes shell command and redirects output
2+
" Description: Vim plugin that execute shell command and redirect output
33
" to a new buffer
44
" Author: Alexander Skachko <[email protected]>
55
" Homepage: https://github.com/lucerion/vim-executor
6-
" Version: 0.2
6+
" Version: 0.2.0 (2016-12-20)
77
" Licence: BSD-3-Clause
88
" ===========================================================================
99

‎doc/executor.vim

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
*vim-executor.txt* Vim plugin that execute shell command and redirect output
2+
to a new buffer
3+
4+
Author: Alexander Skachko <[email protected]>
5+
Homepage: https://github.com/lucerion/vim-executor
6+
Version: 0.2.0 (2016-12-20)
7+
Licence: BSD-3-Clause (see LICENSE)
8+
9+
===============================================================================
10+
CONTENTS *vim-executor*
11+
12+
Install |vim-executor-install|
13+
Commands |vim-executor-commands|
14+
Options |vim-executor-options|
15+
Changelog |vim-executor-changelog|
16+
License |vim-executor-license|
17+
18+
===============================================================================
19+
INSTALL *vim-executor-install*
20+
21+
Vundle https://github.com/VundleVim/Vundle.vim
22+
>
23+
Plugin 'lucerion/vim-executor'
24+
<
25+
Pathogen https://github.com/tpope/vim-pathogen
26+
>
27+
cd ~/.vim/bundle
28+
git clone https://github.com/lucerion/vim-executor
29+
<
30+
NeoBundle https://github.com/Shougo/neobundle.vim
31+
>
32+
NeoBundle 'lucerion/vim-executor'
33+
<
34+
vim-plug https://github.com/junegunn/vim-plug
35+
>
36+
Plug 'lucerion/vim-executor'
37+
<
38+
Manual
39+
>
40+
git clone https://github.com/lucerion/vim-executor
41+
<
42+
copy all of the files into your ~/.vim directory
43+
44+
===============================================================================
45+
COMMANDS *vim-executor-commands*
46+
47+
*:Exec*
48+
49+
:[range]Exec {command} Execute shell {command} and open new buffer
50+
with a command output. If one line selected
51+
this line will be executed as a command, with
52+
more than one - plugin will pass lines as a file
53+
to the command as argument.
54+
55+
===============================================================================
56+
OPTIONS *vim-executor-options*
57+
58+
*g:executor_position*
59+
60+
Result buffer position.
61+
62+
Positions: 'top', 'bottom', 'left', 'right', 'tab'
63+
Default: 'bottom'
64+
65+
*g:executor_buffer_name*
66+
67+
A pattern for a buffer name. {command} will be replaced with executed command,
68+
{filename} with current file name.
69+
70+
Default: '{command}'
71+
72+
*g:executor_reuse_buffer*
73+
74+
Reuse buffer with results instead of opening new one.
75+
76+
Default: 0
77+
78+
*g:executor_exec_async*
79+
80+
Enable/disable async command execution (only for vim version > 8.0).
81+
82+
Default: 1
83+
84+
===============================================================================
85+
CHANGELOG *vim-executor-changelog*
86+
87+
0.2.0 (2016-12-20)~
88+
89+
Changes
90+
* async execution for vim version > 8.0 added
91+
92+
0.1.0 (2016-12-12)~
93+
94+
First release
95+
96+
===============================================================================
97+
LICENSE *vim-executor-license*
98+
99+
Copyright © 2016, Alexander Skachko
100+
All rights reserved.
101+
102+
Redistribution and use in source and binary forms, with or without modification,
103+
are permitted provided that the following conditions are met:
104+
105+
1. Redistributions of source code must retain the above copyright notice, this
106+
list of conditions and the following disclaimer.
107+
108+
2. Redistributions in binary form must reproduce the above copyright notice,
109+
this list of conditions and the following disclaimer in the documentation and/or
110+
other materials provided with the distribution.
111+
112+
3. Neither the name of the copyright holder nor the names of its contributors
113+
may be used to endorse or promote products derived from this software without
114+
specific prior written permission.
115+
116+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
117+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
118+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
119+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
120+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
121+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
122+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
123+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
124+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
125+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
126+
127+
===============================================================================
128+
vim:tw=78:ts=4:ft=help:norl:

‎plugin/executor.vim

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
" ===========================================================================
2-
" Description: Vim plugin that executes shell command and redirects output
2+
" Description: Vim plugin that execute shell command and redirects output
33
" to a new buffer
44
" Author: Alexander Skachko <[email protected]>
55
" Homepage: https://github.com/lucerion/vim-executor
6-
" Version: 0.2
6+
" Version: 0.2.0 (2016-12-20)
77
" Licence: BSD-3-Clause
88
" ===========================================================================
99

10-
if exists('g:loaded_executor') || &compatible || (v:version < 700)
10+
if exists('g:loaded_executor') || &compatible || v:version < 700
1111
finish
1212
endif
1313

0 commit comments

Comments
 (0)