=encoding utf8

=head1 НАЗВА

virt-sparsify - Make a virtual machine disk sparse

=head1 КОРОТКИЙ ОПИС

 virt-sparsify [--options] indisk outdisk

=head1 ОПИС

Virt-sparsify is a tool which can make a virtual machine disk (or any disk
image) sparse a.k.a. thin-provisioned.  This means that free space within
the disk image can be converted back to free space on the host.

Virt-sparsify can locate and sparsify free space in most filesystems
(eg. ext2/3/4, btrfs, NTFS, etc.), and also in LVM physical volumes.

Virt-sparsify can also convert between some disk formats, for example
converting a raw disk image to a thin-provisioned qcow2 image.

Virt-sparsify can operate on any disk image, not just ones from virtual
machines.  If a virtual machine has more than one attached disk, you must
sparsify each one separately.

=head2 ВАЖЛИВІ ОБМЕЖЕННЯ

=over 4

=item *

Virt-sparsify does not do in-place modifications.  It copies from a source
image to a destination image, leaving the source unchanged.  I<Check that
the sparsification was successful before deleting the source image>.

=item *

The virtual machine I<must be shut down> before using this tool.

=item *

Virt-sparsify may require up to 2x the virtual size of the source disk image
(1 temporary copy + 1 destination image).  This is in the worst case and
usually much less space is required.

=item *

Virt-sparsify cannot resize disk images.  To do that, use L<virt-resize(1)>.

=item *

Virt-sparsify cannot handle encrypted disks.  Libguestfs supports encrypted
disks, but encrypted disks themselves cannot be sparsified.

=item *

Virt-sparsify cannot yet sparsify the space between partitions.  Note that
this space is often used for critical items like bootloaders so it's not
really unused.

=back

You may also want to read the manual pages for the associated tools
L<virt-filesystems(1)> and L<virt-df(1)> before starting.

=head1 ПРИКЛАДИ

Типовий приклад використання:

 virt-sparsify indisk outdisk

which copies C<indisk> to C<outdisk>, making the output sparse.  C<outdisk>
is created, or overwritten if it already exists.  The format of the input
disk is detected (eg. qcow2) and the same format is used for the output
disk.

To convert between formats, use the I<--convert> option:

 virt-sparsify disk.raw --convert qcow2 disk.qcow2

Virt-sparsify tries to zero and sparsify free space on every filesystem it
can find within the source disk image.  You can get it to ignore (don't zero
free space on) certain filesystems by doing:

 virt-sparsify --ignore /dev/sda1 indisk outdisk

See L<virt-filesystems(1)> to get a list of filesystems within a disk image.

=head1 ПАРАМЕТРИ

=over 4

=item B<--help>

Показати довідкове повідомлення.

=item B<--compress>

Compress the output file.  This I<only> works if the output format is
C<qcow2>.

=item B<--convert> raw

=item B<--convert> qcow2

=item B<--convert> [other formats]

Use C<output-format> as the format for the destination image.  If this is
not specified, then the input format is used.

Supported and known-working output formats are: C<raw>, C<qcow2>, C<vdi>.

You can also use any format supported by the L<qemu-img(1)> program,
eg. C<vmdk>, but support for other formats is reliant on qemu.

Specifying the I<--convert> option is usually a good idea, because then
virt-sparsify doesn't need to try to guess the input format.

For fine-tuning the output format, see: I<--compress>, I<-o>.

=item B<--debug-gc>

Debug garbage collection and memory allocation.  This is only useful when
debugging memory problems in virt-sparsify or the OCaml libguestfs bindings.

=item B<--format> raw

=item B<--format> qcow2

Specify the format of the input disk image.  If this flag is not given then
it is auto-detected from the image itself.

If working with untrusted raw-format guest disk images, you should ensure
the format is always specified.

=item B<--ignore> файлова_система

=item B<--ignore> група_томів

Ignore the named filesystem.  Free space on the filesystem will not be
zeroed, but existing blocks of zeroes will still be sparsified.

In the second form, this ignores the named volume group.  Use the volume
group name without the C</dev/> prefix, eg. I<--ignore vg_foo>

Цей параметр можна вказувати декілька разів.

=item B<--machine-readable>

This option is used to make the output more machine friendly when being
parsed by other programs.  See L</MACHINE READABLE OUTPUT> below.

=item B<-o> параметр[,параметр,...]

Pass I<-o> option(s) to the L<qemu-img(1)> command to fine-tune the output
format.  Options available depend on the output format (see I<--convert>)
and the installed version of the qemu-img program.

