~ubuntu-branches/ubuntu/quantal/virtinst/quantal-proposed

.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.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\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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-CONVERT 1"
.TH VIRT-CONVERT 1 "2012-07-08" "" "Virtual Machine Install Tools"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
virt\-convert \- convert virtual machines between formats
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBvirt-convert\fR [\s-1OPTION\s0]... \s-1INPUT\s0.VMX|INPUT\-DIR [\s-1OUTPUT\s0.XML|OUTPUT\-DIR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBvirt-convert\fR is a command line tool for converting virtual machines
from one format to another. Pass in either a \s-1VM\s0 definition file (such
as VMWare vmx format) or a directory containing a \s-1VM\s0. By default, a new
\&\s-1VM\s0 definition file, and converted disk images, will be placed in a new
output directory.
.PP
If an output directory is specified, it will be created if necessary,
and the output \s-1VM\s0 definition placed within, along with any disk images
as needed.
.PP
If an output \s-1VM\s0 definition file is specified, it will be created
alongside any disks in the same directory.
.SH "OPTIONS"
.IX Header "OPTIONS"
Any of the options can be omitted, in which case \fBvirt-convert\fR will
use defaults when required. An input \s-1VM\s0 definition or containing directory
must be provided. By default, an output directory is generated based upon
the name of the \s-1VM\s0. The default input format is VMWare vmx, and the
default output format is a libvirt \*(L"image\*(R" \s-1XML\s0 definition
(see \fIvirt\-image\fR\|(5)).
.IP "\-h, \-\-help" 4
.IX Item "-h, --help"
Show the help message and exit
.SS "Conversion Options"
.IX Subsection "Conversion Options"
.IP "\-i format" 2
.IX Item "-i format"
Input format. Currently, \f(CW\*(C`vmx\*(C'\fR, \f(CW\*(C`virt\-image\*(C'\fR, and \f(CW\*(C`ovf\*(C'\fR are supported.
.IP "\-o format" 2
.IX Item "-o format"
Output format. Currently, \f(CW\*(C`vmx\*(C'\fR  and \f(CW\*(C`virt\-image\*(C'\fR are supported.
.IP "\-D format" 2
.IX Item "-D format"
Output disk format, or \f(CW\*(C`none\*(C'\fR if no conversion should be performed. See
\&\fIqemu\-img\fR\|(1).
.SS "Virtualization Type options"
.IX Subsection "Virtualization Type options"
Options to override the default virtualization type choices.
.IP "\-v, \-\-hvm      Create  a fully virtualized guest image" 2
.IX Item "-v, --hvm      Create  a fully virtualized guest image"
Convert machine to a hvm/qemu based image (this is the default if paravirt
is not specified)
.IP "\-p, \-\-paravirt      Create  a paravirtualized guest image" 2
.IX Item "-p, --paravirt      Create  a paravirtualized guest image"
Convert machine to a paravirt xen based image
.SS "General Options"
.IX Subsection "General Options"
General configuration parameters that apply to all types of guest installs.
.IP "\-a \s-1ARCH\s0, \-\-arch=ARCH" 2
.IX Item "-a ARCH, --arch=ARCH"
Architecture of the virtual machine (i686, x86_64, ppc). Defaults to
that of the host machine.
.IP "\-\-os\-type=OS_TYPE" 2
.IX Item "--os-type=OS_TYPE"
Optimize the guest configuration for a type of operating system (ex. 'linux',
\&'windows'). This will attempt to pick the most suitable \s-1ACPI\s0 & \s-1APIC\s0 settings,
optimally supported mouse drivers, virtio, and generally accommodate other
operating system quirks.  See \fIvirt\-install\fR\|(1) for valid values.
.IP "\-\-os\-variant=OS_VARIANT" 2
.IX Item "--os-variant=OS_VARIANT"
Further optimize the guest configuration for a specific operating system
variant (ex. 'fedora8', 'winxp'). This parameter is optional, and does not
require an \f(CW\*(C`\-\-os\-type\*(C'\fR to be specified. See \fIvirt\-install\fR\|(1) for valid
values.
.IP "\-\-noapic" 2
.IX Item "--noapic"
Override the \s-1OS\s0 type / variant to disables the \s-1APIC\s0 setting for fully
virtualized guest.
.IP "\-\-noacpi" 2
.IX Item "--noacpi"
Override the \s-1OS\s0 type / variant to disables the \s-1ACPI\s0 setting for fully
virtualized guest.
.SS "Miscellaneous Options"
.IX Subsection "Miscellaneous Options"
.IP "\-q, \-\-quiet" 2
.IX Item "-q, --quiet"
Avoid verbose output.
.IP "\-d, \-\-debug" 2
.IX Item "-d, --debug"
Print debugging information
.IP "\-\-dry\-run" 2
.IX Item "--dry-run"
Proceed through the conversion process, but don't convert disks or actually
write any converted files.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Convert a paravirt guest from \f(CW\*(C`image.vmx\*(C'\fR:
.PP
.Vb 1
\&  # virt\-convert \-\-arch=i686 \-\-paravirt image.vmx
.Ve
.PP
Convert a 64\-bit hvm guest:
.PP
.Vb 1
\&  # virt\-convert \-\-arch=x86_64 vmx\-appliance/ hvm\-appliance/
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Written by Joey Boggs, John Levon, and Cole Robinson
.PP
See the \s-1AUTHORS\s0 file in the source distribution for the complete list
of credits.
.SH "BUGS"
.IX Header "BUGS"
Please see http://virt\-manager.org/page/BugReporting
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2006\-2012 Red Hat, Inc, 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"
\&\fIvirt\-image\fR\|(5), the project website \f(CW\*(C`http://virt\-manager.org\*(C'\fR