NAME

vicq - console ICQ2000 client

SYNOPSIS

  vicq [-u UIN] [-c config]

DESCRIPTION

vicq is console icq2000 client, simmilar to micq

OPTIONS

-u UIN
When invoked with -u option, vicq expects to read single message from stdin and sends it to the specified UIN

-c config
Use alternative config instead of ~/.vicq/config

CONFIGURATION

Config file (~/.vicq/config) consists of several sections described below. Each section starts with header line like this: '[section_name]'. Lines starting with '#' are comments. You can split entire config in several files using 'include' directive. BUT! You should place whole section in one file, the section header should be placed in the same file. Example of using include you can find at http://www.gonzo.kiev.ua/projects/vicq/eg/

[options]

The [options] section contains configuration variables. Each variable is in ``name=value'' format (case-sensitive).

Configuration variables:

uin (decimal)
User's UIN

password (string)
User's password

keep_config (decimal)
If you dont want to save config on exit set this variable to 1: keep_config=1

encoding (string)
Valid values 'koi' or 'win', depending on your terminal

auto_info (integer)
If not zero, vICQ will request info on every UIN which is not in ContactList automaticaly

prompt (string)
Main vICQ prompt template. The following variables will be parsed and may be used in prompt string: %s - by short description of your status %u - by your uin

Example:

 prompt=vICQ(%s)/%uE<gt>

sms_phonebook (string)
Path to external file with sms phones in [phones] section format. Section tag ('[phones]') is must for this file.

separator_length (integer)
Length of separator line

disable_empty_separators (integer)
if not equal to 0 disables separator without text

history_entries (integer)
Number of messages which displays in user history, if its negative - displays all history

mode (string)
Valid values normal or silent. In silent mode change_status events does not appear on screen.

status (string)
Initial status. Valid values are: 
 Online
 Free_For_Chat
 Away
 Not_Avalible
 Occupied
 Do_Not_Disturb
 Invisible

colors (integer)
If this is not 0, vicq will use colors.

colored_history (integer)
If this is not 0, vICQ use colors for history output(You can set you PAGER environment variable to less -R for using color)

separator_color (string)
Color of the separator line

separator_title_color (string)
Color for the title separator

nick_color (string)
Color for highlighting nicknames

uin_color (string)
Color for highlighting uins

status_color (string)
Color for highlighting status

message_color (string)
Message color

their_history_color (string)
Color for incoming events in history

my_history_color (string)
Color for outgoing events in history

Valid colors are:

 NORMAL
 YELLOW
 MAGENTA
 WHITE
 BLACK
 RED
 GREEN
 BROWN
 BLUE
 CYAN
 LIGHT_CYAN
 LIGHT_RED
 LIGHT_GREEN
 LIGHT_BLUE

And three text attributes for monochrome terminals:

 BOLD
 UNDERSCORE
 REVERSE

player (string)
Command for playing sounds (see [sounds] section) '%f' in player path will be replaced with filename chosen according to the [sounds] section

Example:

 player=/path/to/player -f %f -o /dev/dsp

browser (string)
Command for browsing received URLs: '%u' in browser command will be replaced with last recieved url

Example:

 browser=/path/to/browser -navigator %u

https_proxy (integer)
If not 0, vICQ with work through HTTPS-capable proxy

proxy_host (string)
Proxy host

proxy_port (decimal)
Proxy port

proxy_force_https_port (decimal)
if 1, always connect to login.icq.com on port 443, regardless of what specified in the reconnection messages

Example of proxy configuration:

 https_proxy=1
 proxy_port=3128
 proxy_host=10.25.0.99
 proxy_force_https_port=1

log_path
Directory, which contains history files.

Example:

 log_path=~/.vicq.log

log_type
Specifies method which logs saves. Its a string if its empty - don't log, else calls methods correspondingly chars which appears in strings. Valid chars: 
 a - log to <log_path>/vicq.log
 u - log to <log_path>/<uin>.log
 s - log status changes
 n - make newlines between log records
 l - make symlinks <nick>.log to <uin>.log

Default: log_type=u.

Example:

 log_type=usln

[aliases]

The [aliases] section contains run-time options. Its format is 'alias=command'.

Example:

 m=msg

[phones]

The [phones] section contains phonebook for SMS messages in 'nick phone' format. You can use these aliases in 'sms' command

Example:

 squid +380xxxxx
 ReY +380xxxxxx

[events]

The [events] section contains run-time options. Its format is 'event command' where 'event' is the type of event (could be glob-style wildcard), and 'command' is an external command name to be executed when event occurs. The following variables will be parsed and may be used in 'command' string: %e - by type of event %u - by sender's uin %n - by sender's nick %t - by message text (or status value if type of event is 'status_change')

Example:

 * echo 'Event %e from %n(%u) : %t' | mail mymail@myhost.com

(send email to mymail@myhost.com with the full description of the recieved event)

[sounds]

Section [sounds] is similar to [events] section, allowing you to specify audio files played upon various incoming events. Playback will be done through the ``player'' application defined in the [option] section, with %f token substituted with the proper filename.

[contacts]

[contacts] section lists UINs, format is the same as in .micqrc:

 UIN Nickname

To add user to visible list add asterisk (*) before UIN (see vicqrc.example). If you want be invisible to user add tilde (~) before UIN. If you want create alias for UIN/Nick just add aliases in the line below UIN (see vicqrc.example)

INTERACTIVE OPERATIONS

Messages handling

msg nick|UIN [/msg]
sends an instant ICQ message

sms nick|phone [/msg]
sends SMS to specified person

r
replies to last received message

a
sends a message to the last person you sent a message

auth nick | UIN
sends an authorization to specified UIN

url nick | UIN [URL]
sends an URL to specified person

Status managment

online
changes status to 'Online'

inv
changes status to 'Invisible'

away
changes status to 'Away'

na
changes status to 'Not availabe'

occ
changes status to 'Occupied'

dnd
changes status to 'Do Not Disturb'

ffc
changes status to 'Free for chat'

Contact list managment

add UIN nick
adds UIN as nick to contact list

w
displays the current status of every person in your contact list

e
displays the current status of every online person in your contact list

togvis UIN | nick
adds/removes user to/from visible list

toginvis UIN | nick
adds/removes user to/from invisible list

history UIN | nick [count]
displays last count entries of the user's history. If count is negative shoes all entries

finger UIN | nick
displays user's UIN, nick, current status, IP(and resolved host if available), dirrect connection info, and client version

Miscellaneous commands

help command
displays help on command

! OS command
execute external command

save
saves config

info UIN | nick
sends user info request

search email@host.domain
searches for ICQ user

silent
toggle to silent mode - change status events does not displays

normal
toggle to normal mode - change status events displays

view
open last recieved URL with browser command

set [key[=value]]
shows/sets config variables values

wpset
sets basic White Pages info

Message editing

Input . in the empty line to end message or # to cancel message

AUTHOR

Alexander Timoshenko <gonzo@ukrweb.net>