Merge
[virt-mem.git] / README
1 virt-mem tools
2 Copyright (C) 2008 Red Hat Inc.
3 ----------------------------------------------------------------------
4
5 These are a collection of monitoring and management tools for virtual
6 machines.
7
8 Commands we support at the moment include:
9
10   virt-uname      'uname' command, shows OS version, architecture, etc.
11   virt-dmesg      'dmesg' command, shows kernel messages
12   virt-ps         'ps' command, shows process list
13   virt-ifconfig   'ifconfig' command, shows network interfaces, addresses, etc.
14
15 The general idea is that they allow you to monitor virtual machines
16 without needing to log in to the machine itself or install any extra
17 software inside the virtual machine.  At the moment we only support
18 virtual machines running Linux kernel >= 2.6, but we expect to support
19 other operating systems in the future.
20
21 The commands use libvirt to access the underlying virtualization
22 system, so we support a variety of different systems such as Xen, QEMU
23 and KVM, and more can be added just by adding support to libvirt.
24
25 THIS IS HIGHLY EXPERIMENTAL, ALPHA-QUALITY SOFTWARE.  PLEASE READ THE FAQ:
26 http://et.redhat.com/~rjones/virt-mem/faq.html
27
28
29 Website
30 ----------------------------------------------------------------------
31
32 http://et.redhat.com/~rjones/virt-mem/
33
34 We supply the latest source and binaries at the above site.
35
36
37 Building from source
38 ----------------------------------------------------------------------
39
40 Run ./configure and look at the output for any missing packages.
41
42 Then:
43
44   make
45
46 Then run the virt-mem meta-tool, for example:
47
48   ./mem/virt-mem.opt dmesg
49
50 (If this binary is linked with the name 'virt-dmesg' then it behaves
51 in the same way).
52
53 To install the binaries, man pages and message catalogs, do this as
54 root:
55
56   make install