Mercurial > pidgin.yaz
comparison doc/gaim.1 @ 4340:f418708d4184
[gaim-migrate @ 4604]
Benjamin Tegarden (tegarden) writes:
"Updated the man page to be in line with the changes
made for v0.60cvs. Made sure all options listed still
existed, etc, etc"
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Sat, 18 Jan 2003 15:51:47 +0000 |
parents | ac5a1d04bc7b |
children | 6fc8edf857f5 |
comparison
equal
deleted
inserted
replaced
4339:78bc4c8e4b2e | 4340:f418708d4184 |
---|---|
19 .\" License along with this manual; if not, write to the Free | 19 .\" License along with this manual; if not, write to the Free |
20 .\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, | 20 .\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, |
21 .\" USA. | 21 .\" USA. |
22 .TH gaim 1 | 22 .TH gaim 1 |
23 .SH NAME | 23 .SH NAME |
24 Gaim v0.59 \- Instant Messaging client | 24 Gaim v0.60cvs \- Instant Messaging client |
25 .SH SYNOPSIS | 25 .SH SYNOPSIS |
26 .TP 5 | 26 .TP 5 |
27 \fBgaim \fI[options]\fR | 27 \fBgaim \fI[options]\fR |
28 | 28 |
29 .SH DESCRIPTION | 29 .SH DESCRIPTION |
30 .PP | 30 .PP |
31 \fBgaim\fR is a GTK-based 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, Zephyr, and Gadu-Gadu. | 31 \fBgaim\fR is a GTK2-based Instant Messaging (IM) client designed primarily for use with AOL Instant Messager (AIM). However, it supports most other popular IM protocols including Gadu-Gadu, ICQ, IRC, Jabber, MSN Messager, Napster, Yahoo!, and Zephyr. |
32 | 32 |
33 .SH OPTIONS | 33 .SH OPTIONS |
34 The following options are provided by \fBgaim\fR using the standard GNU command line syntax. | 34 The following options are provided by \fBgaim\fR using the standard GNU command line syntax: |
35 .TP | 35 .TP |
36 .B \-a, \-\-acct | 36 .B \-a, \-\-acct |
37 Launch the \fBaccount editor\fR rather than the login window on start. | 37 Launch the \fBAccount Editor\fR rather than the \fBLogin\fR window on start. |
38 .TP | 38 .TP |
39 .B \-d, \-\-debug | 39 .B \-d, \-\-debug |
40 Print debugging messages to stdout. These are the same debugging messages that are displayed in the \fBdebug window\fR. | 40 Print debugging messages to stdout. These are the same debugging messages that are displayed in the \fBDebug\fR window. |
41 .TP | 41 .TP |
42 .B \-f, \-\-file=FILE | 42 .B \-f, \-\-file=\fIFILE\fB |
43 Use FILE as the configuration file instead of ~/.gaimrc. | 43 Use \fIFILE\fR as the configuration file instead of \fI~/.gaimrc\fR. |
44 .TP | 44 .TP |
45 .B \-h, \-\-help | 45 .B \-h, \-\-help |
46 Print this help and exit. | 46 Print this help and exit. |
47 .TP | 47 .TP |
48 .B \-l, \-\-login[=NAME] | 48 .B \-l, \-\-login[=\fINAME\fB] |
49 Automatically login on start using the default account or the account specified by the NAME parameter. | 49 Automatically login on start using the default account or the account specified by the \fINAME\fR parameter. |
50 .TP | 50 .TP |
51 .B \-u, \-\-user=NAME | 51 .B \-n, \-\-loginwin |
52 Use account NAME as default. | 52 Don't automatically login when \fBgaim\fR starts. Show the \fBLogin\fR window instead. |
53 .TP | |
54 .B \-u, \-\-user=\fINAME\fB | |
55 Use account \fINAME\fR as default. | |
53 .TP | 56 .TP |
54 .B \-v, \-\-version | 57 .B \-v, \-\-version |
55 Display the version information window. | 58 Display the version information window. |
56 .TP | 59 .TP |
57 .B \-w, \-\-away[=MESG] | 60 .B \-w, \-\-away[=\fIMESG\fB] |
58 Automatically go away on signon. You may optionally use the MESG parameter to set the away message. | 61 Automatically go away on signon. You may optionally use the \fIMESG\fR parameter to set the away message. |
59 | 62 |
60 .SH BUDDY LIST | 63 .SH BUDDY LIST |
61 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. | 64 The \fBBuddy List\fR window is \fBgaim\fR's main interface window. The focus of this window is the \fBBuddy List\fR itself, shown in the \fBOnline\fR pane. Buddy list organization and editing is handled in the \fBEdit Buddies\fR pane. |
62 | 65 |
63 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. | 66 Buddy Lists can be imported by using the \fIImport Buddy List\fR command in the \fIFile\fR menu. |
64 | 67 |
65 Buddy Lists can be imported and exported to disk using the appropriate commands in the \fIfile\fR menu. | 68 .SH Online Pane |
66 | 69 The \fBOnline\fR pane contains a list of your buddies who are online and have allowed you to be notified of their presence. The icon to the left of each buddy (if enabled in \fBgaim\fR's \fBPreferences\fR) indicates the buddy's current state. Double clicking a buddy will open a new \fBConversation\fR window. Right clicking will pop up a menu: |
67 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: | |
68 .TP | 70 .TP |
69 .B IM | 71 .B IM |
70 Opens a new \fBconversation window\fR to the selected buddy. | 72 Opens a new \fBConversation\fR window to the selected buddy. |
71 .TP | 73 .TP |
72 .B Alias | 74 .B Alias |
73 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. | 75 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. |
74 | 76 |
75 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. | 77 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. |
76 .TP | 78 .TP |
77 .B Add Buddy Pounce | 79 .B Add Buddy Pounce |
78 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. | 80 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. |
79 .TP | 81 .TP |
80 .B View Log | 82 .B View Log |
81 \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. | 83 \fBgaim\fR is capable of automatically log its activities. These logs are html files (with a .log extenstion) located in the \fI~/.gaim/logs\fR directory. This menu command will attempt to view this file with \fBgaim\fR's internal log viewer. |
82 .LP | 84 .LP |
83 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: | 85 The remainder of the menu will consist of protocol specific commands. These commands vary depending on the protocol; below are the commands available when using OSCAR, the more popular and developer-recommended AIM protocol: |
84 .TP | 86 .TP |
85 .B Get Info | 87 .B Get Info |
86 Retrieves and displays information about the buddy. This information is also known as a Profile. | 88 Retrieves and displays information about the buddy. This information is also known as a Profile. |
87 .TP | 89 .TP |
88 .B Get Away Msg | 90 .B Get Away Msg |
89 If this buddy is in an Away state, this will retrieve and display the buddy's \fBAway Message\fR. | 91 If this buddy is in an Away state, this will retrieve and display the buddy's \fBAway Message\fR. |
90 .TP | 92 .TP |
91 .B Direct IM | 93 .B Get Capabilities |
92 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. | 94 Retrieves and displays the client capabilities of your buddy. |
93 | 95 .LP |
94 .SH The Conversation Window | 96 At the bottom of the pane are several buttons (if enabled in \fBPreferences\fR): |
95 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: | 97 .TP |
98 .B IM | |
99 Opens a new \fBConversation\fR window to to the selected buddy, or brings up the \fBNew Message\fR dialog box if no buddy is selected. | |
100 .TP | |
101 .B Info | |
102 Retrieves and display information about the selected buddy, or brings up the \fBGet User Info\fR dialog box if no buddy is selected. | |
103 .TP | |
104 .B Chat | |
105 Brings up the \fBJoin Chat\fR dialog box, prompting the user to select which username to use and what chat group to join. | |
106 .TP | |
107 .B Away | |
108 Brings up a menu of all available \fBAway Messages\fR. If an item is selected, all online accounts will use this item as their away message. | |
109 | |
110 .SH Edit Buddies Pane | |
111 Clicking the \fBEdit Buddies\fR tab on the \fBBuddy List Window\fR will invoke the main interface to edit and organize buddy lists. Buddies 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 access some of the functions available in the \fBBuddy List Dialog\fR. | |
112 | |
113 At the bottom of the pane are several buttons: | |
114 .TP | |
115 .B Add | |
116 This brings up the \fBAdd Buddy Dialog\fR, where you can add a buddy to your buddy list. | |
117 .TP | |
118 .B Group | |
119 This brings up the \fBAdd Group Dialog\fR, where you can add a group to the current connection (the connection with an item selected, otherwise the top-most connection). | |
120 .TP | |
121 .B Remove | |
122 This removes the currently selected buddy or group. If no buddy or group is selected, no action is taken. | |
123 | |
124 .SH ACCOUNT EDITOR | |
125 The account editor consists of a list of accounts and information about them. Clicking \fIDelete\fR will delete the currently selected account. Clicking \fIAdd\fR or \fIModify\fR will invoke a \fBModify Account\fR window. Here, you can add or alter account information. When creating a new account, you will submit your screen name and password. You will also choose your protocol. The AIM protocol, OSCAR, is always loaded, but other protocols can be dynamically loaded and unloaded using \fBProtocols Plugins\fR (PRPLS). | |
126 | |
127 If \fIRemember Password\fR is chosen, the password will be saved in \fBgaim\fR's configuration file. | |
128 | |
129 If \fIAuto-Login\fR is chosen, this account will automatically login upon starting \fBgaim\fR. | |
130 | |
131 Each protocol has it's own specific options that can be found in the protocol-specific tab on the modify screen. | |
132 | |
133 .SH PREFERENCES | |
134 | |
135 All options take effect immediately. | |
136 | |
137 .SH Interface | |
138 | |
139 \fIShow debug window\fR: Makes visable \fBgaim\fR's debugging window, which displays more verbose operating information. A must for bug-tracking. | |
140 | |
141 \fIDisplay remote nicknames if no alias is set\fR: Toggles whether server nickname data should be used if no local alias exists. | |
142 | |
143 .TP | |
144 .B Themes | |
145 Allows the user to choose between different emoticon themes. | |
146 .TP | |
147 .B Fonts | |
148 Lets the user pick a default font style/face/color for all accounts (only available in protocols that accept HTML messages). | |
149 .TP | |
150 .B Message Text | |
151 \fIShow graphical smileys\fR: Enables the replacement of text emoticons with their graphical equivalents. | |
152 | |
153 \fIShow timestamp on messages\fR: Toggles the timestamp behavior for conversations. Per-conversation behavior can be changed by pressing \fIF2\fR in the \fBConversation\fR window. | |
154 | |
155 \fIShow URLs as links\fR: Enables the translation of URLs (such as \fIhttp://gaim.sourceforge.net\fR) into clickable links. | |
156 | |
157 \fIIgnore colors/font faces/font sizes\fR: Tells \fBgaim\fR to disregard buddies' color/font/size information in displaying IMs or Chats. | |
158 .TP | |
159 .B Shortcuts | |
160 Allows the user to determine which keyboard shortcuts are available. | |
161 .TP | |
162 .B Buddy List | |
163 \fIHide IM/Info/Chat buttons\fR: Disables the display of these buttons on the | |
164 \fBBuddy List\fR's \fBOnline\fR pane. | |
165 | |
166 \fIShow pictures on buttons\fR: Toggles between picture-only and text-only views of the buttons on the \fBBuddy List\fR. | |
167 | |
168 \fISave window size/position\fR: If enabled, \fBgaim\fR will place the \fBBuddy List\fR at its last screen position at start-up. | |
169 | |
170 \fIRaise window on events\fR: Tells \fBgaim\fR to bring the \fBBuddy List\fR window to the top when buddies sign in or out. | |
171 | |
172 \fIHide groups with no online buddies\fR: Groups in which no buddies are currently logged in will not be shown in the \fBOnline\fR pane. | |
173 | |
174 \fIShow numbers in groups\fR: The number of buddies from each group currently logged in will be shown along with the total number of buddies in the group. | |
175 | |
176 \fIShow buddy type icons\fR: The icons showing which protocol each buddy uses and whether or not the buddy is away will not be shown. | |
177 | |
178 \fIShow warning levels\fR: Each buddy's warning level will be displayed next to the screen name. As a buddy's warning level increases, outgoing messages are more and more severely rate-limited. | |
179 | |
180 \fIShow idle times\fR: The amount of time each buddy has been idle will be displayed next to the screen name (if the buddy has opted to have their client report this information). | |
181 | |
182 \fIGrey idle buddies\fR: If enabled, idle buddies will be displayed in grey text instead of black text. | |
183 .TP | |
184 .B IM Window | |
185 \fIShow buttons as...\fR: The selected item will determine whether picture-only, text-only, or combined picture/text buttons will be used for \fBConversation\fR windows. | |
186 | |
187 \fINew window width/height...\fR: The values here determine how large \fBConversation\fR windows are by default. However, each window can be independently resized. | |
188 | |
189 \fIEntry widget height...\fR: This value controls the size of the entry widget (the part of the \fBConversation\fR window where you type). It should not be made greater than the \fINew window height\fR. | |
190 | |
191 \fIRaise windows on events\fR: If enabled, \fBConversation\fR windows will be brought to the top when new messages are received. | |
192 | |
193 \fIHide window on send\fR: If enabled, \fBConversation\fR windows will be iconified after each message is sent. | |
194 | |
195 \fIHide buddy icons\fR: For protocols that support it, buddy icons allow buddies to send small pictures to be displayed during the course of a conversation. This option hides those pictures. | |
196 | |
197 \fIDisable buddy icon animation\fR: If these pictures happen to be animated, this option will disable the animation, displaying only the first frame. | |
198 | |
199 \fIShow logins in window\fR: If currently conversing with a buddy who signs off or on, this information will be shown in the \fBConversation\fR window. | |
200 | |
201 \fINotify buddies that you are typing to them\fR: Some protocols allow clients to tell their buddies when they are typing. This option enables this feature for protocols that supports it. | |
202 .TP | |
203 .B Chat Window | |
204 \fIWindow\fR: The options in this section behave identically to the options of the same name in the \fBIM Window\fR preferences. | |
205 | |
206 \fITab Completion\fR: In a chat room with many participants, it can be tedious to keep typing the screen name of the user to whom you wish to direct a comment. These options allow \fITab\fR to expand the current text into a valid nickname. | |
207 \fIShow people joining/leaving in window\fR: When chat room participants enter or exit the room, the information will be displayed in the \fBBuddy Chat\fR window. | |
208 | |
209 \fIColorize screennames\fR: Color code the screen names of users in chat rooms. | |
210 .TP | |
211 .B Tabs | |
212 Tabbed chatting allows one to have multiple conversations without multiple windows. \fbTabs\fR show which conversations have unanswered messages, and can identify a user either by screen name or by alias. | |
213 | |
214 .SH Proxy | |
215 | |
216 The configuration section to enable \fBgaim\fR to operate through a proxy server. \fBgaim\fR currently supports SOCKS 4/5 and HTTP proxies. | |
217 | |
218 .SH Browser | |
219 | |
220 Allows the user to select \fBgaim\fR's default web browser. Galeon, Konqueror, Mozilla, Netscape, and Opera are supported natively. The user can also manually enter a command to be executed when a link is clicked (\fI%s\fR expands to the URL). For example, \fIxterm -e lynx %s\fR will open the link with lynx. \fIOpen new window by default\fR makes the browser use a new window instead of using the current window (or spawning a new tab). | |
221 | |
222 .SH Logging | |
223 | |
224 \fIMessage Logs\fR lets the user choose whether \fBConversations\fR and/or \fBBuddy Chats\fR will be logged as well as whether logs will be in HTML or plain text format. \fISystem Logs\fR describes the types of events to be logged. | |
225 | |
226 .SH Sounds | |
227 | |
228 \fINo sounds when you log in\fR: Makes the log-in process silent. | |
229 | |
230 \fISounds while away\fR: Determines whether sounds are played when an away message is up. | |
231 | |
232 \fISound Method\fR lets the user choose between different playback methods. The user can also manually enter a command to be executed when a sound is to be played (\fI%s\fR expands to the full path to the file name). | |
233 | |
234 .TP | |
235 .B Sound Events | |
236 Lets the user choose when and what sounds are to be played. | |
237 | |
238 .SH Away / Idle | |
239 | |
240 \fISending messages removes away status\fR: If enabled, sending a message will change the sending account's status to Available. If disabled, any account may send messages without affecting their away status. | |
241 | |
242 \fIQueue new messages when away\fR: Messages received since going Away will not be shown until away status is removed. | |
243 | |
244 \fIIgnore new conversations when away\fR: Messages from current conversations will be accepted, but new conversations will not be shown until away status is removed. | |
245 | |
246 \fISeconds before resending\fR: Auto-response information is resent to all buddies in current conversations every once in a while. This option decides just how often. | |
247 | |
248 \fIDon't send auto-response\fR: If someone messages you while away, your auto-response will not be sent. | |
249 | |
250 \fIOnly send auto-response when idle\fR: If someone messages you while away, your auto-response will only be sent if \fBgaim\fR decides that the connection is idle. | |
251 | |
252 \fIDon't send auto-response in active conversations\fR: If you continue a conversation while away, this option will disable the sending of the auto-response for the duration of the conversation. | |
253 | |
254 \fIIdle time reporting\fR: If \fINone\fR is selected, account idle time will not be reported. \fIGaim usage\fR infers your idle time from your usage of \fBgaim\fR. \fIX usage\fR infers your idle time from \fBX\fR (this option may not be universally available). | |
255 | |
256 \fIAuto-away\fR: Determines if and under what conditions \fBgaim\fR will automatically turn on the Away status. | |
257 | |
258 .TP | |
259 .B Away Messages | |
260 Lets the user add/edit/remove available \fBAway Messages\fR. | |
261 | |
262 .SH Plugins | |
263 | |
264 Allows the user to enable add-on plugins for \fBgaim\fR. Several of these come with \fBgaim\fR, while others must be downloaded separately. The \fIDescription\fR field gives the plugin author's description of the plugin, while the \fIDetails\fR field gives the plugin's authorship, URL, and file name/location information. | |
265 | |
266 Some plugins can be configured. If you load such a plugin, its configuration preferences will appear as a submenu to \fBPlugins\fR, with the submenu title determined by the plugin's name. | |
267 | |
268 .SH CONVERSATIONS | |
269 When starting a new conversation, the user is presented with the \fBConversation\fR window. The conversation appears in the upper text box and the user types his/her message in the lower text box. Between the two is a row of settings, represented by icons. From left to right: | |
96 .TP | 270 .TP |
97 .B Bold | 271 .B Bold |
98 adds <b></b> to your message | 272 adds <b></b> to your message |
99 .TP | 273 .TP |
100 .B Italics | 274 .B Italics |
101 adds <i></i> to your message | 275 adds <i></i> to your message |
102 .TP | 276 .TP |
103 .B Underline | 277 .B Underline |
104 adds <u></u> to your message | 278 adds <u></u> to your message |
105 .TP | 279 .TP |
106 .B Strikethrough | |
107 adds <s></s> to your message | |
108 .TP | |
109 .B Decrease font size | 280 .B Decrease font size |
110 adds <font size="1"></font> to your message | 281 adds <font size="1"></font> to your message |
111 .TP | 282 .TP |
112 .B Default font size | 283 .B Default font size |
113 adds <font size="3"></font> to your message | 284 adds <font size="3"></font> to your message |
114 .TP | 285 .TP |
115 .B Increase font size | 286 .B Increase font size |
116 adds <font size="5"></font> to your message | 287 adds <font size="5"></font> to your message |
117 .TP | 288 .TP |
118 .B Select font face | |
119 adds an appropriate font tag to your message. | |
120 .TP | |
121 .B Select a foreground color | 289 .B Select a foreground color |
122 adds an appropriate font tag to your message. | 290 adds an appropriate font tag to your message. |
123 .TP | 291 .TP |
124 .B Select a background color | 292 .B Select a background color |
125 adds an appropriate body tag to your message. | 293 adds an appropriate body tag to your message. |
126 .TP | 294 .TP |
295 .B Add image | |
296 inserts an appropriate img tag (not available in all protocols). | |
297 .TP | |
127 .B Add hyperlink | 298 .B Add hyperlink |
128 adds an appropriate a href tag to your message. | 299 adds an appropriate a href tag to your message. |
129 .TP | 300 .TP |
130 .B Add smiley | 301 .B Add smiley |
131 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. | 302 adds an ASCII smiley to your message. This will become a graphic smiley in the upper text box if the option for graphical smileys is set. |
132 .TP | 303 |
133 .B Enable logging | 304 Beneath the lower text box is a row of buttons that execute commands: |
134 As the conversation continues, everything will get logged to a log file in ~/.gaim/logs | 305 .TP |
135 .TP | 306 .B Warn |
136 .B Save Conversation | 307 This issues a warning to the other person in the conversation (not available in all protocols). |
137 Saves the current conversation to a log file of your choice. | 308 .TP |
138 .TP | 309 .B Block |
139 .B Enable Sounds | 310 This adds the other person to your deny list (not available in all protocols). |
140 Choose whether events in this conversation will trigger sounds. | 311 .TP |
141 | 312 .B Add |
142 Beneath the lower textbox is a row of buttons that execute commands: | 313 This adds this user to your buddy list. This option is not available if the user is already on your list. |
314 .TP | |
315 .B Remove | |
316 This removes this user from your buddy list. This option is not available if the user is not on your list. | |
317 .TP | |
318 .B Info | |
319 This gets information (a profile) about the other person in the conversation (not available in all protocols). | |
143 .TP | 320 .TP |
144 .B Send | 321 .B Send |
145 This sends what's currently in the lower textbox | 322 This sends what's currently in the lower text box |
146 .TP | 323 |
147 .B Get Info | 324 .SH BUDDY CHATS |
148 This gets information (a profile) about the other person in the conversation. | 325 For protocols that allow it, \fBBuddy Chats\fR can be entered through the \fIFile\fR menu or the \fIChat\fR button at the bottom of the \fBBuddy List\fR's \fBOnline\fR tab. |
149 .TP | |
150 .B Warn | |
151 This issues a warning to the other person in the conversation. | |
152 .TP | |
153 .B Block | |
154 This adds the other person to your deny list. | |
155 .TP | |
156 .B Add to buddy list | |
157 This adds this user to your buddy list. If he already is on your list, it will remove him from it. | |
158 .TP | |
159 .B Close | |
160 Closes this window. | |
161 | |
162 | |
163 .SH Edit Buddies | |
164 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. | |
165 | |
166 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. | |
167 | |
168 .SH Buddy Chat | |
169 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. | |
170 | 326 |
171 Additional commands available in chat, depending on the protocol are: | 327 Additional commands available in chat, depending on the protocol are: |
172 .TP | 328 .TP |
173 .B Whisper | 329 .B Whisper |
174 The text will appear in the chat conversation, but it will only be visible to the sender and the receiver. | 330 The text will appear in the chat conversation, but it will only be visible to the sender and the receiver. |
181 .TP | 337 .TP |
182 .B Set Topic | 338 .B Set Topic |
183 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. | 339 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. |
184 | 340 |
185 .SH AWAY MESSAGES | 341 .SH AWAY MESSAGES |
186 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. | 342 Most protocols allow for away messages. When a user is \fIAway\fR, he can leave an informative message for others to see. The \fBAway\fR submenu of the \fBTools\fR menu is used to add and remove away messages. |
187 | 343 |
188 \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. | 344 \fINew Away Message\fR provides space for one to enter an away message and a title for that message. If \fISave\fR or \fISave & Use\fR are chosen, this message will be saved. It can later be referred to by the title given to it. |
189 | 345 |
190 \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. | 346 \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. |
191 | 347 |
192 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. | 348 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. |
193 | 349 |
194 .SH BUDDY POUNCE | 350 .SH BUDDY POUNCE |
195 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. | 351 A Buddy Pounce is an automated trigger that occurs when a buddy returns to a normal state from an away state. The \fBNew Buddy Pounce\fR dialog box can be activated by selecting the \fIBuddy Pounce\fR submenu from the \fBTools\fR menu. 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. |
196 | 352 |
197 .SH ACCOUNT EDITOR | 353 .SH PLUGINS |
198 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. | 354 \fBGaim\fR allows for dynamic loading of plugins to add extra functionality to \fBgaim\fR. Plugins can be enabled and configured from the \fBPreferences\fR window. See \fIplugins/HOWTO\fR for more information on writing plugins. |
199 | |
200 If \fBRemember Password\fR is chosen, the password will be saved in \fBgaim's\fR configuration file. | |
201 | |
202 If \fBAuto-Login\fR is chosen, this account will automatically login upon starting \fBgaim\fR. | |
203 | |
204 Each protocol has it's own specific options that can be found in the protocol-specific tab on the modify screen. | |
205 | 355 |
206 .SH PERL | 356 .SH PERL |
207 \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. | 357 \fBGaim\fR allows for perl scripting. See \fIplugins/PERL-HOWTO\fR for more information about perl scripting. |
208 | |
209 .SH PLUGINS | |
210 \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. | |
211 | |
212 You may load and unload plugins using the appropriate buttons. | |
213 | |
214 .SH PREFERENCES | |
215 .SH General | |
216 .TP | |
217 .B Use Borderless Buttons | |
218 Change the appearence of the GUI's buttons. | |
219 .TP | |
220 .B Show Buddy Ticker | |
221 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. | |
222 .TP | |
223 .B Show Debug Window | |
224 This opens a debug window into which \fBgaim\fR sends more verbose information about what it's doing. | |
225 .TP | |
226 .B Report Idle Times | |
227 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. | |
228 .TP | |
229 .B Logging | |
230 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. | |
231 .TP | |
232 .B Browser | |
233 Choose the Web Browser to use when a hyperlink is clicked. | |
234 .SH Buddy List | |
235 .TP | |
236 .B Hide IM/Info/Chat buttons | |
237 This option will remove the three buttons beneath the \fBBuddy List\fR in the \fBBuddy List Window\fR. | |
238 .TP | |
239 .B Show pictures on buttons | |
240 If checked, the buttons will feature an icon, otherwise, the buttons will be text. | |
241 .TP | |
242 .B Hide groups with no online buddies | |
243 This feature will only display a folder representing a group if there is at least one online buddy in it. | |
244 .TP | |
245 .B Show numbers in groups | |
246 This feature displays the number of buddies in each group and the number of these online in the \fBBuddy List\fR. | |
247 .TP | |
248 .B Show buddy type icons | |
249 This icon is a quick reference as to what protocol a buddy is using, and what away state, if any, he is in. | |
250 .TP | |
251 .B Show Idle times | |
252 This shows how long a buddy has been idle next to his name. | |
253 .B Show warning levels | |
254 This shows the warning level of a buddy next to his name. | |
255 .SH Conversations | |
256 .TP | |
257 .B Keyboard Options | |
258 These options set certain keybindings. | |
259 .TP | |
260 .B Show graphical smileys | |
261 This will convert emoticons such as :) and >:-O to small icons representing them. | |
262 .TP | |
263 .B Show timestamp on messages | |
264 When selected, this option shows in the conversation window, the time each message was received or sent. | |
265 .TP | |
266 .B Show URLs as links | |
267 This will convert URLs such as http://gaim.sourceforge.net to a hyperlink pointing to that site. | |
268 .TP | |
269 .B Highlight misspelled words | |
270 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. | |
271 .TP | |
272 .B Sending messages removes away status | |
273 If this option is selected, a user will come back from \fBaway\fR if he sends a message to someone. | |
274 .TP | |
275 .B Queue new messages when away | |
276 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. | |
277 .TP | |
278 .B Ignore colors/font faces/ font sizes | |
279 These options ignore font settings that can be set in HTML tags. | |
280 .TP | |
281 .B Ignore TiK Automated Messages | |
282 AOL's open source TiK client gets a user's away message by sending him an automated message. This option ignores those messages. | |
283 .TP | |
284 .B Ignore new conversations when away | |
285 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. | |
286 .SH Windows | |
287 .TP | |
288 .B Show buttons as: | |
289 This option selects the look of the buttons. | |
290 .TP | |
291 .B Show all conversations in one tabbed window | |
292 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. | |
293 .TP | |
294 .B Raise windows on events | |
295 When an event happens to a conversation, the conversation window will be raised above all other windows on the desktop. | |
296 .TP | |
297 .B Show logins in window | |
298 This will show when buddies log in and out in the conversation window, if one is open for that buddy. | |
299 .TP | |
300 .B Window size | |
301 Select the default size for new conversation windows. | |
302 .SH Font Options | |
303 .TP | |
304 These set the font preferences that are sent with all messages over a protocol that supports HTML. | |
305 .SH Chat Rooms | |
306 .TP | |
307 This is a list of available chat rooms and chat rooms that you are subscribed to. | |
308 .SH Sounds | |
309 .TP | |
310 .B No sounds when you log in | |
311 This will prevent sounds from playing when \fBgaim\fR is first notified of your buddy's presence because you just signed on. | |
312 .TP | |
313 .B Sounds while away | |
314 This option will continue to play sounds on events if you are away. | |
315 .TP | |
316 .B Beep instead of playing sound | |
317 This will cause a terminal beep instead of a sound upon events. | |
318 .TP | |
319 .B Command to play sound files | |
320 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. | |
321 .TP | |
322 .B Events | |
323 Choose sounds to play when each event occurs. | |
324 .SH Away Messages | |
325 .TP | |
326 .B Don't send auto-response | |
327 If someone sends the user a message while away, \fBgaim\fR will not respond with the away message if this is checked. | |
328 .TP | |
329 .B Auto Away | |
330 If this is selected \fBgaim\fR will automatically go away if it's been idle for the specified length of time. | |
331 .SH Privacy | |
332 .TP | |
333 Here, the user can configure his permit/deny lists. | |
334 | |
335 | |
336 | 358 |
337 .SH FILES | 359 .SH FILES |
338 ~/.gaimrc \- Gaim Config File | 360 \fI/usr/local/bin/gaim\fR: \fBgaim\fR's default location. |
339 .br | 361 .br |
340 ~/.gaim/logs/SCREENNAME.log \- a log of all conversation with SCREENNAME. | 362 \fI/usr/local/lib/gaim/\fR: \fBgaim\fR's plugins directory. |
341 .br | 363 .br |
342 /usr/local/lib/gaim/ \- Gaim Plugin Files | 364 \fI~/.gaimrc\fR: \fBgaim\fR's configuration file. |
343 .br | 365 .br |
344 ~/.gaim/SCREENAME.PROTOCOL.blist \- the buddy list for SCREENAME using protocol number PROTOCOL | 366 \fI~/.gaim/logs/SCREENNAME.log\fR: a log of all conversation with \fISCREENNAME\fR. |
367 .br | |
368 \fI~/.gaim/SCREENAME.PROTOCOL.blist\fR: the buddy list for \fISCREENAME\fR using protocol number \fIPROTOCOL\fR. | |
369 | |
345 .SH BUGS | 370 .SH BUGS |
346 Known bugs are at http://sourceforge.net/bugs/?group_id=235 | 371 Known bugs are listed at \fIhttp://sourceforge.net/tracker/?group_id=235&atid=100235\fR. |
347 .SH BUG REPORTS | 372 |
348 If you find a bug in \fBgaim\fR, please submit a bug form at | 373 .SH PATCHES |
349 http://sourceforge.net/bugs/?group_id=235 | 374 If you fix a bug in \fBgaim\fR (or otherwise enhance it), please submit a patch (using \fIcvs diff -u > my.diff\fR against the latest CVS version) at \fIhttp://sourceforge.net/tracker/?func=add&group_id=235&atid=300235\fR. |
350 .PP | 375 |
351 Before sending a bug report, please verify that you have the latest | 376 Before sending a bug report, please verify that you have the latest |
352 version of \fBgaim\fR. Many bugs (major and minor) are fixed | 377 version of \fBgaim\fR. Many bugs (major and minor) are fixed |
353 at each release, and if yours is out of date, the problem may already | 378 at each release, and if yours is out of date, the problem may already |
354 have been solved. | 379 have been solved. |
355 | 380 |
356 .SH SEE ALSO | 381 .SH SEE ALSO |
357 \fIhttp://gaim.sourceforge.net/\fR | 382 \fIhttp://gaim.sourceforge.net/\fR |
383 .br | |
358 \fIhttp://www.sourceforge.net/projects/gaim/\fR | 384 \fIhttp://www.sourceforge.net/projects/gaim/\fR |
359 | 385 |
360 .SH LICENSE | 386 .SH LICENSE |
361 This program is free software; you can redistribute it and/or modify | 387 This program is free software; you can redistribute it and/or modify |
362 it under the terms of the GNU General Public License as published by | 388 it under the terms of the GNU General Public License as published by |
363 the Free Software Foundation; either version 2 of the License, or | 389 the Free Software Foundation; either version 2 of the License, or |
364 (at your option) any later version. | 390 (at your option) any later version. |
365 .PP | 391 |
366 This program is distributed in the hope that it will be useful, but | 392 This program is distributed in the hope that it will be useful, but |
367 \fBWITHOUT ANY WARRANTY\fR; without even the implied warranty of | 393 \fBWITHOUT ANY WARRANTY\fR; without even the implied warranty of |
368 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | 394 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
369 General Public License for more details. | 395 General Public License for more details. |
370 .PP | 396 |
371 You should have received a copy of the GNU General Public License | 397 You should have received a copy of the GNU General Public License |
372 along with this program; if not, write to the Free Software | 398 along with this program; if not, write to the Free Software |
373 Foundation, Inc., 59 Temple PLace, Suite 330, Boston, MA 02111-1307 USA | 399 Foundation, Inc., 59 Temple PLace, Suite 330, Boston, MA 02111-1307 USA |
400 | |
374 .SH AUTHORS | 401 .SH AUTHORS |
375 The authors of \fBgaim\fR are: | 402 \fBGaim\fR's active developers are: |
376 .PP | 403 |
377 Rob Flynn <rob@marko.net> \- AIM: RobFlynn | 404 Rob Flynn (maintainer) <\fIrob@marko.net\fR> |
378 .br | 405 .br |
379 Sean Egan <bj91704@binghamton.edu> \- AIM: SeanEgn | 406 Sean Egan (coder) <\fIbj91704@binghamton.edu\fR> |
380 .br | 407 |
381 Syd Logan | 408 The retired developers of \fBgaim\fR are: |
382 | 409 |
383 The retired authors of \fBgaim\fR are: | 410 Jim Duchek |
384 .PP | 411 .br |
385 Jim Duchek <jim@linuxpimps.com> \- AIM: Zilding | 412 Eric Warmenhoven <\fIwarmenhoven@yahoo.com\fR> |
386 .br | 413 .br |
387 Eric Warmenhoven <eric@warmenhoven.org> | 414 Mark Spencer (original author) <\fImarkster@marko.net\fR> |
388 .br | 415 |
389 Mark Spencer <markster@marko.net> \- AIM: Markster97 | 416 |
390 | 417 This manpage was originally written by Dennis Ristuccia <\fIdennis@dennisr.net\fR>. It has been updated and largely rewritten by Sean Egan <\fIbj91704@binghamton.edu\fR> and Ben Tegarden <\fItegarden@uclink.berkeley.edu\fR>. |
391 | 418 |
392 .PP | |
393 | |
394 This manpage was originally written by Dennis Ristuccia <dennis@dennisr.net> AIM: D3nnisR. It has been updated and largely rewritten by Sean Egan <bj91704@binghamton.edu> AIM: SeanEgn | |
395 | |
396 .\" WOO! | |
397 .\" Agreed, Dennis, agreed. |