[usenet/newsstats.git] / install / install.pl

#! /usr/bin/perl
#
# install.pl
#
# This script will create database tables as necessary.
#
# It is part of the NewsStats package.
#
# Copyright (c) 2010-2013 Thomas Hochstein <thh@inter.net>
#
# It can be redistributed and/or modified under the same terms under
# which Perl itself is published.

BEGIN {
  our $VERSION = "0.01";
  use File::Basename;
  # we're in .../install, so our module is in ../lib
  push(@INC, dirname($0).'/../lib');
}
use strict;
use warnings;

use NewsStats qw(:DEFAULT);

use Cwd;

use DBI;
use Getopt::Long qw(GetOptions);
Getopt::Long::config ('bundling');

################################# Main program #################################

### read commandline options
my ($OptUpdate,$OptConfFile);
GetOptions ('u|update=s' => \$OptUpdate,
            'conffile=s' => \$OptConfFile,
            'h|help'     => \&ShowPOD,
            'V|version'  => \&ShowVersion) or exit 1;

### change working directory to .. (as we're in .../install)
chdir dirname($FullPath).'/..';
my $Path = cwd();

### read configuration
print("Reading configuration.\n");
my %Conf = %{ReadConfig($OptConfFile)};

##### --------------------------------------------------------------------------
##### Database table definitions
##### --------------------------------------------------------------------------

my $DBCreate = <<SQLDB;
CREATE DATABASE IF NOT EXISTS `$Conf{'DBDatabase'}` DEFAULT CHARSET=utf8;
SQLDB

my %DBCreate = ('DBTableRaw'  => <<RAW, 'DBTableParse'  => <<PARSE, 'DBTableGrps' => <<GRPS);
--
-- Table structure for table DBTableRaw
--

CREATE TABLE IF NOT EXISTS `$Conf{'DBTableRaw'}` (
  `id` bigint(20) unsigned NOT NULL auto_increment,
  `day` date NOT NULL,
  `mid` varchar(250) character set ascii NOT NULL,
  `date` datetime NOT NULL,
  `timestamp` bigint(20) NOT NULL,
  `token` varchar(80) character set ascii NOT NULL,
  `size` bigint(20) NOT NULL,
  `peer` varchar(250) NOT NULL,
  `path` varchar(1000) NOT NULL,
  `newsgroups` varchar(1000) NOT NULL,
  `headers` longtext NOT NULL,
  `disregard` tinyint(1) default '0',
  PRIMARY KEY  (`id`),
  KEY `day` (`day`),
  KEY `mid` (`mid`),
  KEY `peer` (`peer`)
) ENGINE=MyISAM  DEFAULT CHARSET=utf8 COMMENT='Raw data';
RAW
--
-- Table structure for table DBTableParse
--

CREATE TABLE IF NOT EXISTS `$Conf{'DBTableParse'}` (
  `id` bigint(20) unsigned NOT NULL auto_increment,
  `day` date NOT NULL,
  `mid` varchar(250) character set ascii NOT NULL,
  `refs` varchar(1000) character set ascii,
  `date` varchar(100) NOT NULL,
  `path` varchar(1000) NOT NULL,
  `newsgroups` varchar(1000) NOT NULL,
  `fupto` varchar(200),
  `from_` varchar(500),
  `from_parsed` varchar(200),
  `from_name` varchar(200),
  `from_address` varchar(200),
  `sender` varchar(500),
  `sender_parsed` varchar(200),
  `sender_name` varchar(200),
  `sender_address` varchar(200),
  `replyto` varchar(500),
  `replyto_parsed` varchar(200),
  `replyto_name` varchar(200),
  `replyto_address` varchar(200),
  `subject` varchar(1000) NOT NULL,
  `subject_parsed` varchar(1000),
  `organization` varchar(1000),
  `linecount` int(4) unsigned,
  `approved` varchar(250),
  `supersedes` varchar(250),
  `expires` varchar(100),
  `useragent` varchar(500),
  `xnewsreader` varchar(500),
  `xmailer` varchar(500),
  `xnoarchive` varchar(100),
  `contenttype` varchar(500),
  `contentencoding` varchar(500),
  `cancellock` varchar(500),
  `injectioninfo` varchar(500),
  `xtrace` varchar(500),
  `postinghost` varchar(1000),
  `headers` longtext,
  `disregard` tinyint(1) default '0',
  PRIMARY KEY  (`id`),
  KEY `day` (`day`),
  KEY `mid` (`mid`),
  KEY `newsgroups` (`newsgroups`)
) ENGINE=MyISAM  DEFAULT CHARSET=utf8 COMMENT='Parsed data';
PARSE
--
-- Table structure for table DBTableGrps
--

