tazirc 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 a5901140c630
files README
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Tue Jan 14 00:12:35 2014 +0100
     1.3 @@ -0,0 +1,51 @@
     1.4 +TazIRC - The SliTaz IRC tools
     1.5 +================================================================================
     1.6 +
     1.7 +
     1.8 +TazIRC provide a small command line IRC client and a IRC Log Bot. Both are 
     1.9 +entirely written in SHell script and using Busybox nc and libtaz functions.
    1.10 +TazIRC can connect to all standardized IRC daemon, handle cmdline options and
    1.11 +dont have any configuration file. Run tazirc/tazirc-lb without arguments to 
    1.12 +get a short usage and list of options. Read below for some usage examples.
    1.13 +
    1.14 +
    1.15 +Installation
    1.16 +------------
    1.17 +
    1.18 +# make install
    1.19 +
    1.20 +
    1.21 +TazIRC Usage
    1.22 +------------
    1.23 +You can simply connect to a server then join a channel or directly join a channel
    1.24 +using the --chan= option on cmdline. Run tazirc without arguments to get a short
    1.25 +usage and list of options. Let's connect to SliTaz IRC channel on freenode as the
    1.26 +so famous user tux:
    1.27 +
    1.28 +$ tazirc irc.freenode.net tux --chan=slitaz
    1.29 +
    1.30 +You can also connect to a server then join a channel with:
    1.31 +
    1.32 +$ tazirc irc.freenode.net tux
    1.33 +$ /join #slitaz
    1.34 +
    1.35 +TazIRC will handle a few short IRC commands:
    1.36 +
    1.37 +/j: JOIN
    1.38 +/q: QUIT
    1.39 +
    1.40 +
    1.41 +TazIRC Lob Bot Usage
    1.42 +--------------------
    1.43 +TazIRC-lb the IRC Log Bot can be combined with conspy or screen to have local or
    1.44 +online archives of various IRC channels. Let's log the official SliTaz channel on 
    1.45 +Freenode:
    1.46 +
    1.47 +$ tazirc-lb irc.freenode.net slitaz
    1.48 +
    1.49 +Use Ctrl-c to exit. You will find the logs in the current directory or you can
    1.50 +use the --dest= option to set the output logs path.
    1.51 +
    1.52 +
    1.53 +================================================================================
    1.54 +