Mercurial > pidgin
annotate doc/gaim-text.1.in @ 14799:e908bff64af5
[gaim-migrate @ 17564]
Revert the changes from 17036. The log-displaying signal has a GaimGtkLogViewer argument, and gaim-encryption uses it. Accessor methods would be another way to solve this, but I don't really want to risk breaking things more.
committer: Tailor Script <tailor@pidgin.im>
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Mon, 23 Oct 2006 01:07:27 +0000 |
parents | 8a0cfee11af8 |
children | 9ee68ce424ec |
rev | line source |
---|---|
14585 | 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 gaim-text 1 | |
23 .SH NAME | |
14788
4b20371086f0
[gaim-migrate @ 17552]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14585
diff
changeset
|
24 Gaim-Text \- A Pimpin' Penguin console frontend for Instant Messaging client Gaim. |
14585 | 25 .SH SYNOPSIS |
26 .TP 5 | |
27 \fBgaim-text \fI[options]\fR | |
28 | |
29 .SH DESCRIPTION | |
30 .PP | |
31 \fBgaim-text\fR is a console-based modular messaging client capable of using | |
32 AIM, MSN, Yahoo!, Jabber, ICQ, IRC, SILC, Novell GroupWise, Lotus Sametime, | |
33 Zephyr, Gadu-Gadu, and QQ all at once. It has many common features found in | |
34 other clients, as well as many unique features. Gaim is not endorsed by or | |
35 affiliated with America Online, ICQ, Microsoft, or Yahoo. | |
36 | |
37 .SH OPTIONS | |
38 The following options are provided by \fBgaim-text\fR using the standard GNU | |
39 command line syntax: | |
40 .TP | |
41 .B \-d, \-\-debug | |
42 Print debugging messages to stderr and start with the \fBDebug\fR window. The | |
43 messages shown in the \fBDebug\fR window are the same as the ones printed in | |
44 stderr. | |
45 .TP | |
46 .B \-c, \-\-config=\fIDIR\fB | |
47 Use \fIDIR\fR as the directory for config files instead of \fI~/.gaim\fR. | |
48 .TP | |
49 .B \-h, \-\-help | |
50 Print this help and exit. | |
51 .TP | |
52 .B \-n, \-\-nologin | |
53 Don't automatically login when \fBgaim-text\fR starts. Sets all accounts to | |
54 Offline. | |
55 .TP | |
56 .B \-v, \-\-version | |
57 Display the version information window. | |
58 | |
59 .SH GNT Shortcuts | |
60 You can use the following shortcuts: | |
61 .TP | |
62 .B Alt \+ n | |
63 Go to the next window. | |
64 .TP | |
65 .B Alt \+ p | |
66 Go to the previous window. | |
67 .TP | |
68 .B Alt \+ w | |
69 Show the list of windows. You can select and jump to any window from the list. | |
70 .TP | |
71 .B Alt \+ c | |
72 Close the current window. | |
73 .TP | |
74 .B Alt \+ q | |
75 Quit. | |
76 .TP | |
77 .B Alt \+ m | |
78 Start moving a window. Press the cursor keys to move the window. When you are | |
79 done, press \fBEnter\fR or \fBEscape\fR. | |
80 .TP | |
81 .B Alt \+ r | |
82 Start resizing a window. Press the cursor keys to resize the window. When you | |
83 are done, press \fBEnter\fR or \fBEscape\fR. | |
84 .TP | |
85 .B Alt \+ d | |
86 Dump the contents of the screen in HTML format in a file named "dump.html" in | |
87 working directory. | |
88 .TP | |
89 .B Alt \+ . | |
90 Move the position of the current window in the window list one place to the | |
91 right. | |
92 .TP | |
93 .B Alt \+ , | |
94 Move the position of the current window in the window list one place to the | |
95 left. | |
96 .TP | |
97 .B Alt \+ l | |
98 Refresh the windows. This is useful after resizing the terminal window. | |
99 .TP | |
100 .B Alt \+ 1 2 ... 0 | |
101 Jump to the 1st, 2nd ... 10th window. | |
102 | |
103 .SH FILES | |
104 \fI~/.gntrc\fR: configuration file for gnt applications. | |
105 .br | |
106 .TP | |
107 A sample file looks like: | |
108 .br | |
109 [general] | |
110 .br | |
111 shadow = 0 | |
112 .br | |
113 # There is experimental mouse support | |
114 .br | |
115 mouse = 1 | |
116 .br | |
117 # To use some custom window-manager | |
118 .br | |
119 wm = /usr/local/lib/gaim/s.so | |
120 .br | |
121 | |
122 .br | |
123 [colors] | |
124 .br | |
125 # The RGB values range in [0, 1000] | |
126 .br | |
127 black = 0; 0; 0 | |
128 .br | |
129 red = 1000; 0; 0 | |
130 .br | |
131 green = 0; 1000; 0 | |
132 .br | |
133 blue = 250; 250; 700 | |
134 .br | |
135 white = 1000; 1000; 1000 | |
136 .br | |
137 gray = 700; 700; 700 | |
138 .br | |
139 darkgray = 256; 256; 256 | |
140 .br | |
141 | |
142 .br | |
143 [colorpairs] | |
144 .br | |
145 normal = white; black | |
146 .br | |
147 highlight = white; blue | |
148 .br | |
149 highlightd = black; gray | |
150 .br | |
151 shadow = black; darkgray | |
152 .br | |
153 title = white; blue | |
154 .br | |
155 titled = white; gray | |
156 .br | |
157 text = white; blue | |
158 .br | |
159 disabled = gray; black | |
160 .br | |
161 | |
162 .br | |
163 # Remap some keys for GntEntry | |
164 .br | |
165 [GntEntry::remap] | |
166 .br | |
167 # Remap the up-arrow to the left-arrow | |
168 .br | |
169 ^[[A = ^[[D | |
170 .br | |
171 # Remap the down-arrow to the right-arrow | |
172 .br | |
173 ^[[B = ^[[C | |
174 .br | |
175 # Remap 'a' to 'bcd' | |
176 .br | |
177 a = bcd | |
178 .br | |
179 # Completely ignore the key 'q' | |
180 .br | |
181 q = | |
182 .br | |
183 # But the following will NOT work | |
184 .br | |
185 #abc = bcd | |
186 .br | |
187 | |
188 # Hitting 'space' will activate a button | |
189 .br | |
190 [GntButton::remap] | |
191 .br | |
192 \\ = \\r | |
193 .br | |
194 | |
14793
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
195 .SH Widget Actions |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
196 You can specifiy key-bindings for specific widgets. The following entries in |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
197 \fI~/.gntrc\fR correspond to the default keybindings for the actions: |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
198 |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
199 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
200 [GntEntry::binding] |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
201 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
202 c-a = cursor-home |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
203 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
204 home = cursor-home |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
205 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
206 c-e = cursor-end |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
207 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
208 end = cursor-end |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
209 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
210 backspace = delete-prev |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
211 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
212 del = delete-next |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
213 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
214 c-d = delete-next |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
215 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
216 c-u = delete-start |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
217 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
218 c-k = delete-end |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
219 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
220 left = cursor-prev |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
221 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
222 right = cursor-next |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
223 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
224 tab = suggest-show |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
225 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
226 down = suggest-next |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
227 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
228 up = suggest-prev |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
229 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
230 |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
231 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
232 [GntTree::binding] |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
233 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
234 up = move-up |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
235 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
236 down = move-down |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
237 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
238 c-n = move-down |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
239 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
240 c-p = move-up |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
241 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
242 pageup = page-up |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
243 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
244 pagedown = page-down |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
245 .br |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
246 |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
247 The \fBc-\fR corresponds to the \fBControl\fR key. You can also use \fBctrl-\fR |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
248 or \fBctr-\fR or \fBctl-\fR to indicate a combination. For alt-keys, you can use |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
249 one of \fBa-\fR, \fBalt-\fR, \fBm-\fR or \fBmeta-\fR. You can also use |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
250 \fBhome\fR, \fBend\fR, \fBleft\fR, \fBright\fR etc. keys. |
8a0cfee11af8
[gaim-migrate @ 17558]
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
14788
diff
changeset
|
251 |
14585 | 252 .SH Mouse Support |
253 There is experimental mouse support. You can focus windows, activate buttons, | |
254 select rows in a list, scroll using the wheel-scroll etc. Mouse support is | |
255 disabled by default, so you need to enable it in ~/.gntrc (see the sample | |
256 above). | |
257 | |
258 .SH Window Management | |
259 The default window management is very limited. But it is possible to write | |
260 custom window managers to suit your needs. There is a sample window-manager | |
261 included (named \fIs.so\fR) which adds a little 'close-button' for the windows, | |
262 removes the borders from the buddylist and pops up new windows in the middle of | |
263 the screen, instead of at the upper-left corder. It is provided as a sample | |
264 simple manager, but it should be possible to write more complex managers, and | |
265 it's very possible that the window-manager API will need to be enhanced. Look at | |
266 the sample ~/.gntrc file above to see how to select a window-manager. | |
267 | |
268 | |
269 .SH Conversation Commands | |
270 There are a few helpful commands in addition to the regular commands. You can | |
271 use these from any conversation to access other windows. | |
272 | |
273 .TP | |
274 .B accounts | |
275 for the accounts window. | |
276 | |
277 .TP | |
278 .B buddylist | |
279 for the buddylist. | |
280 | |
281 .TP | |
282 .B debugwin | |
283 for the debug window. | |
284 | |
285 .TP | |
286 .B plugins | |
287 for the plugins window. | |
288 | |
289 .TP | |
290 .B prefs | |
291 for the preferences window. | |
292 | |
293 .TP | |
294 .B status | |
295 for the status window. | |
296 | |
297 .SH BUGS | |
298 Known bugs are listed at | |
299 .br | |
300 \fIhttp://sourceforge.net/tracker/?group_id=235&atid=100235\fR | |
301 | |
302 .SH PATCHES | |
303 If you fix a bug in \fBgaim-text\fR (or otherwise enhance it), please submit a | |
304 patch (using \fIsvn diff > my.diff\fR against the latest SVN version) | |
305 at | |
306 .br | |
307 \fIhttp://sourceforge.net/tracker/?func=add&group_id=235&atid=300235\fR | |
308 | |
309 Before sending a bug report, please verify that you have the latest | |
310 version of \fBgaim-text\fR and \fBlibgaim\fR. Many bugs (major and minor) are | |
311 fixed at each release, and if yours is out of date, the problem may already have | |
312 been solved. | |
313 | |
314 You are also encouraged to drop by at \fB#gaim\fR on \fIirc.freenode.net\fR to | |
315 discuss about development. | |
316 | |
317 .SH SEE ALSO | |
318 \fIhttp://gaim.sourceforge.net/\fR | |
319 .br | |
320 \fIhttp://www.sourceforge.net/projects/gaim/\fR | |
321 | |
322 .SH LICENSE | |
323 This program is free software; you can redistribute it and/or modify | |
324 it under the terms of the GNU General Public License as published by | |
325 the Free Software Foundation; either version 2 of the License, or | |
326 (at your option) any later version. | |
327 | |
328 This program is distributed in the hope that it will be useful, but | |
329 \fBWITHOUT ANY WARRANTY\fR; without even the implied warranty of | |
330 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
331 General Public License for more details. | |
332 | |
333 You should have received a copy of the GNU General Public License | |
334 along with this program; if not, write to the Free Software | |
335 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
336 | |
337 .SH AUTHORS | |
338 Sadrul Habib Chowdhury <\fIsadrul@users.sourceforge.net\fR> | |
339 .br | |
340 | |
341 This manpage was written by Sadrul Habib Chowdhury | |
342 <\fIsadrul@users.sourceforge.net\fR> and Dennis Ristuccia | |
343 <\fIdennis@dennisr.net\fR>. | |
344 |