Changeset 36 for trunk

Timestamp:

11/08/05 19:40:43 (19 years ago)

Author:

thauvin

Message:

• add documentation

File:

• trunk/soft/scripts/transfert (modified) (6 diffs, 1 prop)

trunk/soft/scripts/transfert

@@ -2 +2 @@
 
 # $Id$
+
+=head1 NAME
+
+transfert - A script to transfert data using rsync
+
+=head1 VERSION
+
+CVS: $Revision$
+
+=cut
 
 use strict;
@@ -9 +19 @@
 use Mail::Sendmail;
 use POSIX qw(strftime);
+use Pod::Usage;
 
 # 0 .. 6 => debug, info, report, warn, error, die
@@ -14 +25 @@
 
 GetOptions(
-    'config|s=s' => \my $configfile,
+    'config|c=s' => \my $configfile,
     'v' => sub { $verbose-- },
     'd|debug' => \my $debug,
@@ -20 +31 @@
     'mailto' => \my $mailto,
     'logfile=s' => \my $logfile,
-);
+    'help|h' => sub { pod2usage(-exitval => 0) },
+) or pod2usage();
+
+=head1 SYNOPSIS
+
+transfert -c <configfile> [...]
+
+    config|c <configfile>   use this config file
+    v                       increase verbosity
+    nomail                  do not sent any mail
+    logfile <logfilefmt>    write log into this file
+    help|h                  print this message
+    debug|d                 debug mode
+
+=head1 OPTIONS
+
+=head1 CONFIGURATION FILE
+
+=head2 Description
+
+The configuration is an INI file like. Each section describe
+a path to transfert. The section named 'default' is used to store
+global or default values.
+
+Example:
+
+    [default]
+
+    [musique]
+    source=/source/
+    dest=host:/dest
+    mailto=user@domain
+
+=head2 Globals values
+
+Following paramater should be set into [default] section:
+
+=over
+
+=item * smtp Mail host to use to send mail, default is 'localhost'
+
+=item * mailfrom the mail adress set into mail as from, only the form
+user@domain should appear
+
+=item * mailheader a message to copy at the beggining of each mail
+
+=item * mailfooter a message to copy at the end of each mail
+
+=item * logfile redirect log into this file.
+
+logfile is a strftime format. See L<strftime> man page, or L<POSIX>
+perl module documentation.
+
+=head2 Per transfert parameters
+
+All this paramter can be set into [default] section
+
+=item * source the source file to transfert. 
+
+This paramater is passed directly to rsync, so can be a glob.
+
+=item * destination the destination where file should be copied
+
+=item * rsync command location, default is 'rsync'
+
+=item * mailto the list of coma separate mail address which will receive 
+transfert log
+
+=back
+    
+=cut
 
 $verbose = 0 if ($debug);
@@ -137 +218 @@
             'X-OSBDATA-HOST' => "",
             Smtp => $config->val('default', 'smtp', 'localhost'),
-            From => 'Data transfert bot ' . $config->val(
+            From => 'Data transfert bot <' . $config->val(
                 'default', 
                 'mailfrom',
-                '<olivier.thauvin@aerov.jussieu.fr>'),
+                'olivier.thauvin@aerov.jussieu.fr') .'>',
 
         );
@@ -154 +235 @@
 __END__
 
+=head1 AUTHOR
+
+Olivier Thauvin <olivier.thauvin@aerov.jussieu.fr>
+
 =head1 CHANGELOG
 
     $Log$
+    Revision 1.3  2005/11/08 18:40:43  thauvin
+    - add documentation
+
     Revision 1.2  2005/11/08 17:17:29  thauvin
     - add logfile support