Hostinfo day 5: Implement first round of static host commands.
[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.3
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
29
30 Build
31 ----------------------------------------------------------------------
32
33 On the host:
34
35   ./configure
36   make
37   sudo make install
38
39 There is nothing to build or install in the guest.
40
41
42 Host configuration
43 ----------------------------------------------------------------------
44
45 You can edit the text configuration files under /etc/hostinfod by
46 hand.  Please read the hostinfo(8) manual page.
47
48 For graphical configuration, use virt-manager.
49
50 To create new guests with access to host information, use
51 virt-install.
52
53
54 Accessing host information from guests
55 ----------------------------------------------------------------------
56
57 No special software is required inside the guest.  Simply connect to
58 the serial port (usually, but not always, /dev/ttyS1 or COM2) using
59 your favorite serial terminal software and send commands.
60
61 The protocol is a simple, line-based, text protocol.  No special
62 libraries are needed to use it from programs or by hand.  The commands
63 that you can send are documented in the hostinfo-protocol(5) manual
64 page.
65
66 For troubleshooting, see hostinfo(8) manual page.