#!/usr/bin/perl -w # # $Id$ # # The author disclaims all copyrights and releases this script into the # public domain. # # Run perldoc(1) on this file for additional documentation. # ###################################################################### # # REQUIREMENTS require 5; use strict; ###################################################################### # # MODULES use Carp; # better error reporting use Getopt::Std; # command line option processing ###################################################################### # # VARIABLES my $VERSION; ($VERSION = '$Revision$ ') =~ s/[^0-9.]//g; my (%opts); ###################################################################### # # MAIN # parse command-line options getopts('h?', \%opts); help() if exists $opts{'h'} or exists $opts{'?'}; # read from STDIN if no args left #chomp(@ARGV = ) unless @ARGV; # # and flag the help text if nothing from STDIN #help() unless @ARGV; exit; ###################################################################### # # SUBROUTINES # a generic help blarb sub help { print <<"HELP"; Usage: $0 [opts] Help for a generic script template. Options for version $VERSION: -h/-? Display this message Run perldoc(1) on this script for additional documentation. HELP exit; } ###################################################################### # # DOCUMENTATION =head1 NAME blank.pl - a script with stub docs =head1 SYNOPSIS Quick usage notes here. =head1 DESCRIPTION =head2 Overview Short description of what script is intended to do. =head2 Normal Usage $ blank.pl [options] See L<"OPTIONS"> for details on the command line switches supported. =head1 OPTIONS This script currently supports the following command line switches: =over 4 =item B<-h>, B<-?> Prints a brief usage note. =back Use B<-f> I if a switch takes an argument of some kind. =head1 EXAMPLES Additional examples/helpfull hints expanding on SYNOPSIS. =head1 ENVIRONMENT Any special environement details or warnings? =head1 FILES Any important files this script relies on? =head1 BUGS =head2 Reporting Bugs Newer versions of this script may be available from: http://sial.org/code/perl/ If the bug is in the latest version, send a report to the author. Patches that fix problems or add new features are welcome. =head2 Known Issues No known bugs. =head1 TODO Replace default stub POD entries with real documentation. =head1 SEE ALSO perl(1) =head1 AUTHOR Jeremy Mates, http://sial.org/contact/ =head1 COPYRIGHT The author disclaims all copyrights and releases this script into the public domain. =head1 HISTORY A blank perl template I threw together to make writing new scripts easier. =head1 VERSION $Id$ =cut