Commits

Anonymous committed 256a6ed

added man page

  • Participants
  • Parent commits f5d1768

Comments (0)

Files changed (1)

+.TH six 1 "August 21, 2011" "version 0.1" "USER COMMANDS"
+.SH NAME
+six \- simple IRC client kept simple
+.SH SYNOPSIS
+.B six
+[\-p port] [\-n nickname] [\-j channel] [\-N] [ \-s script ] [\-k password]
+host
+.SH DESCRIPTION
+.B six is an improved version of
+.B sic
+(irc client by suckless.org).
+.PP
+six has a single window interface - all your chats are multiplexed into one
+stream.
+.PP
+six makes is easy to type and edit messages. Instead of raw input it uses
+readline, that's why autocomplete and history can be easily implemented later.
+So, six is very small (~200 SLOC) and very hackable.
+.SH OPTIONS
+.TP
+\-h
+display short help text
+.TP
+\-p port
+use custom port. Default is 6667.
+.TP
+\-n nickname
+use given nickname instead of default (which is retrieved from $USER
+environment variable)
+.TP
+\-j channel
+join the channel after connecting to the server
+.TP
+\-k password
+use password to autorize on the server
+.TP
+\-N
+use NickServ autorization instead of PASS command (use \-k option to provide
+password)
+.TP
+\-s script
+run custom script for connecting to the server. Useful for automating
+connections.
+.TP
+host
+IRC server address
+.SH COMMANDS
+You can use any IRC protocol command directly, prefixed with a colon, e.g.
+":who", ":quit". There is also a number of internal commands listed below.
+.TP
+:j channel
+join the channel
+.TP
+:l channel
+leave the channel
+.TP
+:m nick msg
+send message <msg> to the user <nick>
+.TP
+:s nick
+set the default user name to <nick>. Then, you can just type message and press ENTER to send it
+to the default user (no ':m nick' is needed).
+.SH OTHER PROTOCOLS
+You can use six with bitlbee for communicating with other IMs and login like this:
+
+six -s "PRIVMSG root :IDENTIFY your_password" localhost
+
+You can use shell alias for this command if you like.
+.SH AUTHOR
+Serge A. Zaitsev (zaitsev.serge (at) gmail.com)
+.SH SEE ALSO
+sic(1) readline(3)