#!/usr/bin/perl -w

=head1 NAME

pod-usage - A simple program with its own documentation.

=head1 SYNOPSIS

  pod-usage [options]

  Help Options:
   --help     Show this scripts help information.
   --manual   Read this scripts manual.
   --version  Show the version number and exit.

=cut


=head1 OPTIONS

=over 8

=item B<--help>
Show the brief help information.

=item B<--manual>
Read the manual, with examples.

=item B<--version>
Show the version number and exit.

=back

=cut


=head1 EXAMPLES

  The following is an example of this script:

 pod-usage.pl --help

=cut


=head1 DESCRIPTION


  This is a simple demonstration program for Pod::Usage, this text
 will be displayed if the script is invoked with '--manual'.

=cut


=head1 AUTHOR


 Steve
 --
 http://www.steve.org.uk/

 $Id: pod-usage,v 1.79 2006/01/07 23:23:12 steve Exp $

=cut




use strict;
use Getopt::Long;
use Pod::Usage;



#
# Release number.
#
my $RELEASE = '0.8';


#
#  Parse command line arguments.  These override the values from the
# configuration file.
#
parseCommandLineArguments();


#
#  Do more stuff ..
#


#
#  All done
#
exit;





=head2 parseCommandLineArguments

  Parse the arguments specified upon the command line.

=cut

sub parseCommandLineArguments
{
    my $HELP	= 0;   # Show help overview.
    my $MANUAL	= 0;   # Show manual
    my $VERSION	= 0;   # Show version number and exit.

    #  Parse options.
    #
    GetOptions(
	       "help",         \$HELP,
	       "manual",       \$MANUAL,
	       "version",      \$VERSION
	      );
    
    pod2usage(1) if $HELP;
    pod2usage(-verbose => 2 ) if $MANUAL;


    if ( $VERSION )
    {
	my $REVISION      = '$Id: pod-usage,v 1.79 2006/01/07 23:23:12 steve Exp $';
	$VERSION = join (' ', (split (' ', $REVISION))[2]);
	$VERSION =~ s/,v\b//;
	$VERSION =~ s/(\S+)$/$1/;

	print "pod-usage release $RELEASE - CVS: $VERSION\n";
	exit;
    }
}