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 server connection within climm. Typi‐
16 cally, these are to connect to ICQ or XMPP servers. You may also have
17 a remote control connection: that means a FIFO is opened, and lines
18 read from it are interpreted in the same way as input lines.
19 type <type> [auto]
21 Set the connection type to type, which can be icq8 for a connec‐
22 tion to an ICQ v8 server or xmpp for a connection to an XMPP
23 server. If auto is given, create this connection on startup.
24 You presumable want to do this, unless you have several UINs,
25 then set this on the connection corresponding to this UIN you
26 are using.
27 version <nr>
29 Set the version of the protocol used for this connection to nr.
30 Please note that for a server connections, versions 5, 7 and 8
31 are supported, and for peer to peer connections 6, 7 and 8.
32 Remote control FIFOs don´t have a version.
33 server <server>
35 Set the server to connect to to server. This defaults to
36 login.icq.com. Unused for peer to peer connections. For remote
37 control fifos, this is the path of the FIFO to be created.
38 port <port>
40 Set the port to connect on the server to port, or the first port
41 to try to listen on for peer to peer connections to port.
42 uin <uin>
44 Set the UIN to log in with to uin. Unused for peer to peer con‐
45 nections and remote control FIFOs.
46 password [<password>]
48 Set the password to log in with to password. Unused for peer to
49 peer connections. If omitted, ask for password on startup.
50 Note: BeOS users may not omit the password.
51 status <nr>
53 Set the status to be on log in in to nr. Status can be:
54 0 online
56 1 away
58 5 not available
60 17 occupied
62 19 do not disturb
64 32 free for chat
66 256 invisible
68 options <options>
70 Define options for this server connection. See the opt command
71 in climmcmds(7) for a complete list.
72
74 The General section includes general options and some strings to over‐
75 ride.
76 A few book-keeping options are usually placed at the beginning of the
78 climmrc file:
79 encoding file <encoding>
81 Specify the encoding which is used for strings in this file as
82 encoding. climm will always write this file in UTF-8.
83 encoding local <encoding>
85 Specify the user´s terminal´s encoding as encoding. This over‐
86 rides the encoding derived from environment variables.
87 Note: Using this will cause the locale to be flagged as broken,
88 thus causing characters outside the iso-8859-1 range to be
89 printed in input handling as hex unicode code points as their
90 screen cell width cannot be determined with wcwidth() anymore.
91 Thus, always use the LC_CTYPE locale setting to override the
92 used character encoding.
93 encoding remote <encoding>
95 Set the encoding to use for meta data on the server, including
96 the password, to encoding. This encoding is also used for com‐
97 municating with other contacts whose client doesn´t understand
98 utf8 messages unless a specific encoding is set for this con‐
99 tact. Deprecated as of climm 0.5; use the encoding global
100 option instead.
101 format <nr>
103 Set the format this config file is to nr. Format 2 is current,
104 but format 1 is also accepted.
105 Now the other options:
107 verbose <level>
109 Set the verbosity level on startup to level.
110 auto_away <time>
112 Set the time to set status to away after to time seconds. Set to
113 0 to disable.
114 Screen_width <width>
116 Set the default screen width to width. If unset or 0, 80 will
117 be used. This is rarely needed as usually the current screen
118 width can be deduced at runtime.
119 set delbs on|off
121 If set to on, let the delete character act as a backspace. When
122 off, let it act as a delete character.
123 set funny on|off
125 Disable or enable "funny" messages.
126 set color on|off
128 Disable or enable the use of colors.
129 set hermit on|off
131 If set to on, ignore all messages from everyone not on your con‐
132 tact list. Deprecated as of climm 0.5, set the global option
133 ignore to on for the same effect.
134 set log on|off
136 Disable or enable logging. Deprecated as of climm 0.5, set the
137 global option logmess to on for the same effect.
138 set logonoff on|off
140 When logging, disable or enable the logging of online/offline
141 status changes. Deprecated as of climm 0.5, set the global
142 options logmess and logchange to on for the same effect.
143 set auto on|off
145 Disable or enable automatic responses (reply messages).
146 set autosave on|off
148 Disable or enable the automatic saving of the climmrc.
149 set autofinger on|off
151 Disable or enable the automatic fingering of new UINs.
152 set linebreak <type>
154 Configure the line break type for incoming messages to type,
155 which can be simple to just wrap lines as usual, break to have a
156 line break before each message, indent to have a line break and
157 indent the message and smart to have a line break only if the
158 message doesn´t fit on the current line.
159 set tabs simple|cycle|cycleall
161 Deprecated as of climm 0.5, as it uses a much improved tab han‐
162 dling now which has all of the previous features.
163 set silent <type>
165 Suppress some output, namely status changes for on and status
166 changes, logins and logouts for complete. Deprecated as of
167 climm 0.5, use global options showchange and showonoff to on for
168 the same effect.
169 options <options>
171 Set global options. See the opt command for details.
172 chat <nr>
174 Set the random chat group to nr. Use -1 to disable, and 49 for
175 climm (which is the default).
176 autoupdate <level>
178 Current level of automatic configuration updates done. Will be
179 incremented to a bigger value each time configuration is updated
180 to new default values. Do not make the mistake to set to 0 to
181 disable as that will have the effect of all updates being re-
182 done.
183 At last, some strings can be defined:
185 color scheme <nr>
187 Select the color scheme number nr.
188 color <use> <color>
190 Select color color for use. use can be any of none, server,
191 client, message, contact, sent, ack, error, debug or incoming,
192 while color can be any one of black, red, green, yellow, blue,
193 magenta, cyan, white, none, or bold or a combination of those
194 (bold, however, must be last to take effect), or any verbatim
195 string to make the user´s terminal select the desired color.
196 logplace <file>|<dir>
198 Set the file to log into to file, or the directory to log into
199 to dir. Please note that a path is assumed to be a directory if
200 it has a trailing /.
201 sound on|beep|off|event
203 Specify what happens if a beep is to be generated. on or beep
204 will simply beep, off will do noting, while event will call the
205 script for events.
206 event <script>
208 Set the script to execute for events to script. It is called
209 with the following arguments:
210 1. The IM type, currently only icq.
211 2. The UIN of the contact this event relates to, or 0.
212 3. The nick of the contact this events to relates to, or the
213 empty string.
214 4. The string global.
215 5. The type of this event, which can be msg, on, off, beep or
216 status, where on and off are for oncoming and offgoing contacts.
217 This list may not be exhaustive.
218 6. For messages, the message type, for offgoing contacts, the
219 previous status, and for oncoming contacts or status changes,
220 the new status, otherwise 0.
221 7. The text of the message.
222 8. The contact´s user agent.
223 Note that for security reasons, single quotes may be replaced by
224 double quotes, and the message text may be truncated.
225 auto <status> <string>
227 Set the automatic reply in status status to string. This option
228 may be repeated for all possible values away, na, dnd, occ, inv,
229 and ffc for status.
230 prompt_strftime <strftime_format>
232 Set format for option %T used in user prompt. For details see
233 climmcmds(7) and strftime(3).
234
236 The Strings section contains command renames.
237 prompt <user_prompt>
239 Set user prompt in user_prompt. For details see command prompt
240 in climmcmds(7).
241 alter <old> <new>
243 Rename command old to new. Note the old name may still be used,
244 unless it conflicts with some new name. For possible command
245 names, see climmcmds(7). This option may be repeated as
246 desired.
247 Note: this option is obsolete, use alias instead.
248 alias [auto[expand]] <alias> <expansion>
250 Define an alias named alias which is substituted with expansion.
251 If the auto or autoexpand keyword is given, the expansion also
252 happens when the space key or the return key is pressed directly
253 after the alias. If the string %s is present in expansion, each
254 occurence is replaced with the given arguments when the alias is
255 invoked, otherwise they will be appended. If the string %r is
256 present in expansion, each occurence is replaced by the nick
257 name or, if the nick is not available, the UIN, of the contact
258 that sent the last message to you, or the empty string if there
259 is none. If the string %a is present in expansion, each
260 occurence is replaced by the nick name or, if the nick is not
261 available, the UIN, of the contact that you sent the last mes‐
262 sage to, or the empty string if there is none.
263 New for 0.4.10. Auto-expanding aliases new for 0.5.0.4.
264
266 The Group section contacts a contact group and may be repeated as
267 required. Note that for format 2, it is saved in the BASE/status file,
268 not in BASE/climmrc. It may have the following commands:
269 server <type> <uin>
271 Set the server connection this contact group belongs to to the
272 one of type type, which currently can be icqv8 for ICQ server
273 connections version 8 or icqv5 for ICQ server connections ver‐
274 sion 5, and for UIN uin. If this command is omitted, the first
275 active server connection is assumed.
276 label <label>
278 Set the label of this contact group to label. If it is con‐
279 tacts-<type>-<uin>, then it is the contact list for this server
280 connection. Note that for format 2 of the BASE/status file, this
281 is obsolete, as the contacts distributed to the server connec‐
282 tions according to the server statement in their Contacts sec‐
283 tion.
284 id <id>
286 Set the id of this contact group to id. 0 means no id defined.
287 This will be set when downloading or uploading a contact list.
288 options <options>...
290 Define options for this contact group. See the opt command for
291 details.
292 entry <id> <uin>
294 Add contact with UIN uin as id id to this contact group. Note
295 that id is obsolete as of climm 0.5 and always set to 0. The id
296 is set in the Contacts section instead.
297
299 The Contacts section contains the (global) contact list. It is obsolete
300 in this format.
301 [*][~][^] uin nick
303 Make user with UIN uin known under the nick nick. If * is
304 given, the user may see you while you´re invisible. If ~ is
305 given, let him see you as always offline. If ^ is given, ignore
306 this user. If a uin occurs multiple times, all except the first
307 are treated as aliases.
308
310 The Contacts section contains a contact list for one server connection.
311 It is repeated for each server connection. Note that it is saved in
312 the BASE/status file, not in BASE/climmrc. It may have the following
313 commands:
314 server <type> <uin>
316 Defines the server connection this is the contact list for, with
317 the same syntax as in the Group section.
318 entry <id> <uin> <nick>...
320 Adds user with the UIN uin and id id to this contact list, with
321 nick and arbitrary many aliases nick.
322 options <options>...
324 Define options for the previous contact. See the opt command for
325 details.
326
328 climm(1), climmcmds(7)
329
331 This man page was written by James Morrison <ja2morrison@stu‐
332 dent.math.uwaterloo.ca>. It was rewritten to match new config file
333 syntax by Rüdiger Kuhlmann <climm@ruediger-kuhlmann.de>.
334 climm CLIMMRC(5)