Attachment 264881 Details for Bug 392141 – Replaces the man page with a working one.

[patch] Replaces the man page with a working one.

virt-clone.1.diff (text/plain), 14.57 KB, created by Soren Hansen on 2007-11-20 12:53:29 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Soren Hansen

Created: 2007-11-20 12:53:29 UTC

Size: 14.57 KB

patch

obsolete

>--- man/en/virt-clone.1~	2007-11-20 13:48:12.327607386 +0100
>+++ man/en/virt-clone.1	2007-11-20 13:48:23.807750713 +0100
>@@ -1,129 +1,263 @@
>-NAME
>-    virt-clone - clone existing virtual machine images
>-
>-SYNOPSIS
>-    virt-clone [OPTION]...
>-
>-DESCRIPTION
>-    virt-clone is a command line tool for cloning existing virtual machine
>-    images using the "libvirt" hypervisor management library. It will copy
>+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
>+.\"
>+.\" Standard preamble:
>+.\" ========================================================================
>+.de Sh \" Subsection heading
>+.br
>+.if t .Sp
>+.ne 5
>+.PP
>+\fB\\$1\fR
>+.PP
>+..
>+.de Sp \" Vertical space (when we can't use .PP)
>+.if t .sp .5v
>+.if n .sp
>+..
>+.de Vb \" Begin verbatim text
>+.ft CW
>+.nf
>+.ne \\$1
>+..
>+.de Ve \" End verbatim text
>+.ft R
>+.fi
>+..
>+.\" Set up some character translations and predefined strings.  \*(-- will
>+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
>+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
>+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
>+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
>+.\" nothing in troff, for use with C<>.
>+.tr \(*W-
>+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
>+.ie n \{\
>+.    ds -- \(*W-
>+.    ds PI pi
>+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
>+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
>+.    ds L" ""
>+.    ds R" ""
>+.    ds C` ""
>+.    ds C' ""
>+'br\}
>+.el\{\
>+.    ds -- \|\(em\|
>+.    ds PI \(*p
>+.    ds L" ``
>+.    ds R" ''
>+'br\}
>+.\"
>+.\" If the F register is turned on, we'll generate index entries on stderr for
>+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
>+.\" entries marked with X<> in POD.  Of course, you'll have to process the
>+.\" output yourself in some meaningful fashion.
>+.if \nF \{\
>+.    de IX
>+.    tm Index:\\$1\t\\n%\t"\\$2"
>+..
>+.    nr % 0
>+.    rr F
>+.\}
>+.\"
>+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
>+.\" way too many mistakes in technical documents.
>+.hy 0
>+.if n .na
>+.\"
>+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
>+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
>+.    \" fudge factors for nroff and troff
>+.if n \{\
>+.    ds #H 0
>+.    ds #V .8m
>+.    ds #F .3m
>+.    ds #[ \f1
>+.    ds #] \fP
>+.\}
>+.if t \{\
>+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
>+.    ds #V .6m
>+.    ds #F 0
>+.    ds #[ \&
>+.    ds #] \&
>+.\}
>+.    \" simple accents for nroff and troff
>+.if n \{\
>+.    ds ' \&
>+.    ds ` \&
>+.    ds ^ \&
>+.    ds , \&
>+.    ds ~ ~
>+.    ds /
>+.\}
>+.if t \{\
>+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
>+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
>+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
>+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
>+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
>+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
>+.\}
>+.    \" troff and (daisy-wheel) nroff accents
>+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
>+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
>+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
>+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
>+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
>+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
>+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
>+.ds ae a\h'-(\w'a'u*4/10)'e
>+.ds Ae A\h'-(\w'A'u*4/10)'E
>+.    \" corrections for vroff
>+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
>+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
>+.    \" for low resolution devices (crt and lpr)
>+.if \n(.H>23 .if \n(.V>19 \
>+\{\
>+.    ds : e
>+.    ds 8 ss
>+.    ds o a
>+.    ds d- d\h'-1'\(ga
>+.    ds D- D\h'-1'\(hy
>+.    ds th \o'bp'
>+.    ds Th \o'LP'
>+.    ds ae ae
>+.    ds Ae AE
>+.\}
>+.rm #[ #] #H #V #F C
>+.\" ========================================================================
>+.\"
>+.IX Title "VIRT-CLONE 1"
>+.TH VIRT-CLONE 1 "2007-11-20" "perl v5.8.8" "User Contributed Perl Documentation"
>+.SH "NAME"
>+virt\-clone \- clone existing virtual machine images
>+.SH "SYNOPSIS"
>+.IX Header "SYNOPSIS"
>+\&\fBvirt-clone\fR [\s-1OPTION\s0]...
>+.SH "DESCRIPTION"
>+.IX Header "DESCRIPTION"
>+\&\fBvirt-clone\fR is a command line tool for cloning existing virtual machine
>+images using the \f(CW\*(C`libvirt\*(C'\fR hypervisor management library. It will copy
>     the disk images of any existing virtual machine, and define a new guest
>     with an identical virtual hardware configuration. Elements which require
>     uniqueness will be updated to avoid a clash between old and new guests.
>-
>-    Given suitable command line arguments, "virt-clone" is capable of
>-    running completely unattended, with the guest 'kickstarting' itself too.
>-    This allows for easy automation of guest installs. A companion tool
>-    "virt-clone(1)" is provided for cloning pre-existing guests if their
>-    installation cannot be easily automated from pristine media.
>-
>-OPTIONS
>-    Any of the options can be omitted, in which case "virt-clone" will run
>+.PP
>+Given suitable command line arguments, \f(CW\*(C`virt\-clone\*(C'\fR is capable of running
>+completely unattended, with the guest 'kickstarting' itself too. This allows
>+for easy automation of guest installs. A companion tool \f(CW\*(C`virt\-clone(1)\*(C'\fR is
>+provided for cloning pre-existing guests if their installation cannot be easily
>+automated from pristine media.
>+.SH "OPTIONS"
>+.IX Header "OPTIONS"
>+Any of the options can be omitted, in which case \f(CW\*(C`virt\-clone\*(C'\fR will run
>     interactively prompting for input as required.
>-
>-    -h, --help
>+.IP "\-h, \-\-help" 4
>+.IX Item "-h, --help"
>         Show the help message and exit
>-
>-    -o ORIGINAL_GUEST, --original=ORIGINAL_GUEST
>-        Name or uuid for the original guest to be cloned. This guest must be
>-        shut off since it is not possible to safely clone active guests at
>-        this time.
>-
>-    -n NAME, --name=NAME
>-        Name of the new guest virtual machine instance. This must be unique
>-        amongst all guests known to the hypervisor on this machine,
>-        including those not currently active. To re-define an existing
>-        guest, use the virsh(1) tool to shut it down & delete it prior to
>-        running "virt-clone". This parameter will be prompted for if omitted
>-        on the command line.
>-
>-    -u UUID, --uuid=UUID
>-        UUID for the guest; if none is given a random UUID will be
>-        generated. If you specify UUID, you should use a 32-digit
>-        hexadecimal number. UUID are intended to be unique across the entire
>-        data center, and indeed world. Bear this in mind if manually
>-        specifying a UUID
>-
>-    -f DISKFILE, --file=DISKFILE
>-        Path to the file, disk partition, or logical volume to use as the
>-        backing store for the guest's virtual disk. If the original guest
>-        has multiple disks, this parameter must be repeated multiple times,
>-        once per disk in the original virtual machine.
>-
>-    -m MAC, --mac=MAC
>-        Fixed MAC address for the guest; If this parameter is omitted, or
>-        the value "RANDOM" is specified a suitable address will be randomly
>-        generated. For Xen virtual machines it is required that the first 3
>-        pairs in the MAC address be the sequence '00:16:3e', while for QEMU
>-        or KVM virtual machines it must be '54:52:00'.
>-
>-    --connect=CONNECT Connect to hypervisor with URI
>-        Connect to a non-default hypervisor. The default connection is
>-        chosen based on the following rules:
>-
>-        xen If running on a host with the Xen kernel (checks against
>-            /proc/xen)
>-
>-        qemu:///system
>+.IP "\-o \s-1ORIGINAL_GUEST\s0, \-\-original=ORIGINAL_GUEST" 4
>+.IX Item "-o ORIGINAL_GUEST, --original=ORIGINAL_GUEST"
>+Name or uuid for the original guest to be cloned. This guest must be shut
>+off since it is not possible to safely clone active guests at this time.
>+.IP "\-n \s-1NAME\s0, \-\-name=NAME" 4
>+.IX Item "-n NAME, --name=NAME"
>+Name of the new guest virtual machine instance. This must be unique amongst
>+all guests known to the hypervisor on this machine, including those not
>+currently active. To re-define an existing guest, use the \f(CWvirsh(1)\fR tool
>+to shut it down & delete it prior to running \f(CW\*(C`virt\-clone\*(C'\fR. This parameter
>+will be prompted for if omitted on the command line.
>+.IP "\-u \s-1UUID\s0, \-\-uuid=UUID" 4
>+.IX Item "-u UUID, --uuid=UUID"
>+\&\s-1UUID\s0 for the guest; if none is given a random \s-1UUID\s0 will be generated. If you 
>+specify \s-1UUID\s0, you should use a 32\-digit hexadecimal number. \s-1UUID\s0 are intended
>+to be unique across the entire data center, and indeed world. Bear this in
>+mind if manually specifying a \s-1UUID\s0
>+.IP "\-f \s-1DISKFILE\s0, \-\-file=DISKFILE" 4
>+.IX Item "-f DISKFILE, --file=DISKFILE"
>+Path to the file, disk partition, or logical volume to use as the backing store
>+for the guest's virtual disk. If the original guest has multiple disks, this 
>+parameter must be repeated multiple times, once per disk in the original virtual 
>+machine.
>+.IP "\-m \s-1MAC\s0, \-\-mac=MAC" 4
>+.IX Item "-m MAC, --mac=MAC"
>+Fixed \s-1MAC\s0 address for the guest; If this parameter is omitted, or the value
>+\&\f(CW\*(C`RANDOM\*(C'\fR is specified a suitable address will be randomly generated. For
>+Xen virtual machines it is required that the first 3 pairs in the \s-1MAC\s0 address
>+be the sequence '00:16:3e', while for \s-1QEMU\s0 or \s-1KVM\s0 virtual machines it must
>+be '54:52:00'.
>+.IP "\-\-connect=CONNECT     Connect to hypervisor with \s-1URI\s0" 4
>+.IX Item "--connect=CONNECT     Connect to hypervisor with URI"
>+Connect to a non-default hypervisor. The default connection is chosen based
>+on the following rules:
>+.RS 4
>+.IP "xen" 4
>+.IX Item "xen"
>+If running on a host with the Xen kernel (checks against /proc/xen)
>+.IP "qemu:///system" 4
>+.IX Item "qemu:///system"
>             If running on a bare metal kernel as root
>-
>-        qemu:///session
>+.IP "qemu:///session" 4
>+.IX Item "qemu:///session"
>             If running on a bare metal kernel as non-root
>-
>-        It is only necessary to provide the "--connect" argument if this
>-        default prioritization is incorrect, eg if wanting to use QEMU while
>-        on a Xen kernel.
>-
>-    -d, --debug
>-        Print debugging information to the terminal when running the install
>-        process. The debugging information is also stored in
>-        "$HOME/.virtinst/virt-clone.log" even if this parameter is omitted.
>-
>-EXAMPLES
>-    Clone the guest called "demo" which has a single disk to copy
>-
>-      # virt-clone \
>-           --original demo \
>-           --name newdemo \
>-           --file /var/lib/xen/images/newdemo.img
>-
>-    Clone a QEMU guest with multiple disks
>-
>-      # virt-clone \
>-           --connect qemu:///system \
>-           --original demo \
>-           --name newdemo \
>-           --file /var/lib/xen/images/newdemo.img \
>-           --file /var/lib/xen/images/newdata.img
>-
>+.RE
>+.RS 4
>+.Sp
>+It is only necessary to provide the \f(CW\*(C`\-\-connect\*(C'\fR argument if this default
>+prioritization is incorrect, eg if wanting to use \s-1QEMU\s0 while on a Xen kernel.
>+.RE
>+.IP "\-d, \-\-debug" 4
>+.IX Item "-d, --debug"
>+Print debugging information to the terminal when running the install process.
>+The debugging information is also stored in \f(CW\*(C`$HOME/.virtinst/virt\-clone.log\*(C'\fR
>+even if this parameter is omitted.
>+.SH "EXAMPLES"
>+.IX Header "EXAMPLES"
>+Clone the guest called \f(CW\*(C`demo\*(C'\fR which has a single disk to copy
>+.PP
>+.Vb 4
>+\&  # virt\-clone \e
>+\&       \-\-original demo \e
>+\&       \-\-name newdemo \e
>+\&       \-\-file /var/lib/xen/images/newdemo.img
>+.Ve
>+.PP
>+Clone a \s-1QEMU\s0 guest with multiple disks
>+.PP
>+.Vb 6
>+\&  # virt\-clone \e
>+\&       \-\-connect qemu:///system \e
>+\&       \-\-original demo \e
>+\&       \-\-name newdemo \e
>+\&       \-\-file /var/lib/xen/images/newdemo.img \e
>+\&       \-\-file /var/lib/xen/images/newdata.img
>+.Ve
>+.PP
>     Clone a guest to a physical device which is at least as big as the
>-    original guests disks. If the destination device is bigger, the new
>-    guest can do a filesystem resize when it boots.
>-
>-      # virt-clone \
>-           --connect qemu:///system \
>-           --name demo \
>-           --file /dev/HostVG/DemoVM \
>-           --mac 54:52:00:34:11:54
>-
>-AUTHOR
>-    Written by Kazuki Mizushima, and a team of many other contributors. See
>-    the AUTHORS file in the source distribution for the complete list of
>-    credits.
>-
>-BUGS
>-    Report bugs to the mailing list
>-    "http://www.redhat.com/mailman/listinfo/et-mgmt-tools" or directly to
>-    BugZilla "http://bugzilla.redhat.com/bugzilla/" against the "Fedora"
>-    product, and the "python-virtinst" component.
>-
>-COPYRIGHT
>-    Copyright (C) Fujitsu Limited 2007, and various contributors. This is
>-    free software. You may redistribute copies of it under the terms of the
>-    GNU General Public License "http://www.gnu.org/licenses/gpl.html". There
>-    is NO WARRANTY, to the extent permitted by law.
>-
>-SEE ALSO
>-    virsh(1), "virt-install(1)", "virt-manager(1)", the project website
>-    "http://virt-manager.org"
>-
>+original guests disks. If the destination device is bigger, the
>+new guest can do a filesystem resize when it boots.
>+.PP
>+.Vb 5
>+\&  # virt\-clone \e
>+\&       \-\-connect qemu:///system \e
>+\&       \-\-name demo \e
>+\&       \-\-file /dev/HostVG/DemoVM \e
>+\&       \-\-mac 54:52:00:34:11:54
>+.Ve
>+.SH "AUTHOR"
>+.IX Header "AUTHOR"
>+Written by Kazuki Mizushima, and a team of many other contributors. See the \s-1AUTHORS\s0 
>+file in the source distribution for the complete list of credits.
>+.SH "BUGS"
>+.IX Header "BUGS"
>+Report bugs to the mailing list \f(CW\*(C`http://www.redhat.com/mailman/listinfo/et\-mgmt\-tools\*(C'\fR
>+or directly to BugZilla \f(CW\*(C`http://bugzilla.redhat.com/bugzilla/\*(C'\fR against the
>+\&\f(CW\*(C`Fedora\*(C'\fR product, and the \f(CW\*(C`python\-virtinst\*(C'\fR component.
>+.SH "COPYRIGHT"
>+.IX Header "COPYRIGHT"
>+Copyright (C) Fujitsu Limited 2007, and various contributors. 
>+This is free software. You may redistribute copies of it under the terms of the \s-1GNU\s0 General 
>+Public License \f(CW\*(C`http://www.gnu.org/licenses/gpl.html\*(C'\fR. There is \s-1NO\s0 \s-1WARRANTY\s0, to the extent 
>+permitted by law.
>+.SH "SEE ALSO"
>+.IX Header "SEE ALSO"
>+\&\f(CWvirsh(1)\fR, \f(CW\*(C`virt\-install(1)\*(C'\fR, \f(CW\*(C`virt\-manager(1)\*(C'\fR, the project website \f(CW\*(C`http://virt\-manager.org\*(C'\fR

Actions: View | Diff

Attachments on bug 392141: 264881