mirror of https://github.com/tiyn/ii
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
98 lines
2.8 KiB
98 lines
2.8 KiB
5 years ago
|
.de FN
|
||
|
|
\fI\|\\$1\|\fP\\$2
|
||
|
|
..
|
||
|
|
.TH ii 1
|
||
|
|
.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 and normal file (out)
|
||
|
|
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 servername ]
|
||
|
|
.RB [ \-p
|
||
|
|
.IR port ]
|
||
|
|
.RB [ \-k
|
||
|
|
.IR environment variable ]
|
||
|
|
.RB [ \-i
|
||
|
|
.IR prefix ]
|
||
|
|
.RB [ \-n
|
||
|
|
.IR nickname ]
|
||
|
|
.RB [ \-f
|
||
|
|
.IR realname ]
|
||
|
|
|
||
|
|
.SH OPTIONS
|
||
|
|
.TP
|
||
|
|
.BI \-s " servername"
|
||
|
|
lets you override the default servername (irc.freenode.net)
|
||
|
|
.TP
|
||
|
|
.BI \-p " port"
|
||
|
|
lets you override the default port (6667)
|
||
|
|
.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.
|
||
|
|
.TP
|
||
|
|
.BI \-i " prefix"
|
||
|
|
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
|
||
|
|
|
||
|
|
.SH DIRECTORIES
|
||
|
|
.TP
|
||
|
|
.FN ~/irc
|
||
|
|
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
|
||
|
|
.FN /a " [<message>]"
|
||
|
|
mark yourself as away
|
||
|
|
.TP
|
||
|
|
.FN /j " #channel/nickname [<message>]"
|
||
|
|
join a channel or open private conversation with user
|
||
|
|
.TP
|
||
|
|
.FN /l " #channel/nickname"
|
||
|
|
leave a channel or query
|
||
|
|
.TP
|
||
|
|
.FN /n " nick"
|
||
|
|
change the nick name
|
||
|
|
.TP
|
||
|
|
.FN /t " topic"
|
||
|
|
set the topic of a channel
|
||
|
|
.TP
|
||
|
|
Everything which is not a command will simply be posted into the channel or to the server.
|
||
|
|
So if you need /who just write /WHO as described in the RFC to the server in FIFO.
|
||
|
|
.TP
|
||
|
|
.FN "out file usage"
|
||
|
|
Write wrappers, pagers or use your tools of choice to display the out file contents (loco, multitail, etc.).
|
||
|
|
.SH CONTACT
|
||
|
|
.TP
|
||
|
|
Write to ii (at) modprobe (dot) de for suggestions, fixes, 7|-|>< ;) etc.
|
||
|
|
.SH AUTHORS
|
||
|
|
Copyright \(co 2005-2006 by Anselm R. Garbe <garbeam (at) gmail (dot) com> and
|
||
|
|
Copyright \(co 2005-2008 by Nico Golde <nico (at) ngolde (dot) de>
|
||
|
|
.SH SEE ALSO
|
||
|
|
.BR echo (1),
|
||
|
|
.BR tail (1),
|