diff options
| author | Michael Czigler <37268479+mcpcpc@users.noreply.github.com> | 2020-09-29 17:53:44 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-29 17:53:44 -0400 |
| commit | 499403425ac1ac02cf437910e338b2ef93a092c8 (patch) | |
| tree | 5252093ea08ba13c8552a0f279ab14350c7557bc /kirc.1 | |
| parent | indent code block (diff) | |
| download | kirc-499403425ac1ac02cf437910e338b2ef93a092c8.tar.gz kirc-499403425ac1ac02cf437910e338b2ef93a092c8.tar.bz2 kirc-499403425ac1ac02cf437910e338b2ef93a092c8.tar.xz kirc-499403425ac1ac02cf437910e338b2ef93a092c8.tar.zst kirc-499403425ac1ac02cf437910e338b2ef93a092c8.zip | |
add manpage (#46)
* Create kirc.1
* add VERSION and man page
* change kirc version to definition in Makefile
* fix separator char (TAB)
* remove double parenthesis in puts() command
* change VERSION to be controlled by kirc.c
Diffstat (limited to 'kirc.1')
| -rw-r--r-- | kirc.1 | 77 |
1 files changed, 77 insertions, 0 deletions
@@ -0,0 +1,77 @@ +.TH KIRC 1 kirc\-VERSION +.SH NAME +kirc \- KISS for IRC +.SH SYNOPSIS +.B kirc +.RB [ \-s +.IR server ] +.RB [ \-p +.IR port ] +.RB [ \-n +.IR nick ] +.RB [ \-c +.IR chan ] +.RB ... +.SH DESCRIPTION +.B kirc +is an extremely fast and simple IRC client designed with portability in mind. +This client reads from stdin and prints to stdout, so all traffic can +multiplexed and text parsed or modified using external commands. All highlighted +text and color can be controlled with ANSI escape sequences. +.SH OPTIONS +.TP +.BI \-s " server" +Overrides the default host (irc.freenode.org) +.TP +.BI \-p " port" +Overrides the default port (6697) +.TP +.BI \-c " chan" +Specifies the channel(s) to JOIN (delimited by "," or "|") +.TP +.BI \-n " nick" +Specifies the NICK connection nickname +.TP +.BI \-u " real" +Specifies the users real name +.TP +.BI \-u " user" +Specifies the USER connection username +.TP +.BI \-k " pass" +Specifies the PASS connection password +.TP +.BI \-w " nick_width" +Specifies max character width printed in the left column +.TP +.BI \-W " max_width" +Specifies max printed with of the IRC stream +.TP +.BI \-a " auth" +Specifies SASL PLAIN authentication token +.TP +.BI \-e +Specifies SASL EXTERNAL +.TP +.BI \-v +Prints the version information to stderr, then exits +.SH COMMANDS +.TP +.BI /<command> +Send message to IRC host (e.g. /JOIN, /PART, /WHOIS, etc.) +.TP +.BI /? +Print current default message channel +.TP +.BI /#<channel> +Set default message channel to <channel> +.TP +.BI <message> +Send PRIVMSG to default message channel with <message> as the content +.TP +.BI /@<channel|nick> +Send PRIVMSG to specified <channel> or <nick> +.SH AUTHOR +Michael Czigler <michaelczigler at icloud dot com> +.SH BUGS +Please report them! |