diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 48 |
1 files changed, 27 insertions, 21 deletions
@@ -1,3 +1,9 @@ +<!-- + Title: KISS for IRC (kirc) + Description: A tiny IRC client written in POSIX C99. + Author: mcpcpc +--> + <h3 align="center"><img src="https://raw.githubusercontent.com/mcpcpc/kirc/master/.github/kirc.png" alt="logo" height="170px"></h3> <p align="center">KISS for IRC, a tiny IRC client written in POSIX C99.</p> <p align="center"> @@ -33,27 +39,6 @@  -## Usage - -```shell -usage: kirc [-s hostname] [-p port] [-c channel] [-n nick] [-r real name] [-u username] [-k password] [-x init command] [-w columns] [-W columns] [-o path] [-h|v|V] --s server address (default: 'irc.freenode.org') --p server port (default: '6667') --c channel name(s), delimited by a "," or "|" character (default: 'kirc') --n nickname (required) --u server username (optional) --k server password (optional) --a PLAIN SASL authentication token (optional) --r real name (optional) --v version information --V verbose output (e.g. raw stream) --o output path to log irc stream --x send command to irc server after inital connection --w maximum width of the printed left column (default: '20') --W maximum width of the entire printed stream (default '80') --h basic usage information -``` - ## Installation Building and installing on **KISS Linux** using the Community repository: @@ -80,6 +65,27 @@ make make install ``` +## Usage + +```shell +usage: kirc [-s hostname] [-p port] [-c channel] [-n nick] [-r real name] [-u username] [-k password] [-x init command] [-w columns] [-W columns] [-o path] [-h|v|V] +-s server address (default: 'irc.freenode.org') +-p server port (default: '6667') +-c channel name(s), delimited by a "," or "|" character (default: 'kirc') +-n nickname (required) +-u server username (optional) +-k server password (optional) +-a PLAIN SASL authentication token (optional) +-r real name (optional) +-v version information +-V verbose output (e.g. raw stream) +-o output path to log irc stream +-x send command to irc server after inital connection +-w maximum width of the printed left column (default: '20') +-W maximum width of the entire printed stream (default '80') +-h basic usage information +``` + ## Transport Layer Security (TLS) Support There is no native TLS/SSL support. Instead, users can achieve this functionality by using third-party tools (e.g. stunnel, socat, ghosttunnel). |