aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKian Kasad <kian@kasad.com>2021-02-18 13:26:16 -0800
committerGitHub <noreply@github.com>2021-02-18 16:26:16 -0500
commitefa17453a9f66d801f9de33bcc74236dc2d77be1 (patch)
treeee40cd16e4403b824e68e408547ba918f1b3ce06
parentfix printing of join/part messages when cdef is a substring of the actual cha... (diff)
downloadkirc-efa17453a9f66d801f9de33bcc74236dc2d77be1.tar.gz
kirc-efa17453a9f66d801f9de33bcc74236dc2d77be1.tar.bz2
kirc-efa17453a9f66d801f9de33bcc74236dc2d77be1.tar.xz
kirc-efa17453a9f66d801f9de33bcc74236dc2d77be1.tar.zst
kirc-efa17453a9f66d801f9de33bcc74236dc2d77be1.zip
Update docs (#100)
* add CTCP ACTION information to man page * add documentation for <message> parameter to commands which support it * fix incorrect flag character for real name option * add verbosity option (-V) to man page * separate flag options in usage information Usually the format '[option1|option2]' means EITHER 'option1' OR 'option2' may be specified, but not both. Since the options '-v', '-V', and '-e' can all be given (and are all optional), the proper format is '[-v] [-V] [-e]'.
-rw-r--r--kirc.123
-rw-r--r--kirc.c2
2 files changed, 21 insertions, 4 deletions
diff --git a/kirc.1 b/kirc.1
index 7ce7dfe..a5f8d65 100644
--- a/kirc.1
+++ b/kirc.1
@@ -32,7 +32,7 @@ Specifies the channel(s) to JOIN (delimited by "," or "|")
.BI \-n " nick"
Specifies the NICK connection nickname
.TP
-.BI \-u " real"
+.BI \-r " real"
Specifies the users real name
.TP
.BI \-u " user"
@@ -52,6 +52,10 @@ Specifies SASL EXTERNAL mechanism
.TP
.BI \-v
Prints the version information to stderr, then exits
+.TP
+.BI \-V
+Increases verbosity. Causes raw IRC messages to be printed when sent or
+received.
.SH COMMANDS
.TP
.BI /<command>
@@ -63,8 +67,21 @@ Set default message channel to <channel>
.BI <message>
Send PRIVMSG to default message channel with <message> as the content
.TP
-.BI @<channel|nick>
-Send PRIVMSG to specified <channel> or <nick>
+.BI @<channel|nick> " <message>"
+Send
+.I <message>
+to specified
+.I <channel>
+or
+.I <nick>
+.TP
+.BI @@<channel|nick>
+Send CTCP ACTION containing
+.I <message>
+to specified
+.I <channel>
+or
+.I <nick>
.SH AUTHOR
Michael Czigler <michaelczigler at icloud dot com>
.SH BUGS
diff --git a/kirc.c b/kirc.c
index ff17f95..8b988ac 100644
--- a/kirc.c
+++ b/kirc.c
@@ -674,7 +674,7 @@ static void handleUserInput(struct State * l) {
static void usage(void) {
fputs("kirc [-s host] [-p port] [-c channel] [-n nick] [-r realname] \
-[-u username] [-k password] [-a token] [-x command] [-o path] [-e|v|V]\n", stderr);
+[-u username] [-k password] [-a token] [-x command] [-o path] [-e] [-v] [-V]\n", stderr);
exit(2);
}