Mercurial > pidgin
comparison doc/gaim.1.in @ 9073:cb4d9604d1e5
[gaim-migrate @ 9849]
(14:27:33) nosnilmot: LSchiere:
http://www.nosnilmot.com/patches/gaim-0.78cvs-man-prefslash.patch
(14:29:56) Paco-Paco: every line of that file changed, due to word-wrapping
(14:30:20) nosnilmot: yes, that was intentional
(14:30:41) nosnilmot: but the only real changes are adjustments to match
what is actually in preferences now
(14:34:25) wing|work: if i were to re-wrap every line in man pages, i would
wrap after punctuation :P
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Wed, 26 May 2004 19:06:47 +0000 |
parents | 350c6845c792 |
children | aad506cde4f3 |
comparison
equal
deleted
inserted
replaced
9072:96bfa9bd110f | 9073:cb4d9604d1e5 |
---|---|
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 GTK2-based Instant Messaging (IM) application. It supports multiple protocols via modules, including AIM, ICQ, Yahoo!, MSN, Jabber, IRC, Napster, Gadu-Gadu and Zephyr. It has many common features found in other clients, as well as many unique features. Gaim is not endorsed by or affiliated with America Online, ICQ, Microsoft, or Yahoo. | 31 \fBgaim\fR is a GTK2-based Instant Messaging (IM) application. It supports |
32 multiple protocols via modules, including AIM, ICQ, Yahoo!, MSN, Jabber, | |
33 IRC, Napster, Gadu-Gadu and Zephyr. 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. | |
32 | 36 |
33 .SH OPTIONS | 37 .SH OPTIONS |
34 The following options are provided by \fBgaim\fR using the standard GNU command line syntax: | 38 The following options are provided by \fBgaim\fR using the standard GNU |
39 command line syntax: | |
35 .TP | 40 .TP |
36 .B \-a, \-\-acct | 41 .B \-a, \-\-acct |
37 Launch the \fBAccount Editor\fR rather than the \fBLogin\fR window on start. | 42 Launch the \fBAccount Editor\fR rather than the \fBLogin\fR window on |
43 start. | |
38 .TP | 44 .TP |
39 .B \-d, \-\-debug | 45 .B \-d, \-\-debug |
40 Print debugging messages to stdout. These are the same debugging messages that are displayed in the \fBDebug\fR window. | 46 Print debugging messages to stdout. These are the same debugging messages |
47 that are displayed in the \fBDebug\fR window. | |
41 .TP | 48 .TP |
42 .B \-c, \-\-config=\fIDIR\fB | 49 .B \-c, \-\-config=\fIDIR\fB |
43 Use \fIDIR\fR as the directory for config files instead of \fI~/.gaim\fR. | 50 Use \fIDIR\fR as the directory for config files instead of \fI~/.gaim\fR. |
44 .TP | 51 .TP |
45 .B \-h, \-\-help | 52 .B \-h, \-\-help |
46 Print this help and exit. | 53 Print this help and exit. |
47 .TP | 54 .TP |
48 .B \-l, \-\-login[=\fINAME\fB] | 55 .B \-l, \-\-login[=\fINAME\fB] |
49 Automatically login on start using the default account or the account specified by the \fINAME\fR parameter. | 56 Automatically login on start using the default account or the account |
57 specified by the \fINAME\fR parameter. | |
50 .TP | 58 .TP |
51 .B \-n, \-\-loginwin | 59 .B \-n, \-\-loginwin |
52 Don't automatically login when \fBgaim\fR starts. Show the \fBLogin\fR window instead. | 60 Don't automatically login when \fBgaim\fR starts. Show the \fBLogin\fR |
61 window instead. | |
53 .TP | 62 .TP |
54 .B \-u, \-\-user=\fINAME\fB | 63 .B \-u, \-\-user=\fINAME\fB |
55 Use account \fINAME\fR as default. | 64 Use account \fINAME\fR as default. |
56 .TP | 65 .TP |
57 .B \-v, \-\-version | 66 .B \-v, \-\-version |
58 Display the version information window. | 67 Display the version information window. |
59 .TP | 68 .TP |
60 .B \-w, \-\-away[=\fIMESG\fB] | 69 .B \-w, \-\-away[=\fIMESG\fB] |
61 Automatically go away on signon. You may optionally use the \fIMESG\fR parameter to set the away message. | 70 Automatically go away on signon. You may optionally use the \fIMESG\fR |
71 parameter to set the away message. | |
62 | 72 |
63 .SH BUDDY LIST | 73 .SH BUDDY LIST |
64 The \fBBuddy List\fR window is \fBgaim\fR's main interface window. Using this window you can see which of your buddies is online, away, idle, etc. You can also add and remove buddies from your buddy list. | 74 The \fBBuddy List\fR window is \fBgaim\fR's main interface window. Using |
65 | 75 this window you can see which of your buddies is online, away, idle, etc. |
66 The \fBBuddy List\fR window 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 indicates the buddy's current state and the protocol they are using. Double clicking a buddy will open a new \fBConversation\fR window. Right clicking will pop up a menu: | 76 You can also add and remove buddies from your buddy list. |
77 | |
78 The \fBBuddy List\fR window contains a list of your buddies who are online | |
79 and have allowed you to be notified of their presence. The icon to the | |
80 left of each buddy indicates the buddy's current state and the protocol | |
81 they are using. Double clicking a buddy will open a new \fBConversation\fR | |
82 window. Right clicking will pop up a menu: | |
67 .TP | 83 .TP |
68 .B IM | 84 .B IM |
69 Opens a new \fBConversation\fR window to the selected buddy. | 85 Opens a new \fBConversation\fR window to the selected buddy. |
70 .TP | 86 .TP |
71 .B Add Buddy Pounce | 87 .B Add Buddy Pounce |
72 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. | 88 A Buddy Pounce is a configurable automated action to be performed when the |
73 .TP | 89 buddy's state changes. This will open the \fBBuddy Pounce\fR dialog to be |
90 discussed later. | |
91 .TP | |
74 .B View Log | 92 .B View Log |
75 \fBgaim\fR is capable of automatically log its activities. These logs are either plain text files (with a .log extension) or html files (with a .html extenstion) located under the \fI~/.gaim/logs\fR directory. This menu command will attempt to view this file with \fBgaim\fR's internal log viewer. | 93 \fBgaim\fR is capable of automatically log its activities. These logs are |
94 either plain text files (with a .log extension) or html files (with a | |
95 .html extenstion) located under the \fI~/.gaim/logs\fR directory. This | |
96 menu command will attempt to view this file with \fBgaim\fR's internal log | |
97 viewer. | |
76 .TP | 98 .TP |
77 .B Alias | 99 .B Alias |
78 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. | 100 Create an alias for this buddy. This will open up a new dialog in which |
79 | 101 one can give this buddy an alternate name to appear on the buddy list and |
80 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. | 102 in conversataions. |
103 | |
104 For example, if a buddy's name screen name was jsmith1281xx and his real | |
105 name was 'John Q. Smith,' one could create an alias as to identify the | |
106 buddy by his common name. | |
81 .LP | 107 .LP |
82 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: | 108 The remainder of the menu will consist of protocol specific commands. |
109 These commands vary depending on the protocol; below are the commands | |
110 available when using OSCAR, the more popular and developer-recommended AIM | |
111 protocol: | |
83 .TP | 112 .TP |
84 .B Get Info | 113 .B Get Info |
85 Retrieves and displays information about the buddy. This information is also known as a Profile. | 114 Retrieves and displays information about the buddy. This information is |
115 also known as a Profile. | |
86 .TP | 116 .TP |
87 .B Get Away Msg | 117 .B Get Away Msg |
88 If this buddy is in an Away state, this will retrieve and display the buddy's \fBAway Message\fR. | 118 If this buddy is in an Away state, this will retrieve and display the |
119 buddy's \fBAway Message\fR. | |
89 .LP | 120 .LP |
90 At the bottom of the \fBBuddy List\fR are several buttons (if enabled in \fBPreferences\fR): | 121 At the bottom of the \fBBuddy List\fR are several buttons (if enabled in |
122 \fBPreferences\fR): | |
91 .TP | 123 .TP |
92 .B IM | 124 .B IM |
93 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. | 125 Opens a new \fBConversation\fR window to to the selected buddy, or brings |
126 up the \fBNew Message\fR dialog box if no buddy is selected. | |
94 .TP | 127 .TP |
95 .B Info | 128 .B Info |
96 Retrieves and display information about the selected buddy, or brings up the \fBGet User Info\fR dialog box if no buddy is selected. | 129 Retrieves and display information about the selected buddy, or brings up |
130 the \fBGet User Info\fR dialog box if no buddy is selected. | |
97 .TP | 131 .TP |
98 .B Chat | 132 .B Chat |
99 Brings up the \fBJoin Chat\fR dialog box, prompting the user to select which username to use and what chat group to join. | 133 Brings up the \fBJoin Chat\fR dialog box, prompting the user to select |
134 which username to use and what chat group to join. | |
100 .TP | 135 .TP |
101 .B Away | 136 .B Away |
102 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. | 137 Brings up a menu of all available \fBAway Messages\fR. If an item is |
138 selected, all online accounts will use this item as their away message. | |
103 | 139 |
104 .SH ACCOUNT EDITOR | 140 .SH ACCOUNT EDITOR |
105 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. | 141 The account editor consists of a list of accounts and information about |
106 | 142 them. Clicking \fIDelete\fR will delete the currently selected account. |
107 If \fIRemember Password\fR is chosen, the password will be saved in \fBgaim\fR's configuration file. | 143 Clicking \fIAdd\fR or \fIModify\fR will invoke a \fBModify Account\fR |
108 | 144 window. Here, you can add or alter account information. When creating a |
109 If \fIAuto-Login\fR is chosen, this account will automatically login upon starting \fBgaim\fR. | 145 new account, you will submit your screen name and password. You will also |
110 | 146 choose your protocol. |
111 Each protocol has it's own specific options that can be found in the protocol-specific tab on the modify screen. | 147 |
148 If \fIRemember Password\fR is chosen, the password will be saved in | |
149 \fBgaim\fR's configuration file. | |
150 | |
151 If \fIAuto-Login\fR is chosen, this account will automatically login upon | |
152 starting \fBgaim\fR. | |
153 | |
154 Each protocol has it's own specific options that can be found in the | |
155 protocol-specific tab on the modify screen. | |
112 | 156 |
113 .SH PREFERENCES | 157 .SH PREFERENCES |
114 | 158 |
115 All options take effect immediately. | 159 All options take effect immediately. |
116 | 160 |
117 .SH Interface | 161 .SH Interface |
118 | 162 |
119 \fIDisplay remote nicknames if no alias is set\fR: Toggles whether server nickname data should be used if no local alias exists. | 163 \fIDisplay remote nicknames if no alias is set\fR: Toggles whether server |
164 nickname data should be used if no local alias exists. | |
120 | 165 |
121 .TP | 166 .TP |
122 .B Smiley Themes | 167 .B Smiley Themes |
123 Allows the user to choose between different smiley themes. | 168 Allows the user to choose between different smiley themes. The "none" theme |
124 .TP | 169 will disable graphical emoticons - they will be displayed as text instead. |
125 .B Fonts | |
126 Lets the user pick a default font style/face/color for all accounts (only applicable to protocols that support HTML formatting in messages). | |
127 .TP | 170 .TP |
128 .B Message Text | 171 .B Message Text |
129 \fIShow graphical smileys\fR: Enables the replacement of text emoticons with their graphical equivalents. | 172 \fIShow timestamp on messages\fR: Toggles the timestamp behavior for |
130 | 173 conversations. Per-conversation behavior can be changed by pressing |
131 \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. | 174 \fIF2\fR in the \fBConversation\fR window. |
132 | 175 |
133 \fIShow URLs as links\fR: Enables the translation of URLs (such as \fIhttp://gaim.sourceforge.net\fR) into clickable links. | 176 \fIHighlight misspelled words\fR: Toggles highlighting of misspelled words |
134 | 177 as you type. |
135 \fIIgnore colors/font faces/font sizes\fR: Tells \fBgaim\fR to disregard buddies' color/font/size information in displaying IMs or Chats. | 178 |
179 \fIIgnore colors/font faces/font sizes\fR: Tells \fBgaim\fR to disregard | |
180 buddies' color/font/size information in displaying IMs or Chats. | |
181 | |
182 \fIDefault Formatting\fR: Allows specifing the default formatting to apply | |
183 to all outgoing messages (only applicable to protocols that support | |
184 formatting in messages). | |
136 .TP | 185 .TP |
137 .B Shortcuts | 186 .B Shortcuts |
138 Allows the user to determine which keyboard shortcuts are available. | 187 Allows the user to determine which keyboard shortcuts are available. |
139 .TP | 188 .TP |
140 .B Buddy List | 189 .B Buddy List |
141 \fISorting\fR: Toggles the order in which buddies are shown in your \fBBuddy List\fR between none, alphabetical, by status and by log size. | 190 \fISorting\fR: Toggles the order in which buddies are shown in your |
142 | 191 \fBBuddy List\fR between none, alphabetical, by status and by log size. |
143 \fIShow buttons as\fR: Toggles between picture-only, text-only, picure and text or no buttons view of the buttons on the \fBBuddy List\fR. | 192 |
144 | 193 \fIShow buttons as\fR: Toggles between picture-only, text-only, picure and |
145 \fIRaise window on events\fR: Tells \fBgaim\fR to bring the \fBBuddy List\fR window to the top when buddies sign in or out. | 194 text or no buttons view of the buttons on the \fBBuddy List\fR. |
146 | 195 |
147 \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. | 196 \fIRaise window on events\fR: Tells \fBgaim\fR to bring the \fBBuddy |
197 List\fR window to the top when buddies sign in or out. | |
198 | |
199 \fIShow numbers in groups\fR: The number of buddies from each group | |
200 currently logged in will be shown along with the total number of buddies in | |
201 the group. | |
148 | 202 |
149 \fIShow buddy icons\fR: Toggles the display of buddies' custom icons. | 203 \fIShow buddy icons\fR: Toggles the display of buddies' custom icons. |
150 | 204 |
151 \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. | 205 \fIShow warning levels\fR: Each buddy's warning level will be displayed |
152 | 206 next to the screen name. As a buddy's warning level increases, outgoing |
153 \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). | 207 messages are more and more severely rate-limited. |
154 | 208 |
155 \fIDim idle buddies\fR: If enabled, idle buddies will be displayed in grey text instead of black text. | 209 \fIShow idle times\fR: The amount of time each buddy has been idle will be |
156 | 210 displayed next to the screen name (if the buddy has opted to have their |
157 \fIAutomatically expand contacts\fR: If enabled, contacts will automatically expand to show the associated buddies when the mouse is held over the contact for a short period. | 211 client report this information). |
212 | |
213 \fIDim idle buddies\fR: If enabled, idle buddies will be displayed in grey | |
214 text instead of black text. | |
215 | |
216 \fIAutomatically expand contacts\fR: If enabled, contacts will | |
217 automatically expand to show the associated buddies when the mouse is held | |
218 over the contact for a short period. | |
158 | 219 |
159 .SH Conversations | 220 .SH Conversations |
160 | 221 |
161 \fIPlacement...\fR: Determines where new conversations will be placed (Last created window / New window / windows grouped by group or account). | 222 \fIPlacement...\fR: Determines where new conversations will be placed (Last |
162 | 223 created window / New window / windows grouped by group or account / maximum |
163 \fISend URLs as links\fR: Automatically turns URLs into clickable links when sent on protocols that support HTML. | 224 number of conversations per window). |
164 | 225 |
165 \fIShow formatting toolbar\fR: Display the formatting toolbar between the upper and lower text boxes in conversations. | 226 \fIShow formatting toolbar\fR: Display the formatting toolbar between the |
166 | 227 upper and lower text boxes in conversations. |
167 \fIShow aliases in tabs/titles\fR: Displays buddy alias instead of screen name in window tabs and titles. | 228 |
168 | 229 \fIShow aliases in tabs/titles\fR: Displays buddy alias instead of screen |
169 \fITab Placement...\fR: Specifies where tabs are shown in the conversation window. | 230 name in window tabs and titles. |
170 | 231 |
171 \fIShow IMs and chats in tabbed windows\fR: Tabbed chatting allows one to have multiple conversations without multiple windows. | 232 \fIShow IMs and chats in tabbed windows\fR: Tabbed chatting allows one to |
172 | 233 have multiple conversations without multiple windows. |
173 \fIShow IMs and chats in same tabbed window\fR: Uses the same window for both IMs and chats. | 234 |
235 \fIShow IMs and chats in same tabbed window\fR: Uses the same window for | |
236 both IMs and chats. | |
174 | 237 |
175 \fIShow close buttons on tabs\fR: Adds a close button to each tab. | 238 \fIShow close buttons on tabs\fR: Adds a close button to each tab. |
176 | 239 |
177 \fIShow status icons on tabs\fR: Adds an icon to each tab representing the buddy's status. | 240 \fITab Placement...\fR: Specifies where tabs are shown in the conversation |
241 window. | |
178 | 242 |
179 .TP | 243 .TP |
180 .B IM Window | 244 .B IM Window |
181 \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. | 245 \fIShow buttons as...\fR: The selected item will determine whether |
182 | 246 picture-only, text-only, combined picture/text, or no buttons will be used |
183 \fINew window width/height...\fR: The values here determine how large \fBConversation\fR windows are by default. However, each window can be independently resized. | 247 for \fBConversation\fR windows. |
184 | 248 |
185 \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. | 249 \fIRaise windows on events\fR: If enabled, \fBConversation\fR windows will |
186 | 250 be brought to the top when new messages are received. |
187 \fIRaise windows on events\fR: If enabled, \fBConversation\fR windows will be brought to the top when new messages are received. | 251 |
188 | 252 \fIShow buddy icons\fR: For protocols that support it, buddy icons allow |
189 \fIHide window on send\fR: If enabled, \fBConversation\fR windows will be iconified after each message is sent. | 253 buddies to send small pictures to be displayed during the course of a |
190 | 254 conversation. Turning this option off hides those pictures. |
191 \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. | 255 |
192 | 256 \fIEnable buddy icon animation\fR: If these pictures happen to be animated, |
193 \fIDisable buddy icon animation\fR: If these pictures happen to be animated, this option will disable the animation, displaying only the first frame. | 257 this option will enable the animation, otherwise only the first frame will |
194 | 258 be displayed. |
195 \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. | 259 |
196 | 260 \fINotify buddies that you are typing to them\fR: Some protocols allow |
197 \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. | 261 clients to tell their buddies when they are typing. This option enables |
262 this feature for protocols that supports it. | |
198 .TP | 263 .TP |
199 .B Chat Window | 264 .B Chat Window |
200 \fIWindow\fR: The options in this section behave identically to the options of the same name in the \fBIM Window\fR preferences. | 265 \fIWindow\fR: The options in this section behave identically to the options |
201 | 266 of the same name in the \fBIM Window\fR preferences. |
202 \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. | |
203 \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. | |
204 | 267 |
205 \fIColorize screennames\fR: Color code the screen names of users in chat rooms. | 268 \fIColorize screennames\fR: Color code the screen names of users in chat rooms. |
206 .TP | 269 .TP |
207 | 270 |
208 .SH Proxy | 271 .SH Proxy |
209 | 272 |
210 The configuration section to enable \fBgaim\fR to operate through a proxy server. \fBgaim\fR currently supports SOCKS 4/5 and HTTP proxies. | 273 The configuration section to enable \fBgaim\fR to operate through a proxy |
274 server. \fBgaim\fR currently supports SOCKS 4/5 and HTTP proxies. | |
211 | 275 |
212 .SH Browser | 276 .SH Browser |
213 | 277 |
214 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). | 278 Allows the user to select \fBgaim\fR's default web browser. Galeon, |
279 Konqueror, Mozilla, Netscape, and Opera are supported natively. The user | |
280 can also manually enter a command to be executed when a link is clicked | |
281 (\fI%s\fR expands to the URL). For example, \fIxterm -e lynx "%s"\fR will | |
282 open the link with lynx. \fIOpen new window by default\fR makes the | |
283 browser use a new window instead of using the current window (or spawning a | |
284 new tab). | |
215 | 285 |
216 .SH Logging | 286 .SH Logging |
217 | 287 |
218 \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. | 288 \fIMessage Logs\fR lets the user choose whether \fBConversations\fR and/or |
289 \fBBuddy Chats\fR will be logged as well as whether logs will be in HTML or | |
290 plain text format. \fISystem Logs\fR describes the types of events to be | |
291 logged. | |
219 | 292 |
220 .SH Sounds | 293 .SH Sounds |
221 | 294 |
222 \fISounds when you log in\fR: Enables sounds during log-in. | 295 \fISounds while away\fR: Determines whether sounds are played when an away |
223 | 296 message is up. |
224 \fISounds while away\fR: Determines whether sounds are played when an away message is up. | 297 |
225 | 298 \fISound Method\fR lets the user choose between different playback methods. |
226 \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). | 299 The user can also manually enter a command to be executed when a sound is |
300 to be played (\fI%s\fR expands to the full path to the file name). | |
227 | 301 |
228 .TP | 302 .TP |
229 .B Sound Events | 303 .B Sound Events |
230 Lets the user choose when and what sounds are to be played. | 304 Lets the user choose when and what sounds are to be played. |
231 | 305 |
232 .SH Away / Idle | 306 .SH Away / Idle |
233 | 307 |
234 \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. | 308 \fIQueue new messages when away\fR: Messages received since going Away will |
235 | 309 not be shown until away status is removed. |
236 \fIQueue new messages when away\fR: Messages received since going Away will not be shown until away status is removed. | 310 |
237 | 311 \fISend auto-response\fR: If someone messages you while away, your |
238 \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. | 312 auto-response will be sent. |
239 | 313 |
240 \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. | 314 \fIOnly send auto-response when idle\fR: If someone messages you while |
241 | 315 away, your auto-response will only be sent if \fBgaim\fR decides that the |
242 \fIDon't send auto-response\fR: If someone messages you while away, your auto-response will not be sent. | 316 connection is idle. |
243 | 317 |
244 \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. | 318 \fIIdle time reporting\fR: If \fINone\fR is selected, account idle time |
245 | 319 will not be reported. \fIGaim usage\fR infers your idle time from your |
246 \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. | 320 usage of \fBgaim\fR. \fIX usage\fR infers your idle time from \fBX\fR |
247 | 321 (this option may not be universally available). |
248 \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). | 322 |
249 | 323 \fIAuto-away\fR: Determines if and under what conditions \fBgaim\fR will |
250 \fIAuto-away\fR: Determines if and under what conditions \fBgaim\fR will automatically turn on the Away status. | 324 automatically turn on the Away status. |
251 | 325 |
252 .TP | 326 .TP |
253 .B Away Messages | 327 .B Away Messages |
254 Lets the user add/edit/remove available \fBAway Messages\fR. | 328 Lets the user add/edit/remove available \fBAway Messages\fR. |
255 | 329 |
330 .SH Protocols | |
331 | |
332 Protocols provide protocol specific preferences here. | |
333 | |
256 .SH Plugins | 334 .SH Plugins |
257 | 335 |
258 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. | 336 Allows the user to enable add-on plugins for \fBgaim\fR. Several of these |
259 | 337 come with \fBgaim\fR, while others must be downloaded separately. The |
260 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. | 338 \fIDescription\fR field gives the plugin author's description of the |
339 plugin, while the \fIDetails\fR field gives the plugin's authorship, URL, | |
340 and file name/location information. | |
341 | |
342 Some plugins can be configured. If you load such a plugin, its | |
343 configuration preferences will appear as a submenu to \fBPlugins\fR, with | |
344 the submenu title determined by the plugin's name. | |
261 | 345 |
262 .SH CONVERSATIONS | 346 .SH CONVERSATIONS |
263 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. Some or all buttons may not be active if the protocol does not support the specific formatting. From left to right: | 347 When starting a new conversation, the user is presented with the |
348 \fBConversation\fR window. The conversation appears in the upper text box | |
349 and the user types his/her message in the lower text box. Between the two | |
350 is a row of settings, represented by icons. Some or all buttons may not be | |
351 active if the protocol does not support the specific formatting. From left | |
352 to right: | |
264 .TP | 353 .TP |
265 .B Bold | 354 .B Bold |
266 Turns on/off bold. | 355 Turns on/off bold. |
267 .TP | 356 .TP |
268 .B Italics | 357 .B Italics |
293 Adds an emoticon (smiley) to your message. | 382 Adds an emoticon (smiley) to your message. |
294 | 383 |
295 Beneath the lower text box is a row of buttons that execute commands: | 384 Beneath the lower text box is a row of buttons that execute commands: |
296 .TP | 385 .TP |
297 .B Warn | 386 .B Warn |
298 This issues a warning to the other person in the conversation (not available in all protocols). | 387 This issues a warning to the other person in the conversation (not |
388 available in all protocols). | |
299 .TP | 389 .TP |
300 .B Block | 390 .B Block |
301 This adds the other person to your deny list (not available in all protocols). | 391 This adds the other person to your deny list (not available in all |
392 protocols). | |
302 .TP | 393 .TP |
303 .B Add | 394 .B Add |
304 This adds this user to your buddy list. This option is not available if the user is already on your list. | 395 This adds this user to your buddy list. This option is not available if |
396 the user is already on your list. | |
305 .TP | 397 .TP |
306 .B Remove | 398 .B Remove |
307 This removes this user from your buddy list. This option is not available if the user is not on your list. | 399 This removes this user from your buddy list. This option is not available |
400 if the user is not on your list. | |
308 .TP | 401 .TP |
309 .B Info | 402 .B Info |
310 This gets information (a profile) about the other person in the conversation (not available in all protocols). | 403 This gets information (a profile) about the other person in the |
404 conversation (not available in all protocols). | |
311 .TP | 405 .TP |
312 .B Send | 406 .B Send |
313 This sends what's currently in the lower text box | 407 This sends what's currently in the lower text box |
314 | 408 |
315 .SH BUDDY CHATS | 409 .SH BUDDY CHATS |
316 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. | 410 For protocols that allow it, \fBBuddy Chats\fR can be entered through the |
411 \fIFile\fR menu or the \fIChat\fR button at the bottom of the \fBBuddy | |
412 List\fR's \fBOnline\fR tab. | |
317 | 413 |
318 Additional commands available in chat, depending on the protocol are: | 414 Additional commands available in chat, depending on the protocol are: |
319 .TP | 415 .TP |
320 .B Whisper | 416 .B Whisper |
321 The text will appear in the chat conversation, but it will only be visible to the sender and the receiver. | 417 The text will appear in the chat conversation, but it will only be visible |
418 to the sender and the receiver. | |
322 .TP | 419 .TP |
323 .B Invite | 420 .B Invite |
324 Invite other people to join the chat room. | 421 Invite other people to join the chat room. |
325 .TP | 422 .TP |
326 .B Ignore | 423 .B Ignore |
327 Ignore anything said by the chosen person | 424 Ignore anything said by the chosen person |
328 .TP | 425 .TP |
329 .B Set Topic | 426 .B Set Topic |
330 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. | 427 Set the topic of the chat room. This is usually a brief sentence |
428 describing the nature of the chat--an explanation of the chat room's name. | |
331 | 429 |
332 .SH AWAY MESSAGES | 430 .SH AWAY MESSAGES |
333 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. | 431 Most protocols allow for away messages. When a user is \fIAway\fR, he can |
334 | 432 leave an informative message for others to see. The \fBAway\fR submenu of |
335 \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. | 433 the \fBTools\fR menu is used to add and remove away messages. |
336 | 434 |
337 \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. | 435 \fINew Away Message\fR provides space for one to enter an away message and |
338 | 436 a title for that message. If \fISave\fR or \fISave & Use\fR are chosen, |
339 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. | 437 this message will be saved. It can later be referred to by the title given |
438 to it. | |
439 | |
440 \fIRemove Away Message\fR is a submenu containing the titles of saved away | |
441 messages. Clicking on one of these titles will remove the away message | |
442 associated with it. | |
443 | |
444 The rest of the \fIaway\fR menu provides the user with a way to assign | |
445 different away messages to different connections. Choosing \fISet All | |
446 Away\fR will set away all the connections capable of the away state. | |
340 | 447 |
341 .SH BUDDY POUNCE | 448 .SH BUDDY POUNCE |
342 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. | 449 A Buddy Pounce is an automated trigger that occurs when a buddy returns to |
450 a normal state from an away state. The \fBNew Buddy Pounce\fR dialog box | |
451 can be activated by selecting the \fIBuddy Pounce\fR submenu from the | |
452 \fBTools\fR menu. A pounce can be set to occur on any combination of the | |
453 events listed, and any combination of actions can result. If \fISave this | |
454 pounce after activation\fR is checked, the trigger will remain until it is | |
455 removed from the \fIRemove Buddy Pounce\fR menu. | |
343 | 456 |
344 .SH PLUGINS | 457 .SH PLUGINS |
345 \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. | 458 \fBGaim\fR allows for dynamic loading of plugins to add extra functionality |
459 to \fBgaim\fR. Plugins can be enabled and configured from the | |
460 \fBPreferences\fR window. See \fIplugins/HOWTO\fR for more information on | |
461 writing plugins. | |
346 | 462 |
347 .SH PERL | 463 .SH PERL |
348 \fBGaim\fR allows for perl scripting. See \fIPerl Scripting HOWTO\fR in the Gaim documentation for more information about perl scripting. | 464 \fBGaim\fR allows for perl scripting. See \fIPerl Scripting HOWTO\fR in |
465 the Gaim documentation for more information about perl scripting. | |
349 | 466 |
350 .SH TCL | 467 .SH TCL |
351 \fBGaim\fR allows for Tcl scripting. See \fIplugins/tcl/TCL-HOWTO\fR for more information about Tcl scripting. | 468 \fBGaim\fR allows for Tcl scripting. See \fIplugins/tcl/TCL-HOWTO\fR for |
469 more information about Tcl scripting. | |
352 | 470 |
353 .SH FILES | 471 .SH FILES |
354 \fI@prefix@/bin/gaim\fR: \fBgaim\fR's location. | 472 \fI@prefix@/bin/gaim\fR: \fBgaim\fR's location. |
355 .br | 473 .br |
356 \fI@prefix@/lib/gaim/\fR: \fBgaim\fR's plugins directory. | 474 \fI@prefix@/lib/gaim/\fR: \fBgaim\fR's plugins directory. |
373 Known bugs are listed at | 491 Known bugs are listed at |
374 .br | 492 .br |
375 \fIhttp://sourceforge.net/tracker/?group_id=235&atid=100235\fR | 493 \fIhttp://sourceforge.net/tracker/?group_id=235&atid=100235\fR |
376 | 494 |
377 .SH PATCHES | 495 .SH PATCHES |
378 If you fix a bug in \fBgaim\fR (or otherwise enhance it), please submit a patch (using \fIcvs diff -up > my.diff\fR against the latest CVS version) at | 496 If you fix a bug in \fBgaim\fR (or otherwise enhance it), please submit a |
497 patch (using \fIcvs diff -up > my.diff\fR against the latest CVS version) | |
498 at | |
379 .br | 499 .br |
380 \fIhttp://sourceforge.net/tracker/?func=add&group_id=235&atid=300235\fR | 500 \fIhttp://sourceforge.net/tracker/?func=add&group_id=235&atid=300235\fR |
381 | 501 |
382 Before sending a bug report, please verify that you have the latest | 502 Before sending a bug report, please verify that you have the latest |
383 version of \fBgaim\fR. Many bugs (major and minor) are fixed | 503 version of \fBgaim\fR. Many bugs (major and minor) are fixed |
384 at each release, and if yours is out of date, the problem may already | 504 at each release, and if yours is out of date, the problem may already |
385 have been solved. | 505 have been solved. |
386 | 506 |
387 .SH SEE ALSO | 507 .SH SEE ALSO |
388 \fIhttp://gaim.sourceforge.net/\fR | 508 \fIhttp://gaim.sourceforge.net/\fR |
389 .br | 509 .br |
395 the Free Software Foundation; either version 2 of the License, or | 515 the Free Software Foundation; either version 2 of the License, or |
396 (at your option) any later version. | 516 (at your option) any later version. |
397 | 517 |
398 This program is distributed in the hope that it will be useful, but | 518 This program is distributed in the hope that it will be useful, but |
399 \fBWITHOUT ANY WARRANTY\fR; without even the implied warranty of | 519 \fBWITHOUT ANY WARRANTY\fR; without even the implied warranty of |
400 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | 520 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
401 General Public License for more details. | 521 General Public License for more details. |
402 | 522 |
403 You should have received a copy of the GNU General Public License | 523 You should have received a copy of the GNU General Public License |
404 along with this program; if not, write to the Free Software | 524 along with this program; if not, write to the Free Software |
405 Foundation, Inc., 59 Temple PLace, Suite 330, Boston, MA 02111-1307 USA | 525 Foundation, Inc., 59 Temple PLace, Suite 330, Boston, MA 02111-1307 USA |
406 | 526 |
407 .SH AUTHORS | 527 .SH AUTHORS |
408 \fBGaim\fR's active developers are: | 528 \fBGaim\fR's active developers are: |