]> git.r.bdr.sh - rbdr/dotfiles/blob - vim/doc/conque_term.txt
Remove task Warrior
[rbdr/dotfiles] / vim / doc / conque_term.txt
1 *ConqueTerm* Plugin to run a shell in a buffer
2
3 The ConqueTerm plugin will convert a buffer into a terminal emulator, allowing
4 you to run a shell or shell application in the buffer.
5
6 *conque_term-usage*
7
8 Type :ConqueTerm <command> to launch an application in the current buffer. E.g.
9
10 :ConqueTerm bash
11 :ConqueTerm mysql -h localhost -u joe_lunchbox Menu
12 :ConqueTerm man top
13
14 Use :ConqueTermSplit or :ConqueTermVSplit to open Conque in a new horizontal
15 or vertical buffer.
16
17 Keys pressed in insert mode will be sent to the shell, along with output from
18 the 'p' command in normal mode.
19
20 Press the <Esc> key twice to send a single <Esc> to the shell. Pressing this
21 key once will leave insert mode like normal.
22
23 Press <F9> in any buffer to send a visual selection to the shell.
24
25
26 *conque_term-settings*
27
28 Set the following in your .vimrc (default values shown)
29
30 " Enable colors. Setting this to 0 will make your terminal faster.
31 let g:ConqueTerm_Color = 1
32
33 " Set your terminal type. I strong recommend leaving this as vt100,
34 " however more features may be enabled with xterm.
35 let g:ConqueTerm_TERM = 'vt100'
36
37 " Set buffer syntax. Conque has highlighting for MySQL, but not much else.
38 let g:ConqueTerm_Syntax = 'conque'
39
40 " Continue updating shell when it's not the current, focused buffer
41 let g:ConqueTerm_ReadUnfocused = 1
42
43
44 *conque_term-requirements*
45
46 The following minimum requirements are needed to run Conque. Conque will not
47 run on Windows without a Cygwin-like environment.
48
49 - Vim 7.1
50 - Python 2.3
51 - Supported operating systems: *nix, Mac, or Cygwin
52
53 Tested on:
54 - Vim 7.2 / Python 2.6 / Ubuntu 9.10 (Gnome & GTK)
55 - Vim 7.2 / Python 2.6 / FreeBSD 8.0 (GTK)
56 - Vim 7.1 / Python 2.6 / FreeBSD 8.0 (GTK)
57 x Vim 7.0 / Python 2.6 / FreeBSD 8.0 (GTK)
58 * feedkeys() doesn't restart updatetime
59 - Vim 7.2 / Python 2.4 / OpenSolaris 2009.06 (Gnome)
60 - Vim 7.2 / Python 2.4 / CentOS 5.3 (no GUI)
61 - Vim 7.1 / Python 2.3 / RHEL 4 (no GUI)
62 - Vim 7.2 / Python 2.5 / Cygwin (Windows Vista 64b)
63 - MacVim 7.2 / Python 2.3 / OS X 10.6.2
64
65 *conque_term-bugs*
66
67 The following are known limitations:
68
69 - Font/color highlighting is imperfect and slow. If you don't care about
70 color in your shell, set g:ConqueTerm_Color = 0 in your .vimrc
71 - Conque only supports the extended ASCII character set for input, not utf-8.
72 - VT100 escape sequence support is not complete.
73 - Alt/Meta key support in Vim isn't great in general, and conque is no
74 exception. Pressing <Esc><Esc>x or <Esc><M-x> instead of <M-x> works in
75 most cases.
76
77 *conque_term-todo*
78
79 - Fix pasting from named registers
80 - Polling unfucused conque buffers (Top explodes when window resizes)
81 - Enable graphics character set
82 - Consider supporting xterm escapes
83 - Improve color logic
84 - Find a solution to UTF-8 input (See InsertCharPre in Vim todo.txt)
85 - Find an alternative to updatetime polling (See Vim todo.txt)
86 - Find a graceful solution to Meta key input
87 - Windows support
88 (See PyConsole http://www.vim.org/scripts/script.php?script_id=1974)
89 - Always: look for performance improvements
90
91
92 *conque_term-contribute*
93
94 The two contributions most in need are improvements to Vim itself. I currently
95 use hacks to simulate a key press event and repeating CursorHold event. The
96 Vim todo.txt document lists proposed improvements to give users this behavior
97 without hacks. Having a key press event should allow Conque to work with multi-
98 byte input. If you are a Vim developer, please consider prioritizing these two
99 items:
100
101 - todo.txt (Autocommands, line ~3137)
102 8 Add an event like CursorHold that is triggered repeatedly, not just
103 once after typing something.
104
105 - todo.txt (Autocommands, proposed event list, line ~3189)
106 InsertCharPre - user typed character Insert mode, before inserting the
107 char. Pattern is matched with text before the cursor. Set v:char to the
108 character, can be changed. (not triggered when 'paste' is set).
109
110 Bugs, suggestions and patches are all welcome.
111
112 For more information visit http://conque.googlecode.com
113
114 Check out the latest from svn at http://conque.googlecode.com/svn/trunk/
115
116 *conque_term-changelog*
117
118 - 1.0 / 2010-02-
119 * Complete python rewrite
120 * Add support for ncurses based applications
121 * Add continuous polling, instead of using <Tab>
122 * Improve speed
123 * Improve syntax highlighting
124
125 - 0.6 / 2009-12-18
126 * Fix GVim errors with non-english locale
127 * No functional changes
128
129 - 0.5 / 2009-12-02
130 * Various performance enhancements and bugfixes.
131 * Rewritten escape sequence processing
132
133 - 0.4 / 2009-10-30
134 * Improved history and tab completion
135 * Fix escape sequence formatting and improve highlighting
136 * Send selected text to shell from any buffer
137 * Add special handling of "vi" and "man" commands
138 * Improve error handling
139 * Add key mappings for <C-p> <C-n> <C-l> <C-j>
140 * Various bugfixes
141
142 - 0.3 / 2009-10-13
143 * Apply escape sequence coloring to output, e.g. ls --color
144 * Clean up syntax files for portability
145 * Fix several Vim 7.1 bugs
146 * Bugfixes for multiple shell buffers
147 * Add experimental shell folding option
148
149 - 0.2 / 2009-10-01
150 * Rewritten subprocess management module in python instead of c
151 * Added support for OS X, partial support for Windows
152 * Improved tab completion
153
154 - 0.1 / 2009-09-03
155 * Initial release
156