]> git.r.bdr.sh - rbdr/dotfiles/blame - vim/doc/gist-vim.txt
A whole bunch of new additions to the submodules
[rbdr/dotfiles] / vim / doc / gist-vim.txt
CommitLineData
0d23b6e5
BB
1*Gist.vim* Vimscript for creating gists (http://gist.github.com)
2
3Usage |gist-vim-usage|
4Tips |gist-vim-tips|
5Requirements |gist-vim-requirements|
6License |gist-vim-license|
7Install |gist-vim-install|
8
9This is a vimscript for creating gists (http://gist.github.com)
10
11For the latest version please see https://github.com/mattn/gist-vim.
12
13==============================================================================
14USAGE *:Gist* *gist-vim-usage*
15
16- Post current buffer to gist, using default privacy option. >
17
18 :Gist
19<
20- Post selected text to gist, using defualt privacy option.
21 This applies to all permutations listed below (except multi). >
22
23 :'<,'>Gist
24<
25- Create a private gist. >
26
27 :Gist -p
28<
29- Create a public gist.
30 (Only relevant if you've set gists to be private by default.) >
31
32 :Gist -P
33<
34- Post whole text to gist as public.
35 This is only relevant if you've set gists to be private by default;
36 if you get an empty gist list, try ":Gist --abandon". >
37
38 :Gist -P
39<
40- Post whole text to gist as public.
41 This is only relevant if you've set gists to be private by default.
42 If you get an empty gist list, try ":Gist --abandon". >
43
44 :Gist -P
45<
46- Create a gist anonymously. >
47
48 :Gist -a
49<
50- Create a gist with all open buffers. >
51
52 :Gist -m
53<
54- Edit the gist (you need to have opened the gist buffer first).
55 You can update the gist with the {:w} command within the gist buffer. >
56
57 :Gist -e
58<
59- Edit the gist with name "foo.js" (you need to have opened the gist buffer
60 first). >
61
62 :Gist -e foo.js
63<
64- Delete the gist (you need to have opened the gist buffer first).
65 Password authentication is needed. >
66
67 :Gist -d
68<
69- Fork the gist (you need to have opened the gist buffer first).
70 Password authentication is needed. >
71
72 :Gist -f
73<
74- Get gist XXXXX. >
75
76 :Gist XXXXX
77<
78- Get gist XXXXX and add to clipboard. >
79
80 :Gist -c XXXXX
81<
82- List your public gists. >
83
84 :Gist -l
85<
86- List gists from user "mattn". >
87
88 :Gist -l mattn
89<
90- List all (public and private) of your gists. >
91
92 :Gist -la
93<
94
95==============================================================================
96TIPS *gist-vim-tips*
97
98If you set "g:gist_clip_command", gist.vim will copy the gist code with option
99"-c".
100
101 - Mac: >
102 let g:gist_clip_command = 'pbcopy'
103<
104 - Linux: >
105 let g:gist_clip_command = 'xclip -selection clipboard'
106<
107 - Others (cygwin?): >
108 let g:gist_clip_command = 'putclip'
109<
110If you want to detect filetype from the filename: >
111
112 let g:gist_detect_filetype = 1
113<
114If you want to open the browser after the post: >
115
116 let g:gist_open_browser_after_post = 1
117<
118If you want to change the browser: >
119
120 let g:gist_browser_command = 'w3m %URL%'
121<
122or: >
123
124 let g:gist_browser_command = 'opera %URL% &'
125<
126On windows, this should work with your user settings.
127
128If you want to show your private gists with ":Gist -l": >
129
130 let g:gist_show_privates = 1
131<
132If you get problems when creating gists try: >
133
134 :Gist --abandon
135<
136
137==============================================================================
138REQUIREMENTS *gist-vim-requirements*
139
140 - Curl command (http://curl.haxx.se/)
141 - and, if you want to use your git profile, the git command-line client.
142
143==============================================================================
144LICENSE *gist-vim-license*
145
146
147 Copyright 2010 by Yasuhiro Matsumoto
148 modification, are permitted provided that the following conditions are met:
149
150 1. Redistributions of source code must retain the above copyright notice,
151 this list of conditions and the following disclaimer.
152 2. Redistributions in binary form must reproduce the above copyright notice,
153 this list of conditions and the following disclaimer in the documentation
154 and/or other materials provided with the distribution.
155
156 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
157 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
158 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
159 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
160 REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
161 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
162 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
163 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
164 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
165 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
166 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
167 OF THE POSSIBILITY OF SUCH DAMAGE.
168
169==============================================================================
170INSTALL *gist-vim-install*
171
172Copy gist.vim to your plugin directory.
173
174gist.vim will create a curl cookie-jar file in your runtimepath.
175
176rtp:
177 - plugin/gist.vim
178 - cookies/github
179
180If you want to uninstall gist.vim, remember to also remove "cookies/github".
181
182 vim:tw=78:ts=8:ft=help:norl: