comment on

Besides the lines above, i also invoke pod2usage if Getops returns an failure errorcode:

GetOptions( \%options, 'server=s', 'date=s', 
           'man', 'help', 'alert!', 'debug+'
          ) || pod2usage(2);
[download]

Every file should contain within it the documentation for that script, in POD format. Type perldoc perlpod into an xterm, or browse http://perldoc.perl.org/perlpod.html for details.

On the one hand, it's unsophisticated. On the other hand, it asks a lot. But people wouldn't fill in more complicated formatting, and you need to provide certain information.

My solution is to set up a template file, which has everything I need to start a new script. it contains a few things I frequently use but may not need. My boss likes to have the RCS keywords. The ## no critic is to make perlcritic not complain about that line.

#!/ms/dist/perl5/bin/perl5.10
# A one-line description of what this script does.

our ($VERSION) = '$Revision: #24 $ ' =~ m{ \$Revision: \s+ (\S+) }x; #
+# no critic (InterpolationOfMetachars);

use 5.010;
use warnings;
use strict;

#
#   Last edited by:  $Author$
#               on:  $Date$
#         Filename:  $Source$
#         Revision:  $Revision$
#
#               ID:  $Id$

# Database
#

use English qw( -no_match_vars );
use Fatal qw( open close );

use Readonly;
use DBI;

use POSIX 'strftime';
use Getopt::Long;
use Pod::Usage;

# ====================================================================
+==
# Configuration Section
#

# ====================================================================
+==
# Subroutines
#

######################################################################
+##
# Usage      :
# Purpose    :
# Returns    :
# Parameters :
# Throws     :
# Comments   :
# See Also   :
#

# ====================================================================
+==
# Main Processing Section
#
MAIN: {
    my %options;

    GetOptions( \%options, 
                'man', 'help', 'alert!', 'debug+'
              ) || pod2usage(2);

    pod2usage(1) if $options{'help'};
    pod2usage( '-verbose' => 2 ) if $options{'man'};
}

# ====================================================================
+==
__END__

=head1 NAME
 
<application name> - <One line description of application's purpose>
 
=head1 VERSION
 
This documentation refers to <application name> version $Id$
 
=head1 USAGE
 
    # Brief working invocation example(s) here showing the most common
+ usage(s)
 
    # This section will be as far as many users ever read
    # so make it as educational and exemplary as possible.
 
 
=head1 REQUIRED ARGUMENTS
 
A complete list of every argument that must appear on the command line
+. 
when the application  is invoked, explaining what each of them does, a
+ny
restrictions on where each one may appear (i.e. flags that must appear
+ 
before or after filenames), and how the various arguments and options 
may interact (e.g. mutual exclusions, required combinations, etc.)
 
If all of the application's arguments are optional this section
may be omitted entirely.
 
 
=head1 OPTIONS
 
A complete list of every available option with which the application 
can be invoked, explaining what each does, and listing any restriction
+s,
or interactions.
 
If the application has no options this section may be omitted entirely
+.
 
NOTE: This section, and nothing more, is printed out for C<prog -help>
+.
 
=head1 DESCRIPTION
 
A full description of the application and its features.
May include numerous subsections (i.e. =head2, =head3, etc.) 
 
 
=head1 DIAGNOSTICS
 
A list of every error and warning message that the application can gen
+erate
(even the ones that will "never happen"), with a full explanation of e
+ach 
problem, one or more likely causes, and any suggested remedies. If the
application generates exit status codes (e.g. under Unix) then list th
+e exit
status associated with each error.
 
 
=head1 CONFIGURATION AND ENVIRONMENT
 
A full explanation of any configuration system(s) used by the applicat
+ion,
including the names and locations of any configuration files, and the
meaning of any environment variables or properties that can be set. Th
+ese
descriptions must also include details of any configuration language u
+sed
  
 
=head1 DEPENDENCIES
=head1 INCOMPATIBILITIES
=head1 BUGS AND LIMITATIONS
=head1 AUTHOR

 <name> <long.email>@company.com
 <date> <dept>

=cut 

# ====================================================================
+==
# End of File
# ====================================================================
+==
[download]

As Occam said: Entia non sunt multiplicanda praeter necessitatem.

In reply to Re^3: How to use getopt and $#argv together? by TomDLux
in thread How to use getopt and $#argv together? by iphone

Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!

Titles consisting of a single word are discouraged, and in most cases are disallowed outright.

Read Where should I post X? if you're not absolutely sure you're posting in the right place.

Please read these before you post! —

Posts may use any of the Perl Monks Approved HTML tags:

a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr

You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)

	For:		Use:
	&		`&`
	<		`<`
	>		`>`
	[		`[`
	]		`]`

Link using PerlMonks shortcuts! What shortcuts can I use for linking?

See Writeup Formatting Tips and other pages linked from there for more info.