CREATE TABLE IF NOT EXISTS `$Conf{'DBTableGrps'}` (
  `id` bigint(20) unsigned NOT NULL auto_increment,
  `month` varchar(7) character set ascii NOT NULL,
  `newsgroup` varchar(100) NOT NULL,
  `postings` int(11) NOT NULL,
  `revision` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
  PRIMARY KEY  (`id`),
  UNIQUE KEY `month_newsgroup` (`month`,`newsgroup`),
  KEY `newsgroup` (`newsgroup`),
  KEY `postings` (`postings`)
) ENGINE=MyISAM  DEFAULT CHARSET=utf8 COMMENT='Postings per newsgroup';
GRPS

##### --------------------------------------------------------------------------
##### Installation / upgrade instructions
##### --------------------------------------------------------------------------

my $Install = <<INSTALL;
----------
Things left to do:

1) Setup an INN feed to feedlog.pl

   a) Edit your 'newsfeeds' file and insert something like

          ## gather statistics for NewsStats
          newsstats!\\
                  :!*,de.*\\
                  :Tc,WmtfbsPNH,Ac:$Path/feedlog.pl

      Please

      * check that you got the path to feedlog.pl right
      * check that feedlog.pl can be executed by the news user
      * adapt the pattern (here: 'de.*') to your needs

   b) Check your 'newsfeeds' syntax:

         # ctlinnd checkfile

      and reload 'newsfeeds':

         # ctlinnd reload newsfeeds 'Adding newsstats! feed'

   c) Watch your 'news.notice' and 'errlog' files:

         # tail -f /var/log/news/news.notice
         ...
         # tail -f /var/log/news/errlog

2) Watch your $Conf{'DBTableRaw'} table fill.

3) Read the documentation. ;)

Enjoy!

-thh <thh\@inter.net>
INSTALL

my $Upgrade ='';
if ($OptUpdate) {
 $Upgrade = <<UPGRADE;
----------
Your installation was upgraded from $OptUpdate to $PackageVersion.

Don't forget to restart your INN feed so that it can pick up the new version:

   # ctlinnd begin 'newsstats!'

(or whatever you called your feed).
UPGRADE
}

##### --------------------------- End of definitions ---------------------------

### create DB, if necessary
if (!$OptUpdate) {
  print "----------\nStarting database creation.\n";
  # create database
  # we can't use InitDB() as that will use a table name of
  # the table that doesn't exist yet ...
  my $DBHandle = DBI->connect(sprintf('DBI:%s:host=%s',$Conf{'DBDriver'},
                                      $Conf{'DBHost'}), $Conf{'DBUser'},
                                      $Conf{'DBPw'}, { PrintError => 0 });
  my $DBQuery = $DBHandle->prepare($DBCreate);
  $DBQuery->execute() or &Bleat(2, sprintf("Can't create database %s: %s%\n",
                                           $Conf{'DBDatabase'}, $DBI::errstr));

  printf("Database table %s created succesfully.\n",$Conf{'DBDatabase'});
  $DBHandle->disconnect;
};

### DB init, read list of tables
print "Reading database information.\n";
my $DBHandle = InitDB(\%Conf,1);
my %TablesInDB =
   %{$DBHandle->table_info('%', '%', '%', 'TABLE')->fetchall_hashref('TABLE_NAME')};

