=====================
== NZBirc ===========
======= v1.14~pre3 ==
=====================

for help see: http://www.tiberious.org/wiki/index.php/Nzbirc/v1

see: http://www.tiberious.org/wiki/index.php/Nzbirc/guide for a complete guide on how to setup and use nzbirc


Installation
=============================

 1. From Debian Package
 ==================

  1.1. Using repository
  =====

    - Goto https://launchpad.net/~tiberious/+archive
    - Select your release of choice (for debian users, select any)
    - Copy the sources.list entries
    - Open your sources.list file (/etc/apt/sources.list)
    - Paste the entries from the website
    - run: apt-get update
    - run: apt-get install nzbirc

    This will install all the required pre-requesites, and will keep the software up-to-date

  1.2. Using .deb file
  =====
    
    - goto https://launchpad.net/~tiberious/+archive or https://launchpad.net/nzbirc/+download
    - download the latest .deb file
    - ensure you have all the dependencies installed
      - php5-cli, php-pear, php-http-request, php-xml-serializer, php5-xmlrpc
    - run: dpkg -i nzbirc_[version].deb   


 2. From Source
 ==================

  http://www.tiberious.org/wiki/index.php/Nzbirc/guide/installation

  Download and extract the archive into an appropriate directory.


  Prerequesites:

    php-cli	>=4				http://www.php.net
    [if php 4] php4-xml

    PEAR					http://pear.php.net
    - HTTP/Request			http://pear.php.net/package/http_request
    - XML/Serializer >=0.18	http://pear.php.net/package/XML_Serializer

    To install the pear packages use the command:

    # pear install --alldeps http_request xml_serializer-beta


  Recommended:

    hellanzb				http://www.hellanzb.com
    - PEAR: XML/XML_RPC		http://pear.php.net/package/xml_rpc
    
    # pear install --alldeps xml_rpc


  Optional:

    PECL Runkit				http://pecl.php.net/package/runkit

    # pecl install runkit


Configuration
=============================
http://www.tiberious.org/wiki/index.php/Nzbirc/guide/configuration

If you are running nzbirc for the first time it will self configure, 
so go to the Running section

otherwise run [linux]:

# nzbirc --first
or 
# nzbirc -f

[windows]:

# php.exe nzbirc.php first

these will show the basic configuration options again


Running
=============================
http://www.tiberious.org/wiki/index.php/Nzbirc/guide/running

 1. Linux/Unix/POSIX:
 ==================

  If you installed the software via the debian package, type the following 
  command from anywhere

  # nzbirc

  otherwise, type the above command in the directory it was installed in.


 2. Windows:
 ==================
 
  To run nzbirc in windows the following can be used:

  # php.exe "path\to\nzbirc.php"



Using
=============================
http://www.tiberious.org/wiki/index.php/Nzbirc/guide/using

See the above url for a brief overview of some of the commands available



Reporting Bugs / Feature Requests / Questions
=============================

Use one of the following url's:

https://launchpad.net/nzbirc
http://www.sf.net/projects/phpnzbirc



for more information on various aspects of nzbirc visit:

http://www.tiberious.org/wiki/nzbirc

(c) 2008 - tiberious.org