doc/gaim.1

   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 v0.56 \- Instant Messaging client
  25 .SH SYNOPSIS
  26 .TP 5
  27 \fBgaim \fI[options]\fR
  28
  29 .SH DESCRIPTION
  30 .PP
  31 \fBgaim\fR is an Instant Messaging (IM) client designed primarily for use with AOL Instant Messager (AIM).  However, it supports most other popular IM protocols including ICQ, MSN Messager, Jabber, Yahoo!, IRC, Napster, and Zephyr.
  32
  33 .SH OPTIONS
  34 The following options are provided by \fBgaim\fR using the standard GNU command line syntax.
  35 .TP
  36 .B \-a, \-\-acct
  37 Launch the \fBaccount editor\fR rather than the login window on start.
  38 .TP
  39 .B \-w, \-\-away[=MESG]
  40 Automatically go away on signon.  You may optionally use the MESG parameter to set the away message.
  41 .TP
  42 .B \-l, \-\-login[=NAME]
  43 Automatically login on start using the default account or the account specified by the NAME parameter.
  44 .TP
  45 .B \-u, \-\-user=NAME
  46 Use account NAME as default.
  47 .TP
  48 .B \-f, \-\-file=FILE
  49 Use FILE as the configuration file instead of ~/.gaimrc.
  50
  51 .SH BUDDY LIST
  52 The \fBBuddy List Window\fR is \fBgaim\fR's main interface window.  The focus of this window is the \fBBuddy List\fR itself.  This is a list of your contacts whose presence you have been notified of.
  53
  54 The list of buddies is organized into groups.  \fBGaim\fR supports multiple connections, but all online buddies are organized on the same buddy list.  Buddy List organization is handled in the \fBEdit Buddies\fR tab.
  55
  56 Buddy Lists can be imported and exported to disk using the appropriate commands in the \fIfile\fR menu.
  57
  58 The icon to the left of each buddy indicates the buddy's current state.  Double clicking a buddy will open a new \fBconversation window\fR.  Right clicking will open a menu:
  59 .TP
  60 .B IM
  61 Opens a new \fBconversation window\fR to the selected buddy.
  62 .TP
  63 .B Alias
  64 Create an alias for this buddy.  This will open up a new dialog in which one can give this buddy an alternate name to appear on the buddy list and in conversataions.
  65
  66 For example, if a buddy's name screen name was jsmith1281xx and his real name was 'John Q. Smith,' one could create an alias as to identify the buddy by his common name.
  67 .TP
  68 .B Add Buddy Pounce
  69 A Buddy Pounce is a configurable automated action to be performed when the buddy's state changes.  This will open the \fBBuddy Pounce\fR dialog to be discussed later.
  70 .TP
  71 .B View Log
  72 \fBgaim\fR is capable of automatically log its activities.  These logs are html files (with a .log extenstion) located in the ~/.gaim/logs directory.  This menu command will attempt to view this file with \fBgaim's\fR internal log viewer.
  73 .LP
  74 The remainder of the menu will consist of protocol specific commands.  If logged on with multiple connections, these will appear in submenus named with each screen name logged on.  These commands vary depending on the protocol; below are the commands available when using OSCAR, the more popular and developer-recommended AIM protocol:
  75 .TP
  76 .B Get Info
  77 Retrieves and displays information about the buddy.  This information is also known as a Profile.
  78 .TP
  79 .B Get Away Msg
  80 If this buddy is in an Away state, this will retrieve and display the buddy's \fBAway Message\fR.
  81 .TP
  82 .B Direct IM
  83 This will send a request to the buddy for a \fBDirect IM\fR.  If accepted, a direct connection will be made between the two clients, no longer relying on the server.  This will reveal your IP address to your buddy, which may constitute a security risk.
  84
  85 .SH The Conversation Window
  86 When starting a new conversation, the user is presented with the conversation window.  The conversation appears in the upper text box and the user types his message in the lower.  Between the two is a row of setting, represented by icons.  From left to right:
  87 .TP
  88 .B Bold
  89 adds <b></b> to your message
  90 .TP
  91 .B Italics
  92 adds <i></i> to your message
  93 .TP
  94 .B Underline
  95 adds <u></u> to your message
  96 .TP
  97 .B Strikethrough
  98 adds <s></s> to your message
  99 .TP
 100 .B Decrease font size
 101 adds <font size="1"></font> to your message
 102 .TP
 103 .B Default font size
 104 adds <font size="3"></font> to your message
 105 .TP
 106 .B Increase font size
 107 adds <font size="5"></font> to your message
 108 .TP
 109 .B Select font face
 110 adds an appropriate font tag to your message.
 111 .TP
 112 .B Select a foreground color
 113 adds an appropriate font tag to your message.
 114 .TP
 115 .B Select a background color
 116 adds an appropriate body tag to your message.
 117 .TP
 118 .B Add hyperlink
 119 adds an appropriate a href tag to your message.
 120 .TP
 121 .B Add smiley
 122 adds an ASCII smiley to your message.  This will become a graphic smiley in the upper textbox if the option for graphical smileys is set.
 123 .TP
 124 .B Enable logging
 125 As the conversation continues, everything will get logged to a log file in ~/.gaim/logs
 126 .TP
 127 .B Save Conversation
 128 Saves the current conversation to a log file of your choice.
 129 .TP
 130 .B Enable Sounds
 131 Choose whether events in this conversation will trigger sounds.
 132
 133 Beneath the lower textbox is a row of buttons that execute commands:
 134 .TP
 135 .B Send
 136 This sends what's currently in the lower textbox
 137 .TP
 138 .B Get Info
 139 This gets information (a profile) about the other person in the conversation.
 140 .TP
 141 .B Warn
 142 This issues a warning to the other person in the conversation.
 143 .TP
 144 .B Block
 145 This adds the other person to your deny list.
 146 .TP
 147 .B Add to buddy list
 148 This adds this user to your buddy list.  If he already is on your list, it will remove him from it.
 149 .TP
 150 .B Close
 151 Closes this window.
 152
 153
 154 .SH Edit Buddies
 155 Clicking this tab on the \fBBuddy List Window\fR will invoke the main interface to edit and organize buddy lists.  Buddy's already in your buddy list can be moved to different groups or reordered in the same group by clicking and dragging with the mouse.  One can also add, rename, alias, or delete buddies here, as well as some of the functions available in the \fBBuddy List Dialog\fR.
 156
 157 In the \fBEdit Buddies\fR dialog, the list is arranged by connection.  If two or more connections have a group of the same, the \fBBuddy List\fR will only show one group with that name.  Available buddies from \fIboth\fR connections will be shown in this group.  If both connections have a buddy with the same screen name in a group of the same name, the buddy will appear only once.
 158
 159 .SH Buddy Chat
 160 For protocols that allow it, \fBBuddy Chats\fR can be entered through the file menu, the keyboard shortcut \fICTRL+C\fR, or the right most button on the bottom of the \bBBuddy List Dialog\fR.
 161
 162 Additional commands available in chat, depending on the protocol are:
 163 .TP
 164 .B Whisper
 165 The text will appear in the chat conversation, but it will only be visible to the sender and the receiver.
 166 .TP
 167 .B Invite
 168 Invite other people to join the chat room.
 169 .TP
 170 .B Ignore
 171 Ignore anything said by the chosen person
 172 .TP
 173 .B Set Topic
 174 Set the topic of the chat room.  This is usually a brief sentence describing the nature of the chat--an explanation of the chat room's name.
 175
 176 .SH AWAY MESSAGES
 177 Most protocols allow for away messages.  When a user is \fIaway\fR, he can leave a message indicating why for others to see.  The \fBaway\fR submenu of the \fBTools\fR menu is used to add and remove away message, as well as to set a user's away state.
 178
 179 \fINew Away Message\fR provides space for one to enter an away message and a title for that message.  If \fISave\fR of \fISave & Use\fR are chosen, this message will be saved.  It can later be referred to by the title given to it.
 180
 181 \fIRemove Away Message\fR is a submenu containing the titles of saved away messages.  Clicking on one of these titles will remove the away message associated with it.
 182
 183 The rest of the \fIaway\fR menu provides the user with a way to assign different away messages to different connections.  Choosing \fISet All Away\fR will set away all the connections capable of the away state.
 184
 185 .SH BUDDY POUNCE
 186 A Buddy Pounce is an automated trigger that occurs when a buddy returns to a normal state from an away state.  A pounce can be set to occur on any combination of the events listed, and any combination of actions can result.  If \fISave this pounce after activation\fR is checked, the trigger will remain until it is removed from the \fIRemove buddy pounce\fR menu.
 187
 188 .SH ACCOUNT EDITOR
 189 The account editor consists of a list of accounts and information about them.  Clicking \fIAdd\fR or \fIModify\fR will invoke a \fIModify Account\fR window.  Here, you can alter information about your account.  When creating a new account, you will submit your screen name and password.  You will also choose your protocol; The two AIM protocols, TOC and OSCAR are always loaded, but other protocols can be dynamically loaded and unloaded using \fBProtocols Plugins (PRPLS)\fR.
 190
 191 If \fBRemember Password\fR is chosen, the password will be saved in \fBgaim's\fR configuration file.
 192
 193 If \fBAuto-Login\fR is chosen, this account will automatically login upon starting \fBgaim\fR.
 194
 195 Each protocol has it's own specific options that can be found in the protocol-specific tab on the modify screen.
 196
 197 .SH PERL
 198 \fBGaim\fR allows for perl scripting.  This submenu provides for the loading of individual perl scripts and for the unloading of all of them.  See PERL-HOWTO for more information about perl scripting.
 199
 200 .SH PLUGINS
 201 \fBGaim\fR allows for dynamic loading of plugins.  The plugin window shows the paths to loaded plugins on the left, and the name and description of the plugin on the right.
 202
 203 You may load and unload plugins using the appropriate buttons.
 204
 205 .SH PREFERENCES
 206 .SH General
 207 .TP
 208 .B Use Borderless Buttons
 209 Change the appearence of the GUI's buttons.
 210 .TP
 211 .B Show Buddy Ticker
 212 This opens the \fBBuddy Ticker\fR, a small window in which the contents of your buddy list scroll to keep you up to date on their status.
 213 .TP
 214 .B Show Debug Window
 215 This opens a debug window into which \fBgaim\fR sends more verbose information about what it's doing.
 216 .TP
 217 .B Report Idle Times
 218 For protocol's that require the client to report idle times, this option sets the method of determining idle times.  If \fINone\fR is chosen, idleness will not be reported.  If \fIGaim Use\fR is chosen, it will send idle times relative to the last time \fBgaim\fR was used.  If \fIX Use\fR is chosen, idle times will be reported based on the last time the mouse or keyboard was used.
 219 .TP
 220 .B Logging
 221 Log all conversations will automatically log conversations into ~/.gaim/logs/.  Unless \fIStrip HTML from logs\fR is checked, they will be saved as an HTML file with a .log extension.  The preferences window provides options to specify exactly what to log.
 222 .TP
 223 .B Browser
 224 Choose the Web Browser to use when a hyperlink is clicked.
 225 .SH Buddy List
 226 .TP
 227 .B Hide IM/Info/Chat buttons
 228 This option will remove the three buttons beneath the \fBBuddy List\fR in the \fBBuddy List Window\fR.
 229 .TP
 230 .B Show pictures on buttons
 231 If checked, the buttons will feature an icon, otherwise, the buttons will be text.
 232 .TP
 233 .B Hide groups with no online buddies
 234 This feature will only display a folder representing a group if there is at least one online buddy in it.
 235 .TP
 236 .B Show numbers in groups
 237 This feature displays the number of buddies in each group and the number of these online in the \fBBuddy List\fR.
 238 .TP
 239 .B Show buddy type icons
 240 This icon is a quick reference as to what protocol a buddy is using, and what away state, if any, he is in.
 241 .TP
 242 .B Show Idle times
 243 This shows how long a buddy has been idle next to his name.
 244 .B Show warning levels
 245 This shows the warning level of a buddy next to his name.
 246 .SH Conversations
 247 .TP
 248 .B Keyboard Options
 249 These options set certain keybindings.
 250 .TP
 251 .B Show graphical smileys
 252 This will convert emoticons such as :) and >:-O to small icons representing them.
 253 .TP
 254 .B Show timestamp on messages
 255 When selected, this option shows in the conversation window, the time each message was received or sent.
 256 .TP
 257 .B Show URLs as links
 258 This will convert URLs such as http://gaim.sourceforge.net to a hyperlink pointing to that site.
 259 .TP
 260 .B Highlight misspelled words
 261 While typing a message, if a user misspells a word, it will immediately turn red.  Right-clicking on the word will invoke a menu of possible corrections.
 262 .TP
 263 .B Sending messages removes away status
 264 If this option is selected, a user will come back from \fBaway\fR if he sends a message to someone.
 265 .TP
 266 .B Queue new messages when away
 267 This option will cause new conversation windows not to be created until a user returns from away.  Instead, a record of how many messages received and from whom they were received is shown in the away message window.
 268 .TP
 269 .B Ignore colors/font faces/ font sizes
 270 These options ignore font settings that can be set in HTML tags.
 271 .TP
 272 .B Ignore TiK Automated Messages
 273 AOL's open source TiK client gets a user's away message by sending him an automated message.  This option ignores those messages.
 274 .TP
 275 .B Ignore new conversations when away
 276 If checked, new conversations will be ignored entirely when away.  Unlike the \fBQueue new messages when away\fR option, no record will be kept of these.
 277 .SH Windows
 278 .TP
 279 .B Show buttons as:
 280 This option selects the look of the buttons.
 281 .TP
 282 .B Show all conversations in one tabbed window
 283 Instead of seperate windows for each conversation, they are all shown in one window with tabs at the top to select the conversation.  A name on a tab will become red if a new message hasn't yet been read.
 284 .TP
 285 .B Raise windows on events
 286 When an event happens to a conversation, the conversation window will be raised above all other windows on the desktop.
 287 .TP
 288 .B Show logins in window
 289 This will show when buddies log in and out in the conversation window, if one is open for that buddy.
 290 .TP
 291 .B Window size
 292 Select the default size for new conversation windows.
 293 .SH Font Options
 294 .TP
 295  These set the font preferences that are sent with all messages over a protocol that supports HTML.
 296 .SH Chat Rooms
 297 .TP
 298 This is a list of available chat rooms and chat rooms that you are subscribed to.
 299 .SH Sounds
 300 .TP
 301 .B No sounds when you log in
 302 This will prevent sounds from playing when \fBgaim\fR is first notified of your buddy's presence because you just signed on.
 303 .TP
 304 .B Sounds while away
 305 This option will continue to play sounds on events if you are away.
 306 .TP
 307 .B Beep instead of playing sound
 308 This will cause a terminal beep instead of a sound upon events.
 309 .TP
 310 .B Command to play sound files
 311 If you need a special command executed to play a sound, enter it in the given box with %s representing the filename.  If you prefer \fBgaim\fR to play the sound, leave it blank.
 312 .TP
 313 .B Events
 314 Choose sounds to play when each event occurs.
 315 .SH Away Messages
 316 .TP
 317 .B Don't send auto-response
 318 If someone sends the user a message while away, \fBgaim\fR will not respond with the away message if this is checked.
 319 .TP
 320 .B Auto Away
 321 If this is selected \fBgaim\fR will automatically go away if it's been idle for the specified length of time.
 322 .SH Privacy
 323 .TP
 324 Here, the user can configure his permit/deny lists.
 325
 326
 327
 328 .SH FILES
 329 ~/.gaimrc \- Gaim Config File
 330 .br
 331 ~/.gaim/logs/SCREENNAME.log \- a log of all conversation with SCREENNAME.
 332 .br
 333 /usr/local/lib/gaim/ \- Gaim Plugin Files
 334 .br
 335 ~/.gaim/SCREENAME.PROTOCOL.blist \- the buddy list for SCREENAME using protocol number PROTOCOL
 336 .SH BUGS
 337 Known bugs are at http://sourceforge.net/bugs/?group_id=235
 338 .SH BUG REPORTS
 339 If you find a bug in \fBgaim\fR, please submit a bug form at
 340 http://sourceforge.net/bugs/?group_id=235
 341 .PP
 342 Before sending a bug report, please verify that you have the latest
 343 version of \fBgaim\fR.  Many bugs (major and minor) are fixed
 344 at each release, and if yours is out of date, the problem may already
 345 have been solved.
 346
 347 .SH SEE ALSO
 348 \fIhttp://gaim.sourceforge.net/\fR
 349 \fIhttp://www.sourceforge.net/projects/gaim/\fR
 350
 351 .SH LICENSE
 352 This program is free software; you can redistribute it and/or modify
 353 it under the terms of the GNU General Public License as published by
 354 the Free Software Foundation; either version 2 of the License, or
 355 (at your option) any later version.
 356 .PP
 357 This program is distributed in the hope that it will be useful, but
 358 \fBWITHOUT ANY WARRANTY\fR; without even the implied warranty of
 359 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 360 General Public License for more details.
 361 .PP
 362 You should have received a copy of the GNU General Public License
 363 along with this program; if not, write to the Free Software
 364 Foundation, Inc., 59 Temple PLace, Suite 330, Boston, MA  02111-1307  USA
 365 .SH AUTHORS
 366 The authors of \fBgaim\fR are:
 367 .PP
 368  Rob Flynn <rob@marko.net> \- AIM: RobFlynn
 369 .br
 370  Sean Egan <bj91704@binghamton.edu> \- AIM: SeanEgn
 371 .br
 372  Syd Logan
 373
 374 The retired authors of \fBgaim\fR are:
 375 .PP
 376  Jim Duchek <jim@linuxpimps.com> \- AIM: Zilding
 377 .br
 378  Eric Warmenhoven <eric@warmenhoven.org>
 379 .br
 380  Mark Spencer <markster@marko.net> \- AIM: Markster97
 381
 382
 383 .PP
 384
 385 This manpage was originally written by Dennis Ristuccia <dennis@dennisr.net> AIM: D3nnisR.  It has been updated and largely rewritten by Sean Egan <sean@posseweb.org> AIM: SeanEgn
 386
 387 .\" WOO!
 388 .\" Agreed, Dennis, agreed.