/*****************************************************************************
 * Copyright (c)2004 badpenguins.com                                         *
 * Distributed under the terms of the GNU General Public License v2          *
 * Created 2004-09-09 Mike Green <mikey at badpenguins dot com>              *
 *****************************************************************************/ 

Welcome to yasuck, please see the files AUTHORS and COPYING for
copyright and licensing information.  yasuck is released under the
GNU GPL.

yasuck will suck messages from Yahoo Financial Message boards and plug them
into a database.

To install, edit includes/globals.php, particularly the path and database
settings.  Make sure the database user has sufficient privileges to 
drop/create the database.

Running yasuck without arguments will give you a help message.

NOTES ON NNTP FUNCTIONALITY

The ability to export database messages to newsgroup messages was added
on Jan 5, 2005.  This functionality was developed to interact specifically
with the GPL'ed newsd personal nntp server which is available at:

http://www.easysw.com/~mike/newsd/

To get newsd functioning do the usual ./configure --prefix=/usr, make, 
make install.  Verify the init script that is provided.  Run newsd -newgroup
to initialize the groups.  In yasuck, define NNTP_SPOOL_DIR to match the 
SpoolDir setting in /etc/newsd.conf.  For personal use only 
(no non-private access), the full yahoo post can be included in the 
newsgroup message by defining NNTP_COPY_TEXT to true in globals.php.

The nntp command line arguments accept the standard --start and --end
arguments.

yasuck --exportnntp board_name will dump all messages present in the
database not present in the spool directory.  If message are present
in the spool directory, --exportnntp will start where the existing
messages left off.  The export will be done in chunks of 10000 messages
to account for machines with low resources.

Adding --dumpnntp will dump nntp messages during standard runs.

Change ownership of the resulting messages created by yasuck in the spool 
directory to whatever user newsd is running as (news by default).  If
a cron script is used, run it under the same user as newsd.

If using newsd, set define(NNTP_USE_NEWSD,true) to automatically create
.config and update .info files in spool directories so that updates
will be reflected to the client.

NOTES ON HTML EXPORT FUNCTIONALITY

yasuck --exporthtml board_name will dump all messages from the
database that do not already exist in the spool directory.  If messages
are present in the spool directory, --exportthml will start where the 
existing messages left off.  The export will be done in chunks of 
10000 messages to account for machines with low resources.

The spool directory is set by defining HTML_EXPORT_DIR in globals.php.
If HTML_EXPORT_DIR is not defined the message will be dumped into the
current working directory.

The messages will be created in a simple html format that is more 
intended for spiders than humans.

If LICENSE_TEXT is defined in globals.php, a licensing blurb will be
appended to the dumped html messages.  LICENSE_TEXT should short, such
as "Contact Author" or "CCL Non-Commercial Share-Alike".

Limited meta tags (content and keywords) can be added on a per board
basis by editing the $META array in globals.php.

Note that --exporthtml is not the same as --dumphtml.  The --dumphtml
argument is for debugging purposes, it dumps the raw html copy of
posts as they are retrieved.