doc/gaim.1.in

changeset 15634
f6283b35426f
parent 15623
bf485c598199
parent 15633
a199751d1c05
child 15635
68712783854b
child 15636
988327c23dcf
equal deleted inserted replaced
15623:bf485c598199 15634:f6283b35426f
1 .\" Copyright (c) 2000, Dennis Ristuccia <dennis@dennisr.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 1
23 .SH NAME
24 Gaim v@VERSION@ \- Instant Messaging client
25 .SH SYNOPSIS
26 .TP 5
27 \fBgaim \fI[options]\fR
28
29 .SH DESCRIPTION
30 .PP
31 \fBgaim\fR is a gtk2-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\fR using the standard GNU
39 command line syntax:
40 .TP
41 .B \-d, \-\-debug
42 Print debugging messages to stdout. These are the same debugging messages
43 that are displayed in the \fBDebug\fR window.
44 .TP
45 .B \-c, \-\-config=\fIDIR\fB
46 Use \fIDIR\fR as the directory for config files instead of \fI~/.gaim\fR.
47 .TP
48 .B \-h, \-\-help
49 Print this help and exit.
50 .TP
51 .B \-n, \-\-nologin
52 Don't automatically login when \fBgaim\fR starts. Sets all accounts to
53 Offline.
54 .TP
55 .B \-l, \-\-login[=\fINAME\fR,\fINAME\fR,...]
56 Sign in the comma-separated list of accounts provided, in addition to the
57 accounts that would be logged in anyway. If you do not specify such a
58 comma-separated list, your first account will be signed in.
59 .TP
60 .B \-v, \-\-version
61 Display the version information window.
62
63 .SH BUDDY LIST
64 The \fBBuddy List\fR window is \fBgaim\fR's main interface window. Using
65 this window you can see which of your buddies is online, away, idle, etc.
66 You can also add and remove buddies from your buddy list.
67
68 The \fBBuddy List\fR window contains a list of your buddies who are online
69 and have allowed you to be notified of their presence. The icon to the
70 left of each buddy indicates the buddy's current state and the protocol
71 they are using. Double clicking a buddy will open a new \fBConversation\fR
72 window. Right clicking will pop up a menu:
73 .TP
74 .B Get Info
75 Retrieves and displays information about the buddy. This information is
76 also known as a Profile.
77 .TP
78 .B IM
79 Opens a new \fBConversation\fR window to the selected buddy.
80 .TP
81 .B Send File
82 Sends a file to the selected buddy (only available on protocols that support
83 file transfer).
84 .TP
85 .B Add Buddy Pounce
86 A Buddy Pounce is a configurable automated action to be performed when the
87 buddy's state changes. This will open the \fBBuddy Pounce\fR dialog to be
88 discussed later.
89 .TP
90 .B View Log
91 \fBgaim\fR is capable of automatically log its activities. These logs are
92 either plain text files (with a .log extension) or html files (with a
93 \&.html extension) located under the \fI~/.gaim/logs\fR directory. This
94 menu command will attempt to view this file with \fBgaim\fR's internal log
95 viewer.
96 .TP
97 .B Alias
98 Create an alias for this buddy. This will open up a new dialog in which
99 one can give this buddy an alternate name to appear on the buddy list and
100 in conversations.
101
102 For example, if a buddy's name screen name was jsmith1281xx and his real
103 name was 'John Q. Smith,' one could create an alias as to identify the
104 buddy by his common name.
105 .LP
106 The remainder of the menu will consist of protocol specific commands.
107 These commands vary depending on the protocol.
108 .LP
109 At the bottom of the \fBBuddy List\fR are several buttons (if enabled in
110 \fBPreferences\fR):
111 .TP
112 .B IM
113 Opens a new \fBConversation\fR window to to the selected buddy, or brings
114 up the \fBNew Message\fR dialog box if no buddy is selected.
115 .TP
116 .B Info
117 Retrieves and display information about the selected buddy, or brings up
118 the \fBGet User Info\fR dialog box if no buddy is selected.
119 .TP
120 .B Chat
121 Brings up the \fBJoin Chat\fR dialog box, prompting the user to select
122 which username to use and what chat group to join.
123 .TP
124 .B Away
125 Brings up a menu of all available \fBAway Messages\fR. If an item is
126 selected, all online accounts will use this item as their away message.
127
128 .SH ACCOUNT EDITOR
129 The account editor consists of a list of accounts and information about
130 them. Clicking \fIDelete\fR will delete the currently selected account.
131 Clicking \fIAdd\fR or \fIModify\fR will invoke a \fBModify Account\fR
132 window. Here, you can add or alter account information. When creating a
133 new account, you will submit your screen name and password. You will also
134 choose your protocol.
135
136 If \fIRemember Password\fR is chosen, the password will be saved in
137 \fBgaim\fR's configuration file.
138
139 If \fIAuto-Login\fR is chosen, this account will automatically login upon
140 starting \fBgaim\fR.
141
142 Each protocol has it's own specific options that can be found in the
143 modify screen.
144
145 .SH PREFERENCES
146
147 All options take effect immediately.
148
149 .SH Interface
150
151 \fIDisplay remote nicknames if no alias is set\fR: Toggles whether server
152 nickname data should be used if no local alias exists.
153
154 .SH Buddy List
155 \fISorting\fR: Toggles the order in which buddies are shown in your
156 \fBBuddy List\fR between none, alphabetical, by status and by log size.
157
158 \fIShow buttons as\fR: Toggles between picture-only, text-only, picture and
159 text or no buttons view of the buttons on the \fBBuddy List\fR.
160
161 \fIRaise window on events\fR: Tells \fBgaim\fR to bring the \fBBuddy
162 List\fR window to the top when buddies sign in or out.
163
164 \fIShow numbers in groups\fR: The number of buddies from each group
165 currently logged in will be shown along with the total number of buddies in
166 the group.
167
168 \fIShow buddy icons\fR: Toggles the display of buddies' custom icons.
169
170 \fIShow warning levels\fR: Each buddy's warning level will be displayed
171 next to the screen name. As a buddy's warning level increases, outgoing
172 messages are more and more severely rate-limited.
173
174 \fIShow idle times\fR: The amount of time each buddy has been idle will be
175 displayed next to the screen name (if the buddy has opted to have their
176 client report this information).
177
178 \fIDim idle buddies\fR: If enabled, idle buddies will be displayed in grey
179 text instead of black text.
180
181 \fIAutomatically expand contacts\fR: If enabled, contacts will
182 automatically expand to show the associated buddies when the mouse is held
183 over the contact for a short period.
184
185 .SH Conversations
186
187 \fIShow buttons as...\fR: The selected item will determine whether
188 picture-only, text-only, combined picture/text, or no buttons will be used
189 for \fBConversation\fR windows.
190
191 \fIEnable "slash" commands\fR: Determines whether messages starting with
192 "slash" (eg. /help) will be interpreted as commands by \fBgaim\fR, or if they
193 will just be sent as messages.
194
195 \fIShow formatting toolbar\fR: Display the formatting toolbar between the
196 upper and lower text boxes in conversations.
197
198 \fIShow aliases in tabs/titles\fR: Displays buddy alias instead of screen
199 name in window tabs and titles.
200
201 \fIShow buddy icons\fR: For protocols that support it, buddy icons allow
202 buddies to send small pictures to be displayed during the course of a
203 conversation. Turning this option off hides those pictures.
204
205 \fIEnable buddy icon animation\fR: If these pictures happen to be animated,
206 this option will enable the animation, otherwise only the first frame will
207 be displayed.
208
209 \fINotify buddies that you are typing to them\fR: Some protocols allow
210 clients to tell their buddies when they are typing. This option enables
211 this feature for protocols that supports it.
212
213 \fIRaise IM windows on events\fR: If enabled, IM \fBConversation\fR windows
214 will be brought to the top when new messages are received.
215
216 \fIRaise Chat windows on events\fR: If enabled, chat \fBConversation\fR windows
217 will be brought to the top when new messages are received.
218
219 \fIUse multi-colored screen names in chats\fR: Color code the screen names of
220 users in chat rooms.
221
222 .TP
223 .B Tab Options
224 \fIShow IMs and chats in tabbed windows\fR: Tabbed chatting allows one to
225 have multiple conversations without multiple windows.
226
227 \fIShow close buttons on tabs\fR: Adds a close button to each tab.
228
229 \fITab Placement...\fR: Specifies where tabs are shown in the conversation
230 window.
231
232 \fI New conversation placement...\fR: Determines where new conversations will
233 be placed (Last created window / New window / windows grouped by group or
234 account / separate windows for IMs and Chats).
235
236 .TP
237 .B Message Text
238 \fIShow timestamp on messages\fR: Toggles the timestamp behavior for
239 conversations. Per-conversation behavior can be changed by pressing
240 \fIF2\fR in the \fBConversation\fR window.
241
242 \fIHighlight misspelled words\fR: Toggles highlighting of misspelled words
243 as you type.
244
245 \fIIgnore colors/font faces/font sizes\fR: Tells \fBgaim\fR to disregard
246 buddies' color/font/size information in displaying IMs or Chats.
247
248 \fIDefault Formatting\fR: Allows specifying the default formatting to apply
249 to all outgoing messages (only applicable to protocols that support
250 formatting in messages).
251
252 .TP
253 .B Shortcuts
254 Allows the user to determine which keyboard shortcuts are available.
255
256 .TP
257 .B Smiley Themes
258 Allows the user to choose between different smiley themes. The "none" theme
259 will disable graphical emoticons - they will be displayed as text instead.
260
261 .SH Sounds
262
263 \fISounds while away\fR: Determines whether sounds are played when an away
264 message is up.
265
266 \fISound Method\fR lets the user choose between different playback methods.
267 The user can also manually enter a command to be executed when a sound is
268 to be played (\fI%s\fR expands to the full path to the file name).
269
270 .TP
271 .B Sound Events
272 Lets the user choose when and what sounds are to be played.
273
274 .SH Network
275
276 .TP
277 .B IP Address
278 \fIAutodetect IP Address\fR: \fBGaim\fR will attempt to automatically determine
279 your IP address for use in file transfers and Direct IMs.
280
281 \fIPublic IP\fR: What IP address to use for file transfer and Direct IMs. This
282 is mainly useful for users with multiple network interfaces or behind NAT.
283
284 .TP
285 .B Ports
286 \fIManually specify range of ports to listen on\fR: Specify specific ports to
287 listen on, overriding any defaults.
288
289 .TP
290 .B Proxy Server
291 The configuration section to enable \fBgaim\fR to operate through a proxy
292 server. \fBgaim\fR currently supports SOCKS 4/5 and HTTP proxies.
293
294 .SH Browser
295
296 Allows the user to select \fBgaim\fR's default web browser. Firefox, Galeon,
297 Konqueror, Mozilla, Netscape and Opera are supported natively. The user
298 can also manually enter a command to be executed when a link is clicked
299 (\fI%s\fR expands to the URL). For example, \fIxterm -e lynx "%s"\fR will
300 open the link with lynx. \fIOpen new window by default\fR makes the
301 browser use a new window instead of using the current window (or spawning a
302 new tab).
303
304 .SH Logging
305
306 \fIMessage Logs\fR lets the user choose whether \fBConversations\fR and/or
307 \fBBuddy Chats\fR will be logged as well as whether logs will be in HTML or
308 plain text format. \fISystem Logs\fR describes the types of events to be
309 logged.
310
311 .SH Away / Idle
312
313 \fIQueue new messages when away\fR: Messages received since going Away will
314 not be shown until away status is removed.
315
316 \fISend auto-response\fR: If someone messages you while away, your
317 auto-response will be sent.
318
319 \fIOnly send auto-response when idle\fR: If someone messages you while
320 away, your auto-response will only be sent if \fBgaim\fR decides that the
321 connection is idle.
322
323 \fIIdle time reporting\fR: If \fINone\fR is selected, account idle time
324 will not be reported. \fIGaim usage\fR infers your idle time from your
325 usage of \fBgaim\fR. \fIX usage\fR infers your idle time from \fBX\fR
326 (this option may not be universally available).
327
328 \fIAuto-away\fR: Determines if and under what conditions \fBgaim\fR will
329 automatically turn on the Away status.
330
331 .TP
332 .B Away Messages
333 Lets the user add/edit/remove available \fBAway Messages\fR.
334
335 .SH Plugins
336
337 Allows the user to enable add-on plugins for \fBgaim\fR. Several of these
338 come with \fBgaim\fR, while others must be downloaded separately. The
339 \fIDescription\fR field gives the plugin author's description of the
340 plugin, while the \fIDetails\fR field gives the plugin's authorship, URL,
341 and file name/location information.
342
343 Some plugins can be configured. If you load such a plugin, its
344 configuration preferences will appear as a submenu to \fBPlugins\fR, with
345 the submenu title determined by the plugin's name.
346
347 .SH Protocols
348
349 Protocols provide protocol specific preferences here.
350
351 .SH CONVERSATIONS
352 When starting a new conversation, the user is presented with the
353 \fBConversation\fR window. The conversation appears in the upper text box
354 and the user types his/her message in the lower text box. Between the two
355 is a row of settings, represented by icons. Some or all buttons may not be
356 active if the protocol does not support the specific formatting. From left
357 to right:
358 .TP
359 .B Bold
360 Turns on/off bold.
361 .TP
362 .B Italics
363 Turns on/off italics.
364 .TP
365 .B Underline
366 Turns on/off underline.
367 .TP
368 .B Decrease font size
369 Increases the size of the message text.
370 .TP
371 .B Increase font size
372 Decreases the size of the message text.
373 .TP
374 .B Select a foreground color
375 Changes the foreground color of the message text.
376 .TP
377 .B Select a background color
378 Changes the background color of the message text.
379 .TP
380 .B Add image
381 Inserts an in-line image in the message.
382 .TP
383 .B Add hyperlink
384 Adds a clickable link to the message.
385 .TP
386 .B Add smiley
387 Adds an emoticon (smiley) to your message.
388
389 Beneath the lower text box is a row of buttons that execute commands:
390 .TP
391 .B Warn
392 This issues a warning to the other person in the conversation (not
393 available in all protocols).
394 .TP
395 .B Block
396 This adds the other person to your deny list (not available in all
397 protocols).
398 .TP
399 .B Send File
400 Send a file to this user. This option is only available on protocols where
401 \fBGaim\fR supports file transfer.
402 .TP
403 .B Add
404 This adds this user to your buddy list. This option is not available if
405 the user is already on your list.
406 .TP
407 .B Remove
408 This removes this user from your buddy list. This option is not available
409 if the user is not on your list.
410 .TP
411 .B Info
412 This gets information (a profile) about the other person in the
413 conversation (not available in all protocols).
414 .TP
415 .B Send
416 This sends what's currently in the lower text box
417
418 .SH BUDDY CHATS
419 For protocols that allow it, \fBBuddy Chats\fR can be entered through the
420 \fIFile\fR menu or the \fIChat\fR button at the bottom of the \fBBuddy
421 List\fR's \fBOnline\fR tab.
422
423 Additional commands available in chat, depending on the protocol are:
424 .TP
425 .B Whisper
426 The text will appear in the chat conversation, but it will only be visible
427 to the sender and the receiver.
428 .TP
429 .B Invite
430 Invite other people to join the chat room.
431 .TP
432 .B Ignore
433 Ignore anything said by the chosen person
434 .TP
435 .B Set Topic
436 Set the topic of the chat room. This is usually a brief sentence
437 describing the nature of the chat--an explanation of the chat room's name.
438
439 .SH AWAY MESSAGES
440 Most protocols allow for away messages. When a user is \fIAway\fR, he can
441 leave an informative message for others to see. The \fBAway\fR submenu of
442 the \fBTools\fR menu is used to add and remove away messages.
443
444 \fINew Away Message\fR provides space for one to enter an away message and
445 a title for that message. If \fISave\fR or \fISave & Use\fR are chosen,
446 this message will be saved. It can later be referred to by the title given
447 to it.
448
449 \fIRemove Away Message\fR is a submenu containing the titles of saved away
450 messages. Clicking on one of these titles will remove the away message
451 associated with it.
452
453 The rest of the \fIaway\fR menu provides the user with a way to assign
454 different away messages to different connections. Choosing \fISet All
455 Away\fR will set away all the connections capable of the away state.
456
457 .SH BUDDY POUNCE
458 A Buddy Pounce is an automated trigger that occurs when a buddy returns to
459 a normal state from an away state. The \fBNew Buddy Pounce\fR dialog box
460 can be activated by selecting the \fIBuddy Pounce\fR submenu from the
461 \fBTools\fR menu. A pounce can be set to occur on any combination of the
462 events listed, and any combination of actions can result. If \fISave this
463 pounce after activation\fR is checked, the trigger will remain until it is
464 removed from the \fIRemove Buddy Pounce\fR menu.
465
466 .SH PLUGINS
467 \fBGaim\fR allows for dynamic loading of plugins to add extra functionality
468 to \fBgaim\fR. Plugins can be enabled and configured from the
469 \fBPreferences\fR window. See \fIplugins/HOWTO\fR for more information on
470 writing plugins.
471
472 .SH PERL
473 \fBGaim\fR allows for perl scripting. See \fIPerl Scripting HOWTO\fR in
474 the Gaim documentation for more information about perl scripting.
475
476 .SH TCL
477 \fBGaim\fR allows for Tcl scripting. See \fIplugins/tcl/TCL-HOWTO\fR for
478 more information about Tcl scripting.
479
480 .SH FILES
481 \fI@prefix@/bin/gaim\fR: \fBgaim\fR's location.
482 .br
483 \fI@prefix@/lib/gaim/\fR: \fBgaim\fR's plugins directory.
484 .br
485 \fI~/.gaim/prefs.xml\fR: \fBgaim\fR's configuration file.
486 .br
487 \fI~/.gaim/accounts.xml\fR: information about your accounts.
488 .br
489 \fI~/.gaim/status.xml\fR: stores your away messages.
490 .br
491 \fI~/.gaim/pounces.xml\fR: stores your buddy pounces.
492 .br
493 \fI~/.gaim/logs/PROTOCOL/ACCOUNT/SCREENNAME/DATE.log\fR: conversation logs.
494 .br
495 \fI~/.gaim/blist.xml\fR: the buddy list.
496 .br
497 \fI~/.gaim/plugins/\fR: users local plugins
498
499 .SH BUGS
500 Known bugs are listed at
501 .br
502 \fIhttp://sourceforge.net/tracker/?group_id=235&atid=100235\fR
503
504 .SH PATCHES
505 If you fix a bug in \fBgaim\fR (or otherwise enhance it), please submit a
506 patch (using \fIcvs diff -up > my.diff\fR against the latest CVS version)
507 at
508 .br
509 \fIhttp://sourceforge.net/tracker/?func=add&group_id=235&atid=300235\fR
510
511 Before sending a bug report, please verify that you have the latest
512 version of \fBgaim\fR. Many bugs (major and minor) are fixed
513 at each release, and if yours is out of date, the problem may already
514 have been solved.
515
516 .SH SEE ALSO
517 \fIhttp://gaim.sourceforge.net/\fR
518 .br
519 \fIhttp://www.sourceforge.net/projects/gaim/\fR
520
521 .SH LICENSE
522 This program is free software; you can redistribute it and/or modify
523 it under the terms of the GNU General Public License as published by
524 the Free Software Foundation; either version 2 of the License, or
525 (at your option) any later version.
526
527 This program is distributed in the hope that it will be useful, but
528 \fBWITHOUT ANY WARRANTY\fR; without even the implied warranty of
529 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
530 General Public License for more details.
531
532 You should have received a copy of the GNU General Public License
533 along with this program; if not, write to the Free Software
534 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
535
536 .SH AUTHORS
537 \fBGaim\fR's active developers are:
538
539 Sean Egan (lead developer) <\fIseanegan@gmail.com\fR>
540 .br
541 Daniel 'datallah' Atallah
542 .br
543 Ethan 'Paco-Paco' Blanton (developer)
544 .br
545 Mark 'KingAnt' Doliner (developer) <\fIthekingant@users.sourceforge.net\fR>
546 .br
547 Christian 'ChipX86' Hammond (developer & webmaster) <\fIchipx86@chipx86.com\fR>
548 .br
549 Gary 'grim' Kramlich
550 .br
551 Richard 'rlaager' Laager <\fIrlaager@users.sf.net\fR>
552 .br
553 Christopher 'siege' O'Brien
554 .br
555 Etan 'deryni' Reisner
556 .br
557 Tim 'marv' Ringenbach <\fImarv_sf@users.sf.net\fR>
558 .br
559 Luke 'LSchiere' Schierer (support)
560 .br
561 Stu 'nosnilmot' Tomlinson
562 .br
563 Nathan 'faceprint' Walp (developer)
564 .br
565
566
567 Our crazy patch writers include:
568
569 Ka-Hing 'javabsp' Cheung
570 .br
571 Sadrul Habib Chowdhury
572 .br
573 Felipe 'shx' Contreras
574 .br
575 Decklin Foster
576 .br
577 Peter 'Bleeter' Lawler
578 .br
579 Robert 'Robot101' McQueen
580 .br
581 Benjamin Miller
582 .br
583 Kevin 'SimGuy' Stange
584 .br
585
586
587 The retired developers of \fBgaim\fR are:
588
589 Herman Bloggs (win32 port) <\fIherman@bluedigits.com\fR>
590 .br
591 Jim Duchek <\fIjim@linuxpimps.com\fR> (maintainer)
592 .br
593 Rob Flynn <\fIgaim@robflynn.com\fR> (maintainer)
594 .br
595 Adam Fritzler (libfaim maintainer)
596 .br
597 Syd Logan (hacker and designated driver [lazy bum])
598 .br
599 Jim Seymour (Jabber developer)
600 .br
601 Mark Spencer (original author) <\fImarkster@marko.net\fR>
602 .br
603 Eric Warmenhoven (former lead developer) <\fIeric@warmenhoven.org\fR>
604 .br
605
606 This manpage was originally written by Dennis Ristuccia <\fIdennis@dennisr.net\fR>. It has been updated and largely rewritten by Sean Egan <\fIseanegan@gmail.com\fR> and Ben Tegarden <\fItegarden@uclink.berkeley.edu\fR>.

mercurial