You should use I<-o> at most once.  To pass multiple options, separate them
with commas, eg:

 virt-sparsify --convert qcow2 \
   -o cluster_size=512,preallocation=metadata ...

=item B<-q>

=item B<--quiet>

This disables progress bars and other unnecessary output.

=item B<-v>

=item B<--verbose>

Увімкнути докладний показ повідомлень з метою діагностики.

=item B<-V>

=item B<--version>

Показати дані щодо версії і завершити роботу.

=item B<-x>

Увімкнути трасування викликів програмного інтерфейсу libguestfs.

=item B<--zero> розділ

=item B<--zero> логічний_том

Zero the contents of the named partition or logical volume in the guest.
All data on the device is lost, but sparsification is excellent! You can
give this option multiple times.

=back

=head1 MACHINE READABLE OUTPUT

The I<--machine-readable> option can be used to make the output more machine
friendly, which is useful when calling virt-sparsify from other programs,
GUIs etc.

Існує два способи використання цього параметра.

Firstly use the option on its own to query the capabilities of the
virt-sparsify binary.  Typical output looks like this:

 $ virt-sparsify --machine-readable
 virt-sparsify
 ntfs
 btrfs

A list of features is printed, one per line, and the program exits with
status 0.

Secondly use the option in conjunction with other options to make the
regular program output more machine friendly.

У поточній версії це означає таке:

=over 4

=item 1.

Progress bar messages can be parsed from stdout by looking for this regular
expression:

 ^[0-9]+/[0-9]+$

=item 2.

The calling program should treat messages sent to stdout (except for
progress bar messages) as status messages.  They can be logged and/or
displayed to the user.

=item 3.

The calling program should treat messages sent to stderr as error messages.
In addition, virt-sparsify exits with a non-zero status code if there was a
fatal error.

=back

All versions of virt-sparsify have supported the I<--machine-readable>
option.

=head1 СТАН ВИХОДУ

Ця програма повертає значення 0 у разі успішного завершення і ненульове
значення, якщо сталася помилка.

=head1 ЗМІННІ СЕРЕДОВИЩА

=over 4

=item TMPDIR

Location of the temporary directory used for the potentially large temporary
overlay file.

You should ensure there is enough free space in the worst case for a full
copy of the source disk (I<virtual> size), or else set C<$TMPDIR> to point
to another directory that has enough space.

Типовим значенням є C</tmp>.

Note that if C<$TMPDIR> is a tmpfs (eg. if C</tmp> is on tmpfs, or if you
use C<TMPDIR=/dev/shm>), tmpfs defaults to a maximum size of I<half> of
physical RAM.  If virt-sparsify exceeds this, it will hang.  The solution is
either to use a real disk, or to increase the maximum size of the tmpfs
mountpoint, eg:

 mount -o remount,size=10G /tmp

=back

Опис інших змінних середовища наведено у розділі L<guestfs(3)/ENVIRONMENT
VARIABLES>.

=head1 ТАКОЖ ПЕРЕГЛЯНЬТЕ

L<virt-filesystems(1)>, L<virt-df(1)>, L<virt-resize(1)>, L<virt-rescue(1)>,
L<guestfs(3)>, L<guestfish(1)>, L<truncate(1)>, L<fallocate(1)>,
L<qemu-img(1)>, L<http://libguestfs.org/>.

=head1 АВТОР

Richard W.M. Jones L<http://people.redhat.com/~rjones/>

=head1 АВТОРСЬКІ ПРАВА

© Red Hat Inc., 2011

Ця програма є вільним програмним забезпеченням; ви можете поширювати та/або
змінювати її за умов дотримання GNU General Public License  утому вигляді,
що оприлюднений Free Software Foundation; версії 2 цієї Ліцензії, або (якщо
забажаєте) будь-якої випущеної пізніше.

Ця програма поширюється у сподіванні, що вона буде корисною, але БЕЗ
БУДЬ-ЯКИХ ГАРАНТІЙНИХ ЗОБОВ’ЯЗАНЬ; навіть без очевидної гарантії
ПРАЦЕЗДАТНОСТІ або ПРИДАТНОСТІ ДЛЯ ВИКОРИСТАННЯ З ПЕВНОЮ МЕТОЮ. Докладніше
про це можна дізнатися з GNU General Public License.

Ви маєте отримати копію GNU General Public License разом з цією програмою;
якщо це не так, повідомте про факт за адресою Free Software Foundation,
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.