aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authormcpcpc <michaelczigler@icloud.com>2020-08-18 21:26:52 -0400
committermcpcpc <michaelczigler@icloud.com>2020-08-18 21:26:52 -0400
commitcc0c97d9385669b264ebeb11e7bb9c6cce269fc3 (patch)
tree5c923d25b65edfa78d651e732458c2a4c1e1d701 /README
parentincrease input buffer from to max 510 character length (diff)
downloadkirc-cc0c97d9385669b264ebeb11e7bb9c6cce269fc3.tar.gz
kirc-cc0c97d9385669b264ebeb11e7bb9c6cce269fc3.tar.bz2
kirc-cc0c97d9385669b264ebeb11e7bb9c6cce269fc3.tar.xz
kirc-cc0c97d9385669b264ebeb11e7bb9c6cce269fc3.tar.zst
kirc-cc0c97d9385669b264ebeb11e7bb9c6cce269fc3.zip
fix initial line single char indent issue
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 10 insertions, 6 deletions
diff --git a/README b/README
index 4abaab3..d5c2a50 100644
--- a/README
+++ b/README
@@ -37,7 +37,7 @@ INSTALLATION
Building and installing from source:
git clone https://github.com/mcpcpc/kirc.git
- tcd kirc
+ cd kirc
make
make install
@@ -50,17 +50,19 @@ Building and installing using KISS Linux Community repository [2]:
USAGE
-----
-usage: kirc [-s hostname] [-p port] [-c channel] [-n nick] [-k password] [-w
-columns] [-W columns] [-v|V]
+usage: kirc [-s hostname] [-p port] [-c channel] [-n nick] [-r real name]
+[-u username] [-k password] [-w columns] [-W columns] [-v|V]
-s server address (default: 'irc.freenode.org')
-p server port (default: '6667')
-c channel name (default: '#kisslinux')
--n user nickname
--k user password
+-n nickname (required)
+-u server username (optional)
+-k server password (optional)
+-r real name (optional)
-v version information
-V verbose output (e.g. raw stream)
-w maximum width of the printed left column (default: '10')
--W maximum width of the entire printed stream (default '82')
+-W maximum width of the entire printed stream (default '80')
CUSTOMIZATION
@@ -76,6 +78,8 @@ CUSTOMIZATION
after the nick in the left column). Therefore, assuming that the default
values are being used, an IRC message could never exceed 80 printed characters
before word wrapping.
+- In order to connect to an IRC server, a nickname must be specified. Server
+ username (-u), password (-k) and real name (-r) are optional.
REFERENCES