Mercurial > pidgin.yaz
comparison doc/pidgin.1.in @ 21153:b16bc37d07e6
Some more work on the man page. Updated the sections for the Interface,
Conversations, Smiley Themes, and Sounds tabs of the Preferences dialog.
author | John Bailey <rekkanoryo@rekkanoryo.org> |
---|---|
date | Tue, 06 Nov 2007 19:05:42 +0000 |
parents | c2cd8ea9a60a |
children | 50970c85709a |
comparison
equal
deleted
inserted
replaced
21151:4886667b0686 | 21153:b16bc37d07e6 |
---|---|
30 .PP | 30 .PP |
31 \fBpidgin\fR is a graphical modular messaging client based on libpurple | 31 \fBpidgin\fR is a graphical modular messaging client based on libpurple |
32 which is capable of connecting to AIM, MSN, Yahoo!, XMPP, ICQ, IRC, SILC, | 32 which is capable of connecting to AIM, MSN, Yahoo!, XMPP, ICQ, IRC, SILC, |
33 Novell GroupWise, Lotus Sametime, Zephyr, Gadu-Gadu, and QQ all at once. It has | 33 Novell GroupWise, Lotus Sametime, Zephyr, Gadu-Gadu, and QQ all at once. It has |
34 many common features found in other clients, as well as many unique features. | 34 many common features found in other clients, as well as many unique features. |
35 Finch is not endorsed by or affiliated with America Online, ICQ, Microsoft, or | 35 Pidgin is not endorsed by or affiliated with America Online, ICQ, Microsoft, or |
36 Yahoo. | 36 Yahoo. |
37 | 37 |
38 .SH OPTIONS | 38 .SH OPTIONS |
39 The following options are provided by Pidgin using the standard GNU | 39 The following options are provided by Pidgin using the standard GNU |
40 command line syntax: | 40 command line syntax: |
46 Print debugging messages to stdout. These are the same debugging messages | 46 Print debugging messages to stdout. These are the same debugging messages |
47 that are displayed in the \fBDebug Window\fR. | 47 that are displayed in the \fBDebug Window\fR. |
48 .TP | 48 .TP |
49 .B \-h, \-\-help | 49 .B \-h, \-\-help |
50 Print a summary of command line options and exit. | 50 Print a summary of command line options and exit. |
51 .TP | |
52 .B \-m, \-\-multiple | |
53 Allow multiple instances of Pidgin to run. | |
51 .TP | 54 .TP |
52 .B \-n, \-\-nologin | 55 .B \-n, \-\-nologin |
53 Don't automatically login when Pidgin starts. Sets the global status to | 56 Don't automatically login when Pidgin starts. Sets the global status to |
54 \fBOffline\fR. | 57 \fBOffline\fR. |
55 .TP | 58 .TP |
66 this window you can see which of your buddies is online, away, idle, etc. | 69 this window you can see which of your buddies is online, away, idle, etc. |
67 You can also add and remove buddies from your buddy list. | 70 You can also add and remove buddies from your buddy list. |
68 | 71 |
69 The \fBBuddy List\fR window contains a list of your buddies who are online | 72 The \fBBuddy List\fR window contains a list of your buddies who are online |
70 and have allowed you to be notified of their presence. The icon to the | 73 and have allowed you to be notified of their presence. The icon to the |
71 left of each buddy indicates the buddy's current state and the protocol | 74 left of each buddy indicates the buddy's current status. Double clicking |
72 they are using. Double clicking a buddy will open a new \fBConversation\fR | 75 a buddy will open a new \fBConversation\fR window. Right clicking will |
73 window. Right clicking will pop up a menu: | 76 pop up a menu: |
74 .TP | 77 .TP |
75 .B Get Info | 78 .B Get Info |
76 Retrieves and displays information about the buddy. This information is | 79 Retrieves and displays information about the buddy. This information is |
77 also known as a Profile. | 80 also known as a Profile. |
78 .TP | 81 .TP |
87 A Buddy Pounce is a configurable automated action to be performed when the | 90 A Buddy Pounce is a configurable automated action to be performed when the |
88 buddy's state changes. This will open the \fBBuddy Pounce\fR dialog to be | 91 buddy's state changes. This will open the \fBBuddy Pounce\fR dialog to be |
89 discussed later. | 92 discussed later. |
90 .TP | 93 .TP |
91 .B View Log | 94 .B View Log |
92 Pidgin is capable of automatically log its activities. These logs are | 95 Pidgin is capable of automatically logging messages. These logs are |
93 either plain text files (with a .txt extension) or html files (with a | 96 either plain text files (with a .txt extension) or html files (with a |
94 \&.html extension) located under the \fI~/.purple/logs\fR directory. This | 97 \&.html extension) located under the \fI~/.purple/logs\fR directory. This |
95 menu command will display Pidgin's log viewer with logs loaded for that | 98 menu command will display Pidgin's log viewer with logs loaded for that |
96 buddy or chat. | 99 buddy or chat. |
97 .TP | 100 .TP |
98 .B Alias | 101 .B Alias |
99 Create an alias for this buddy. This will open up a new dialog in which | 102 Create an alias for this buddy. This will show an editable text field where |
100 one can give this buddy an alternate name to appear on the buddy list and | 103 the buddy's screen name was displayed. In this field one can give this |
101 in conversations. | 104 buddy an alternate, more friendly name to appear on the buddy list and in |
105 conversations. | |
102 | 106 |
103 For example, if a buddy's name screen name was jsmith1281xx and his real | 107 For example, if a buddy's name screen name was jsmith1281xx and his real |
104 name was 'John Q. Smith,' one could create an alias as to identify the | 108 name was 'John Q. Smith,' one could create an alias as to identify the |
105 buddy by his common name. | 109 buddy by his common name. |
106 .LP | 110 .LP |
107 The remainder of the menu will consist of protocol specific commands. | 111 The remainder of the menu will consist of protocol specific commands. |
108 These commands vary depending on the protocol. | 112 These commands vary depending on the protocol. |
109 .LP | 113 .TP |
110 At the bottom of the \fBBuddy List\fR are several buttons (if enabled in | 114 .B Status Selector |
111 \fBPreferences\fR): | 115 At the bottom of the \fBBuddy List\fR is a status selector which allows |
112 .TP | 116 one to change his/her status. This will be discussed further below. |
113 .B IM | 117 .T |
114 Opens a new \fBConversation\fR window to to the selected buddy, or brings | |
115 up the \fBNew Message\fR dialog box if no buddy is selected. | |
116 .TP | |
117 .B Info | |
118 Retrieves and display information about the selected buddy, or brings up | |
119 the \fBGet User Info\fR dialog box if no buddy is selected. | |
120 .TP | |
121 .B Chat | |
122 Brings up the \fBJoin Chat\fR dialog box, prompting the user to select | |
123 which username to use and what chat group to join. | |
124 .TP | |
125 .B Away | |
126 Brings up a menu of all available \fBAway Messages\fR. If an item is | |
127 selected, all online accounts will use this item as their away message. | |
128 | 118 |
129 .SH ACCOUNT EDITOR | 119 .SH ACCOUNT EDITOR |
130 The account editor consists of a list of accounts and information about | 120 The account editor consists of a list of accounts and information about |
131 them. Clicking \fIDelete\fR will delete the currently selected account. | 121 them. It can be accessed by selecting \fBManage\fR from the Tools menu. |
122 Clicking \fIDelete\fR will delete the currently selected account. | |
132 Clicking \fIAdd\fR or \fIModify\fR will invoke a \fBModify Account\fR | 123 Clicking \fIAdd\fR or \fIModify\fR will invoke a \fBModify Account\fR |
133 window. Here, you can add or alter account information. When creating a | 124 window. Here, you can add or alter account information. When creating a |
134 new account, you will submit your screen name and password. You will also | 125 new account, you will submit your screen name and password. You will also |
135 choose your protocol. | 126 choose your protocol. |
136 | 127 |
137 If \fIRemember Password\fR is chosen, the password will be saved in | 128 If \fIRemember Password\fR is chosen, the password will be saved in |
138 Pidgin's configuration file. | 129 Pidgin's \fI~/.purple/accounts.xml\fR configuration file. |
139 | 130 |
140 If \fIAuto-Login\fR is chosen, this account will automatically login upon | 131 If \fIEnabled\fR is checked in the accounts dialog, this account will |
141 starting Pidgin. | 132 follow the status currently selected in the status selector. If it is |
133 not checked, the account will always be offline. | |
142 | 134 |
143 Each protocol has its own specific options that can be found in the | 135 Each protocol has its own specific options that can be found in the |
144 modify screen. | 136 modify screen. |
145 | 137 |
146 .SH PREFERENCES | 138 .SH PREFERENCES |
147 | 139 |
148 All options take effect immediately. | 140 All options take effect immediately. |
149 | 141 |
150 .SH Interface | 142 .SH Interface |
151 | 143 |
152 \fIDisplay remote nicknames if no alias is set\fR: Toggles whether server | 144 .TP |
153 nickname data should be used if no local alias exists. | 145 .B Show system tray icon |
154 | 146 Specifies when to show a Pidgin icon in the notification area of your |
155 .SH Buddy List | 147 panel (commonly referred to as the System Tray). |
156 \fISorting\fR: Toggles the order in which buddies are shown in your | 148 |
157 \fBBuddy List\fR between none, alphabetical, by status and by log size. | 149 .TP |
158 | 150 .B Hide new IM conversations |
159 \fIShow buttons as\fR: Toggles between picture-only, text-only, picture and | 151 Specifies when to hide new IM messages. Messages will queue under the |
160 text or no buttons view of the buttons on the \fBBuddy List\fR. | 152 specified condition until shown. Clicking the Pidgin icon in the |
161 | 153 notification area or system tray will display the queued messages. An |
162 \fIRaise window on events\fR: Tells Pidgin to bring the \fBBuddy | 154 icon also appears in the buddy list's menu bar; this icon may also be |
163 List\fR window to the top when buddies sign in or out. | 155 used to display queued messages. |
164 | 156 |
165 \fIShow numbers in groups\fR: The number of buddies from each group | 157 .TP |
166 currently logged in will be shown along with the total number of buddies in | 158 .B Show IMs and chats in tabbed windows |
167 the group. | 159 When checked, this option will cause IM and chat sessions to appear in |
168 | 160 windows with multiple tabs. One tab will represent one conversation or |
169 \fIShow buddy icons\fR: Toggles the display of buddies' custom icons. | 161 chat. Where tabs are placed will be dictated by the preferences below. |
170 | 162 |
171 \fIShow warning levels\fR: Each buddy's warning level will be displayed | 163 .TP |
172 next to the screen name. As a buddy's warning level increases, outgoing | 164 .B Show close buttons on tabs |
173 messages are more and more severely rate-limited. | 165 When checked, this option will cause a clickable "U+2715 MULTIPLICATION X" |
174 | 166 unicode character to appear at the right edge of each tab. Clicking this |
175 \fIShow idle times\fR: The amount of time each buddy has been idle will be | 167 will cause the tab to be closed. |
176 displayed next to the screen name (if the buddy has opted to have their | 168 |
177 client report this information). | 169 .TP |
178 | 170 .B Placement |
179 \fIDim idle buddies\fR: If enabled, idle buddies will be displayed in grey | 171 Specifies where to place tabs in the window. Some tab orientations may |
180 text instead of black text. | 172 allow some users to fit more tabs into a single window comfortably. |
181 | 173 |
182 \fIAutomatically expand contacts\fR: If enabled, contacts will | 174 .TP |
183 automatically expand to show the associated buddies when the mouse is held | 175 .B New conversations |
184 over the contact for a short period. | 176 Specifies under which conditions tabs are placed into existing windows or |
177 into new windows. For a single window, select \fILast created window\fR here. | |
185 | 178 |
186 .SH Conversations | 179 .SH Conversations |
187 | 180 |
188 \fIShow buttons as...\fR: The selected item will determine whether | 181 .TP |
189 picture-only, text-only, combined picture/text, or no buttons will be used | 182 .B Enable buddy icon animation |
190 for \fBConversation\fR windows. | 183 If a buddy's icon happens to be animated, this option will enable the |
191 | 184 animation, otherwise only the first frame will be displayed. |
192 \fIShow formatting toolbar\fR: Display the formatting toolbar between the | 185 |
193 upper and lower text boxes in conversations. | 186 .TP |
194 | 187 .B Notify buddies that you are typing to them |
195 \fIShow aliases in tabs/titles\fR: Displays buddy alias instead of screen | 188 Some protocols allow clients to tell their buddies when they are typing. |
196 name in window tabs and titles. | 189 This option enables this feature for protocols that supports it. For XMPP, |
197 | 190 this also enables sending the "User has left the conversation" message |
198 \fIShow buddy icons\fR: For protocols that support it, buddy icons allow | 191 when ending the conversation. |
199 buddies to send small pictures to be displayed during the course of a | 192 |
200 conversation. Turning this option off hides those pictures. | 193 .TP |
201 | 194 .B Default Formatting |
202 \fIEnable buddy icon animation\fR: If these pictures happen to be animated, | 195 Allows specifying the default formatting to apply to all outgoing messages |
203 this option will enable the animation, otherwise only the first frame will | 196 (only applicable to protocols that support formatting in messages). |
204 be displayed. | 197 |
205 | 198 .SH Smiley Themes |
206 \fINotify buddies that you are typing to them\fR: Some protocols allow | |
207 clients to tell their buddies when they are typing. This option enables | |
208 this feature for protocols that supports it. | |
209 | |
210 \fIRaise IM windows on events\fR: If enabled, IM \fBConversation\fR windows | |
211 will be brought to the top when new messages are received. | |
212 | |
213 \fIRaise Chat windows on events\fR: If enabled, chat \fBConversation\fR windows | |
214 will be brought to the top when new messages are received. | |
215 | |
216 \fIUse multi-colored screen names in chats\fR: Color code the screen names of | |
217 users in chat rooms. | |
218 | |
219 .TP | |
220 .B Tab Options | |
221 \fIShow IMs and chats in tabbed windows\fR: Tabbed chatting allows one to | |
222 have multiple conversations without multiple windows. | |
223 | |
224 \fIShow close buttons on tabs\fR: Adds a close button to each tab. | |
225 | |
226 \fITab Placement...\fR: Specifies where tabs are shown in the conversation | |
227 window. | |
228 | |
229 \fI New conversation placement...\fR: Determines where new conversations will | |
230 be placed (Last created window / New window / windows grouped by group or | |
231 account / separate windows for IMs and Chats). | |
232 | |
233 .TP | |
234 .B Message Text | |
235 \fIShow timestamp on messages\fR: Toggles the timestamp behavior for | |
236 conversations. Per-conversation behavior can be changed by pressing | |
237 \fIF2\fR in the \fBConversation\fR window. | |
238 | |
239 \fIHighlight misspelled words\fR: Toggles highlighting of misspelled words | |
240 as you type. | |
241 | |
242 \fIIgnore colors/font faces/font sizes\fR: Tells Pidgin to disregard | |
243 buddies' color/font/size information in displaying IMs or Chats. | |
244 | |
245 \fIDefault Formatting\fR: Allows specifying the default formatting to apply | |
246 to all outgoing messages (only applicable to protocols that support | |
247 formatting in messages). | |
248 | |
249 .TP | |
250 .B Shortcuts | |
251 Allows the user to determine which keyboard shortcuts are available. | |
252 | |
253 .TP | |
254 .B Smiley Themes | |
255 Allows the user to choose between different smiley themes. The "none" theme | 199 Allows the user to choose between different smiley themes. The "none" theme |
256 will disable graphical emoticons - they will be displayed as text instead. | 200 will disable graphical emoticons - they will be displayed as text instead. |
201 The \fBAdd\fR and \fBRemove\fR buttons may be used to install or uninstall | |
202 smiley themes. Themes may also be installed by dragging and dropping them | |
203 onto the list of themes. | |
257 | 204 |
258 .SH Sounds | 205 .SH Sounds |
259 | 206 |
260 \fISounds while away\fR: Determines whether sounds are played when an away | 207 .TP |
261 message is up. | 208 .B Method |
262 | 209 Lets the user choose between different playback methods. The user can also |
263 \fISound Method\fR lets the user choose between different playback methods. | 210 manually enter a command to be executed when a sound is to be played\ |
264 The user can also manually enter a command to be executed when a sound is | 211 (\fI%s\fR expands to the full path to the file name). |
265 to be played (\fI%s\fR expands to the full path to the file name). | 212 |
213 .TP | |
214 .B Sounds when conversation has focus | |
215 When checked, sounds will play for events in the active conversation if | |
216 the window is focused. When unchecked, sounds will not play for the | |
217 active conversation when the window is focused. | |
218 | |
219 .TP | |
220 .B Enable Sounds | |
221 Determines when to play sounds. | |
266 | 222 |
267 .TP | 223 .TP |
268 .B Sound Events | 224 .B Sound Events |
269 Lets the user choose when and what sounds are to be played. | 225 Lets the user choose when and what sounds are to be played. |
270 | 226 |
418 .SH TCL | 374 .SH TCL |
419 Pidgin allows for Tcl scripting. See \fIplugins/tcl/TCL-HOWTO\fR for | 375 Pidgin allows for Tcl scripting. See \fIplugins/tcl/TCL-HOWTO\fR for |
420 more information about Tcl scripting. | 376 more information about Tcl scripting. |
421 | 377 |
422 .SH FILES | 378 .SH FILES |
423 \fI@prefix@/bin/pidgin\fR: Pidgin's location. | 379 \fI@prefix@/bin/pidgin\fR: Pidgin's location. |
424 .br | 380 .br |
425 \fI@prefix@/lib/pidgin/\fR: Pidgin's plugins directory. | 381 \fI@prefix@/lib/pidgin/\fR: Pidgin's plugins directory. |
426 .br | 382 .br |
427 \fI~/.purple/prefs.xml\fR: Pidgin's configuration file. | 383 \fI@prefix@/lib/purple-2/\fR: libpurple's plugins directory. |
428 .br | 384 .br |
429 \fI~/.purple/accounts.xml\fR: information about your accounts. | 385 \fI~/.purple/prefs.xml\fR: Pidgin's configuration file. |
430 .br | 386 .br |
431 \fI~/.purple/status.xml\fR: stores your away messages. | 387 \fI~/.purple/accounts.xml\fR: information about your accounts. |
432 .br | 388 .br |
433 \fI~/.purple/pounces.xml\fR: stores your buddy pounces. | 389 \fI~/.purple/status.xml\fR: stores your away messages. |
434 .br | 390 .br |
435 \fI~/.purple/logs/PROTOCOL/ACCOUNT/SCREENNAME/DATE.{html,txt}\fR: conversation logs. | 391 \fI~/.purple/pounces.xml\fR: stores your buddy pounces. |
436 .br | 392 .br |
437 \fI~/.purple/blist.xml\fR: the buddy list. | 393 \fI~/.purple/logs/PROTOCOL/ACCOUNT/SCREENNAME/DATE.{html,txt}\fR: conversation logs. |
438 .br | 394 .br |
439 \fI~/.purple/plugins/\fR: users' local plugins | 395 \fI~/.purple/blist.xml\fR: the buddy list. |
396 .br | |
397 \fI~/.purple/plugins/\fR: users' local plugins | |
440 | 398 |
441 .SH BUGS | 399 .SH BUGS |
442 The bug tracker can be reached by visiting \fIhttp://developer.pidgin.im/query\fR | 400 The bug tracker can be reached by visiting \fIhttp://developer.pidgin.im/query\fR |
443 | 401 |
444 .SH PATCHES | 402 .SH PATCHES |