2006-08-14 20:55:29 by steve
Don't show the documentation for internal functions in the --manual or manpage. See: #383032 Solution from here: http://www.perlmonks.org/?node_id=567327
This commit is contained in:
@@ -439,7 +439,7 @@ Install an X11 server, using VNC and XDM
|
||||
--
|
||||
http://www.steve.org.uk/
|
||||
|
||||
$Id: xen-create-image,v 1.58 2006-07-25 15:49:52 steve Exp $
|
||||
$Id: xen-create-image,v 1.59 2006-08-14 20:55:29 steve Exp $
|
||||
|
||||
=cut
|
||||
|
||||
@@ -640,7 +640,7 @@ exit;
|
||||
|
||||
|
||||
|
||||
=head2 checkSystem
|
||||
=begin doc
|
||||
|
||||
Test that this system is fully setup for the new xen-create-image
|
||||
script.
|
||||
@@ -667,7 +667,7 @@ sub checkSystem
|
||||
|
||||
|
||||
|
||||
=head2 setupDefaultOptions
|
||||
=begin doc
|
||||
|
||||
Setup the default options we'd expect into our global CONFIG hash.
|
||||
|
||||
@@ -738,7 +738,7 @@ sub setupDefaultOptions
|
||||
|
||||
|
||||
|
||||
=head2 readConfigurationFile
|
||||
=begin doc
|
||||
|
||||
read the global configuration file /etc/xen-tools/xen-tools.conf
|
||||
|
||||
@@ -795,7 +795,7 @@ sub readConfigurationFile
|
||||
|
||||
|
||||
|
||||
=head2 parseCommandLineArguments
|
||||
=begin doc
|
||||
|
||||
Parse the command line arguments this script was given.
|
||||
|
||||
@@ -865,7 +865,7 @@ sub parseCommandLineArguments
|
||||
|
||||
if ( $VERSION )
|
||||
{
|
||||
my $REVISION = '$Revision: 1.58 $';
|
||||
my $REVISION = '$Revision: 1.59 $';
|
||||
|
||||
if ( $REVISION =~ /1.([0-9.]+) / )
|
||||
{
|
||||
@@ -879,7 +879,7 @@ sub parseCommandLineArguments
|
||||
}
|
||||
|
||||
|
||||
=head2 testRootUser
|
||||
=begin doc
|
||||
|
||||
Make sure this script is being run by a user with UID 0.
|
||||
|
||||
@@ -903,7 +903,7 @@ E_O_ROOT
|
||||
|
||||
|
||||
|
||||
=head2 checkArguments
|
||||
=begin doc
|
||||
|
||||
Test that the command line arguments we were given make sense.
|
||||
|
||||
@@ -1043,7 +1043,7 @@ E_O_ERROR
|
||||
|
||||
|
||||
|
||||
=head2 checkFilesPresent
|
||||
=begin doc
|
||||
|
||||
Check that we have some required files present.
|
||||
|
||||
@@ -1089,7 +1089,7 @@ sub checkFilesPresent
|
||||
|
||||
|
||||
|
||||
=head2 showSummery
|
||||
=begin doc
|
||||
|
||||
Show the user a summery of what is going to be created for them
|
||||
|
||||
@@ -1141,7 +1141,7 @@ sub showSummery
|
||||
|
||||
|
||||
|
||||
=head2 testLoopbackModule
|
||||
=begin doc
|
||||
|
||||
Test that the user has the "loop" module loaded and present,
|
||||
this is just a warning useful to newcomers.
|
||||
@@ -1167,7 +1167,7 @@ sub testLoopbackModule
|
||||
|
||||
|
||||
|
||||
=head2 createLoopbackImages
|
||||
=begin doc
|
||||
|
||||
Create the two images "swap.img" and "disk.img" in the directory
|
||||
we've been given.
|
||||
@@ -1283,7 +1283,7 @@ sub createLoopbackImages
|
||||
}
|
||||
|
||||
|
||||
=head2 createLVMBits
|
||||
=begin doc
|
||||
|
||||
This function is responsible for creating two new logical volumes within
|
||||
a given LVM volume group.
|
||||
@@ -1388,7 +1388,7 @@ sub createLVMBits
|
||||
|
||||
|
||||
|
||||
=head2 createFilesystem
|
||||
=begin doc
|
||||
|
||||
Format the given image in the users choice of filesystem.
|
||||
|
||||
@@ -1438,7 +1438,7 @@ sub createFilesystem
|
||||
|
||||
|
||||
|
||||
=head2 createSwap
|
||||
=begin doc
|
||||
|
||||
Create the swap filesystem on the given device.
|
||||
|
||||
@@ -1452,7 +1452,7 @@ sub createSwap
|
||||
}
|
||||
|
||||
|
||||
=head2 mountImage
|
||||
=begin doc
|
||||
|
||||
Mount the loopback disk image into a temporary directory.
|
||||
|
||||
@@ -1512,7 +1512,7 @@ sub mountImage
|
||||
|
||||
|
||||
|
||||
=head2 installSystem
|
||||
=begin doc
|
||||
|
||||
Install the system, by invoking the xt-install-system script.
|
||||
|
||||
@@ -1576,7 +1576,7 @@ sub installSystem
|
||||
|
||||
|
||||
|
||||
=head2 runCustomisationHooks
|
||||
=begin doc
|
||||
|
||||
Run the xt-customise-system script to customize our fresh installation.
|
||||
|
||||
@@ -1650,7 +1650,7 @@ sub runCustomisationHooks
|
||||
|
||||
|
||||
|
||||
=head2 runRoleScript
|
||||
=begin doc
|
||||
|
||||
If the user specified a role for the new instance then execute it.
|
||||
|
||||
@@ -1693,7 +1693,7 @@ sub runRoleScript
|
||||
|
||||
|
||||
|
||||
=head2 runXenConfigCreation
|
||||
=begin doc
|
||||
|
||||
Create the Xen configuration file.
|
||||
|
||||
@@ -1714,7 +1714,7 @@ sub runXenConfigCreation
|
||||
|
||||
|
||||
|
||||
=head2 setupRootPassword
|
||||
=begin doc
|
||||
|
||||
chroot() into the new system and setup the password.
|
||||
|
||||
@@ -1736,7 +1736,7 @@ sub setupRootPassword
|
||||
|
||||
|
||||
|
||||
=head2 runCommand
|
||||
=begin doc
|
||||
|
||||
A utility method to run a system command. We will capture the return
|
||||
value and exit if the command files.
|
||||
@@ -1798,7 +1798,7 @@ sub runCommand
|
||||
|
||||
|
||||
|
||||
=head2 END
|
||||
=begin doc
|
||||
|
||||
If we still have the temporary image mounted then make sure
|
||||
it is unmounted before we terminate.
|
||||
|
||||
@@ -99,7 +99,7 @@ Specify the LVM volume group where images were previously saved.
|
||||
--
|
||||
http://www.steve.org.uk/
|
||||
|
||||
$Id: xen-delete-image,v 1.11 2006-07-21 20:17:41 steve Exp $
|
||||
$Id: xen-delete-image,v 1.12 2006-08-14 20:55:29 steve Exp $
|
||||
|
||||
=cut
|
||||
|
||||
@@ -196,7 +196,7 @@ exit;
|
||||
|
||||
|
||||
|
||||
=head2 readConfigurationFile
|
||||
=begin doc
|
||||
|
||||
Read the configuration file specified.
|
||||
|
||||
@@ -254,7 +254,7 @@ sub readConfigurationFile
|
||||
|
||||
|
||||
|
||||
=head2 parseCommandLineArguments
|
||||
=begin doc
|
||||
|
||||
Parse the arguments specified upon the command line.
|
||||
|
||||
@@ -284,7 +284,7 @@ sub parseCommandLineArguments
|
||||
|
||||
if ( $VERSION )
|
||||
{
|
||||
my $REVISION = '$Revision: 1.11 $';
|
||||
my $REVISION = '$Revision: 1.12 $';
|
||||
|
||||
if ( $REVISION =~ /1.([0-9.]+) / )
|
||||
{
|
||||
@@ -299,7 +299,7 @@ sub parseCommandLineArguments
|
||||
|
||||
|
||||
|
||||
=head2 checkArguments
|
||||
=begin doc
|
||||
|
||||
Check that we received the arguments we expected.
|
||||
|
||||
@@ -338,7 +338,7 @@ sub checkArguments
|
||||
|
||||
|
||||
|
||||
=head2 deleteXenImage
|
||||
=begin doc
|
||||
|
||||
Delete the named image, and the corresponding configuration file
|
||||
from /etc/xen.
|
||||
@@ -433,7 +433,7 @@ sub deleteXenImage
|
||||
|
||||
|
||||
|
||||
=head2 runCommand
|
||||
=begin doc
|
||||
|
||||
A utility method to run a system command. We will capture the return
|
||||
value and exit if the command files.
|
||||
|
||||
@@ -67,7 +67,7 @@ Show the version number and exit.
|
||||
--
|
||||
http://www.steve.org.uk/
|
||||
|
||||
$Id: xen-list-images,v 1.9 2006-07-21 20:17:41 steve Exp $
|
||||
$Id: xen-list-images,v 1.10 2006-08-14 20:55:29 steve Exp $
|
||||
|
||||
=cut
|
||||
|
||||
@@ -152,7 +152,8 @@ foreach my $instance ( @instances )
|
||||
exit;
|
||||
|
||||
|
||||
=head2 readConfigurationFile
|
||||
|
||||
=begin doc
|
||||
|
||||
Read the configuration file specified.
|
||||
|
||||
@@ -210,7 +211,7 @@ sub readConfigurationFile
|
||||
|
||||
|
||||
|
||||
=head2 parseCommandLineArguments
|
||||
=begin doc
|
||||
|
||||
Parse the arguments specified upon the command line.
|
||||
|
||||
@@ -237,7 +238,7 @@ sub parseCommandLineArguments
|
||||
|
||||
if ( $VERSION )
|
||||
{
|
||||
my $REVISION = '$Revision: 1.9 $';
|
||||
my $REVISION = '$Revision: 1.10 $';
|
||||
|
||||
if ( $REVISION =~ /1.([0-9.]+) / )
|
||||
{
|
||||
@@ -252,7 +253,7 @@ sub parseCommandLineArguments
|
||||
|
||||
|
||||
|
||||
=head2 findXenInstances
|
||||
=begin doc
|
||||
|
||||
Return an array containing the names of each xen configuration
|
||||
file we found.
|
||||
@@ -273,7 +274,7 @@ sub findXenInstances
|
||||
|
||||
|
||||
|
||||
=head2 displayInstance
|
||||
=begin doc
|
||||
|
||||
Show details about the the Xen instance contained in the given
|
||||
configuration file.
|
||||
|
||||
@@ -82,7 +82,7 @@ Specify the LVM volume group which contains the image(s).
|
||||
--
|
||||
http://www.steve.org.uk/
|
||||
|
||||
$Id: xen-update-image,v 1.6 2006-07-21 20:17:41 steve Exp $
|
||||
$Id: xen-update-image,v 1.7 2006-08-14 20:55:29 steve Exp $
|
||||
|
||||
=cut
|
||||
|
||||
@@ -176,7 +176,7 @@ exit;
|
||||
|
||||
|
||||
|
||||
=head2 updateXenImage
|
||||
=begin doc
|
||||
|
||||
Mount the primary disk image, so that we're ready to update it.
|
||||
|
||||
@@ -263,7 +263,7 @@ sub updateXenImage
|
||||
}
|
||||
|
||||
|
||||
=head2 readConfigurationFile
|
||||
=begin doc
|
||||
|
||||
Read the configuration file specified.
|
||||
|
||||
@@ -321,7 +321,7 @@ sub readConfigurationFile
|
||||
|
||||
|
||||
|
||||
=head2 parseCommandLineArguments
|
||||
=begin doc
|
||||
|
||||
Parse the arguments specified upon the command line.
|
||||
|
||||
@@ -348,7 +348,7 @@ sub parseCommandLineArguments
|
||||
|
||||
if ( $VERSION )
|
||||
{
|
||||
my $REVISION = '$Revision: 1.6 $';
|
||||
my $REVISION = '$Revision: 1.7 $';
|
||||
|
||||
if ( $REVISION =~ /1.([0-9.]+) / )
|
||||
{
|
||||
@@ -362,7 +362,7 @@ sub parseCommandLineArguments
|
||||
|
||||
|
||||
|
||||
=head2 checkArguments
|
||||
=begin doc
|
||||
|
||||
Test that the options we received from the command line, or our
|
||||
configuration file, make sense.
|
||||
|
||||
@@ -57,7 +57,7 @@ xt-create-config - Create a Xen configuration file for a new domain.
|
||||
--
|
||||
http://www.steve.org.uk/
|
||||
|
||||
$Id: xt-create-xen-config,v 1.12 2006-07-21 20:17:41 steve Exp $
|
||||
$Id: xt-create-xen-config,v 1.13 2006-08-14 20:55:29 steve Exp $
|
||||
|
||||
=cut
|
||||
|
||||
@@ -132,7 +132,7 @@ exit 0;
|
||||
|
||||
|
||||
|
||||
=head2 parseArguments
|
||||
=begin doc
|
||||
|
||||
Parse the command line arguments this script was given.
|
||||
|
||||
@@ -162,7 +162,7 @@ sub parseCommandLineArguments
|
||||
|
||||
if ( $VERSION )
|
||||
{
|
||||
my $REVISION = '$Revision: 1.12 $';
|
||||
my $REVISION = '$Revision: 1.13 $';
|
||||
|
||||
if ( $REVISION =~ /1.([0-9.]+) / )
|
||||
{
|
||||
@@ -177,7 +177,7 @@ sub parseCommandLineArguments
|
||||
|
||||
|
||||
|
||||
=head2 checkArguments
|
||||
=begin doc
|
||||
|
||||
Test that the command line arguments we were given make sense.
|
||||
|
||||
@@ -225,7 +225,7 @@ sub checkArguments
|
||||
|
||||
|
||||
|
||||
=head2 createXenConfig
|
||||
=begin doc
|
||||
|
||||
This function does the real work of creating the Xen configuration
|
||||
file. We modify some of the variables contained in our environment
|
||||
|
||||
@@ -66,7 +66,7 @@ xt-customize-image - Customize a freshly installed copy of GNU/Linux
|
||||
--
|
||||
http://www.steve.org.uk/
|
||||
|
||||
$Id: xt-customize-image,v 1.12 2006-07-21 20:17:41 steve Exp $
|
||||
$Id: xt-customize-image,v 1.13 2006-08-14 20:55:29 steve Exp $
|
||||
|
||||
=cut
|
||||
|
||||
@@ -133,7 +133,7 @@ exit 0;
|
||||
|
||||
|
||||
|
||||
=head2 parseArguments
|
||||
=begin doc
|
||||
|
||||
Parse the command line arguments this script was given.
|
||||
|
||||
@@ -163,7 +163,7 @@ sub parseCommandLineArguments
|
||||
|
||||
if ( $VERSION )
|
||||
{
|
||||
my $REVISION = '$Revision: 1.12 $';
|
||||
my $REVISION = '$Revision: 1.13 $';
|
||||
|
||||
if ( $REVISION =~ /1.([0-9.]+) / )
|
||||
{
|
||||
@@ -178,7 +178,7 @@ sub parseCommandLineArguments
|
||||
|
||||
|
||||
|
||||
=head2 checkArguments
|
||||
=begin doc
|
||||
|
||||
Test that the command line arguments we were given make sense.
|
||||
|
||||
@@ -246,7 +246,7 @@ E_OR
|
||||
|
||||
|
||||
|
||||
=head2 runDistributionHooks
|
||||
=begin doc
|
||||
|
||||
This function does the real work of running each of our hook scripts.
|
||||
|
||||
|
||||
@@ -79,7 +79,7 @@ Install the distribution specified by the B<--dist> argument using the debootstr
|
||||
--
|
||||
http://www.steve.org.uk/
|
||||
|
||||
$Id: xt-install-image,v 1.19 2006-07-21 20:17:41 steve Exp $
|
||||
$Id: xt-install-image,v 1.20 2006-08-14 20:55:29 steve Exp $
|
||||
|
||||
=cut
|
||||
|
||||
@@ -190,7 +190,7 @@ exit 0;
|
||||
|
||||
|
||||
|
||||
=head2 parseArguments
|
||||
=begin doc
|
||||
|
||||
Parse the command line arguments this script was given.
|
||||
|
||||
@@ -233,7 +233,7 @@ sub parseCommandLineArguments
|
||||
|
||||
if ( $VERSION )
|
||||
{
|
||||
my $REVISION = '$Revision: 1.19 $';
|
||||
my $REVISION = '$Revision: 1.20 $';
|
||||
|
||||
if ( $REVISION =~ /1.([0-9.]+) / )
|
||||
{
|
||||
@@ -248,7 +248,7 @@ sub parseCommandLineArguments
|
||||
|
||||
|
||||
|
||||
=head2 checkArguments
|
||||
=begin doc
|
||||
|
||||
Test that the command line arguments we were given make sense.
|
||||
|
||||
@@ -367,7 +367,7 @@ EOF
|
||||
|
||||
|
||||
|
||||
=head2 installDebootstrapImage
|
||||
=begin doc
|
||||
|
||||
Install a new image of Debian using 'debootstrap'.
|
||||
|
||||
@@ -426,7 +426,7 @@ sub installDebootstrapImage
|
||||
|
||||
|
||||
|
||||
=head2 installRPMStrapImage
|
||||
=begin doc
|
||||
|
||||
Install a new distribution of GNU/Linux using the rpmstrap tool.
|
||||
|
||||
@@ -462,7 +462,7 @@ sub installRPMStrapImage
|
||||
|
||||
|
||||
|
||||
=head2 runCommand
|
||||
=begin doc
|
||||
|
||||
A utility method to run a system command. We will capture the return
|
||||
value and exit if the command fails.
|
||||
@@ -544,7 +544,7 @@ sub runCommand
|
||||
|
||||
|
||||
|
||||
=head2 copyDebFiles
|
||||
=begin doc
|
||||
|
||||
This function will copy all the .deb files from one directory
|
||||
to another as a caching operation which will speed up installations via
|
||||
|
||||
Reference in New Issue
Block a user