Documentation fixes.
[virt-hostinfo.git] / README
1 virt-hostinfo
2 Copyright (C) 2009 Red Hat Inc.
3 ----------------------------------------------------------------------
4
5 This is a project designed to allow controlled access to host
6 information from virtual machines.  It is proposed as a new feature
7 for Fedora 12, and you can read more about it on this web page:
8
9 http://fedoraproject.org/wiki/Features/Hostinfo
10
11
12 Requirements
13 ----------------------------------------------------------------------
14
15 - C compiler
16
17 - APR (Apache Portable Runtime) 1.2.7 (1.3 preferred)
18
19 - Perl
20
21 - pod2man and other perldoc tools
22   * these are usually supplied with Perl
23
24 - libvirt & development tools
25
26 - Perl module Sys::Virt
27
28 - Perl module XML::XPath
29
30
31 Build
32 ----------------------------------------------------------------------
33
34 On the host:
35
36   ./configure
37   make
38   sudo make install
39
40 There is nothing to build or install in the guest.
41
42
43 Host configuration
44 ----------------------------------------------------------------------
45
46 You can edit the text configuration files under /etc/hostinfod by
47 hand.  Please read the hostinfo(8) manual page.
48
49 For graphical configuration, use virt-manager.
50
51 To create new guests with access to host information, use
52 virt-install.
53
54
55 Accessing host information from guests
56 ----------------------------------------------------------------------
57
58 No special software is required inside the guest.  Simply connect to
59 the serial port (usually, but not always, /dev/ttyS1 or COM2) using
60 your favorite serial terminal software and send commands.
61
62 The protocol is a simple, line-based, text protocol.  No special
63 libraries are needed to use it from programs or by hand.  The commands
64 that you can send are documented in the hostinfo-protocol(5) manual
65 page.
66
67 For troubleshooting, see hostinfo(8) manual page.