Changeset 1445

Timestamp:

04/04/12 17:14:47 (14 months ago)

Author:

ebaudrez

Message:

started using POD documentation

File:

• projects/md2mb/devel/md2mb/bin/md2mb.pl (modified) (4 diffs)

projects/md2mb/devel/md2mb/bin/md2mb.pl

@@ -1 +1 @@
 #!/usr/bin/perl -w
-#
-# Program to import a maildir kmail environement into a thunderbird one.
-#
-# Released under the GPLv2 or the Artistic license at your will.
+
+=head1 NAME
+
+md2mb.pl - Import a maildir kmail environment into a thunderbird one
+
+=cut
 
 use strict;
@@ -11 +13 @@
 use File::Path;
 use File::Glob ':glob';
+use Getopt::Long;
+use Pod::Usage;
 
+# settings
 my $cmd="formail";
 # CHANGE AS YOU WISH
@@ -20 +25 @@
 my $debug = 0;
 # END CHANGE
+my $help = 0;
+my $man = 0;
 
-$debug++ if ((defined $ARGV[0]) && ($ARGV[0] eq "-v"));
+# parse command-line options
+GetOptions(
+    'help|h'    => \$help,
+    'man|m'     => \$man,
+    'verbose|v' => sub { $debug++ },
+) or pod2usage(2);
+pod2usage(1) if ($help);
+pod2usage(-exitstatus => 0, -verbose => 2) if ($man);
+
 print "DEBUG MODE, not doing anything, just printing\n" if ($debug);
 if ($debug) { 
@@ -112 +127 @@
 }
 }
+__END__
+
+=head1 SYNOPSIS
+
+md2mb.pl  [options]
+
+ Options:
+   -help        brief help message
+   -man         full documentation
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-help>
+
+Print a brief help message and exits.
+
+=item B<-man>
+
+Prints the manual page and exits.
+
+=back
+
+=head1 DESCRIPTION
+
+B<md2mb.pl> will import a B<kmail> maildir environment, and transform it into a
+B<thunderbird> one.
+
+=head1 AUTHOR
+
+Bruno Cornec, http://brunocornec.wordpress.com
+
+=head1 LICENSE
+
+Released under the GPLv2 or the Artistic license at your will.
+
+=cut