README

   1 virt-tools - virtual machine info and statistics
   2 Copyright (C) Red Hat Inc. 2009
   3 ----------------------------------------------------------------------
   4
   5 This README file is just an overview of the available documentation
   6 for virt-tools.
   7
   8 To compile from source, see 'INSTALL'.
   9
  10 To use and understand virt-tools, also including how it works and
  11 security considerations, see 'docs/virt-tools.pod' (which is installed
  12 as virt-tools(8) manpage).
  13
  14 To hack on the code, see 'HACKING'.
  15
  16
  17 What is in each directory
  18 ----------------------------------------------------------------------
  19
  20 '[guest]' denotes something that is installed in the guest, and
  21 '[host]' denotes something that is install in the host.
  22
  23 daemon/                [guest]
  24   On Linux/Unix, this contains the configuration used to start the
  25   virt-tools service *in the guest*.  Note that the service is
  26   just snmpd with a modified configuration.  We don't include
  27   the source for snmpd here -- that is supplied by another package
  28   like net-snmp.
  29
  30 docs/                  [guest/host]
  31
  32   Man pages.
  33
  34 linux/                 [guest]
  35
  36   Linux-specific startup scripts for the guest.
  37
  38 m4/
  39
  40   Autotools m4 macros.
  41
  42 tools/                 [host]
  43
  44   Source for the client tools.
  45
  46 windows/               [guest]
  47
  48   Windows-specific configuration for the guest.