if (!$OptUpdate) {
  ##### installation mode
  # check for tables and create them, if they don't exist yet
  foreach my $Table (keys %DBCreate) {
    &CreateTable($Table);
  };
  print "Database table generation done.\n";

  # Display install instructions
  print $Install;
} else {
  ##### upgrade mode
  print "----------\nStarting upgrade process.\n";
  $PackageVersion = '0.03';
  if ($OptUpdate < $PackageVersion) {
    if ($OptUpdate < 0.02) {
      # 0.01 -> 0.02
      # &DoMySQL('...;');
      # print "v0.02: Database upgrades ...\n";
      # &PrintInstructions('0.02',<<"      INSTRUCTIONS");
      # INSTRUCTIONS
    };
  };
  # Display general upgrade instructions
  print $Upgrade;
};

# close handle
$DBHandle->disconnect;

exit(0);

################################# Subroutines ##################################

sub CreateTable {
  my $Table = shift;
  if (defined($TablesInDB{$Conf{$Table}})) {
    printf("Database table %s.%s already exists, skipping ....\n",
           $Conf{'DBDatabase'},$Conf{$Table});
    return;
  };
  my $DBQuery = $DBHandle->prepare($DBCreate{$Table});
  $DBQuery->execute() or
    &Bleat(2, sprintf("Can't create table %s in database %s: %s%\n",$Table,
                      $Conf{'DBDatabase'},$DBI::errstr));
  printf("Database table %s.%s created succesfully.\n",
         $Conf{'DBDatabase'},$Conf{$Table});
  return;
};

sub DoMySQL {
  my $SQL = shift;
  my $DBQuery = $DBHandle->prepare($SQL);
  $DBQuery->execute() or &Bleat(1, sprintf("Database error: %s\n",$DBI::errstr));
  return;
};

sub PrintInstructions {
  my ($UpVersion,$Instructions) = @_;
  print "v$UpVersion: Upgrade Instructions >>>>>\n";
  my $Padding = ' ' x (length($UpVersion) + 3);
    $Instructions =~ s/^      /$Padding/mg;
    print $Instructions;
    print "<" x (length($UpVersion) + 29) . "\n";
};


__END__

################################ Documentation #################################

=head1 NAME

install - installation script

=head1 SYNOPSIS

