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