github.com/xen-tools.xen-tools
1
0
Fork 0
mirror of synced 2026-01-13 15:17:30 +00:00
Code Releases Activity

Remove all redundant pod-inline occurrences of "=cut"

Browse Source 
Also care that there are always two blank lines before each "=head1"
(except behind "=head1 NAME").
This commit is contained in:
Axel Beckert 2013-04-18 20:41:51 +02:00
parent dcb9284636
commit 5ac0f15c32
11 changed files with 4 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
bin/xen-create-image
View File

@ -4,12 +4,11 @@
xen-create-image - Easily create new Xen instances with networking and OpenSSH.
=cut
=head1 SYNOPSIS
xen-create-image --hostname=<hostname> <further options>
=head1 EXAMPLES
xen-create-image --hostname=some-domu --dist=wheezy --lvm=vg0
@ -19,6 +18,7 @@ xen-create-image --hostname=some-domu --dist=precise --dir=/srv/xen
See below for more specific examples: LOOPBACK EXAMPLES, LVM EXAMPLE
and EVMS EXAMPLE.
=head1 OPTIONS
Help Options:
@ -326,8 +326,6 @@ and EVMS EXAMPLE.
If you do not wish to use LVM specify --dir or --evms.
(These three options are mutually exclusive.)
=cut
=head1 NOTES
@ -350,8 +348,6 @@ Create a Xen configuration file in so that xm/xl can start the new domain.
The result of invoking these three scripts, and some minor glue between
them, is a simple means of creating new Xen guest domains.
=cut
=head1 DESCRIPTION
@ -374,7 +370,6 @@ Create a Xen configuration file in so that xm/xl can start the new domain.
If you wish to install additional packages or do any additional
configuration of your new guests, please read the section on "ROLES".
=cut
=head1 CONFIGURATION
@ -454,9 +449,6 @@ Create a Xen configuration file in so that xm/xl can start the new domain.
This makes use of loopback images stored beneath /home/xen and
will be installed via the debootstrap command.
=cut
=head1 NETWORKING AUTO-SETUP
@ -492,8 +484,6 @@ Create a Xen configuration file in so that xm/xl can start the new domain.
and would no longer be available. If all the IP addresses are taken
then the system will fail.
=cut
=head1 PARTITIONING
@ -508,8 +498,6 @@ Create a Xen configuration file in so that xm/xl can start the new domain.
Now when you create a new image specify the name of this file with as
an argument to the --partition option.
=cut
=head1 XEN CONFIGURATION FILE
@ -527,8 +515,6 @@ Create a Xen configuration file in so that xm/xl can start the new domain.
Alternatively you can create multiple configuration files and
specify the one to use with the --template option.
=cut
=head1 LOOPBACK EXAMPLES
@ -564,8 +550,6 @@ Create a Xen configuration file in so that xm/xl can start the new domain.
The '/domains/' subdirectory will be created if necessary.
=cut
=head1 LVM EXAMPLE
@ -587,7 +571,6 @@ Create a Xen configuration file in so that xm/xl can start the new domain.
mkdir -p /mnt/foo
mount /dev/myvolumegroup/vm01.my.flat-disk /mnt/foo
=cut
=head1 EVMS EXAMPLE
@ -609,8 +592,6 @@ Create a Xen configuration file in so that xm/xl can start the new domain.
mkdir -p /mnt/foo
mount /dev/evms/vm01.my.flat-disk /mnt/foo
=cut
=head1 INSTALLATION METHODS
@ -626,7 +607,6 @@ Create a Xen configuration file in so that xm/xl can start the new domain.
arguments, or settings in the configuration file. Only one installation
method may be specified at a time; they are mutually-exclusive.
=cut
=head1 INSTALLATION SPEEDUPS
@ -656,8 +636,6 @@ Create a Xen configuration file in so that xm/xl can start the new domain.
--lvm=myvolumegroup --hostname=vm01.my.flat \
--install-method=copy --install-source=/path/to/copy/from
=cut
=head1 DEBOOTSTRAP CACHING
@ -685,8 +663,6 @@ Create a Xen configuration file in so that xm/xl can start the new domain.
If you set your cache directory to anything else, simply rm the
contents of the directory.
=cut
=head1 ROLES
@ -763,9 +739,6 @@ Install an X11 server, using VNC and XDM
NOTE: Multiple role scripts may be invoked if you separate their
names with commas.
=cut
=head1 THE SKELETON DIRECTORY
@ -793,7 +766,6 @@ Install an X11 server, using VNC and XDM
Dmitry Nedospasov, http://nedos.net/
Stéphane Jourdois
=cut
=head1 LICENSE

12
bin/xen-create-nfs
View File