B<install> [B<-Vh> [--update I<version>] [--conffile I<filename>]

=head1 REQUIREMENTS

See L<doc/README>.

=head1 DESCRIPTION

This script will create database tables as necessary and configured.

=head2 Configuration

B<install> will read its configuration from F<newsstats.conf> via
Config::Auto.

See L<doc/INSTALL> for an overview of possible configuration options.

=head1 OPTIONS

=over 3

=item B<-V>, B<--version>

Print out version and copyright information and exit.

=item B<-h>, B<--help>

Print this man page and exit.

=item B<-u>, B<--update> I<version>

Don't do a fresh install, but update from I<version>.

=item B<--conffile> I<filename>

Load configuration from I<filename> instead of F<newsstats.conf>.

=back

=head1 FILES

=over 4

=item F<install/install.pl>

The script itself.

=item F<lib/NewsStats.pm>

Library functions for the NewsStats package.

=item F<etc/newsstats.conf>

Runtime configuration file.

=back

=head1 BUGS

Please report any bugs or feature requests to the author or use the
bug tracker at L<http://bugs.th-h.de/>!

=head1 SEE ALSO

=over 2

=item -

L<doc/README>

=item -

L<doc/INSTALL>

=back

This script is part of the B<NewsStats> package.

=head1 AUTHOR

Thomas Hochstein <thh@inter.net>

=head1 COPYRIGHT AND LICENSE

Copyright (c) 2010-2012 Thomas Hochstein <thh@inter.net>

This program is free software; you may redistribute it and/or modify it
under the same terms as Perl itself.

=cut
Commit	Line	Data
3f817eb4	1	#! /usr/bin/perl
2832c235 TH	2	#
	3	# install.pl
	4	#
	5	# This script will create database tables as necessary.
dfc2b81c	6	#
2832c235 TH	7	# It is part of the NewsStats package.
2832c235 TH	8	#
07c0b258	9	# Copyright (c) 2010-2013 Thomas Hochstein <thh@inter.net>
2832c235	10	#
dfc2b81c	11	# It can be redistributed and/or modified under the same terms under
2832c235 TH	12	# which Perl itself is published.
	13
	14	BEGIN {
	15	our $VERSION = "0.01";
	16	use File::Basename;
2ad99c20 TH	17	# we're in .../install, so our module is in ../lib
2ad99c20 TH	18	push(@INC, dirname($0).'/../lib');
2832c235 TH	19	}
2832c235 TH	20	use strict;
3f817eb4	21	use warnings;
2832c235 TH	22
	23	use NewsStats qw(:DEFAULT);
	24
	25	use Cwd;
	26
	27	use DBI;
1fa94799 TH	28	use Getopt::Long qw(GetOptions);
1fa94799 TH	29	Getopt::Long::config ('bundling');
2832c235 TH	30
	31	################################# Main program #################################
	32
	33	### read commandline options
23ab67a0	34	my ($OptUpdate,$OptConfFile);
1fa94799	35	GetOptions ('u\|update=s' => \$OptUpdate,
23ab67a0	36	'conffile=s' => \$OptConfFile,
1fa94799 TH	37	'h\|help' => \&ShowPOD,
1fa94799 TH	38	'V\|version' => \&ShowVersion) or exit 1;
2832c235 TH	39
2832c235 TH	40	### change working directory to .. (as we're in .../install)
512781bd	41	chdir dirname($FullPath).'/..';
f6d15ca7	42	my $Path = cwd();
2832c235 TH	43
	44	### read configuration
	45	print("Reading configuration.\n");
23ab67a0	46	my %Conf = %{ReadConfig($OptConfFile)};
2832c235 TH	47
	48	##### --------------------------------------------------------------------------
	49	##### Database table definitions
	50	##### --------------------------------------------------------------------------
	51
36cffe7a TH	52	my $DBCreate = <<SQLDB;
	53	CREATE DATABASE IF NOT EXISTS `$Conf{'DBDatabase'}` DEFAULT CHARSET=utf8;
	54	SQLDB
	55
6d72dad2	56	my %DBCreate = ('DBTableRaw' => <<RAW, 'DBTableParse' => <<PARSE, 'DBTableGrps' => <<GRPS);
23ab67a0	57	--
2832c235	58	-- Table structure for table DBTableRaw
23ab67a0	59	--
2832c235 TH	60
	61	CREATE TABLE IF NOT EXISTS `$Conf{'DBTableRaw'}` (
	62	`id` bigint(20) unsigned NOT NULL auto_increment,
	63	`day` date NOT NULL,
	64	`mid` varchar(250) character set ascii NOT NULL,
	65	`date` datetime NOT NULL,
	66	`timestamp` bigint(20) NOT NULL,
	67	`token` varchar(80) character set ascii NOT NULL,
	68	`size` bigint(20) NOT NULL,
	69	`peer` varchar(250) NOT NULL,
	70	`path` varchar(1000) NOT NULL,
	71	`newsgroups` varchar(1000) NOT NULL,
	72	`headers` longtext NOT NULL,
	73	`disregard` tinyint(1) default '0',
	74	PRIMARY KEY (`id`),
	75	KEY `day` (`day`),
	76	KEY `mid` (`mid`),
	77	KEY `peer` (`peer`)
	78	) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='Raw data';
	79	RAW
23ab67a0	80	--
6d72dad2 TH	81	-- Table structure for table DBTableParse
	82	--
	83
	84	CREATE TABLE IF NOT EXISTS `$Conf{'DBTableParse'}` (
	85	`id` bigint(20) unsigned NOT NULL auto_increment,
	86	`day` date NOT NULL,
	87	`mid` varchar(250) character set ascii NOT NULL,
	88	`refs` varchar(1000) character set ascii,
	89	`date` varchar(100) NOT NULL,
	90	`path` varchar(1000) NOT NULL,
	91	`newsgroups` varchar(1000) NOT NULL,
	92	`fupto` varchar(200),
	93	`from_` varchar(500),
	94	`from_parsed` varchar(200),
	95	`from_name` varchar(200),
	96	`from_address` varchar(200),
	97	`sender` varchar(500),
	98	`sender_parsed` varchar(200),
	99	`sender_name` varchar(200),
	100	`sender_address` varchar(200),
	101	`replyto` varchar(500),
	102	`replyto_parsed` varchar(200),
	103	`replyto_name` varchar(200),
	104	`replyto_address` varchar(200),
	105	`subject` varchar(1000) NOT NULL,
	106	`subject_parsed` varchar(1000),
	107	`organization` varchar(1000),
	108	`linecount` int(4) unsigned,
	109	`approved` varchar(250),
	110	`supersedes` varchar(250),
	111	`expires` varchar(100),
	112	`useragent` varchar(500),
	113	`xnewsreader` varchar(500),
	114	`xmailer` varchar(500),
	115	`xnoarchive` varchar(100),
	116	`contenttype` varchar(500),
	117	`contentencoding` varchar(500),
	118	`cancellock` varchar(500),
	119	`injectioninfo` varchar(500),
	120	`xtrace` varchar(500),
	121	`postinghost` varchar(1000),
	122	`headers` longtext,
	123	`disregard` tinyint(1) default '0',
	124	PRIMARY KEY (`id`),
	125	KEY `day` (`day`),
	126	KEY `mid` (`mid`),
	127	KEY `newsgroups` (`newsgroups`)
	128	) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='Parsed data';
	129	PARSE
	130	--
2832c235	131	-- Table structure for table DBTableGrps
23ab67a0	132	--
2832c235 TH	133
	134	CREATE TABLE IF NOT EXISTS `$Conf{'DBTableGrps'}` (
	135	`id` bigint(20) unsigned NOT NULL auto_increment,
	136	`month` varchar(7) character set ascii NOT NULL,
	137	`newsgroup` varchar(100) NOT NULL,
	138	`postings` int(11) NOT NULL,
	139	`revision` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
	140	PRIMARY KEY (`id`),
	141	UNIQUE KEY `month_newsgroup` (`month`,`newsgroup`),
	142	KEY `newsgroup` (`newsgroup`),
	143	KEY `postings` (`postings`)
	144	) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='Postings per newsgroup';
	145	GRPS
	146
f6d15ca7 TH	147	##### --------------------------------------------------------------------------
	148	##### Installation / upgrade instructions
	149	##### --------------------------------------------------------------------------
2832c235	150
f6d15ca7 TH	151	my $Install = <<INSTALL;
f6d15ca7 TH	152	----------
2832c235 TH	153	Things left to do:
	154
	155	1) Setup an INN feed to feedlog.pl
	156
	157	a) Edit your 'newsfeeds' file and insert something like
	158
	159	## gather statistics for NewsStats
