Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 1.86 KB

README.rst

File metadata and controls

67 lines (45 loc) · 1.86 KB
Raw
Image Layers

irclogger is a simple daemon written in the Python Programming Language utilizing the circuits framework for the sole purpose of logging a set of IRC Channels to disk in the form that something like irclog2html can understand and parse.

Installation

From PyPi using pip:

$ pip install irclogger

from source:

$ mkvirtualenv irclogger
$ hg clone https://bitbucket.org/prologic/irclogger
$ cd irclogger
$ pip install -r requirements.txt

Usage

To display help:

$ irclogger --help

Usage: irclogger [options] <host> [<port>]

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -d, --daemon          Enable daemon mode
  -c CHANNELS, --channel=CHANNELS
                        Channel to join (multiple allowed)
  -n NICK, --nick=NICK  Nickname to use
  -o OUTPUT, --output=OUTPUT
                        Path to store log files
  -p PIDFILE, --pidfile=PIDFILE
                        Path to store PID file
  -v, --verbose         Enable verbose debugging mode

To log a single channel:

$ irclogger -c "#mychannel" irc.freenode.net

Note

By default irclogger stores logs in the current working directory. Use -o/--output to change the location to store log files.

Note

Also note that the default nickname used is your current username on your system. i.e: $USER. To change this use the -n/--nick option.