Skip to content

Commit

Permalink
Update docs (#100)
Browse files Browse the repository at this point in the history
* 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]'.
  • Loading branch information
kdkasad committed Feb 18, 2021
1 parent 02bbbe8 commit efa1745
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 4 deletions.
23 changes: 20 additions & 3 deletions kirc.1
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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>
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion kirc.c
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}

Expand Down

0 comments on commit efa1745

Please sign in to comment.