Documentation fixes.

[virt-hostinfo.git] / README

diff --git a/README b/README
index cd91204..00fab3e 100644 (file)
--- a/README
+++ b/README
@@ -12,7 +12,20 @@ http://fedoraproject.org/wiki/Features/Hostinfo
 Requirements
 ----------------------------------------------------------------------
 
-- APR (Apache Portable Runtime) 1.3
+- C compiler
+
+- APR (Apache Portable Runtime) 1.2.7 (1.3 preferred)
+
+- Perl
+
+- pod2man and other perldoc tools
+  * these are usually supplied with Perl
+
+- libvirt & development tools
+
+- Perl module Sys::Virt
+
+- Perl module XML::XPath
 
 
 Build
@@ -31,7 +44,7 @@ Host configuration
 ----------------------------------------------------------------------
 
 You can edit the text configuration files under /etc/hostinfod by
-hand.  Please read the hostinfod(8) manual page.
+hand.  Please read the hostinfo(8) manual page.
 
 For graphical configuration, use virt-manager.
 
@@ -43,31 +56,12 @@ Accessing host information from guests
 ----------------------------------------------------------------------
 
 No special software is required inside the guest.  Simply connect to
-the serial port[1] (eg. /dev/ttyS1 or COM2) using your favorite serial
-terminal software and send commands.
+the serial port (usually, but not always, /dev/ttyS1 or COM2) using
+your favorite serial terminal software and send commands.
 
 The protocol is a simple, line-based, text protocol.  No special
 libraries are needed to use it from programs or by hand.  The commands
-that you can send are documented in the hostinfod(8) manual page.
-
-If you get no response on the serial port at all, check on the host
-side that the guest is allowed access (see /etc/hostinfod/).  Also
-check that the serial port has been set up in libvirt:
-
-  virsh dumpxml DOMAIN
-
-(should show a <serial/> clause)
-
-Also check that hostinfod (the daemon) is running on the host.
-
-Note that serial port settings like speed, parity etc. make no
-difference for these emulated serial ports, so that won't be a factor.
-
-If you get an answer from the hostinfo daemon, but it indicates a
-permissions error, check on the host side that the guest is allowed to
-access the particular resource (see /etc/hostinfod/).
+that you can send are documented in the hostinfo-protocol(5) manual
+page.
 
-[1] _Which_ serial port can vary - you need to either try them one by
-one or ask the host administrator to tell you.  We try to stay on the
-second serial port (ttyS1 or COM2) but there are some configurations
-where we get bumped up or down to other serial ports.
+For troubleshooting, see hostinfo(8) manual page.