Changeset 3143 in MondoRescue for branches/3.0/mindi/mindi-bkphw

Timestamp:

Jun 14, 2013, 6:06:09 AM (11 years ago)

Author:

Bruno Cornec

Message:

r5349@localhost: bruno | 2013-06-14 01:23:53 +0200

• Adds pod content to the perl scripts used, and generate man pages frmo it as part of the install process. This also fixes rpmlint and deblint issues

File:

• branches/3.0/mindi/mindi-bkphw (modified) (2 diffs)

branches/3.0/mindi/mindi-bkphw

@@ -2 +2 @@
 #
 # $Id$
+# Copyright B. Cornec 2005-2013
+# Provided under the GPL v2
 #
 # Backup the hardware configuration on machine supporting it
@@ -8 +10 @@
 use strict;
 use File::Basename;
+
+=pod
+
+=head1 NAME
+
+mindi-bkphw keeps track of your hardware configuration (BIOS, Raid, Management board, ...)
+
+=head1 DESCRIPTION
+
+mindi-bkphw keeps track of your hardware configuration by calling the tool provided by IHV (Independant Hardware Vendor) in order to store the configuration of the system BIOS, the RAID controller or the onboard management card if any of those is present.
+
+For the moment, this is only working for HP ProLiant servers, as HP provides all these tools in a convenient way to perform these actions. Other manufacturer can provide patches or relevant info in order to be supported as well here.
+
+=head1 SYNOPSIS
+
+mindi-bkphw /path/to/cache-dir /path/to/conf-dir
+
+=head1 ARGUMENTS
+
+=over 4
+
+=item B</path/to/cache-dir> 
+
+This is the directory where the generated files will be stored.
+
+=item B</path/to/conf-dir>
+
+This is the directory where the configuration file describing the tools needed to backup hardware information is stored. Generaly /etc/mindi. It should contain a deplist.d subdirectory, and for now only the ProLiant.conf file is used in it.
+
+=back
+
+=head1 WEB SITES
+
+The main Web site of the project is available at L<http://www.mondorescue.org>. Bug reports should be filled using the trac instance of the project at L<http://trac.mondorescue.org/>.
+
+=head1 USER MAILING LIST
+
+For community exchanges around MondoRescue please use the list L<http://sourceforge.net/mailarchive/forum.php?forum_name=mondo-devel>
+
+=head1 AUTHORS
+
+The MondoRescue team lead by Bruno Cornec L<mailto:bruno@mondorescue.org>.
+
+=head1 COPYRIGHT
+
+MondoRescue is distributed under the GPL v2.0 license or later,
+described in the file C<COPYING> included with the distribution.
+
+=cut
+
 
 # Handling Configuration files