amanda-plugin-dumpext: comparison bin/amdumpext

equal deleted inserted replaced

-:d176b9443312
+:8231f7b00052
 use constant NO        => 'NO';
 use constant DUMPDATES => '/var/lib/dumpdates';
 use constant FD3       => 3;
 use constant FD4       => 4;
-$SIG{__DIE__} = sub { die "$ME: ", @_ };
+$SIG{__DIE__} = sub { die $^S ? '' : "$ME: ", @_ };
 my %SUPPORT = (
 CONFIG          => YES,    # --config … (default)
 DISK            => NO,     # --disk …
 HOST            => NO,     # --host …
 # may: $opt_level
 OK "$ME version $VERSION";
 OK "euid=$> (" . getpwuid($>) . ')';
 OK "egid=" . do {
-my $gid = (split ' ', $))[0];
+my ($gid, undef) = split ' ', $);
 my $group = getgrgid $gid;
 "$gid ($group)";
 };
 OK "groups=" . do {
 my (undef, @gids) = split ' ', $);
 "@gids (@groups)";
 };
 foreach my $tool (qw(dump restore)) {
 if ($_ = (grep { -x ($_ .= "/$tool") } split /:/ => $ENV{PATH})[0]) {
-chomp(my $version = (`$_ 2>&1`)[0]);
+my ($version, undef) = `$_ 2>&1`;
+	    chomp $version;
 OK "$tool is $version";
 }
 else {
 ERROR "$tool not found in $ENV{PATH}";
 }
 # check the dumpdates file
 if ($opt_record) {
 my $dumpdates = $opt_dumpdates ? expand($opt_dumpdates) : DUMPDATES;
 eval { open(my $x, "+>>", $dumpdates) or die "$!\n" };
-if   (chomp $@) { ERROR "dumpdates file \"$dumpdates\": $@" }
+if   (chomp $@) { ERROR "dumpdates file $dumpdates: $@" }
-else            { OK "dumpdates file: \"$dumpdates\"" }
+else            { OK "dumpdates file is $dumpdates" }
 }
 exit 0;
 }
 amdumpext support
 amdumpext selfcheck [options] [--level <level>]    --device <device>
 amdumpext estimate [options]  [--level <level>]... --device <device>
+=head1 DESCRIPTION
+The B<amdumpext> is an application plugin for amanda. It drives the
+native ext2/3/4 dump/restore programs found on most Linux systems. See L<dump(8)>
+and L<restore(8)> for more information on these tools.
 =head1 COMMANDS
+The B<amdumpext> supports the commands from the API description found on
+L<http://wiki.zmanda.com/index.php/Application_API/Operations>.
+=head1 COMMON OPTIONS
 =over
-=item B<support>
+=item B<--device> I<device>
-Send a list of supported features.
+The disk device from the disklist.
+=item B<--disk> I<disk>
+The diskname from the disklist. Currently ignored.
+=item B<--host> I<host>
+The hostname from the disklist. Currently ignored.
+=item B<--config> I<config>
+The name of the configuration.
+=item B<--level> I<level>
+The level of the backup. 0 means full backup.
+=item B<--index> I<xml|line>
+Create an index of the files backed up. XML is not supported yet.
+(Default: not set, means no index at all)
+=item B<--message> I<xml|line>
+The format used for messages. XML is not supported yet.
+(Default: line)
 =back
-=head1 OPTIONS
+=head1 COMMANDS
-=head2 Common Options
+=head2 support
-The following options have to be supported by the application.
+This command returns the list of supported features.
-=over 4
+=head2 selfcheck
-=item B<--config> I<config>
+This command instructs B<amdumpext> to so some selfchecks. In an ideal
+world it will detect any problem that might prevent a successful backup.
-The configuration to be used (the backup set).
+mandatory options: device, level
-=item B<--host> I<host>
+=head2 estimate
-The host from the DLE.
+Create an estimate about the amount of data we may expect for the
-=item B<--disk> I<disk>
+backup. Multi-Level estimates are supported.
-The disk to be saved. It's some "label" for the device to be backed up.
+mandatory options: device, level, ...
-=item B<--device> I<device>
+=head1 PROPERTIES
-The device to be backed up (may be a device name, a mountpoint).
+The properties may be set on the server side to tune the behaviour
+of the application. Currently property setting on the client side is
-=back
+not supported.
-=head2 Optional options
-The following options need to be supported if indicated by the "support"
-command.
-=over
-=item B<--message> "line"
-Send messages line by line.
-=item B<--index> "line"
-Send the index line by line.
-=back
-=cut
-=head2 Properties
 =over 4
 =item B<--dumpdates> I<dumpdates>
 The location of the dumpdates file. Placeholder "${c}" is allowed and
 replaced by the name of the current config.
 =back
+=head1 TESTING
+The B<amdumpext> may be tested on the command line. The following output
+file descriptors are used:
+=over
+=item 1 (STDOUT)
+The normal command output, the data stream.
+=item 2 (STDERR)
+Not used by the API, but probably redirected to some log files.
+=item 3 (messages)
+Operational messages, often it's postprocessed output of some of
+the invoked tools
+=item 4 (index)
+If index generation is ordered (via the B<--index> option), the index is
+sent to this file descriptor.
+=back
+The following shell command line is suitable to test the B<amdumpext>:
+$ amdumpext backup --device /dev/sda1 --level 0 1>dump 3>messages 4>index
+If you're interested in reading the messages as they appear:
+$ amdumpext backup --device /dev/sda1 --level 0 3>&1 1>dump 4>index
 =head1 EXAMPLE
-define application "dump" {
+The C<amanda.conf> should contain something similiar to the following
+stanza:
+define application "mydump" {
 plugin "amdumpext"
 	# optional - define some additional parameters
 property "dumpdates" "/tmp/dumpdates.${c}"
 }
+define dumptype "dump" {
+	program "APPLICATION"
+	application "mydump"
+}
 =cut
 # vim:sts=4 sw=4 aw ai sm:

changeset 10	8231f7b00052
parent 9	d176b9443312
child 11	9ad262d8c301