9c141b0c TH	160	newsstats!\\
9c141b0c TH	161	:!,de.\\
2832c235 TH	162	:Tc,WmtfbsPNH,Ac:$Path/feedlog.pl
	163
	164	Please
	165
	166	* check that you got the path to feedlog.pl right
	167	* check that feedlog.pl can be executed by the news user
	168	* adapt the pattern (here: 'de.*') to your needs
	169
	170	b) Check your 'newsfeeds' syntax:
	171
	172	# ctlinnd checkfile
	173
	174	and reload 'newsfeeds':
	175
	176	# ctlinnd reload newsfeeds 'Adding newsstats! feed'
	177
	178	c) Watch your 'news.notice' and 'errlog' files:
	179
	180	# tail -f /var/log/news/news.notice
	181	...
	182	# tail -f /var/log/news/errlog
	183
	184	2) Watch your $Conf{'DBTableRaw'} table fill.
	185
	186	3) Read the documentation. ;)
	187
	188	Enjoy!
	189
	190	-thh <thh\@inter.net>
f6d15ca7 TH	191	INSTALL
f6d15ca7 TH	192
da6fc073 TH	193	my $Upgrade ='';
	194	if ($OptUpdate) {
	195	$Upgrade = <<UPGRADE;
f6d15ca7	196	----------
1fa94799	197	Your installation was upgraded from $OptUpdate to $PackageVersion.
f6d15ca7 TH	198
	199	Don't forget to restart your INN feed so that it can pick up the new version:
	200
	201	# ctlinnd begin 'newsstats!'
	202
	203	(or whatever you called your feed).
	204	UPGRADE
da6fc073	205	}
f6d15ca7	206
f6d15ca7 TH	207	##### --------------------------- End of definitions ---------------------------
f6d15ca7 TH	208
36cffe7a TH	209	### create DB, if necessary
	210	if (!$OptUpdate) {
	211	print "----------\nStarting database creation.\n";
	212	# create database
	213	# we can't use InitDB() as that will use a table name of
	214	# the table that doesn't exist yet ...
	215	my $DBHandle = DBI->connect(sprintf('DBI:%s:host=%s',$Conf{'DBDriver'},
	216	$Conf{'DBHost'}), $Conf{'DBUser'},
	217	$Conf{'DBPw'}, { PrintError => 0 });
	218	my $DBQuery = $DBHandle->prepare($DBCreate);
	219	$DBQuery->execute() or &Bleat(2, sprintf("Can't create database %s: %s%\n",
	220	$Conf{'DBDatabase'}, $DBI::errstr));
23ab67a0	221
36cffe7a TH	222	printf("Database table %s created succesfully.\n",$Conf{'DBDatabase'});
	223	$DBHandle->disconnect;
	224	};
	225
