MICQRC(5)

NAME
~/.micq/micqrc - The configuration file for micq

DESCRIPTION
This manual page describes the configuration file for micq. 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 ~/.micq/.

CONNECTIONS
A Connection section describes a connection within ICQ. Typically, there are two of them, that are related to each other: a connection to the ICQ server, and a connection to listen to peer to peer communication. 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 icq5 for a connection to an ICQ v5 server, icq8 for a connection to an ICQ v8 server, peer for a connection listening to peer to peer communication, or remote for a remote control FIFO. 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 port 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
    For peer to peer connections, this is used for the direct connection setting:

    1   We're firewalled and can't receive any connection. Don't even try.

    2   We're firewalled, but use SOCKS and can receive connections.

    4   We're not firewalled at all. This is the default.
    Remote control FIFOs do not use this setting.

GENERAL
The General section includes the options for SOCKS 5, that may be eventually moved to their own section, general options, and some strings to override.

s5_use number
    Set number to 0 to disable and 1 to enable.

s5_host host
    Connect to socks 5 proxy on host host.

s5_port port
    Connect to socks 5 proxy listening on port port.

s5_auth number
    Set number to 0 to omit authentication and 1 to do authentication.

s5_name name
    Identify as user name to socks 5 proxy.

s5_pass password
    Authenticate with password password to socks 5 proxy.

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

encoding file encoding
    Specify the encoding which is used for strings in this file as encoding. mICQ will write this file in utf8 it utf8 is enabled, otherwise in the current local encoding. If utf8 is disabled, mICQ will refuse to load the file if the encoding given in this option does not agree with the current local one.

encoding local encoding
    Specify the user's terminal's encoding as encoding. This overrides the encoding derived from environment variables.

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.

format nr
    Set the format this config file is to nr. Currently, only format 1 is known and 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 with to width. If unset or 0, 80 will be used. This is rarely needed as usually the current screen width can be deduced on 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.

set log on|off
    Disable or enable logging.

set logonoff on|off
    When logging, disable or enable the logging of online/offline status changes.

set auto on|off
    Disable or enable automatic responses (reply messages).

set uinprompt on|off
    Disable or enable the use of the nick you last received a message from in the prompt.

set autosave on|off
    Disable or enable the automatic saving of the micqrc.

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
    Selects the style of tab cycling. Older versions of mICQ only knew simple, which would only work with the msg command and would complete the command and cycle through all contacts that messages had been sent to or received from. Already typed text after the nick name was lost. cycle however cycles through all online contacts on your contact list. It keeps all other input text intact, however it also doesn't add the default msg command. cycleall is like cycle, it just cycles through all, and not only online, contacts.

set silent type
    Suppress some output, namely status changes for on and status changes, logins and logouts for complete.

chat nr
    Set the random chat group to nr. Use -1 to disable, and 49 for mICQ (which is the default).

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 onandoff 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.
    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.

STRINGS
The Strings section contains command renames.

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 micq(7). This option may be repeated as desired.
    Note: this option is obsolete.

alias <alias> <expansion>
    Define an alias named alias which is substituted with expansion. If the string %s is present in expansion, it is replaced with the given arguments when the alias is invoked, otherwise they will be appended. New for 0.4.10.

GROUP
The Group section contacts a contact group and may be repeated as required. 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.

id <id>
    Set the id of this contact group to id. 0 means no id defined. This will be set when downloading a contact list.

entry <id> <uin>
    Add contact with UIN uin as id id to this contact group.

CONTACTS
The Contacts section contains the (global) contact list. It may become obsolete.

[*][~][^] 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.

SEE ALSO
micq(1), micq(7)

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 <micq@ruediger-kuhlmann.de>.