Mercurial > pidgin.yaz
comparison doc/gaim.1.in @ 8736:374477c0dd76
[gaim-migrate @ 9491]
(21:37:35) nosnilmot: LSchiere: do you want this?
http://nosnilmot.com/patches/gaim-0.77cvs-doclove.patch
(21:38:43) LSchiere: oh wow
(21:38:44) LSchiere: sure
(21:38:56) nosnilmot: oh crap, does that spelling nonsense conflict with
it?
(21:40:22) nosnilmot: LSchiere: apparently the spelling police avoided doc/
, so that patch should still apply
(21:40:29) KingAnt: :-)
(21:40:31) LSchiere: nosnilmot: commit message?
(21:40:44) KingAnt: "Dr. Love"
(21:40:54) nosnilmot: "I never knew EvilDennisR did anything, now I do"
(21:41:05) LSchiere: and the serious commit message?
but apparently we aren't being serious tonight.
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Wed, 21 Apr 2004 01:43:16 +0000 |
parents | 9758dcf0afcc |
children | 350c6845c792 |
comparison
equal
deleted
inserted
replaced
8735:92cbf9713795 | 8736:374477c0dd76 |
---|---|
37 Launch the \fBAccount Editor\fR rather than the \fBLogin\fR 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\fR window. | 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=\fIFILE\fB | 42 .B \-c, \-\-config=\fIDIR\fB |
43 Use \fIFILE\fR as the configuration file instead of \fI~/.gaimrc\fR. | 43 Use \fIDIR\fR as the directory for config files instead of \fI~/.gaim\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[=\fINAME\fB] | 48 .B \-l, \-\-login[=\fINAME\fB] |
70 .TP | 70 .TP |
71 .B Add Buddy Pounce | 71 .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. | 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. |
73 .TP | 73 .TP |
74 .B View Log | 74 .B View Log |
75 \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. | 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. |
76 .TP | 76 .TP |
77 .B Alias | 77 .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. | 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. |
79 | 79 |
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. | 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. |
117 .SH Interface | 117 .SH Interface |
118 | 118 |
119 \fIDisplay remote nicknames if no alias is set\fR: Toggles whether server nickname data should be used if no local alias exists. | 119 \fIDisplay remote nicknames if no alias is set\fR: Toggles whether server nickname data should be used if no local alias exists. |
120 | 120 |
121 .TP | 121 .TP |
122 .B Themes | 122 .B Smiley Themes |
123 Allows the user to choose between different emoticon themes. | 123 Allows the user to choose between different smiley themes. |
124 .TP | 124 .TP |
125 .B Fonts | 125 .B Fonts |
126 Lets the user pick a default font style/face/color for all accounts (only available in protocols that accept HTML messages). | 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 | 127 .TP |
128 .B Message Text | 128 .B Message Text |
129 \fIShow graphical smileys\fR: Enables the replacement of text emoticons with their graphical equivalents. | 129 \fIShow graphical smileys\fR: Enables the replacement of text emoticons with their graphical equivalents. |
130 | 130 |
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. | 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. |
136 .TP | 136 .TP |
137 .B Shortcuts | 137 .B Shortcuts |
138 Allows the user to determine which keyboard shortcuts are available. | 138 Allows the user to determine which keyboard shortcuts are available. |
139 .TP | 139 .TP |
140 .B Buddy List | 140 .B Buddy List |
141 \fIHide IM/Info/Chat buttons\fR: Disables the display of these buttons on the | 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. |
142 \fBBuddy List\fR's \fBOnline\fR pane. | 142 |
143 | 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. |
144 \fIShow pictures on buttons\fR: Toggles between picture-only and text-only views of the buttons on the \fBBuddy List\fR. | |
145 | |
146 \fISave window size/position\fR: If enabled, \fBgaim\fR will place the \fBBuddy List\fR at its last screen position at start-up. | |
147 | 144 |
148 \fIRaise window on events\fR: Tells \fBgaim\fR to bring the \fBBuddy List\fR window to the top when buddies sign in or out. | 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. |
149 | 146 |
150 \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. | |
151 | |
152 \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. | 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. |
153 | 148 |
154 \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. | 149 \fIShow buddy icons\fR: Toggles the display of buddies' custom icons. |
155 | 150 |
156 \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. | 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. |
157 | 152 |
158 \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). | 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). |
159 | 154 |
160 \fIGrey idle buddies\fR: If enabled, idle buddies will be displayed in grey text instead of black text. | 155 \fIDim idle buddies\fR: If enabled, idle buddies will be displayed in grey text instead of black text. |
156 | |
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. | |
158 | |
159 .SH Conversations | |
160 | |
161 \fIPlacement...\fR: Determines where new conversations will be placed (Last created window / New window / windows grouped by group or account). | |
162 | |
163 \fISend URLs as links\fR: Automatically turns URLs into clickable links when sent on protocols that support HTML. | |
164 | |
165 \fIShow formatting toolbar\fR: Display the formatting toolbar between the upper and lower text boxes in conversations. | |
166 | |
167 \fIShow aliases in tabs/titles\fR: Displays buddy alias instead of screen name in window tabs and titles. | |
168 | |
169 \fITab Placement...\fR: Specifies where tabs are shown in the conversation window. | |
170 | |
171 \fIShow IMs and chats in tabbed windows\fR: Tabbed chatting allows one to have multiple conversations without multiple windows. | |
172 | |
173 \fIShow IMs and chats in same tabbed window\fR: Uses the same window for both IMs and chats. | |
174 | |
175 \fIShow close buttons on tabs\fR: Adds a close button to each tab. | |
176 | |
177 \fIShow status icons on tabs\fR: Adds an icon to each tab representing the buddy's status. | |
178 | |
161 .TP | 179 .TP |
162 .B IM Window | 180 .B IM Window |
163 \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. | 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. |
164 | 182 |
165 \fINew window width/height...\fR: The values here determine how large \fBConversation\fR windows are by default. However, each window can be independently resized. | 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. |
184 \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. | 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. |
185 \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. | 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. |
186 | 204 |
187 \fIColorize screennames\fR: Color code the screen names of users in chat rooms. | 205 \fIColorize screennames\fR: Color code the screen names of users in chat rooms. |
188 .TP | 206 .TP |
189 .B Tabs | |
190 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. | |
191 | 207 |
192 .SH Proxy | 208 .SH Proxy |
193 | 209 |
194 The configuration section to enable \fBgaim\fR to operate through a proxy server. \fBgaim\fR currently supports SOCKS 4/5 and HTTP proxies. | 210 The configuration section to enable \fBgaim\fR to operate through a proxy server. \fBgaim\fR currently supports SOCKS 4/5 and HTTP proxies. |
195 | 211 |
201 | 217 |
202 \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. | 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. |
203 | 219 |
204 .SH Sounds | 220 .SH Sounds |
205 | 221 |
206 \fINo sounds when you log in\fR: Makes the log-in process silent. | 222 \fISounds when you log in\fR: Enables sounds during log-in. |
207 | 223 |
208 \fISounds while away\fR: Determines whether sounds are played when an away message is up. | 224 \fISounds while away\fR: Determines whether sounds are played when an away message is up. |
209 | 225 |
210 \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). | 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). |
211 | 227 |
242 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. | 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. |
243 | 259 |
244 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. | 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. |
245 | 261 |
246 .SH CONVERSATIONS | 262 .SH CONVERSATIONS |
247 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: | 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: |
248 .TP | 264 .TP |
249 .B Bold | 265 .B Bold |
250 adds <b></b> to your message | 266 Turns on/off bold. |
251 .TP | 267 .TP |
252 .B Italics | 268 .B Italics |
253 adds <i></i> to your message | 269 Turns on/off italics. |
254 .TP | 270 .TP |
255 .B Underline | 271 .B Underline |
256 adds <u></u> to your message | 272 Turns on/off underline. |
257 .TP | 273 .TP |
258 .B Decrease font size | 274 .B Decrease font size |
259 adds <font size="1"></font> to your message | 275 Increases the size of the message text. |
260 .TP | |
261 .B Default font size | |
262 adds <font size="3"></font> to your message | |
263 .TP | 276 .TP |
264 .B Increase font size | 277 .B Increase font size |
265 adds <font size="5"></font> to your message | 278 Decreases the size of the message text. |
266 .TP | 279 .TP |
267 .B Select a foreground color | 280 .B Select a foreground color |
268 adds an appropriate font tag to your message. | 281 Changes the foreground color of the message text. |
269 .TP | 282 .TP |
270 .B Select a background color | 283 .B Select a background color |
271 adds an appropriate body tag to your message. | 284 Changes the background color of the message text. |
272 .TP | 285 .TP |
273 .B Add image | 286 .B Add image |
274 inserts an appropriate img tag (not available in all protocols). | 287 Inserts an in-line image in the message. |
275 .TP | 288 .TP |
276 .B Add hyperlink | 289 .B Add hyperlink |
277 adds an appropriate a href tag to your message. | 290 Adds a clickable link to the message. |
278 .TP | 291 .TP |
279 .B Add smiley | 292 .B Add smiley |
280 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. | 293 Adds an emoticon (smiley) to your message. |
281 | 294 |
282 Beneath the lower text box is a row of buttons that execute commands: | 295 Beneath the lower text box is a row of buttons that execute commands: |
283 .TP | 296 .TP |
284 .B Warn | 297 .B Warn |
285 This issues a warning to the other person in the conversation (not available in all protocols). | 298 This issues a warning to the other person in the conversation (not available in all protocols). |
332 \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. | 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. |
333 | 346 |
334 .SH PERL | 347 .SH PERL |
335 \fBGaim\fR allows for perl scripting. See \fIPerl Scripting HOWTO\fR in the Gaim documentation for more information about perl scripting. | 348 \fBGaim\fR allows for perl scripting. See \fIPerl Scripting HOWTO\fR in the Gaim documentation for more information about perl scripting. |
336 | 349 |
350 .SH TCL | |
351 \fBGaim\fR allows for Tcl scripting. See \fIplugins/tcl/TCL-HOWTO\fR for more information about Tcl scripting. | |
352 | |
337 .SH FILES | 353 .SH FILES |
338 \fI@prefix@/bin/gaim\fR: \fBgaim\fR's location. | 354 \fI@prefix@/bin/gaim\fR: \fBgaim\fR's location. |
339 .br | 355 .br |
340 \fI@prefix@/lib/gaim/\fR: \fBgaim\fR's plugins directory. | 356 \fI@prefix@/lib/gaim/\fR: \fBgaim\fR's plugins directory. |
341 .br | 357 .br |
345 .br | 361 .br |
346 \fI~/.gaim/status.xml\fR: stores your away messages. | 362 \fI~/.gaim/status.xml\fR: stores your away messages. |
347 .br | 363 .br |
348 \fI~/.gaim/pounces.xml\fR: stores your buddy pounces. | 364 \fI~/.gaim/pounces.xml\fR: stores your buddy pounces. |
349 .br | 365 .br |
350 \fI~/.gaim/logs/SCREENNAME.log\fR: a log of all conversation with \fISCREENNAME\fR. | 366 \fI~/.gaim/logs/PROTOCOL/ACCOUNT/SCREENNAME/DATE.log\fR: conversation logs. |
351 .br | 367 .br |
352 \fI~/.gaim/blist.xml\fR: the buddy list. | 368 \fI~/.gaim/blist.xml\fR: the buddy list. |
369 .br | |
370 \fI~/.gaim/plugins/\fR: users local plugins | |
353 | 371 |
354 .SH BUGS | 372 .SH BUGS |
355 Known bugs are listed at \fIhttp://sourceforge.net/tracker/?group_id=235&atid=100235\fR. | 373 Known bugs are listed at |
374 .br | |
375 \fIhttp://sourceforge.net/tracker/?group_id=235&atid=100235\fR | |
356 | 376 |
357 .SH PATCHES | 377 .SH PATCHES |
358 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. | 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 |
379 .br | |
380 \fIhttp://sourceforge.net/tracker/?func=add&group_id=235&atid=300235\fR | |
359 | 381 |
360 Before sending a bug report, please verify that you have the latest | 382 Before sending a bug report, please verify that you have the latest |
361 version of \fBgaim\fR. Many bugs (major and minor) are fixed | 383 version of \fBgaim\fR. Many bugs (major and minor) are fixed |
362 at each release, and if yours is out of date, the problem may already | 384 at each release, and if yours is out of date, the problem may already |
363 have been solved. | 385 have been solved. |