usage: Normalize a bit the usage and man-page
This commit is contained in:
parent
25c000bf98
commit
39907c79a4
94
ii.1
94
ii.1
@ -1,6 +1,23 @@
|
|||||||
.TH II 1 ii\-VERSION
|
.TH II 1 ii-VERSION
|
||||||
.SH NAME
|
.SH NAME
|
||||||
ii \- irc it or irc improved
|
ii - irc it or irc improved
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B ii
|
||||||
|
.B -s
|
||||||
|
.I host
|
||||||
|
.RB [ -p
|
||||||
|
.I port
|
||||||
|
|
|
||||||
|
.B -u
|
||||||
|
.IR sockname ]
|
||||||
|
.RB [ -i
|
||||||
|
.IR ircdir ]
|
||||||
|
.RB [ -n
|
||||||
|
.IR nickname ]
|
||||||
|
.RB [ -f
|
||||||
|
.IR realname ]
|
||||||
|
.RB [ -k
|
||||||
|
.IR env_pass ]
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
.B ii
|
.B ii
|
||||||
is a minimalistic FIFO and filesystem based IRC client.
|
is a minimalistic FIFO and filesystem based IRC client.
|
||||||
@ -15,43 +32,30 @@ The basic idea of this is to be able to communicate with an IRC
|
|||||||
server with basic command line tools.
|
server with basic command line tools.
|
||||||
For example if you will join a channel just do echo "/j #channel" > in
|
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.
|
and ii creates a new channel directory with in and out file.
|
||||||
.SH SYNOPSIS
|
|
||||||
.B ii
|
|
||||||
.RB < \-s
|
|
||||||
.IR host >
|
|
||||||
.RB [ \-p
|
|
||||||
.IR port ]
|
|
||||||
.RB [ \-u
|
|
||||||
.IR sockname ]
|
|
||||||
.RB [ \-i
|
|
||||||
.IR ircdir ]
|
|
||||||
.RB [ \-n
|
|
||||||
.IR nickname ]
|
|
||||||
.RB [ \-f
|
|
||||||
.IR realname ]
|
|
||||||
.RB [ \-k
|
|
||||||
.IR "environment variable" ]
|
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
.TP
|
.TP
|
||||||
.BI \-s " servername"
|
.BI -s " host"
|
||||||
server/host to connect to, for example: irc.freenode.net
|
server/host to connect to, for example: irc.freenode.net
|
||||||
.TP
|
.TP
|
||||||
.BI \-p " port"
|
.BI -p " port"
|
||||||
lets you override the default port (6667)
|
lets you override the default port (6667)
|
||||||
.TP
|
.TP
|
||||||
.BI \-u " sockname"
|
.BI -u " sockname"
|
||||||
connect to a UNIX domain socket instead of directly to a server.
|
connect to a UNIX domain socket instead of directly to a server.
|
||||||
|
If set, the
|
||||||
|
.B -p
|
||||||
|
option will be ignored.
|
||||||
.TP
|
.TP
|
||||||
.BI \-i " ircdir"
|
.BI -i " ircdir"
|
||||||
lets you override the default irc path (~/irc)
|
lets you override the default irc path (~/irc)
|
||||||
.TP
|
.TP
|
||||||
.BI \-n " nickname"
|
.BI -n " nickname"
|
||||||
lets you override the default nick ($USER)
|
lets you override the default nick ($USER)
|
||||||
.TP
|
.TP
|
||||||
.BI \-f " realname"
|
.BI -f " realname"
|
||||||
lets you specify your real name associated with your nick
|
lets you specify your real name associated with your nick
|
||||||
.TP
|
.TP
|
||||||
.BI \-k " environment variable"
|
.BI -k " env_pass"
|
||||||
lets you specify an environment variable that contains your IRC password,
|
lets you specify an environment variable that contains your IRC password,
|
||||||
e.g. IIPASS="foobar" ii -k IIPASS.
|
e.g. IIPASS="foobar" ii -k IIPASS.
|
||||||
This is done in order to prevent other users from eavesdropping the server
|
This is done in order to prevent other users from eavesdropping the server
|
||||||
@ -63,26 +67,48 @@ 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
|
will find a directory for your server (default: irc.freenode.net) in
|
||||||
which the FIFO and the output file will be stored.
|
which the FIFO and the output file will be stored.
|
||||||
If you join a channel a new directory with the name of the channel
|
If you join a channel a new directory with the name of the channel
|
||||||
will be created in the ~/irc/$servername/ directory.
|
will be created in the
|
||||||
|
.BI ~/irc/ servername /
|
||||||
|
directory.
|
||||||
.SH COMMANDS
|
.SH COMMANDS
|
||||||
.TP
|
.TP
|
||||||
.BI /a " [<message>]"
|
.BI /a " [message]"
|
||||||
mark yourself as away
|
mark yourself as away,
|
||||||
|
with the optional
|
||||||
|
.I message
|
||||||
|
as an away reason.
|
||||||
.TP
|
.TP
|
||||||
.BI /j " #channel/nickname [<message>]"
|
.BI /j " #channel [password]"
|
||||||
join a channel or open private conversation with user
|
join a
|
||||||
|
.IR #channel ,
|
||||||
|
with the optional
|
||||||
|
.IR password .
|
||||||
|
.TP
|
||||||
|
.BI /j " nickname [message]"
|
||||||
|
open private conversation with user
|
||||||
|
.I nickname
|
||||||
|
and directly send the optional
|
||||||
|
.IR message .
|
||||||
.TP
|
.TP
|
||||||
.BI /l " [reason]"
|
.BI /l " [reason]"
|
||||||
leave a channel or query
|
leave a channel or query,
|
||||||
|
giving the optional
|
||||||
|
.I reason
|
||||||
|
message.
|
||||||
.TP
|
.TP
|
||||||
.BI /n " nick"
|
.BI /n " nick"
|
||||||
change the nick name
|
change the nick name to
|
||||||
|
.IR nick .
|
||||||
.TP
|
.TP
|
||||||
.BI /q " [reason]"
|
.BI /q " [reason]"
|
||||||
quit ii
|
quit ii,
|
||||||
|
giving the optional
|
||||||
|
.I reason
|
||||||
|
message.
|
||||||
.TP
|
.TP
|
||||||
.BI /t " topic"
|
.BI /t " topic"
|
||||||
set the topic of a channel
|
set the topic of a channel with
|
||||||
|
.IR topic.
|
||||||
.SH RAW COMMANDS
|
.SH RAW COMMANDS
|
||||||
Everything which is not a command will be posted into the channel or to the
|
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. So if you need /who just write /WHO as described in RFC#1459 to the
|
||||||
|
5
ii.c
5
ii.c
@ -98,9 +98,8 @@ die(const char *fmt, ...)
|
|||||||
static void
|
static void
|
||||||
usage(void)
|
usage(void)
|
||||||
{
|
{
|
||||||
die("usage: %s <-s host> [-p <port>] [-u sockname]\n"
|
die("usage: %s -s host [-p port | -u sockname] [-i ircdir]\n"
|
||||||
" [-i <ircdir>] "
|
" [-n nickname] [-f fullname] [-k env_pass]\n", argv0);
|
||||||
" [-n <nick>] [-f <fullname>] [-k <password>]\n", argv0);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
static void
|
static void
|
||||||
|
Loading…
Reference in New Issue
Block a user