1CLIMMRC(5) File Formats Manual CLIMMRC(5)
2
6 ~/.climm/climmrc - The configuration file for climm
7
9 This manual page describes the configuration files for climm. It con‐
10 sists of several sections that are started by [section], where section
11 is the name of the section. File or directory names given are taken
12 relative to the base directory, which is usually ~/.climm/.
13
15 A Connection section describes a connection within ICQ. Typically,
16 there are two of them, that are related to each other: a connection to
17 the ICQ server, and a connection to listen to peer to peer communica‐
18 tion. You may also have a remote control connection: that means a FIFO
19 is opened, and lines read from it are interpreted in the same way as
20 input lines.
21 type <type> [auto]
23 Set the connection type to type, which can be icq5 for a connec‐
24 tion to an ICQ v5 server, icq8 for a connection to an ICQ v8
25 server, peer for a connection listening to peer to peer communi‐
26 cation, or remote for a remote control FIFO. If auto is given,
27 create this connection on startup. You presumable want to do
28 this, unless you have several UINs, then set this on the connec‐
29 tion corresponding to this UIN you are using.
30 version <nr>
32 Set the version of the protocol used for this connection to nr.
33 Please note that for a server connections, versions 5, 7 and 8
34 are supported, and for peer to peer connections 6, 7 and 8.
35 Remote control FIFOs don´t have a version.
36 server <server>
38 Set the server to connect to to server. This defaults to
39 login.icq.com. Unused for peer to peer connections. For remote
40 control fifos, this is the path of the FIFO to be created.
41 port <port>
43 Set the port to connect on the server to port, or the first port
44 to try to listen on for peer to peer connections to port.
45 uin <uin>
47 Set the UIN to log in with to uin. Unused for peer to peer con‐
48 nections and remote control FIFOs.
49 password [<password>]
51 Set the password to log in with to password. Unused for peer to
52 peer connections. If omitted, ask for password on startup.
53 Note: BeOS users may not omit the password.
54 status <nr>
56 Set the status to be on log in in to nr. Status can be:
57 0 online
59 1 away
61 5 not available
63 17 occupied
65 19 do not disturb
67 32 free for chat
69 256 invisible
71 For peer to peer connections, this is used for the direct con‐
73 nection setting:
74 1 We´re firewalled and can´t receive any connection. Don´t
76 even try.
77 2 We´re firewalled, but use SOCKS and can receive connec‐
79 tions.
80 4 We´re not firewalled at all. This is the default.
82 Remote control FIFOs do not use this setting.
83
85 The General section includes the options for SOCKS 5, that may be even‐
86 tually moved to their own section, general options, and some strings to
87 override.
88 s5_use <number>
90 Set number to 0 to disable and 1 to enable.
91 s5_host <host>
93 Connect to socks 5 proxy on host host.
94 s5_port <port>
96 Connect to socks 5 proxy listening on port port.
97 s5_auth <number>
99 Set number to 0 to omit authentication and 1 to do authentica‐
100 tion.
101 s5_name <name>
103 Identify as user name to socks 5 proxy.
104 s5_pass <password>
106 Authenticate with password password to socks 5 proxy.
107 A few book-keeping options are usually placed at the beginning of the
109 climmrc file:
110 encoding file <encoding>
112 Specify the encoding which is used for strings in this file as
113 encoding. climm will always write this file in UTF-8.
114 encoding local <encoding>
116 Specify the user´s terminal´s encoding as encoding. This over‐
117 rides the encoding derived from environment variables.
118 Note: Using this will cause the locale to be flagged as broken,
119 thus causing characters outside the iso-8859-1 range to be
120 printed in input handling as hex unicode code points as their
121 screen cell width cannot be determined with wcwidth() anymore.
122 Thus, always use the LC_CTYPE locale setting to override the
123 used character encoding.
124 encoding remote <encoding>
126 Set the encoding to use for meta data on the server, including
127 the password, to encoding. This encoding is also used for com‐
128 municating with other contacts whose client doesn´t understand
129 utf8 messages unless a specific encoding is set for this con‐
130 tact. Deprecated as of climm 0.5; use the encoding global
131 option instead.
132 format <nr>
134 Set the format this config file is to nr. Format 2 is current,
135 but format 1 is also accepted.
136 Now the other options:
138 verbose <level>
140 Set the verbosity level on startup to level.
141 auto_away <time>
143 Set the time to set status to away after to time seconds. Set to
144 0 to disable.
145 Screen_width <width>
147 Set the default screen with to width. If unset or 0, 80 will be
148 used. This is rarely needed as usually the current screen width
149 can be deduced at runtime.
150 set delbs on|off
152 If set to on, let the delete character act as a backspace. When
153 off, let it act as a delete character.
154 set funny on|off
156 Disable or enable "funny" messages.
157 set color on|off
159 Disable or enable the use of colors.
160 set hermit on|off
162 If set to on, ignore all messages from everyone not on your con‐
163 tact list. Deprecated as of climm 0.5, set the global option
164 ignore to on for the same effect.
165 set log on|off
167 Disable or enable logging. Deprecated as of climm 0.5, set the
168 global option logmess to on for the same effect.
169 set logonoff on|off
171 When logging, disable or enable the logging of online/offline
172 status changes. Deprecated as of climm 0.5, set the global
173 options logmess and logchange to on for the same effect.
174 set auto on|off
176 Disable or enable automatic responses (reply messages).
177 set autosave on|off
179 Disable or enable the automatic saving of the climmrc.
180 set autofinger on|off
182 Disable or enable the automatic fingering of new UINs.
183 set linebreak <type>
185 Configure the line break type for incoming messages to type,
186 which can be simple to just wrap lines as usual, break to have a
187 line break before each message, indent to have a line break and
188 indent the message and smart to have a line break only if the
189 message doesn´t fit on the current line.
190 set tabs simple|cycle|cycleall
192 Deprecated as of climm 0.5, as it uses a much improved tab han‐
193 dling now which has all of the previous features.
194 set silent <type>
196 Suppress some output, namely status changes for on and status
197 changes, logins and logouts for complete. Deprecated as of
198 climm 0.5, use global options showchange and showonoff to on for
199 the same effect.
200 options <options>
202 Set global options. See the opt command for details.
203 chat <nr>
205 Set the random chat group to nr. Use -1 to disable, and 49 for
206 climm (which is the default).
207 autoupdate <level>
209 Current level of automatic configuration updates done. Will be
210 incremented to a bigger value each time configuration is updated
211 to new default values. Do not make the mistake to set to 0 to
212 disable as that will have the effect of all updates being re-
213 done.
214 At last, some strings can be defined:
216 color scheme <nr>
218 Select the color scheme number nr.
219 color <use> <color>
221 Select color color for use. use can be any of none, server,
222 client, message, contact, sent, ack, error, debug or incoming,
223 while color can be any one of black, red, green, yellow, blue,
224 magenta, cyan, white, none, or bold or a combination of those
225 (bold, however, must be last to take effect), or any verbatim
226 string to make the user´s terminal select the desired color.
227 logplace <file>|<dir>
229 Set the file to log into to file, or the directory to log into
230 to dir. Please note that a path is assumed to be a directory if
231 it has a trailing /.
232 sound on|beep|off|event
234 Specify what happens if a beep is to be generated. on or beep
235 will simply beep, off will do noting, while event will call the
236 script for events.
237 event <script>
239 Set the script to execute for events to script. It is called
240 with the following arguments:
241 1. The IM type, currently only icq.
242 2. The UIN of the contact this event relates to, or 0.
243 3. The nick of the contact this events to relates to, or the
244 empty string.
245 4. The string global.
246 5. The type of this event, which can be msg, on, off, beep or
247 status, where on and off are for oncoming and offgoing contacts.
248 This list may not be exhaustive.
249 6. For messages, the message type, for offgoing contacts, the
250 previous status, and for oncoming contacts or status changes,
251 the new status, otherwise 0.
252 7. The text of the message.
253 8. The contact´s user agent.
254 Note that for security reasons, single quotes may be replaced by
255 double quotes, and the message text may be truncated.
256 auto <status> <string>
258 Set the automatic reply in status status to string. This option
259 may be repeated for all possible values away, na, dnd, occ, inv,
260 and ffc for status.
261 prompt_strftime <strftime_format>
263 Set format for option %T used in user prompt. For details see
264 climmcmds(7) and strftime(3).
265
267 The Strings section contains command renames.
268 prompt <user_prompt>
270 Set user prompt in user_prompt. For details see command prompt
271 in climmcmds(7).
272 alter <old> <new>
274 Rename command old to new. Note the old name may still be used,
275 unless it conflicts with some new name. For possible command
276 names, see climmcmds(7). This option may be repeated as
277 desired.
278 Note: this option is obsolete, use alias instead.
279 alias [auto[expand]] <alias> <expansion>
281 Define an alias named alias which is substituted with expansion.
282 If the auto or autoexpand keyword is given, the expansion also
283 happens when the space key or the return key is pressed directly
284 after the alias. If the string %s is present in expansion, each
285 occurence is replaced with the given arguments when the alias is
286 invoked, otherwise they will be appended. If the string %r is
287 present in expansion, each occurence is replaced by the nick
288 name or, if the nick is not available, the UIN, of the contact
289 that sent the last message to you, or the empty string if there
290 is none. If the string %a is present in expansion, each
291 occurence is replaced by the nick name or, if the nick is not
292 available, the UIN, of the contact that you sent the last mes‐
293 sage to, or the empty string if there is none.
294 New for 0.4.10. Auto-expanding aliases new for 0.5.0.4.
295
297 The Group section contacts a contact group and may be repeated as
298 required. Note that for format 2, it is saved in the BASE/status file,
299 not in BASE/climmrc. It may have the following commands:
300 server <type> <uin>
302 Set the server connection this contact group belongs to to the
303 one of type type, which currently can be icqv8 for ICQ server
304 connections version 8 or icqv5 for ICQ server connections ver‐
305 sion 5, and for UIN uin. If this command is omitted, the first
306 active server connection is assumed.
307 label <label>
309 Set the label of this contact group to label. If it is con‐
310 tacts-<type>-<uin>, then it is the contact list for this server
311 connection. Note that for format 2 of the BASE/status file, this
312 is obsolete, as the contacts distributed to the server connec‐
313 tions according to the server statement in their Contacts sec‐
314 tion.
315 id <id>
317 Set the id of this contact group to id. 0 means no id defined.
318 This will be set when downloading or uploading a contact list.
319 options <options>...
321 Define options for this contact group. See the opt command for
322 details.
323 entry <id> <uin>
325 Add contact with UIN uin as id id to this contact group. Note
326 that id is obsolete as of climm 0.5 and always set to 0. The id
327 is set in the Contacts section instead.
328
330 The Contacts section contains the (global) contact list. It is obsolete
331 in this format.
332 [*][~][^] uin nick
334 Make user with UIN uin known under the nick nick. If * is
335 given, the user may see you while you´re invisible. If ~ is
336 given, let him see you as always offline. If ^ is given, ignore
337 this user. If a uin occurs multiple times, all except the first
338 are treated as aliases.
339
341 The Contacts section contains a contact list for one server connection.
342 It is repeated for each server connection. Note that it is saved in
343 the BASE/status file, not in BASE/climmrc. It may have the following
344 commands:
345 server <type> <uin>
347 Defines the server connection this is the contact list for, with
348 the same syntax as in the Group section.
349 entry <id> <uin> <nick>...
351 Adds user with the UIN uin and id id to this contact list, with
352 nick and arbitrary many aliases nick.
353 options <options>...
355 Define options for the previous contact. See the opt command for
356 details.
357
359 climm(1), climmcmds(7)
360
362 This man page was written by James Morrison <ja2morrison@stu‐
363 dent.math.uwaterloo.ca>. It was rewritten to match new config file
364 syntax by Rüdiger Kuhlmann <climm@ruediger-kuhlmann.de>.
365 climm CLIMMRC(5)