f6d15ca7 TH	226	### DB init, read list of tables
	227	print "Reading database information.\n";
	228	my $DBHandle = InitDB(\%Conf,1);
1fa94799 TH	229	my %TablesInDB =
1fa94799 TH	230	%{$DBHandle->table_info('%', '%', '%', 'TABLE')->fetchall_hashref('TABLE_NAME')};
f6d15ca7	231
1fa94799	232	if (!$OptUpdate) {
f6d15ca7	233	##### installation mode
f6d15ca7 TH	234	# check for tables and create them, if they don't exist yet
	235	foreach my $Table (keys %DBCreate) {
	236	&CreateTable($Table);
	237	};
	238	print "Database table generation done.\n";
dfc2b81c	239
f6d15ca7 TH	240	# Display install instructions
	241	print $Install;
	242	} else {
	243	##### upgrade mode
	244	print "----------\nStarting upgrade process.\n";
59d0c5ef	245	$PackageVersion = '0.03';
1fa94799 TH	246	if ($OptUpdate < $PackageVersion) {
1fa94799 TH	247	if ($OptUpdate < 0.02) {
59d0c5ef TH	248	# 0.01 -> 0.02
	249	# &DoMySQL('...;');
	250	# print "v0.02: Database upgrades ...\n";
	251	# &PrintInstructions('0.02',<<" INSTRUCTIONS");
	252	# INSTRUCTIONS
f6d15ca7 TH	253	};
f6d15ca7 TH	254	};
59d0c5ef	255	# Display general upgrade instructions
f6d15ca7 TH	256	print $Upgrade;
	257	};
	258
	259	# close handle
	260	$DBHandle->disconnect;
	261
	262	exit(0);
	263
	264	################################# Subroutines ##################################
	265
59d0c5ef	266	sub CreateTable {
f6d15ca7 TH	267	my $Table = shift;
f6d15ca7 TH	268	if (defined($TablesInDB{$Conf{$Table}})) {
1fa94799 TH	269	printf("Database table %s.%s already exists, skipping ....\n",
1fa94799 TH	270	$Conf{'DBDatabase'},$Conf{$Table});
f6d15ca7 TH	271	return;
	272	};
	273	my $DBQuery = $DBHandle->prepare($DBCreate{$Table});
1fa94799 TH	274	$DBQuery->execute() or
	275	&Bleat(2, sprintf("Can't create table %s in database %s: %s%\n",$Table,
	276	$Conf{'DBDatabase'},$DBI::errstr));
	277	printf("Database table %s.%s created succesfully.\n",
	278	$Conf{'DBDatabase'},$Conf{$Table});
f6d15ca7 TH	279	return;
	280	};
	281
