diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 56 |
1 files changed, 26 insertions, 30 deletions
@@ -4,15 +4,33 @@ <a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg"></a> <a href="https://github.com/mcpcpc/kirc/releases"><img src="https://img.shields.io/github/v/release/mcpcpc/kirc.svg"></a> <a href="https://repology.org/metapackage/kirc"><img src="https://repology.org/badge/tiny-repos/kirc.svg" alt="Packaging status"></a> +<a href="https://www.codacy.com/manual/mcpcpc/kirc/dashboard?utm_source=github.com&utm_medium=referral&utm_content=mcpcpc/kirc&utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/5616c0ed4b2f4209826038dbc270dbf5" alt="Codacy status"></a> </p> -## Objectives +## Features + +* Excellent cross-platform compatibility (due to [POSIX](https://opensource.com/article/19/7/what-posix-richard-stallman-explains) standard compliance). +* No dependencies other than a [C99 compiler](https://en.wikipedia.org/wiki/C99). +* Native [PLAIN SASL](https://tools.ietf.org/html/rfc4422) authentication support. +* [TLS/SSL](https://en.m.wikipedia.org/wiki/Transport_Layer_Security) protocol capable (via external TLS utilities). +* Chat history logging. +* Multi-channel joining at server connection. +* Simple shortcut commands and full support for all IRC commands in the [RFC 2812](https://tools.ietf.org/html/rfc2812) standard: + +```shell +<message> Send a PRIVMSG to the current channel. +/<command> Send command to IRC server (see RFC 2812 for full list). +/#<channel> Assign new default message channel. +/? Print current message channel. +``` -_"Do one thing and do it well"_ — Emphasis was placed on building simple, short, clear, modular, and extensible code that can be easily maintained and repurposed (per the [Unix philosophy](https://en.wikipedia.org/wiki/Unix_philosophy)). +* Color scheme definition via [ANSI 8-bit colors](https://en.wikipedia.org/wiki/ANSI_escape_code). Therefore, one could theoretically achieve uniform color definition across all shell applications and tools. -_Portability_ — [POSIX](https://en.wikipedia.org/wiki/POSIX) compliance ensures seamless compatibility and interoperability between variants of Unix and other operating systems. +## Screenshots -_Usability_ — Commands and shortcuts should feel "natural" when using a [standard 104-key US keyboard layout](https://en.wikipedia.org/wiki/Keyboard_layout). Where possible, the number of keystrokes have been minimized. + + + ## Usage @@ -20,7 +38,7 @@ _Usability_ — Commands and shortcuts should feel "natural" when using a [stand 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 (default: 'kirc') +-c channel name(s), delimited by a "," or "|" character (default: 'kirc') -n nickname (required) -u server username (optional) -k server password (optional) @@ -30,33 +48,11 @@ usage: kirc [-s hostname] [-p port] [-c channel] [-n nick] [-r real name] [-u us -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: '10') +-w maximum width of the printed left column (default: '20') -W maximum width of the entire printed stream (default '80') -h basic usage information ``` -## Features - -* No dependencies other than a [C99 compiler](https://gcc.gnu.org/). -* Supports IPv4 and IPv6 connections. -* Supports [PLAIN SASL](https://tools.ietf.org/html/rfc4422) authentication methods. -* Can be used in conjunction with an [TLS/SSL](https://en.m.wikipedia.org/wiki/Transport_Layer_Security) client to communicate across a network in a way designed to prevent eavesdropping and tampering. -* Ability to log the entire chat history (see _Usage_ section for more information). -* Simple commands and full support for all IRC commands in the [RFC 2812](https://tools.ietf.org/html/rfc2812) standard: - -```shell -<message> Send a PRIVMSG to the current channel. -/<command> Send command to IRC server (see RFC 2812 for full list). -/#<channel> Assign new default message channel. -/? Print current message channel. -``` - -* Color scheme definition via [ANSI 8-bit colors](https://en.wikipedia.org/wiki/ANSI_escape_code). Therefore, one could theoretically achieve uniform color definition across all shell applications and tools. - -## Screenshots - - - ## Installation Building and installing on **KISS Linux** using the Community repository: @@ -87,14 +83,14 @@ make install There is no native TLS/SSL support. Instead, users can achieve this functionality by using third-party tools (e.g. stunnel, socat, ghosttunnel). -* _socat_ example: +* _socat_ example: ```shell socat tcp-listen:6667,reuseaddr,fork,bind=127.0.0.1 ssl:<irc-server>:6697 kirc -s 127.0.0.1 -c 'channel' -n 'name' -r 'realname' ``` -## PLAIN SASL Support +## PLAIN SASL Authentication In order to connect using PLAIN SASL authentication, the user must provide the required token during the initial connection. If the authentication token is base64 encoded and, therefore, can be generated a number of ways. For example, using Python, one could use the following: |