@ -36,8 +36,6 @@ xen-create-nfs - Create a Xen configuration file for an NFS-root guest.
--nfs_server Specify the NFS server to mount the root partition from.
--nfs_root Specify the path, upon the NFS server, to mount.
=cut
=head1 OPTIONS
@ -55,11 +53,8 @@ Read the manual for this script.
=item B<--version>
Show the version number and exit.
=back
=cut
=head1 DESCRIPTION
@ -71,8 +66,6 @@ Show the version number and exit.
support more than the minimal number of options to completement the
existing xen-create-image script, however it is hopefully useful.
=cut
=head1 REFERENCE
@ -81,16 +74,12 @@ Show the version number and exit.
http://www.debian-administration.org/articles/505
=cut
=head1 AUTHORS
Steve Kemp, http://www.steve.org.uk/
Stéphane Jourdois
=cut
=head1 LICENSE
@ -102,7 +91,6 @@ you can redistribute it and/or modify it under
the same terms as Perl itself.
The LICENSE file contains the full text of the license.
=cut

16
bin/xen-delete-image
View File

@ -30,8 +30,6 @@ xen-delete-image - Delete previously created Xen instances.
--test Don't complain if we're not invoked by root.
--no-xen-ok Don't complain if xen seems not installed or xend is not running
=cut
=head1 OPTIONS
@ -61,11 +59,8 @@ Do not complain, or exit, if the script is not executed by the root user.
=item B<--version>
Show the version number and exit.
=back
=cut
=head1 DESCRIPTION
@ -79,8 +74,6 @@ Show the version number and exit.
but will fail to remove anything which the user does not have permission
to delete.)
=cut
=head1 LOOPBACK EXAMPLE
@ -96,8 +89,6 @@ Show the version number and exit.
(The matching Xen configuration files beneath /etc/xen will also be
removed.)
=cut
=head1 LVM EXAMPLE
@ -114,8 +105,6 @@ Show the version number and exit.
The Xen configuration files will also be removed from beneath /etc/xen.
=cut
=head1 EVMS EXAMPLE
@ -132,8 +121,6 @@ Show the version number and exit.
The Xen configuration files will also be removed.
=cut
=head1 AUTHORS
@ -141,8 +128,6 @@ Show the version number and exit.
Axel Beckert, http://noone.org/abe/
Stéphane Jourdois
=cut
=head1 LICENSE
@ -154,7 +139,6 @@ you can redistribute it and/or modify it under
the same terms as Perl itself.
The LICENSE file contains the full text of the license.
=cut

5
bin/xen-list-images
View File

@ -20,6 +20,7 @@ xen-list-images - List all the created and configured Xen images.
Testing options:
--test Specify an alternate Xen configuration directory.
=head1 OPTIONS
=over 8
@ -52,22 +53,18 @@ Show the version number and exit.
and then either the IP address configured, or "DHCP" to denote
a dynamic host.
=cut
=head1 TODO
It should be possible to determine the disk(s) used by the images,
and then display their sizes.
=cut
=head1 AUTHORS
Steve Kemp, http://www.steve.org.uk/
Stéphane Jourdois
=cut
=head1 LICENSE

8
bin/xen-resize-guest
View File

@ -20,8 +20,6 @@ xen-resize-guest - Resize a loopback or LVM based xen guest.
--force Force the resize to happen without a last-chance delay.
--hostname Specify the hostname of the guest to resize.
=cut
=head1 OPTIONS
@ -53,8 +51,6 @@ Show the version number and exit.
=back
=cut
=head1 DESCRIPTION
@ -74,15 +70,12 @@ Show the version number and exit.
More than once I've heard of users making mistakes and breaking their
filesystems; hence this tool.
=cut
=head1 AUTHORS
Steve Kemp, http://www.steve.org.uk/
Axel Beckert, http://noone.org/abe/
=cut
=head1 LICENSE
@ -94,7 +87,6 @@ you can redistribute it and/or modify it under
the same terms as Perl itself.
The LICENSE file contains the full text of the license.
=cut

10
bin/xen-update-image
View File

@ -18,9 +18,6 @@ xen-update-image - Update the software installed upon offline Xen images.
--lvm Specify the LVM volume group which contains the image(s).
--evms Specify the EVMS container which contains the image(s).
=cut
=head1 OPTIONS
@ -46,8 +43,6 @@ Show the version number and exit.
=back
=cut
=head1 DESCRIPTION
@ -65,8 +60,6 @@ Show the version number and exit.
corruption otherwise it will allow you to update your image without
booting it.
=cut
=head1 EXAMPLES
@ -77,8 +70,6 @@ Show the version number and exit.
xen-update-images --dir=/home/xen test.my.flat x11.my.flat
=cut
=head1 AUTHORS
@ -86,7 +77,6 @@ Show the version number and exit.
Axel Beckert, http://noone.org/abe/
Stéphane Jourdois
=cut
=head1 LICENSE

