mirror/ii
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ii.1: improve documentation of usage options

Browse Source 
* Also improve the order of options and consistency with the usage in ii.c.
* Remove some redundant sections.

Adapted from a patch by Petr Vaněk <arkamar@atlas.cz>, thanks!
This commit is contained in:
Hiltjo Posthuma 2022-09-02 11:23:08 +02:00
parent 71c1e50da0
commit 2d0480ce81
2 changed files with 23 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
ii.1
View File

@ -18,35 +18,33 @@ and ii creates a new channel directory with in and out file.
.SH SYNOPSIS .SH SYNOPSIS
.B ii .B ii
.RB < \-s .RB < \-s
.IR servername > .IR host >
.RB [ \-p .RB [ \-p
.IR port ] .IR port ]
.RB [ \-k |
.IR "environment variable" ] .RB < \-u
.IR sockname >
.RB [ \-i .RB [ \-i
.IR prefix ] .IR ircdir ]
.RB [ \-n .RB [ \-n
.IR nickname ] .IR nickname ]
.RB [ \-f .RB [ \-f
.IR realname ] .IR realname ]
.RB < \-u .RB [ \-k
.IR sockname > .IR "environment variable" ]
.SH OPTIONS .SH OPTIONS
.TP .TP
.BI \-s " servername" .BI \-s " servername"
server to connect to, for example: irc.freenode.net server/host to connect to, for example: irc.freenode.net
.TP
.BI \-u " sockname"
connect to a UNIX domain socket instead of directly to a server.
.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 \-k " environment variable" .BI \-u " sockname"
lets you specify an environment variable that contains your IRC password, e.g. IIPASS="foobar" ii -k IIPASS. connect to a UNIX domain socket instead of directly to a server.
This is done in order to prevent other users from eavesdropping the server password via the process list.
.TP .TP
.BI \-i " prefix" .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"
@ -54,6 +52,11 @@ 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
.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.
.SH DIRECTORIES .SH DIRECTORIES
.TP .TP
.B ~/irc .B ~/irc
@ -85,16 +88,10 @@ set the topic of a channel
.LP .LP
Everything which is not a command will be posted into the channel or to the server. 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. So if you need /who just write /WHO as described in RFC#1459 to the server in FIFO.
.SH SSL PROTOCOL SUPPORT .SH SSL/TLS PROTOCOL SUPPORT
.LP .LP
For TLS/SSL protocol support you can connect to a local tunnel, for example with stunnel or socat. For SSL/TLS protocol support you can connect to a local tunnel, for example
.SH CONTACT with stunnel or socat.
.LP
Subscribe to the mailinglist and write to dev (at) suckless (dot) org for suggestions, fixes, etc.
.SH AUTHORS
ii engineers, see LICENSE file
.SH SEE ALSO .SH SEE ALSO
.BR echo (1), .BR echo (1),
.BR tail (1) .BR tail (1)
.SH BUGS
Please report them!

6
ii.c
View File

@ -98,9 +98,9 @@ die(const char *fmt, ...)
static void static void
usage(void) usage(void)
{ {
die("usage: %s <-s host> [-i <irc dir>] [-p <port>] " die("usage: %s <-s host> [-p <port>] | <-u sockname>\n"
"[-u <sockname>] [-n <nick>] [-k <password>] " " [-i <ircdir>] "
"[-f <fullname>]\n", argv0); " [-n <nick>] [-f <fullname>] [-k <password>]\n", argv0);
} }
static void static void