59d0c5ef	282	sub DoMySQL {
f6d15ca7 TH	283	my $SQL = shift;
f6d15ca7 TH	284	my $DBQuery = $DBHandle->prepare($SQL);
1fa94799	285	$DBQuery->execute() or &Bleat(1, sprintf("Database error: %s\n",$DBI::errstr));
f6d15ca7 TH	286	return;
	287	};
	288
59d0c5ef TH	289	sub PrintInstructions {
	290	my ($UpVersion,$Instructions) = @_;
	291	print "v$UpVersion: Upgrade Instructions >>>>>\n";
	292	my $Padding = ' ' x (length($UpVersion) + 3);
	293	$Instructions =~ s/^ /$Padding/mg;
	294	print $Instructions;
	295	print "<" x (length($UpVersion) + 29) . "\n";
	296	};
	297
2832c235 TH	298
	299	__END__
	300
	301	################################ Documentation #################################
	302
	303	=head1 NAME
	304
	305	install - installation script
	306
	307	=head1 SYNOPSIS
	308
23ab67a0	309	B<install> [B<-Vh> [--update I<version>] [--conffile I<filename>]
2832c235 TH	310
	311	=head1 REQUIREMENTS
	312
1fa94799	313	See L<doc/README>.
2832c235 TH	314
	315	=head1 DESCRIPTION
	316
	317	This script will create database tables as necessary and configured.
	318
	319	=head2 Configuration
	320
1fa94799	321	B<install> will read its configuration from F<newsstats.conf> via
2832c235 TH	322	Config::Auto.
2832c235 TH	323
1fa94799	324	See L<doc/INSTALL> for an overview of possible configuration options.
2832c235 TH	325
	326	=head1 OPTIONS
	327
	328	=over 3
	329
1fa94799	330	=item B<-V>, B<--version>
2832c235	331
1fa94799	332	Print out version and copyright information and exit.
2832c235	333
1fa94799	334	=item B<-h>, B<--help>
2832c235 TH	335
	336	Print this man page and exit.
	337
1fa94799 TH	338	=item B<-u>, B<--update> I<version>
	339
	340	Don't do a fresh install, but update from I<version>.
	341
23ab67a0 TH	342	=item B<--conffile> I<filename>
	343
	344	Load configuration from I<filename> instead of F<newsstats.conf>.
	345
2832c235 TH	346	=back
	347
	348	=head1 FILES
	349
	350	=over 4
	351
2ad99c20	352	=item F<install/install.pl>
2832c235 TH	353
	354	The script itself.
	355
2ad99c20	356	=item F<lib/NewsStats.pm>
2832c235 TH	357
	358	Library functions for the NewsStats package.
	359
2ad99c20	360	=item F<etc/newsstats.conf>
2832c235	361
1fa94799	362	Runtime configuration file.
2832c235 TH	363
	364	=back
	365
	366	=head1 BUGS
	367
	368	Please report any bugs or feature requests to the author or use the
	369	bug tracker at L<http://bugs.th-h.de/>!
	370
	371	=head1 SEE ALSO
	372
	373	=over 2
	374
	375	=item -
	376
1fa94799	377	L<doc/README>
2832c235 TH	378
	379	=item -
	380
1fa94799	381	L<doc/INSTALL>
2832c235 TH	382
	383	=back
	384
	385	This script is part of the B<NewsStats> package.
	386
	387	=head1 AUTHOR
	388
	389	Thomas Hochstein <thh@inter.net>
	390
	391	=head1 COPYRIGHT AND LICENSE
	392
1fa94799	393	Copyright (c) 2010-2012 Thomas Hochstein <thh@inter.net>
2832c235 TH	394
	395	This program is free software; you may redistribute it and/or modify it
	396	under the same terms as Perl itself.
	397
	398	=cut