Mercurial > pidgin
annotate doc/finch.1.in @ 18447:8fc91e437981
Possible crash fix.
author | Sadrul Habib Chowdhury <imadil@gmail.com> |
---|---|
date | Fri, 06 Jul 2007 06:14:31 +0000 |
parents | 76b7adc8e934 |
children | 902685705e4e |
rev | line source |
---|---|
15844 | 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 | |
16965
6b516b7eebc5
Pimp libpurple, based on a suggestion from James Lockie. This okay?
Richard Laager <rlaager@wiktel.com>
parents:
16904
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:
16904
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:
16904
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:
16904
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:
16904
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:
16904
diff
changeset
|
37 Yahoo. |
15844 | 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:
15844
diff
changeset
|
49 Use \fIDIR\fR as the directory for config files instead of \fI~/.purple\fR. |
15844 | 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. | |
17829 | 112 .TP |
18381
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
113 .B Alt \+ / |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
114 Show a list of available key-bindings for the current widget in focus. |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
115 .TP |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
116 .B Alt \+ \> |
17829 | 117 Switch to the next workspace |
118 .TP | |
18381
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
119 .B Alt \+ \< |
17829 | 120 Switch to the previous workspace |
121 .TP | |
18381
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
122 .B Alt \+ t |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
123 Tag (or untag) the current window |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
124 .TP |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
125 .B Alt \+ T |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
126 Attached all the tag windows to the current workspace |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
127 .TP |
17829 | 128 .B Alt \+ s |
129 Show the workspace list | |
18381
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
130 .TP |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
131 .B F9 |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
132 Create a new workspace and switch to it |
15844 | 133 |
134 .SH FILES | |
135 \fI~/.gntrc\fR: configuration file for gnt applications. | |
136 .br | |
137 .TP | |
138 A sample file looks like: | |
139 .br | |
140 [general] | |
141 .br | |
142 shadow = 0 | |
143 .br | |
144 # There is experimental mouse support | |
145 .br | |
146 mouse = 1 | |
147 .br | |
148 # To use some custom window-manager | |
149 .br | |
18381
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
150 wm = /usr/local/lib/gnt/s.so |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
151 .br |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
152 # There's also a custom window manager called irssi.so |
15844 | 153 .br |
154 # Remember window-positions based on the titles (on by default) | |
155 .br | |
156 remember_position = 1 | |
157 .br | |
158 | |
159 .br | |
17829 | 160 # Workspaces are created simply by adding Workspace-X groups as follows: |
161 .br | |
162 [Workspace-1] | |
163 .br | |
164 name = blist | |
165 .br | |
166 # window-names specifies that windows with these semi-colon separated names are placed | |
167 into this workspace | |
168 .br | |
169 window-names = buddylist;debug-window | |
170 .br | |
171 | |
172 .br | |
173 [Workspace-2] | |
174 .br | |
175 name = IM | |
176 .br | |
177 window-names = conversation-window | |
178 .br | |
179 # window-titles specifies that windows with these semi-colon separated titles are placed | |
180 into this workspace. These are matched as substrings. Window titles take precedence over | |
181 names. | |
182 .br | |
183 window-titles = Preferences;Pounce | |
184 .br | |
185 | |
186 .br | |
15844 | 187 [colors] |
188 .br | |
189 # The RGB values range in [0, 1000] | |
190 .br | |
191 black = 0; 0; 0 | |
192 .br | |
193 red = 1000; 0; 0 | |
194 .br | |
195 green = 0; 1000; 0 | |
196 .br | |
197 blue = 250; 250; 700 | |
198 .br | |
199 white = 1000; 1000; 1000 | |
200 .br | |
201 gray = 700; 700; 700 | |
202 .br | |
203 darkgray = 256; 256; 256 | |
204 .br | |
205 | |
206 .br | |
207 [colorpairs] | |
208 .br | |
209 normal = white; black | |
210 .br | |
211 highlight = white; blue | |
212 .br | |
213 highlightd = black; gray | |
214 .br | |
215 shadow = black; darkgray | |
216 .br | |
217 title = white; blue | |
218 .br | |
219 titled = white; gray | |
220 .br | |
221 text = white; blue | |
222 .br | |
223 disabled = gray; black | |
224 .br | |
225 urgent = green; black | |
226 .br | |
227 | |
228 .br | |
229 # Remap some keys for GntEntry | |
230 .br | |
231 [GntEntry::remap] | |
232 .br | |
233 # Remap the up-arrow to the left-arrow | |
234 .br | |
235 ^[[A = ^[[D | |
236 .br | |
237 # Remap the down-arrow to the right-arrow | |
238 .br | |
239 ^[[B = ^[[C | |
240 .br | |
241 # Remap 'a' to 'bcd' | |
242 .br | |
243 a = bcd | |
244 .br | |
245 # Completely ignore the key 'q' | |
246 .br | |
247 q = | |
248 .br | |
249 # But the following will NOT work | |
250 .br | |
251 #abc = bcd | |
252 .br | |
253 | |
254 # Hitting 'space' will activate a button | |
255 .br | |
256 [GntButton::remap] | |
257 .br | |
258 \\ = \\r | |
259 .br | |
260 | |
261 .SH Widget Actions | |
262 You can specifiy key-bindings for specific widgets. The following entries in | |
263 \fI~/.gntrc\fR correspond to the default keybindings for the actions: | |
264 | |
265 .br | |
266 [GntEntry::binding] | |
267 .br | |
268 c-a = cursor-home | |
269 .br | |
270 home = cursor-home | |
271 .br | |
272 c-e = cursor-end | |
273 .br | |
274 end = cursor-end | |
275 .br | |
276 backspace = delete-prev | |
277 .br | |
278 del = delete-next | |
279 .br | |
280 c-d = delete-next | |
281 .br | |
282 c-u = delete-start | |
283 .br | |
284 c-k = delete-end | |
285 .br | |
286 c-b = cursor-prev | |
287 .br | |
288 left = cursor-prev | |
289 .br | |
290 c-f = cursor-next | |
291 .br | |
292 right = cursor-next | |
293 .br | |
294 tab = suggest-show | |
295 .br | |
296 down = suggest-next | |
297 .br | |
298 up = suggest-prev | |
299 .br | |
300 c-w = delete-prev-word | |
301 .br | |
302 a-b = cursor-prev-word | |
303 .br | |
304 a-f = cursor-next-word | |
305 .br | |
306 a-d = delete-next-word | |
307 .br | |
308 c-v = clipboard-paste | |
309 | |
310 .br | |
311 [GntTree::binding] | |
312 .br | |
313 up = move-up | |
314 .br | |
315 down = move-down | |
316 .br | |
317 c-n = move-down | |
318 .br | |
319 c-p = move-up | |
320 .br | |
321 pageup = page-up | |
322 .br | |
323 pagedown = page-down | |
324 .br | |
18381
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
325 backspace = move-parent |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
326 .br |
15844 | 327 # Following is the default binding for the context-menu |
328 .br | |
329 menu = context-menu | |
330 .br | |
331 # The following will let you open the context-menu in the buddylist with c-b | |
332 .br | |
333 # c-b = context-menu | |
334 | |
335 .br | |
336 [GntWidget::binding] | |
337 .br | |
338 f11 = context-menu | |
339 | |
340 [GntWindow::binding] | |
341 .br | |
342 c-o = show-menu | |
343 .br | |
344 f10 = show-menu | |
345 | |
346 The \fBc-\fR corresponds to the \fBControl\fR key. You can also use \fBctrl-\fR | |
347 or \fBctr-\fR or \fBctl-\fR to indicate a combination. For alt-keys, you can use | |
348 one of \fBa-\fR, \fBalt-\fR, \fBm-\fR or \fBmeta-\fR. You can also use | |
349 \fBhome\fR, \fBend\fR, \fBleft\fR, \fBright\fR etc. keys. | |
350 | |
351 .SH Mouse Support | |
352 There is experimental mouse support. You can focus windows, activate buttons, | |
353 select rows in a list, scroll using the wheel-scroll etc. Selecting text in a | |
354 text-view copies it to the gnt clipboard. Mouse support is disabled by default, | |
355 so you need to enable it in \fI~/.gntrc\fR (see the sample above). | |
356 | |
357 .SH Window Management | |
358 The default window management is very limited. But it is possible to write | |
359 custom window managers to suit your needs. There is a sample window-manager | |
360 included (named \fIs.so\fR) which adds a little 'close-button' for the windows, | |
361 removes the borders from the buddylist and pops up new windows in the middle of | |
362 the screen, instead of at the upper-left corder. It is provided as a sample | |
363 simple manager, but it should be possible to write more complex managers, and | |
364 it's very possible that the window-manager API will need to be enhanced. Look at | |
365 the sample \fI~/.gntrc\fR file above to see how to select a window-manager. | |
366 | |
367 It is also possible to rebind the window-manager actions in \fI~/.gntrc\fR, eg: | |
368 | |
369 .br | |
370 [GntWM::binding] | |
371 .br | |
372 a-n = window-next | |
373 .br | |
374 a-p = window-prev | |
375 .br | |
376 a-c = window-close | |
377 .br | |
378 a-w = window-list | |
379 .br | |
380 a-d = dump-screen | |
381 .br | |
382 a-, = shift-left | |
383 .br | |
384 a-. = shift-right | |
385 .br | |
386 a-a = action-list | |
387 .br | |
388 a-m = start-move | |
389 .br | |
390 a-r = start-resize | |
391 .br | |
392 a-q = wm-quit | |
393 .br | |
394 a-l = refresh-screen | |
395 .br | |
18381
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
396 a-s = workspace-list |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
397 .br |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
398 a-t = window-tag |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
399 .br |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
400 a-T = place-tagged |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
401 .br |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
402 a-C = toggle-clipboard |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
403 .br |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
404 a-/ = help-for-widget |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
405 .br |
15844 | 406 # The following action is still incomplete, and doesn't have a default binding |
407 .br | |
408 # switch-window-n | |
409 .br | |
410 | |
411 # For the sample custom window manager | |
412 .br | |
413 [GntS::binding] | |
414 .br | |
415 a-b = toggle-buddylist | |
18381
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
416 |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
417 # For the irssi window manager |
15844 | 418 .br |
18381
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
419 [Irssi::binding] |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
420 .br |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
421 a-L = move-right |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
422 .br |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
423 a-H = move-left |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
424 .br |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
425 a-J = move-down |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
426 .br |
76b7adc8e934
Some manpage updates.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17829
diff
changeset
|
427 a-K = move-up |
15844 | 428 |
429 .SH Conversation Commands | |
430 There are a few helpful commands in addition to the regular commands. You can | |
431 use these from any conversation to access other windows. | |
432 | |
433 .TP | |
434 .B accounts | |
435 for the accounts window. | |
436 | |
437 .TP | |
438 .B buddylist | |
439 for the buddylist. | |
440 | |
441 .TP | |
442 .B debugwin | |
443 for the debug window. | |
444 | |
445 .TP | |
446 .B plugins | |
447 for the plugins window. | |
448 | |
449 .TP | |
450 .B prefs | |
451 for the preferences window. | |
452 | |
453 .TP | |
454 .B status | |
455 for the status window. | |
456 | |
457 .SH BUGS | |
458 Known bugs are listed at | |
459 .br | |
460 \fIhttp://sourceforge.net/tracker/?group_id=235&atid=100235\fR | |
461 | |
462 Before sending a bug report, please verify that you have the latest | |
463 version of \fBfinch\fR and \fBlibpurple\fR. Many bugs (major and minor) are | |
464 fixed at each release, and if yours is out of date, the problem may already have | |
465 been solved. | |
466 | |
467 | |
468 .SH PATCHES | |
469 If you fix a bug in \fBfinch\fR (or otherwise enhance it), please submit a | |
470 patch (using \fImtn diff > my.diff\fR against the latest version from the | |
471 Monotone repository) at | |
472 .br | |
473 \fIhttp://developer.pidgin.im/newticket\fR | |
474 | |
475 You are also encouraged to drop by at \fB#pidgin\fR on \fIirc.freenode.net\fR to | |
476 discuss development. | |
477 | |
478 .SH SEE ALSO | |
479 \fIhttp://pidgin.im/\fR | |
480 | |
481 .SH LICENSE | |
482 This program is free software; you can redistribute it and/or modify | |
483 it under the terms of the GNU General Public License as published by | |
484 the Free Software Foundation; either version 2 of the License, or | |
485 (at your option) any later version. | |
486 | |
487 This program is distributed in the hope that it will be useful, but | |
488 \fBWITHOUT ANY WARRANTY\fR; without even the implied warranty of | |
489 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
490 General Public License for more details. | |
491 | |
492 You should have received a copy of the GNU General Public License | |
493 along with this program; if not, write to the Free Software | |
494 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
495 | |
496 .SH AUTHORS | |
497 Sadrul Habib Chowdhury <\fIsadrul@users.sourceforge.net\fR> | |
498 .br | |
499 | |
500 This manpage was written by Sadrul Habib Chowdhury | |
501 <\fIsadrul@users.sourceforge.net\fR> and Dennis Ristuccia | |
502 <\fIdennis@dennisr.net\fR>. | |
503 |