tazirc annotate README @ rev 0

Initial commit with the README
author Christophe Lincoln <pankso@slitaz.org>
date Tue Jan 14 00:12:35 2014 +0100 (2014-01-14)
parents
children 533ffcc81327
rev   line source
pankso@0 1 TazIRC - The SliTaz IRC tools
pankso@0 2 ================================================================================
pankso@0 3
pankso@0 4
pankso@0 5 TazIRC provide a small command line IRC client and a IRC Log Bot. Both are
pankso@0 6 entirely written in SHell script and using Busybox nc and libtaz functions.
pankso@0 7 TazIRC can connect to all standardized IRC daemon, handle cmdline options and
pankso@0 8 dont have any configuration file. Run tazirc/tazirc-lb without arguments to
pankso@0 9 get a short usage and list of options. Read below for some usage examples.
pankso@0 10
pankso@0 11
pankso@0 12 Installation
pankso@0 13 ------------
pankso@0 14
pankso@0 15 # make install
pankso@0 16
pankso@0 17
pankso@0 18 TazIRC Usage
pankso@0 19 ------------
pankso@0 20 You can simply connect to a server then join a channel or directly join a channel
pankso@0 21 using the --chan= option on cmdline. Run tazirc without arguments to get a short
pankso@0 22 usage and list of options. Let's connect to SliTaz IRC channel on freenode as the
pankso@0 23 so famous user tux:
pankso@0 24
pankso@0 25 $ tazirc irc.freenode.net tux --chan=slitaz
pankso@0 26
pankso@0 27 You can also connect to a server then join a channel with:
pankso@0 28
pankso@0 29 $ tazirc irc.freenode.net tux
pankso@0 30 $ /join #slitaz
pankso@0 31
pankso@0 32 TazIRC will handle a few short IRC commands:
pankso@0 33
pankso@0 34 /j: JOIN
pankso@0 35 /q: QUIT
pankso@0 36
pankso@0 37
pankso@0 38 TazIRC Lob Bot Usage
pankso@0 39 --------------------
pankso@0 40 TazIRC-lb the IRC Log Bot can be combined with conspy or screen to have local or
pankso@0 41 online archives of various IRC channels. Let's log the official SliTaz channel on
pankso@0 42 Freenode:
pankso@0 43
pankso@0 44 $ tazirc-lb irc.freenode.net slitaz
pankso@0 45
pankso@0 46 Use Ctrl-c to exit. You will find the logs in the current directory or you can
pankso@0 47 use the --dest= option to set the output logs path.
pankso@0 48
pankso@0 49
pankso@0 50 ================================================================================
pankso@0 51