virt-similarity.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 virt-similarity - Find clusters of similar/cloned virtual machines
   6
   7 =head1 SYNOPSIS
   8
   9  virt-similarity disk1 disk2 [disk3 ...]
  10
  11 =head1 DESCRIPTION
  12
  13 Virt-similarity is a tool for doing cluster analysis of groups of
  14 virtual machines.  It can automatically detect machines which have
  15 been cloned from each other.  It can produce a "cladogram" showing the
  16 "family history" of each guest, or you can use it to create the most
  17 efficient tree of backing files which will use the least disk space.
  18
  19 Basic usage is simply to run virt-similarity with a list of disk
  20 images.  It will read and analyze the disk images, then print a
  21 cladogram showing how they are related:
  22
  23  $ virt-similarity winxp-copy.img winxp-copy2.img \
  24      f19rawhidex32.img f19rawhidex64.img archlinux20121201x64.img \
  25      winxp.img winxp-copy2b.img
  26
  27  ---+------+------+------+------+------ winxp-copy2.img
  28     |      |      |      |      |
  29     |      |      |      |      +------ winxp-copy2b.img
  30     |      |      |      |
  31     |      |      |      +------+------ winxp.img
  32     |      |      |             |
  33     |      |      |             +------ winxp-copy.img
  34     |      |      |
  35     |      |      +------ f19rawhidex64.img
  36     |      |
  37     |      +------ f19rawhidex32.img
  38     |
  39     +------ archlinux20121201x64.img
  40
  41 The first time you run virt-similarity, it has to read the disk images
  42 which takes some time.  On subsequent runs, the information from each
  43 disk image is cached in a special form in a hidden file in your home
  44 directory called C<~/.similarity-cache.v1>.  You can simply delete
  45 this cache file at any time if you want, especially if you want to
  46 force virt-similarity to re-read the disk images.
  47
  48 =head1 FILES
  49
  50 =over 4
  51
  52 =item C<~/.similarity-cache.v1>
  53
  54 The cache file where virt-similarity saves information about each disk
  55 image so that it doesn't have to re-read them each time it is run.
  56 You can delete this file at any time.
  57
  58 =back
  59
  60 =head1 ENVIRONMENT VARIABLES
  61
  62 Virt-similarity uses libguestfs, and is affected by various libguestfs
  63 environment variables.  See L<guestfs(3)/ENVIRONMENT VARIABLES>.
  64
  65 =head1 SEE ALSO
  66
  67 L<guestfs(3)>, L<http://virt-tools.org/>
  68
  69 =head1 AUTHOR
  70
  71 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
  72
  73 =head1 COPYRIGHT
  74
  75 Copyright (C) 2013 Red Hat Inc.
  76
  77 This program is free software; you can redistribute it and/or modify
  78 it under the terms of the GNU General Public License as published by
  79 the Free Software Foundation; either version 2 of the License, or
  80 (at your option) any later version.
  81
  82 This program is distributed in the hope that it will be useful,
  83 but WITHOUT ANY WARRANTY; without even the implied warranty of
  84 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  85 GNU General Public License for more details.
  86
  87 You should have received a copy of the GNU General Public License
  88 along with this program; if not, write to the Free Software
  89 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.