summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README46
1 files changed, 12 insertions, 34 deletions
diff --git a/README b/README
index 3df4965..b3ccad5 100644
--- a/README
+++ b/README
@@ -1,42 +1,20 @@
-IRC client http://c9x.me/irc/
+IRC client https://c9x.me/irc/
===========================================================
This is a simple irc client, it requires the ncurses
library to compile.
-For usage information, read ./irc -h
+Usage: irc [OPTIONS]
-- TLS support using relayd
---------------------------
+ OPTION DEFAULT
-This sets up a relay TCP connection on localhost. This
-way you can connect using a more secure TLS connection
-with a IRC program that doesn't have TLS support builtin.
+ -n NICK Sets the nick $IRCNICK
+ -u USER Sets the username $USER
+ -s SERVER Server to connect to irc.oftc.net
+ -p PORT Port to connect to 6667
+ -l FILE File to log recieved data
+ -t Use a secured connection
+ -h Display help
-
-/etc/relayd.conf:
-
- table <freenode> { irc.freenode.net }
- table <oftc> { irc.oftc.net }
-
- protocol "irctls" {
- tcp { nodelay, sack }
- }
-
- relay "freenode" {
- listen on 127.0.0.1 port 6668
- protocol "irctls"
- forward with tls to <freenode> port 6697
- }
-
- relay "oftc" {
- listen on 127.0.0.1 port 6669
- protocol "irctls"
- forward with tls to <oftc> port 6697
- }
-
-
-Then connect:
-
- ./irc -n nick -u name -s 127.0.0.1 -p 6668
- ./irc -n nick -u name -s 127.0.0.1 -p 6669
+A password sent to the server can be specified by setting
+the environment variable $IRCPASS.