NAME

~/.climm/climmrc - The configuration file for climm

DESCRIPTION

This manual page describes the configuration files for climm. It consists of several sections that are started by [section], where section is the name of the section. File or directory names given are taken relative to the base directory, which is usually ~/.climm/.

CONNECTIONS

A Connection section describes a server connection within climm. Typically, these are to connect to ICQ or XMPP servers. You may also have a remote control connection: that means a FIFO is opened, and lines read from it are interpreted in the same way as input lines.

type <type> [auto]: Set the connection type to type, which can be icq8 for a connection to an ICQ v8 server or xmpp for a connection to an XMPP server. If auto is given, create this connection on startup. You presumable want to do this, unless you have several UINs, then set this on the connection corresponding to this UIN you are using.
version <nr>: Set the version of the protocol used for this connection to nr. Please note that for a server connections, versions 5, 7 and 8 are supported, and for peer to peer connections 6, 7 and 8. Remote control FIFOs don´t have a version.
server <server>: Set the server to connect to to server. This defaults to login.icq.com. Unused for peer to peer connections. For remote control fifos, this is the path of the FIFO to be created.
port <port>: Set the port to connect on the server to port, or the first port to try to listen on for peer to peer connections to port.
uin <uin>: Set the UIN to log in with to uin. Unused for peer to peer connections and remote control FIFOs.
password [<password>]: Set the password to log in with to password. Unused for peer to peer connections. If omitted, ask for password on startup. Note: BeOS users may not omit the password.
status <nr>: Set the status to be on log in in to nr. Status can be:

0: online
1: away
5: not available
17: occupied
19: do not disturb
32: free for chat
256: invisible

options <options>: Define options for this server connection. See the opt command in climmcmds(7) for a complete list.

GENERAL

The General section includes general options and some strings to override.

A few book-keeping options are usually placed at the beginning of the climmrc file:

encoding file <encoding>: Specify the encoding which is used for strings in this file as encoding. climm will always write this file in UTF-8.
encoding local <encoding>: Specify the user´s terminal´s encoding as encoding. This overrides the encoding derived from environment variables.
Note: Using this will cause the locale to be flagged as broken, thus causing characters outside the iso-8859-1 range to be printed in input handling as hex unicode code points as their screen cell width cannot be determined with wcwidth() anymore. Thus, always use the LC_CTYPE locale setting to override the used character encoding.
encoding remote <encoding>: Set the encoding to use for meta data on the server, including the password, to encoding. This encoding is also used for communicating with other contacts whose client doesn´t understand utf8 messages unless a specific encoding is set for this contact. Deprecated as of climm 0.5; use the encoding global option instead.
format <nr>: Set the format this config file is to nr. Format 2 is current, but format 1 is also accepted.

Now the other options:

verbose <level>: Set the verbosity level on startup to level.
auto_away <time>: Set the time to set status to away after to time seconds. Set to 0 to disable.
Screen_width <width>: Set the default screen width to width. If unset or 0, 80 will be used. This is rarely needed as usually the current screen width can be deduced at runtime.
set delbs on|off: If set to on, let the delete character act as a backspace. When off, let it act as a delete character.
set funny on|off: Disable or enable "funny" messages.
set color on|off: Disable or enable the use of colors.
set hermit on|off: If set to on, ignore all messages from everyone not on your contact list. Deprecated as of climm 0.5, set the global option ignore to on for the same effect.
set log on|off: Disable or enable logging. Deprecated as of climm 0.5, set the global option logmess to on for the same effect.
set logonoff on|off: When logging, disable or enable the logging of online/offline status changes. Deprecated as of climm 0.5, set the global options logmess and logchange to on for the same effect.
set auto on|off: Disable or enable automatic responses (reply messages).
set autosave on|off: Disable or enable the automatic saving of the climmrc.
set autofinger on|off: Disable or enable the automatic fingering of new UINs.
set linebreak <type>: Configure the line break type for incoming messages to type, which can be simple to just wrap lines as usual, break to have a line break before each message, indent to have a line break and indent the message and smart to have a line break only if the message doesn´t fit on the current line.
set tabs simple|cycle|cycleall: Deprecated as of climm 0.5, as it uses a much improved tab handling now which has all of the previous features.
set silent <type>: Suppress some output, namely status changes for on and status changes, logins and logouts for complete. Deprecated as of climm 0.5, use global options showchange and showonoff to on for the same effect.
options <options>: Set global options. See the opt command for details.
chat <nr>: Set the random chat group to nr. Use -1 to disable, and 49 for climm (which is the default).
autoupdate <level>: Current level of automatic configuration updates done. Will be incremented to a bigger value each time configuration is updated to new default values. Do not make the mistake to set to 0 to disable as that will have the effect of all updates being re-done.

