Mercurial > pidgin.yaz
annotate doc/finch.1.in @ 17593:759cd72bd2ff
Replaced a clean and simple API with a very weird hack due to vivid request on #pidgin by multiple devs. This avoids the change in PurplePluginProtocolInfo, but requires complicated change tracking in every prpl. The others prpl should add this change tracking, too (since otherwise the status gets changed even though nothing they care about changed), but that's not up to me.
author | Andreas Monitzer <pidgin@monitzer.com> |
---|---|
date | Mon, 18 Jun 2007 12:37:29 +0000 |
parents | 6b516b7eebc5 |
children | bb4f0b96ba1e |
rev | line source |
---|---|
15845 | 1 .\" Copyright (c) 2006, Sadrul Habib Chowdhury <sadrul@users.sf.net> |
2 .\" | |
3 .\" This is free documentation; you can redistribute it and/or | |
4 .\" modify it under the terms of the GNU General Public License as | |
5 .\" published by the Free Software Foundation; either version 2 of | |
6 .\" the License, or (at your option) any later version. | |
7 .\" | |
8 .\" The GNU General Public License's references to "object code" | |
9 .\" and "executables" are to be interpreted as the output of any | |
10 .\" document formatting or typesetting system, including | |
11 .\" intermediate and printed output. | |
12 .\" | |
13 .\" This manual is distributed in the hope that it will be useful, | |
14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 .\" GNU General Public License for more details. | |
17 .\" | |
18 .\" You should have received a copy of the GNU General Public | |
19 .\" License along with this manual; if not, write to the Free | |
20 .\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, | |
21 .\" USA. | |
22 .TH finch 1 | |
23 .SH NAME | |
24 Finch \- A Pimpin' Penguin console frontend to libpurple. Instant | |
25 Messaging client. | |
26 .SH SYNOPSIS | |
27 .TP 5 | |
28 \fBfinch \fI[options]\fR | |
29 | |
30 .SH DESCRIPTION | |
31 .PP | |
16976
6b516b7eebc5
Pimp libpurple, based on a suggestion from James Lockie. This okay?
Richard Laager <rlaager@wiktel.com>
parents:
16915
diff
changeset
|
32 \fBfinch\fR is a console-based modular messaging client based on libpurple |
6b516b7eebc5
Pimp libpurple, based on a suggestion from James Lockie. This okay?
Richard Laager <rlaager@wiktel.com>
parents:
16915
diff
changeset
|
33 which is capable of connecting to AIM, MSN, Yahoo!, XMPP, ICQ, IRC, SILC, |
6b516b7eebc5
Pimp libpurple, based on a suggestion from James Lockie. This okay?
Richard Laager <rlaager@wiktel.com>
parents:
16915
diff
changeset
|
34 Novell GroupWise, Lotus Sametime, Zephyr, Gadu-Gadu, and QQ all at once. It has |
6b516b7eebc5
Pimp libpurple, based on a suggestion from James Lockie. This okay?
Richard Laager <rlaager@wiktel.com>
parents:
16915
diff
changeset
|
35 many common features found in other clients, as well as many unique features. |
6b516b7eebc5
Pimp libpurple, based on a suggestion from James Lockie. This okay?
Richard Laager <rlaager@wiktel.com>
parents:
16915
diff
changeset
|
36 Finch is not endorsed by or affiliated with America Online, ICQ, Microsoft, or |
6b516b7eebc5
Pimp libpurple, based on a suggestion from James Lockie. This okay?
Richard Laager <rlaager@wiktel.com>
parents:
16915
diff
changeset
|
37 Yahoo. |
15845 | 38 |
39 .SH OPTIONS | |
40 The following options are provided by \fBfinch\fR using the standard GNU | |
41 command line syntax: | |
42 .TP | |
43 .B \-d, \-\-debug | |
44 Print debugging messages to stderr and start with the \fBDebug\fR window. The | |
45 messages shown in the \fBDebug\fR window are the same as the ones printed in | |
46 stderr. | |
47 .TP | |
48 .B \-c, \-\-config=\fIDIR\fB | |
16197
30557aad1951
Update some paths in the man pages.
Richard Laager <rlaager@wiktel.com>
parents:
15845
diff
changeset
|
49 Use \fIDIR\fR as the directory for config files instead of \fI~/.purple\fR. |
15845 | 50 .TP |
51 .B \-h, \-\-help | |
52 Print this help and exit. | |
53 .TP | |
54 .B \-n, \-\-nologin | |
55 Don't automatically login when \fBfinch\fR starts. Sets all accounts to | |
56 Offline. | |
57 .TP | |
58 .B \-v, \-\-version | |
59 Display the version information window. | |
60 | |
61 .SH GNT Shortcuts | |
62 You can use the following shortcuts: | |
63 .TP | |
64 .B Alt \+ a | |
65 Bring up a list of available actions. You can use this list to access the | |
66 accounts window, plugins window, preference window etc. | |
67 .TP | |
68 .B Alt \+ n | |
69 Go to the next window. | |
70 .TP | |
71 .B Alt \+ p | |
72 Go to the previous window. | |
73 .TP | |
74 .B Alt \+ w | |
75 Show the list of windows. You can select and jump to any window from the list. | |
76 .TP | |
77 .B Alt \+ c | |
78 Close the current window. | |
79 .TP | |
80 .B Alt \+ q | |
81 Quit. | |
82 .TP | |
83 .B Alt \+ m | |
84 Start moving a window. Press the cursor keys to move the window. When you are | |
85 done, press \fBEnter\fR or \fBEscape\fR. | |
86 .TP | |
87 .B Alt \+ r | |
88 Start resizing a window. Press the cursor keys to resize the window. When you | |
89 are done, press \fBEnter\fR or \fBEscape\fR. | |
90 .TP | |
91 .B Alt \+ d | |
92 Dump the contents of the screen in HTML format in a file named "dump.html" in | |
93 working directory. | |
94 .TP | |
95 .B Alt \+ . | |
96 Move the position of the current window in the window list one place to the | |
97 right. | |
98 .TP | |
99 .B Alt \+ , | |
100 Move the position of the current window in the window list one place to the | |
101 left. | |
102 .TP | |
103 .B Alt \+ l | |
104 Refresh the windows. This is useful after resizing the terminal window. | |
105 .TP | |
106 .B Alt \+ 1 2 ... 0 | |
107 Jump to the 1st, 2nd ... 10th window. | |
108 .TP | |
109 .B Ctrl \+ o | |
110 Bring up the menu (if there is one) for a window. Note that currently only the | |
111 buddylist has a menu. | |
112 | |
113 .SH FILES | |
114 \fI~/.gntrc\fR: configuration file for gnt applications. | |
115 .br | |
116 .TP | |
117 A sample file looks like: | |
118 .br | |
119 [general] | |
120 .br | |
121 shadow = 0 | |
122 .br | |
123 # There is experimental mouse support | |
124 .br | |
125 mouse = 1 | |
126 .br | |
127 # To use some custom window-manager | |
128 .br | |
16197
30557aad1951
Update some paths in the man pages.
Richard Laager <rlaager@wiktel.com>
parents:
15845
diff
changeset
|
129 wm = /usr/local/lib/purple/s.so |
15845 | 130 .br |
131 # Remember window-positions based on the titles (on by default) | |
132 .br | |
133 remember_position = 1 | |
134 .br | |
135 | |
136 .br | |
137 [colors] | |
138 .br | |
139 # The RGB values range in [0, 1000] | |
140 .br | |
141 black = 0; 0; 0 | |
142 .br | |
143 red = 1000; 0; 0 | |
144 .br | |
145 green = 0; 1000; 0 | |
146 .br | |
147 blue = 250; 250; 700 | |
148 .br | |
149 white = 1000; 1000; 1000 | |
150 .br | |
151 gray = 700; 700; 700 | |
152 .br | |
153 darkgray = 256; 256; 256 | |
154 .br | |
155 | |
156 .br | |
157 [colorpairs] | |
158 .br | |
159 normal = white; black | |
160 .br | |
161 highlight = white; blue | |
162 .br | |
163 highlightd = black; gray | |
164 .br | |
165 shadow = black; darkgray | |
166 .br | |
167 title = white; blue | |
168 .br | |
169 titled = white; gray | |
170 .br | |
171 text = white; blue | |
172 .br | |
173 disabled = gray; black | |
174 .br | |
175 urgent = green; black | |
176 .br | |
177 | |
178 .br | |
179 # Remap some keys for GntEntry | |
180 .br | |
181 [GntEntry::remap] | |
182 .br | |
183 # Remap the up-arrow to the left-arrow | |
184 .br | |
185 ^[[A = ^[[D | |
186 .br | |
187 # Remap the down-arrow to the right-arrow | |
188 .br | |
189 ^[[B = ^[[C | |
190 .br | |
191 # Remap 'a' to 'bcd' | |
192 .br | |
193 a = bcd | |
194 .br | |
195 # Completely ignore the key 'q' | |
196 .br | |
197 q = | |
198 .br | |
199 # But the following will NOT work | |
200 .br | |
201 #abc = bcd | |
202 .br | |
203 | |
204 # Hitting 'space' will activate a button | |
205 .br | |
206 [GntButton::remap] | |
207 .br | |
208 \\ = \\r | |
209 .br | |
210 | |
211 .SH Widget Actions | |
212 You can specifiy key-bindings for specific widgets. The following entries in | |
213 \fI~/.gntrc\fR correspond to the default keybindings for the actions: | |
214 | |
215 .br | |
216 [GntEntry::binding] | |
217 .br | |
218 c-a = cursor-home | |
219 .br | |
220 home = cursor-home | |
221 .br | |
222 c-e = cursor-end | |
223 .br | |
224 end = cursor-end | |
225 .br | |
226 backspace = delete-prev | |
227 .br | |
228 del = delete-next | |
229 .br | |
230 c-d = delete-next | |
231 .br | |
232 c-u = delete-start | |
233 .br | |
234 c-k = delete-end | |
235 .br | |
236 c-b = cursor-prev | |
237 .br | |
238 left = cursor-prev | |
239 .br | |
240 c-f = cursor-next | |
241 .br | |
242 right = cursor-next | |
243 .br | |
244 tab = suggest-show | |
245 .br | |
246 down = suggest-next | |
247 .br | |
248 up = suggest-prev | |
249 .br | |
250 c-w = delete-prev-word | |
251 .br | |
252 a-b = cursor-prev-word | |
253 .br | |
254 a-f = cursor-next-word | |
255 .br | |
256 a-d = delete-next-word | |
257 .br | |
258 c-v = clipboard-paste | |
259 | |
260 .br | |
261 [GntTree::binding] | |
262 .br | |
263 up = move-up | |
264 .br | |
265 down = move-down | |
266 .br | |
267 c-n = move-down | |
268 .br | |
269 c-p = move-up | |
270 .br | |
271 pageup = page-up | |
272 .br | |
273 pagedown = page-down | |
274 .br | |
275 # Following is the default binding for the context-menu | |
276 .br | |
277 menu = context-menu | |
278 .br | |
279 # The following will let you open the context-menu in the buddylist with c-b | |
280 .br | |
281 # c-b = context-menu | |
282 | |
283 .br | |
284 [GntWidget::binding] | |
285 .br | |
286 f11 = context-menu | |
287 | |
288 [GntWindow::binding] | |
289 .br | |
290 c-o = show-menu | |
291 .br | |
292 f10 = show-menu | |
293 | |
294 The \fBc-\fR corresponds to the \fBControl\fR key. You can also use \fBctrl-\fR | |
295 or \fBctr-\fR or \fBctl-\fR to indicate a combination. For alt-keys, you can use | |
296 one of \fBa-\fR, \fBalt-\fR, \fBm-\fR or \fBmeta-\fR. You can also use | |
297 \fBhome\fR, \fBend\fR, \fBleft\fR, \fBright\fR etc. keys. | |
298 | |
299 .SH Mouse Support | |
300 There is experimental mouse support. You can focus windows, activate buttons, | |
301 select rows in a list, scroll using the wheel-scroll etc. Selecting text in a | |
302 text-view copies it to the gnt clipboard. Mouse support is disabled by default, | |
303 so you need to enable it in \fI~/.gntrc\fR (see the sample above). | |
304 | |
305 .SH Window Management | |
306 The default window management is very limited. But it is possible to write | |
307 custom window managers to suit your needs. There is a sample window-manager | |
308 included (named \fIs.so\fR) which adds a little 'close-button' for the windows, | |
309 removes the borders from the buddylist and pops up new windows in the middle of | |
310 the screen, instead of at the upper-left corder. It is provided as a sample | |
311 simple manager, but it should be possible to write more complex managers, and | |
312 it's very possible that the window-manager API will need to be enhanced. Look at | |
313 the sample \fI~/.gntrc\fR file above to see how to select a window-manager. | |
314 | |
315 It is also possible to rebind the window-manager actions in \fI~/.gntrc\fR, eg: | |
316 | |
317 .br | |
318 [GntWM::binding] | |
319 .br | |
320 a-n = window-next | |
321 .br | |
322 a-p = window-prev | |
323 .br | |
324 a-c = window-close | |
325 .br | |
326 a-w = window-list | |
327 .br | |
328 a-d = dump-screen | |
329 .br | |
330 a-, = shift-left | |
331 .br | |
332 a-. = shift-right | |
333 .br | |
334 a-a = action-list | |
335 .br | |
336 a-m = start-move | |
337 .br | |
338 a-r = start-resize | |
339 .br | |
340 a-q = wm-quit | |
341 .br | |
342 a-l = refresh-screen | |
343 .br | |
344 # The following action is still incomplete, and doesn't have a default binding | |
345 .br | |
346 # switch-window-n | |
347 .br | |
348 | |
349 # For the sample custom window manager | |
350 .br | |
351 [GntS::binding] | |
352 .br | |
353 a-b = toggle-buddylist | |
354 .br | |
355 a-C = toggle-clipboard | |
356 | |
357 .SH Conversation Commands | |
358 There are a few helpful commands in addition to the regular commands. You can | |
359 use these from any conversation to access other windows. | |
360 | |
361 .TP | |
362 .B accounts | |
363 for the accounts window. | |
364 | |
365 .TP | |
366 .B buddylist | |
367 for the buddylist. | |
368 | |
369 .TP | |
370 .B debugwin | |
371 for the debug window. | |
372 | |
373 .TP | |
374 .B plugins | |
375 for the plugins window. | |
376 | |
377 .TP | |
378 .B prefs | |
379 for the preferences window. | |
380 | |
381 .TP | |
382 .B status | |
383 for the status window. | |
384 | |
385 .SH BUGS | |
386 Known bugs are listed at | |
387 .br | |
388 \fIhttp://sourceforge.net/tracker/?group_id=235&atid=100235\fR | |
389 | |
390 Before sending a bug report, please verify that you have the latest | |
391 version of \fBfinch\fR and \fBlibpurple\fR. Many bugs (major and minor) are | |
392 fixed at each release, and if yours is out of date, the problem may already have | |
393 been solved. | |
394 | |
395 | |
396 .SH PATCHES | |
397 If you fix a bug in \fBfinch\fR (or otherwise enhance it), please submit a | |
398 patch (using \fImtn diff > my.diff\fR against the latest version from the | |
399 Monotone repository) at | |
400 .br | |
401 \fIhttp://developer.pidgin.im/newticket\fR | |
402 | |
403 You are also encouraged to drop by at \fB#pidgin\fR on \fIirc.freenode.net\fR to | |
404 discuss development. | |
405 | |
406 .SH SEE ALSO | |
407 \fIhttp://pidgin.im/\fR | |
408 | |
409 .SH LICENSE | |
410 This program is free software; you can redistribute it and/or modify | |
411 it under the terms of the GNU General Public License as published by | |
412 the Free Software Foundation; either version 2 of the License, or | |
413 (at your option) any later version. | |
414 | |
415 This program is distributed in the hope that it will be useful, but | |
416 \fBWITHOUT ANY WARRANTY\fR; without even the implied warranty of | |
417 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
418 General Public License for more details. | |
419 | |
420 You should have received a copy of the GNU General Public License | |
421 along with this program; if not, write to the Free Software | |
422 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
423 | |
424 .SH AUTHORS | |
425 Sadrul Habib Chowdhury <\fIsadrul@users.sourceforge.net\fR> | |
426 .br | |
427 | |
428 This manpage was written by Sadrul Habib Chowdhury | |
429 <\fIsadrul@users.sourceforge.net\fR> and Dennis Ristuccia | |
430 <\fIdennis@dennisr.net\fR>. | |
431 |