Changeset 3239 in MondoRescue for branches/3.2/MondoRescue/etc/mondorescue.conf

Timestamp:

Jan 5, 2014, 1:35:28 PM (10 years ago)

Author:

Bruno Cornec

Message:

• Fix build process for perl modules deps (creation of the perl-scripts file was incorrect with build dir in it, and overwritten)
• Fix pod2man issue on mondorescue.conf by adding pod content in it which is then processed in the Makefile.PL

File:

• branches/3.2/MondoRescue/etc/mondorescue.conf (modified) (2 diffs)

branches/3.2/MondoRescue/etc/mondorescue.conf

@@ +1 @@
+# $Id$
+# 
+# =pod
+#
+# =head1 NAME
+# 
 # MondoRescue configuration file
 #
-# $Id$
+# =head1 DESCRIPTION
 #
-# We tried to give sensible defaults in this file.
-# It will always be loaded by the tools before your other configuration files. 
+# The mondorescue.conf contains the various parameters that can be adapted for MondoRescue usage
+#
+# =head1 SYNOPSIS
+#
+# We tried to give sensible defaults in this file (mondorescue.conf.dist).
+# It will always be loaded by the tools before your own configuration files (mondorescue.conf). 
+#
 # DO NOT CHANGE THAT FILE IN ANYWAY AS ITS MD5 SUM IS USED AS A CHECK !!
 # Anyway changing some values in your own configuration file may render 
 # MondoRescue tools instable or cause failures. Use with care.
+#
+# =head1 CONFIGURATION PARAMETERS
+# 
 
+# =over 4
+
+# =item B<mr_tmp_dir default>
+#
 # Temporary directory
+#
 # Under it a temporary directory will be created to host all
-# temporary files for mrmini. That subdirectory is erased at the end of mrmini
+# temporary files for MondoRescue tools. That subdirectory is erased at the end of execution
 #
+#  Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). The family name is generaly used here.
+#  Value: Full path of the temporary directory
+#  Example: 
 mr_tmp_dir default = /tmp
 
+# =item B<mr_cmdline>
 #
-# Location of some configuration files
+# Location of the file containing the boot command line for the OS
 #
-# depends on genre
+#  Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). The family name is generaly used here.
+#  Value: comma separated list of URLs that point to repository files, or packages to install. The values may not include substitutions.
+#  Example: 
 mr_cmdline linux = /proc/cmdline
 mr_cmdline bsd = /tmp/cmdline
 # TBC
 mr_cmdline solaris = /proc/cmdline
+#
+
+# =item B<TO BE DOCUMENTED LATER>
 #
 mr_etc_fstab default = /etc/fstab
@@ -64 +92 @@
 mr_cmd_lvm default = /usr/sbin/lvm
 mr_path_lvm default = /usr/sbin/
+
+# =back
+
+# =head1 COPYRIGHT
+
+# (c) B. Cornec 2007-2014
+#
+# Provided under the Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) Creative Common License
+
+# =cut