At last, some strings can be defined:

color scheme <nr>: Select the color scheme number nr.
color <use> <color>: Select color color for use. use can be any of none, server, client, message, contact, sent, ack, error, debug or incoming, while color can be any one of black, red, green, yellow, blue, magenta, cyan, white, none, or bold or a combination of those (bold, however, must be last to take effect), or any verbatim string to make the user´s terminal select the desired color.
logplace <file>|<dir>: Set the file to log into to file, or the directory to log into to dir. Please note that a path is assumed to be a directory if it has a trailing /.
sound on|beep|off|event: Specify what happens if a beep is to be generated. on or beep will simply beep, off will do noting, while event will call the script for events.
event <script>: Set the script to execute for events to script. It is called with the following arguments:
1. The IM type, currently only icq.
2. The UIN of the contact this event relates to, or 0.
3. The nick of the contact this events to relates to, or the empty string.
4. The string global.
5. The type of this event, which can be msg, on, off, beep or status, where on and off are for oncoming and offgoing contacts. This list may not be exhaustive.
6. For messages, the message type, for offgoing contacts, the previous status, and for oncoming contacts or status changes, the new status, otherwise 0.
7. The text of the message.
8. The contact´s user agent.
Note that for security reasons, single quotes may be replaced by double quotes, and the message text may be truncated.
auto <status> <string>: Set the automatic reply in status status to string. This option may be repeated for all possible values away, na, dnd, occ, inv, and ffc for status.
prompt_strftime <strftime_format>: Set format for option %T used in user prompt. For details see climmcmds(7) and strftime(3).

STRINGS

The Strings section contains command renames.

prompt <user_prompt>: Set user prompt in user_prompt. For details see command prompt in climmcmds(7).
alter <old> <new>: Rename command old to new. Note the old name may still be used, unless it conflicts with some new name. For possible command names, see climmcmds(7). This option may be repeated as desired.
Note: this option is obsolete, use alias instead.
alias [auto[expand]] <alias> <expansion>: Define an alias named alias which is substituted with expansion. If the auto or autoexpand keyword is given, the expansion also happens when the space key or the return key is pressed directly after the alias. If the string %s is present in expansion, each occurence is replaced with the given arguments when the alias is invoked, otherwise they will be appended. If the string %r is present in expansion, each occurence is replaced by the nick name or, if the nick is not available, the UIN, of the contact that sent the last message to you, or the empty string if there is none. If the string %a is present in expansion, each occurence is replaced by the nick name or, if the nick is not available, the UIN, of the contact that you sent the last message to, or the empty string if there is none.
New for 0.4.10. Auto-expanding aliases new for 0.5.0.4.

GROUP

The Group section contacts a contact group and may be repeated as required. Note that for format 2, it is saved in the BASE/status file, not in BASE/climmrc. It may have the following commands:

server <type> <uin>: Set the server connection this contact group belongs to to the one of type type, which currently can be icqv8 for ICQ server connections version 8 or icqv5 for ICQ server connections version 5, and for UIN uin. If this command is omitted, the first active server connection is assumed.
label <label>: Set the label of this contact group to label. If it is contacts-<type>-<uin>, then it is the contact list for this server connection. Note that for format 2 of the BASE/status file, this is obsolete, as the contacts distributed to the server connections according to the server statement in their Contacts section.
id <id>: Set the id of this contact group to id. 0 means no id defined. This will be set when downloading or uploading a contact list.
options <options>...: Define options for this contact group. See the opt command for details.
entry <id> <uin>: Add contact with UIN uin as id id to this contact group. Note that id is obsolete as of climm 0.5 and always set to 0. The id is set in the Contacts section instead.

CONTACTS (obsolete format)

The Contacts section contains the (global) contact list. It is obsolete in this format.

[*][~][^] uin nick: Make user with UIN uin known under the nick nick. If * is given, the user may see you while you´re invisible. If ~ is given, let him see you as always offline. If ^ is given, ignore this user. If a uin occurs multiple times, all except the first are treated as aliases.

CONTACTS

The Contacts section contains a contact list for one server connection. It is repeated for each server connection. Note that it is saved in the BASE/status file, not in BASE/climmrc. It may have the following commands:

server <type> <uin>: Defines the server connection this is the contact list for, with the same syntax as in the Group section.
entry <id> <uin> <nick>...: Adds user with the UIN uin and id id to this contact list, with nick and arbitrary many aliases nick.
options <options>...: Define options for the previous contact. See the opt command for details.

AUTHOR

This man page was written by James Morrison <ja2morrison@student.math.uwaterloo.ca>. It was rewritten to match new config file syntax by Rüdiger Kuhlmann <climm@ruediger-kuhlmann.de>.