Initial commit.
[virt-resize-ui.git] / virt-resize-ui.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 virt-resize-ui - Graphical interface for virt-resize
6
7 =head1 SYNOPSIS
8
9  virt-resize-ui [--options]
10
11 =head1 DESCRIPTION
12
13 C<virt-resize-ui> is a graphical interface for the command line
14 L<virt-resize(1)> program.  It enables many of the features of
15 C<virt-resize> through a guided, interactive interface.
16
17 In most cases you can just run C<virt-resize-ui> and follow the
18 questions.
19
20 C<virt-resize-ui> does not I<need> to run as root, but it may have to
21 access disk images that can only be read or created as root (for
22 example to read virtual machines or do C<lvcreate>).  If you only want
23 to resize disk images stored as files in your home directory then root
24 is not needed.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item B<-a>
31
32 =item B<--add>
33
34 Add I<file> which should be a disk image.  You can supply multiple
35 disk images by repeating this option.
36
37 The format of the disk image is auto-detected.  To override this and
38 force a particular format use the I<--format=..> option.
39
40 =item B<-c> URI
41
42 =item B<--connect> URI
43
44 If using libvirt, connect to the given I<URI>.  If omitted, then we
45 connect to the default libvirt hypervisor.
46
47 If you specify guest block devices directly (I<-a>), then libvirt is
48 not used at all.
49
50 =item B<-d> guest
51
52 =item B<--domain> guest
53
54 Add all the disks from the named libvirt guest.
55
56 =item B<--format raw>
57
58 =item B<--format qcow2>
59
60 =item B<--format "">
61
62 The default for the I<-a> option is to auto-detect the format of the
63 disk image.  Using this forces the disk format for I<-a> options which
64 follow on the command line.  Using I<--format ""> (an empty string
65 argument) switches back to auto-detection for subsequent I<-a>
66 options.
67
68 For example:
69
70  virt-resize-ui --format raw -a disk.img
71
72 forces raw format (no auto-detection) for C<disk.img>.
73
74  virt-resize-ui --format raw -a disk.img --format "" -a another.img
75
76 forces raw format (no auto-detection) for C<disk.img> and reverts to
77 auto-detection for C<another.img>.
78
79 If you have untrusted raw-format guest disk images, you should use
80 this option to specify the disk format.  This avoids a possible
81 security problem with malicious guests (CVE-2010-3851).
82
83 =item B<-v>
84
85 =item B<--verbose>
86
87 Enable verbose messages for debugging.
88
89 =item B<-V>
90
91 =item B<--version>
92
93 Display version number and exit.
94
95 =item B<-x>
96
97 Enable tracing of libguestfs API calls.
98
99 =back
100
101 =head1 SEE ALSO
102
103 L<virt-resize(1)>,
104 L<guestfs(3)>,
105 L<guestfish(1)>,
106 L<virt-rescue(1)>,
107 L<http://libguestfs.org/>.
108
109 =head1 AUTHOR
110
111 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
112
113 =head1 COPYRIGHT
114
115 Copyright (C) 2011 Red Hat Inc.
116
117 This program is free software; you can redistribute it and/or modify
118 it under the terms of the GNU General Public License as published by
119 the Free Software Foundation; either version 2 of the License, or
120 (at your option) any later version.
121
122 This program is distributed in the hope that it will be useful,
123 but WITHOUT ANY WARRANTY; without even the implied warranty of
124 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
125 GNU General Public License for more details.
126
127 You should have received a copy of the GNU General Public License
128 along with this program; if not, write to the Free Software
129 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.