 |
ii.1: improve documentation of usage options - ii - irc it, simple FIFO based i… |
 |
git clone git://git.suckless.org/ii |
 |
Log |
|
Files |
|
Refs |
|
README |
|
LICENSE |
|
--- |
|
commit 2d0480ce81d5bc4329686fe8ef7f0b440bf35ec0 |
|
parent 71c1e50da069b17e9e5073b32e83a9be8672b954 |
|
Author: Hiltjo Posthuma <[email protected]> |
|
Date: Fri, 2 Sep 2022 11:23:08 +0200 |
|
|
|
ii.1: improve documentation of usage options |
|
|
|
* 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 <[email protected]>, thanks! |
|
|
|
Diffstat: |
|
M ii.1 | 43 ++++++++++++++---------------… |
|
M ii.c | 6 +++--- |
|
|
|
2 files changed, 23 insertions(+), 26 deletions(-) |
|
--- |
|
diff --git a/ii.1 b/ii.1 |
|
@@ -18,35 +18,33 @@ and ii creates a new channel directory with in and out file. |
|
.SH SYNOPSIS |
|
.B ii |
|
.RB < \-s |
|
-.IR servername > |
|
+.IR host > |
|
.RB [ \-p |
|
.IR port ] |
|
-.RB [ \-k |
|
-.IR "environment variable" ] |
|
+| |
|
+.RB < \-u |
|
+.IR sockname > |
|
+ |
|
.RB [ \-i |
|
-.IR prefix ] |
|
+.IR ircdir ] |
|
.RB [ \-n |
|
.IR nickname ] |
|
.RB [ \-f |
|
.IR realname ] |
|
-.RB < \-u |
|
-.IR sockname > |
|
+.RB [ \-k |
|
+.IR "environment variable" ] |
|
.SH OPTIONS |
|
.TP |
|
.BI \-s " servername" |
|
-server to connect to, for example: irc.freenode.net |
|
-.TP |
|
-.BI \-u " sockname" |
|
-connect to a UNIX domain socket instead of directly to a server. |
|
+server/host to connect to, for example: 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.… |
|
-This is done in order to prevent other users from eavesdropping the server pas… |
|
+.BI \-u " sockname" |
|
+connect to a UNIX domain socket instead of directly to a server. |
|
.TP |
|
-.BI \-i " prefix" |
|
+.BI \-i " ircdir" |
|
lets you override the default irc path (~/irc) |
|
.TP |
|
.BI \-n " nickname" |
|
@@ -54,6 +52,11 @@ 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.… |
|
+This is done in order to prevent other users from eavesdropping the server |
|
+password via the process list. |
|
.SH DIRECTORIES |
|
.TP |
|
.B ~/irc |
|
@@ -85,16 +88,10 @@ set the topic of a channel |
|
.LP |
|
Everything which is not a command will be posted into the channel or to the se… |
|
So if you need /who just write /WHO as described in RFC#1459 to the server in … |
|
-.SH SSL PROTOCOL SUPPORT |
|
-.LP |
|
-For TLS/SSL protocol support you can connect to a local tunnel, for example wi… |
|
-.SH CONTACT |
|
+.SH SSL/TLS PROTOCOL SUPPORT |
|
.LP |
|
-Subscribe to the mailinglist and write to dev (at) suckless (dot) org for sugg… |
|
-.SH AUTHORS |
|
-ii engineers, see LICENSE file |
|
+For SSL/TLS protocol support you can connect to a local tunnel, for example |
|
+with stunnel or socat. |
|
.SH SEE ALSO |
|
.BR echo (1), |
|
.BR tail (1) |
|
-.SH BUGS |
|
-Please report them! |
|
diff --git a/ii.c b/ii.c |
|
@@ -98,9 +98,9 @@ die(const char *fmt, ...) |
|
static void |
|
usage(void) |
|
{ |
|
- die("usage: %s <-s host> [-i <irc dir>] [-p <port>] " |
|
- "[-u <sockname>] [-n <nick>] [-k <password>] " |
|
- "[-f <fullname>]\n", argv0); |
|
+ die("usage: %s <-s host> [-p <port>] | <-u sockname>\n" |
|
+ " [-i <ircdir>] " |
|
+ " [-n <nick>] [-f <fullname>] [-k <password>]\n", argv0); |
|
} |
|
|
|
static void |
