aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMichael Czigler <37268479+mcpcpc@users.noreply.github.com>2020-09-27 18:30:37 -0400
committerGitHub <noreply@github.com>2020-09-27 18:30:37 -0400
commite6a4cd9bb746748103e34ed99ea3415e7556bd74 (patch)
tree6e6ec775e7cf10f999c7b5838763a1b694231dba /README.md
parentadd SEO information. (diff)
downloadkirc-e6a4cd9bb746748103e34ed99ea3415e7556bd74.tar.gz
kirc-e6a4cd9bb746748103e34ed99ea3415e7556bd74.tar.bz2
kirc-e6a4cd9bb746748103e34ed99ea3415e7556bd74.tar.xz
kirc-e6a4cd9bb746748103e34ed99ea3415e7556bd74.tar.zst
kirc-e6a4cd9bb746748103e34ed99ea3415e7556bd74.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 21 insertions, 21 deletions
diff --git a/README.md b/README.md
index 920f26b..8c669d3 100644
--- a/README.md
+++ b/README.md
@@ -39,27 +39,6 @@
![Screenshot 1](/.github/example2.png)
-## 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:
@@ -86,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).