usage: Normalize a bit the usage and man-page - ii - irc it, simple FIFO based … | |
git clone git://git.suckless.org/ii | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit 39907c79a4c5509db8500b4ad3fb7947eb7b94d9 | |
parent 25c000bf98735aa4f07b4ab90506111118426e2f | |
Author: Quentin Rameau <[email protected]> | |
Date: Sun, 4 Sep 2022 11:26:26 +0200 | |
usage: Normalize a bit the usage and man-page | |
Diffstat: | |
M ii.1 | 94 ++++++++++++++++++++---------… | |
M ii.c | 5 ++--- | |
2 files changed, 62 insertions(+), 37 deletions(-) | |
--- | |
diff --git a/ii.1 b/ii.1 | |
@@ -1,6 +1,23 @@ | |
-.TH II 1 ii\-VERSION | |
+.TH II 1 ii-VERSION | |
.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 | |
.B ii | |
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… | |
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 > | |
-.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 | |
.TP | |
-.BI \-s " servername" | |
+.BI -s " host" | |
server/host to connect to, for example: irc.freenode.net | |
.TP | |
-.BI \-p " port" | |
+.BI -p " port" | |
lets you override the default port (6667) | |
.TP | |
-.BI \-u " sockname" | |
+.BI -u " sockname" | |
connect to a UNIX domain socket instead of directly to a server. | |
+If set, the | |
+.B -p | |
+option will be ignored. | |
.TP | |
-.BI \-i " ircdir" | |
+.BI -i " ircdir" | |
lets you override the default irc path (~/irc) | |
.TP | |
-.BI \-n " nickname" | |
+.BI -n " nickname" | |
lets you override the default nick ($USER) | |
.TP | |
-.BI \-f " realname" | |
+.BI -f " realname" | |
lets you specify your real name associated with your nick | |
.TP | |
-.BI \-k " environment variable" | |
+.BI -k " env_pass" | |
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 | |
@@ -63,26 +67,48 @@ In this directory the irc tree will be created. In this dir… | |
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. | |
+will be created in the | |
+.BI ~/irc/ servername / | |
+directory. | |
.SH COMMANDS | |
.TP | |
-.BI /a " [<message>]" | |
-mark yourself as away | |
+.BI /a " [message]" | |
+mark yourself as away, | |
+with the optional | |
+.I message | |
+as an away reason. | |
+.TP | |
+.BI /j " #channel [password]" | |
+join a | |
+.IR #channel , | |
+with the optional | |
+.IR password . | |
.TP | |
-.BI /j " #channel/nickname [<message>]" | |
-join a channel or open private conversation with user | |
+.BI /j " nickname [message]" | |
+open private conversation with user | |
+.I nickname | |
+and directly send the optional | |
+.IR message . | |
.TP | |
.BI /l " [reason]" | |
-leave a channel or query | |
+leave a channel or query, | |
+giving the optional | |
+.I reason | |
+message. | |
.TP | |
.BI /n " nick" | |
-change the nick name | |
+change the nick name to | |
+.IR nick . | |
.TP | |
.BI /q " [reason]" | |
-quit ii | |
+quit ii, | |
+giving the optional | |
+.I reason | |
+message. | |
.TP | |
.BI /t " topic" | |
-set the topic of a channel | |
+set the topic of a channel with | |
+.IR topic. | |
.SH RAW COMMANDS | |
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 | |
diff --git a/ii.c b/ii.c | |
@@ -98,9 +98,8 @@ die(const char *fmt, ...) | |
static void | |
usage(void) | |
{ | |
- die("usage: %s <-s host> [-p <port>] [-u sockname]\n" | |
- " [-i <ircdir>] " | |
- " [-n <nick>] [-f <fullname>] [-k <password>]\n", argv0); | |
+ die("usage: %s -s host [-p port | -u sockname] [-i ircdir]\n" | |
+ " [-n nickname] [-f fullname] [-k env_pass]\n", argv0); | |
} | |
static void |