10
bin/xt-create-xen-config
View File

@ -4,8 +4,6 @@
xt-create-config - Create a Xen configuration file for a new guest
=cut
=head1 SYNOPSIS
xt-create-config [options]
@ -39,7 +37,6 @@ xt-create-config - Create a Xen configuration file for a new guest
All other options from xen-create-image, such as the new IP address(es)
to give to the new instance, will be passed as environmental variables.
=cut
=head1 ABOUT
@ -53,8 +50,6 @@ xt-create-config - Create a Xen configuration file for a new guest
By default the script will use /etc/xen-tools/xm.tmpl as its input.
=cut
=head1 INVOCATION
@ -75,9 +70,6 @@ xt-create-config - Create a Xen configuration file for a new guest
=for example end
=cut
=head1 ARGUMENT PASSING
This script will be invoked with a full copy of the arguments from
@ -102,7 +94,6 @@ xt-create-config - Create a Xen configuration file for a new guest
for the "Text::Template" perl module. (If you have the perldoc
package installed you can read this with "perldoc Text::Template".)
=cut
=head1 AUTHORS
@ -110,7 +101,6 @@ xt-create-config - Create a Xen configuration file for a new guest
Axel Beckert, http://noone.org/abe/
Stéphane Jourdois
=cut
=head1 LICENSE

9
bin/xt-customize-image
View File

@ -4,8 +4,6 @@
xt-customize-image - Customize a freshly installed copy of GNU/Linux
=cut
=head1 SYNOPSIS
xt-customize-image [options]
@ -25,7 +23,6 @@ xt-customize-image - Customize a freshly installed copy of GNU/Linux
All other options from xen-create-image, such as the new IP address(es)
to give to the new instance, will be passed as environmental variables.
=cut
=head1 NOTES
@ -41,8 +38,6 @@ xt-customize-image - Customize a freshly installed copy of GNU/Linux
--location - The temporary installation root of the new install
--dist - The distribution which has been installed.
=cut
=head1 HOOK SCRIPTS
@ -57,8 +52,6 @@ xt-customize-image - Customize a freshly installed copy of GNU/Linux
executed from '/usr/share/xen-tools/foo.d'. Each executable will
be loaded and executed in sorted order.
=cut
=head1 AUTHORS
@ -66,8 +59,6 @@ xt-customize-image - Customize a freshly installed copy of GNU/Linux
Axel Beckert, http://noone.org/abe/
Stéphane Jourdois
=cut
=head1 LICENSE

5
bin/xt-guess-suite-and-mirror
View File

@ -5,8 +5,6 @@
xt-guess-suite-and-mirror - Tries to guess the most suitable suite and
mirror for DomUs on Debian and Ubuntu Dom0s.
=cut
=head1 SYNOPSIS
--suite Show suite
@ -20,7 +18,6 @@ mirror for DomUs on Debian and Ubuntu Dom0s.
--manual Show the manual for this script.
--version Show the version number and exit.
=cut
=head1 DESCRIPTION
@ -28,14 +25,12 @@ xt-guess-suite-and-mirror tries to find the mirror and suite the Xen
Dom0 is currently using and returns them in a way suitable for
xen-create-image(1) or the backticks feature in xen-tools.conf.
=cut
=head1 AUTHORS
Axel Beckert, http://noone.org/abe/
Stéphane Jourdois
=cut
=head1 LICENSE

9
bin/xt-install-image
View File

@ -4,8 +4,6 @@
xt-install-image - Install a fresh copy of GNU/Linux into a directory
=cut
=head1 SYNOPSIS
xt-install-image [options]
@ -39,8 +37,6 @@ xt-install-image - Install a fresh copy of GNU/Linux into a directory
All other options from xen-create-image will be passed as environmental
variables.
=cut
=head1 NOTES
@ -50,8 +46,6 @@ xt-install-image - Install a fresh copy of GNU/Linux into a directory
configuration, etc.
=cut
=head1 INSTALLATION METHODS
There are several available methods of installation, depending upon the
@ -78,8 +72,6 @@ Untar a .tar file into the new installation location. This tarfile is assumed t
=back
=cut
=head1 AUTHORS
@ -88,7 +80,6 @@ Untar a .tar file into the new installation location. This tarfile is assumed t
Dmitry Nedospasov, http://nedos.net/
Stéphane Jourdois
=cut
=head1 LICENSE

1
lib/Xen/Tools/Common.pm
View File

@ -6,6 +6,7 @@ package Xen::Tools::Common;
Xen::Tools::Common - Common funtions used in xen-tools' Perl scripts
=head1 SYNOPSIS
use Xen::Tools::Common;