centerim.1

   1 .TH CENTERIM 1 "April 2, 2007"
   2
   3 .SH NAME
   4 \fBcenterim\fP \- a text mode based IM client for Linux, *BSD, Sun
   5 Solaris, MacOS X and possibly, other Unices. ICQ2000, Yahoo!, AIM TOC,
   6 IRC, MSN, Gadu-Gadu and Jabber protocols are now supported. Internal
   7 LiveJournal client and RSS reader are also provided.
   8
   9 .SH SYNOPSIS
  10 .B "centerim "
  11 [
  12 .B option
  13 ] ...
  14
  15 .SH DESCRIPTION
  16 This manual page documents briefly the
  17 .B centerim
  18 command.
  19 .PP
  20 \fBcenterim\fP is a text mode menu- and window-driven IM interface.
  21 Currently ICQ2000, Yahoo!, AIM, IRC, MSN, Gadu-Gadu and Jabber protocols
  22 are supported. It allows you to send, receive, and forward messages,
  23 URLs, SMSes and, contacts, mass message send, search for users
  24 (including extended "whitepages search"), view users' details, maintain
  25 your contact list directly from the program (including non-icq
  26 contacts), view the messages history, register a new UIN and update your
  27 details, be informed on receiving email messages, automatically set away
  28 after the defined period of inactivity (on any console), and have your
  29 own ignore, visible and invisible lists. It can also associate events
  30 with sounds, add events to the outgoing queue from command line, define
  31 external event processing actions (like events auto-forwarding or
  32 elizatalk), has support for Hebrew and Arabic languages and allows to
  33 arrange contacts into groups.
  34
  35 .SH OPTIONS
  36 .TP
  37 \fB\-a\fR, \fB\-\-ascii\fR
  38 use ascii characters to draw lines and boxes
  39 .TP
  40 \fB\-h\fR, \fB\-\-help\fR
  41 display command line usage
  42 .TP
  43 \fB\-v\fR, \fB\-\-version\fR
  44 show the program version info
  45 .TP
  46 \fB\-b\fR, \fB\-\-basedir\fR <directory>
  47 specify another base directory; useful for having several IM identities
  48 under the same UNIX account
  49 .TP
  50 \fB\-B\fR, \fB\-\-bind\fR <hostname/ip>
  51 tells centerim to use the specified IP address for outgoing connections
  52 .TP
  53 \fB\-B\fR, \fB\-\-no\-xtitles\fR
  54 disable title changing in xterm or screen
  55 .TP
  56 \fB\-o\fR, \fB\-\-offline\fR
  57 start with all protocols set offline
  58
  59 .PP
  60
  61 The following commands are used to put events to the outgoing queue from
  62 the command line. If centerim is already running they're to be sent
  63 immediately, otherwise they will be sent as soon as you go on-line.
  64
  65
  66 .TP
  67 \fB\-s\fR, \fB\-\-send\fR <event type>
  68 This parameter specifies the type of event you want to send.
  69 Currently only "msg", "url" and "sms" are supported.
  70 .TP
  71 \fB\-p\fR, \fB\-\-proto\fR <protocol type>
  72 This one specifies to which IM network the destination contact
  73 belongs. Can be "icq", "yahoo", "aim", "irc", "jab", "msn", "gg" or "lj".
  74 .TP
  75 \fB\-t\fR, \fB\-\-to\fR <nickname or UIN>
  76 With this one you specify nickname or UIN of the
  77 destination contact. For icq it's possible to specify 0 to send
  78 events to yourself. Only SMSes are known to be possible to be sent
  79 to oneself though.
  80 .TP
  81 \fB\-n\fR, \fB\-\-number\fR <phone number>
  82 Using this parameter you can send SMSes to any mobile numbers
  83 through the ICQ network.
  84
  85 .PP
  86
  87 The message text is read from the standard input, so use pipes in shell
  88 to pass it. For example, you can say "hi" to me through the ICQ network
  89 with the following command:
  90
  91     \fB$ echo "hi" | centerim -s msg -p icq -t 17502151\fR
  92
  93 In case you want to send an URL, the URL itself and its description are
  94 separated with a newline character the following way:
  95
  96     \fB$ echo -e "http://thekonst.net/\\nMy modest homepage." \
  97     | centerim -s url -p icq -t 17502151\fR
  98
  99 Please note, that all three parameters are required in order to queue an
 100 event.
 101
 102 Finally, a small example of sending SMSes:
 103
 104     \fB$ echo "sms test" | centerim -s sms -n 1234567890\fR
 105
 106 .PP
 107
 108
 109 It's also possible to change your current status on a particular IM
 110 network with the following command line option.
 111
 112 .TP
 113 \fB\-S\fR, \fB\-\-status\fR <status letter>
 114 The argument parameter is a letter which indicates which status is
 115 to be set: o (Online), _ (Offline), a (Away), d (Don't disturb), n (N/A),
 116 c (Occupied), f (Free for chat), i (Invisible)
 117 .TP
 118 \fB\-p\fR or \fB\-\-proto\fR <protocol name>
 119 Exactly the same like it was described for the previous command.
 120
 121 .PP
 122
 123
 124 Examples:
 125
 126     \fB$ centerim -S _ -p icq\fR
 127
 128 This will set the icq status to offline. In other words, it'll be
 129 disconnected immediately.
 130
 131     \fB$ centerim -S a -p yahoo\fR
 132
 133 And this command will switch your yahoo status to away.
 134
 135
 136 .SH VERSION
 137 centerim 4.22.1
 138
 139 .SH BUG REPORT
 140 Report any bugs at our Bugzilla site at http://bugzilla.centerim.org/
 141
 142 .SH AUTHOR
 143 This page and centerim was originally written by Konstantin Klyagin.
 144 Currently, several people are maintaining this software project.
 145
 146 .SH WEB
 147 http://www.centerim.org/