ii/ii.1

98 lines
2.6 KiB
Groff
Raw Normal View History

.TH II 1 ii\-VERSION
2005-12-19 16:39:54 +03:00
.SH NAME
ii \- irc it or irc improved
.SH DESCRIPTION
.B ii
is a minimalistic FIFO and filesystem based IRC client.
It creates an irc directory tree with server, channel and
nick name directories.
In every directory a FIFO file (in) and normal file (out)
2005-12-19 16:39:54 +03:00
is placed. This will be for example ~/irc/irc.freenode.net/.
The in file is used to communicate with the servers and the out
files includes the server messages. For every channel and every nick
name there will be new in and out files.
The basic idea of this is to be able to communicate with an IRC
server with basic command line tools.
For example if you will join a channel just do echo "/j #channel" > in
and ii creates a new channel directory with in and out file.
.SH SYNOPSIS
.B ii
.RB < \-s
.IR host >
2005-12-19 16:39:54 +03:00
.RB [ \-p
.IR port ]
|
.RB < \-u
.IR sockname >
2005-12-19 16:39:54 +03:00
.RB [ \-i
.IR ircdir ]
2005-12-19 16:39:54 +03:00
.RB [ \-n
.IR nickname ]
.RB [ \-f
.IR realname ]
.RB [ \-k
.IR "environment variable" ]
2005-12-19 16:39:54 +03:00
.SH OPTIONS
.TP
.BI \-s " servername"
server/host to connect to, for example: irc.freenode.net
2005-12-19 16:39:54 +03:00
.TP
.BI \-p " port"
lets you override the default port (6667)
.TP
.BI \-u " sockname"
connect to a UNIX domain socket instead of directly to a server.
2005-12-19 16:39:54 +03:00
.TP
.BI \-i " ircdir"
2005-12-19 16:39:54 +03:00
lets you override the default irc path (~/irc)
.TP
.BI \-n " nickname"
lets you override the default nick ($USER)
.TP
.BI \-f " realname"
lets you specify your real name associated with your nick
.TP
.BI \-k " environment variable"
lets you specify an environment variable that contains your IRC password, e.g. IIPASS="foobar" ii -k IIPASS.
This is done in order to prevent other users from eavesdropping the server
password via the process list.
2005-12-19 16:39:54 +03:00
.SH DIRECTORIES
.TP
.B ~/irc
2005-12-19 16:39:54 +03:00
In this directory the irc tree will be created. In this directory you
will find a directory for your server (default: irc.freenode.net) in
which the FIFO and the output file will be stored.
If you join a channel a new directory with the name of the channel
will be created in the ~/irc/$servername/ directory.
.SH COMMANDS
.TP
.BI /a " [<message>]"
mark yourself as away
.TP
.BI /j " #channel/nickname [<message>]"
2007-01-23 02:01:43 +03:00
join a channel or open private conversation with user
2005-12-19 16:39:54 +03:00
.TP
.BI /l " [reason]"
2007-02-01 13:56:45 +03:00
leave a channel or query
2005-12-19 16:39:54 +03:00
.TP
.BI /n " nick"
2005-12-19 16:39:54 +03:00
change the nick name
.TP
.BI /q " [reason]"
quit ii
2005-12-19 16:39:54 +03:00
.TP
.BI /t " topic"
set the topic of a channel
.SH RAW COMMANDS
.LP
Everything which is not a command will be posted into the channel or to the server.
So if you need /who just write /WHO as described in RFC#1459 to the server in FIFO.
.SH SSL/TLS PROTOCOL SUPPORT
.LP
For SSL/TLS protocol support you can connect to a local tunnel, for example
with stunnel or socat.
2005-12-19 16:39:54 +03:00
.SH SEE ALSO
.BR echo (1),
.BR tail (1)