Add .gitignore file for git.

[virt-mem.git] / README

diff --git a/README b/README
index ce48e4e..83d4022 100644 (file)
--- a/README
+++ b/README
@@ -10,6 +10,7 @@ Commands we support at the moment include:
   virt-uname      'uname' command, shows OS version, architecture, etc.
   virt-dmesg      'dmesg' command, shows kernel messages
   virt-ps         'ps' command, shows process list
+  virt-ifconfig   'ifconfig' command, shows network interfaces, addresses, etc.
 
 The general idea is that they allow you to monitor virtual machines
 without needing to log in to the machine itself or install any extra
@@ -17,15 +18,13 @@ software inside the virtual machine.  At the moment we only support
 virtual machines running Linux kernel >= 2.6, but we expect to support
 other operating systems in the future.
 
-Most of the commands also offer a CSV (comma-separated values) output
-format ('virt-xx --csv'), allowing usage from scripts to update
-spreadsheets, databases or integrate with existing monitoring systems
-like Nagios.
-
 The commands use libvirt to access the underlying virtualization
 system, so we support a variety of different systems such as Xen, QEMU
 and KVM, and more can be added just by adding support to libvirt.
 
+THIS IS HIGHLY EXPERIMENTAL, ALPHA-QUALITY SOFTWARE.  PLEASE READ THE FAQ:
+http://et.redhat.com/~rjones/virt-mem/faq.html
+
 
 Website
 ----------------------------------------------------------------------
@@ -43,18 +42,15 @@ Run ./configure and look at the output for any missing packages.
 Then:
 
   make
-  make -C po     # if you want to rebuild the locales
 
-The binaries are called things like 'virt-dmesg.opt' and located in
-the respective directories, so you could run them by doing:
+Then run the virt-mem meta-tool, for example:
 
-  dmesg/virt-dmesg.opt
+  ./mem/virt-mem.opt dmesg
 
-All the binaries understand the --help option to provide a summary of
-options.  All require virtual machines to run against, but most also
-offer a test mode (-t option).
+(If this binary is linked with the name 'virt-dmesg' then it behaves
+in the same way).
 
-To install the binaries, man pages and locales, do this as root:
+To install the binaries, man pages and message catalogs, do this as
+root:
 
   make install
-  make -C po install
\ No newline at end of file