Hostinfo day 1: Mainly documentation.

[virt-hostinfo.git] / hostinfo-test / hostinfo-test.pl

diff --git a/hostinfo-test/hostinfo-test.pl b/hostinfo-test/hostinfo-test.pl
new file mode 100755 (executable)
index 0000000..8f9694e
--- /dev/null
+++ b/hostinfo-test/hostinfo-test.pl
@@ -0,0 +1,95 @@
+#!/usr/bin/perl -w
+# @configure_input@
+# virt-hostinfo
+# Copyright (C) 2009 Red Hat Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+use strict;
+
+#use Sys::Virt;
+
+=pod
+
+=head1 NAME
+
+hostinfo-test - make or test hostinfo requests from a virtual machine
+
+=head1 SYNOPSIS
+
+ hostinfo-test [--options]
+
+=head1 DESCRIPTION
+
+I<Note:> It only makes sense to use this command from inside
+a guest (virtual machine).
+
+This command is used to make/test hostinfo requests.  You can
+use this to test that the hostinfo system is working end-to-end.
+
+On its own, the command will make a simple 'ping' request, just
+to check that the path from the guest to the C<hostinfod> (daemon)
+inside the host is working:
+
+ # hostinfo-test
+
+or:
+
+ # hostinfo-test
+ error: no response ping request
+
+=cut
+
+
+
+
+
+=head1 RETURN VALUE
+
+This command returns 0 if the test succeeded, or 1 if the test failed
+or there was an error.
+
+=head1 SEE ALSO
+
+L<hostinfo(8)>,
+L<hostinfo-set(8)>,
+L<hostinfo-status(8)>,
+L<virt-install(1)>,
+L<virt-manager(1)>,
+L<http://fedoraproject.org/wiki/Features/Hostinfo>,
+L<http://libvirt.org/>.
+
+=head1 AUTHORS
+
+Richard W.M. Jones (C<rjones at redhat dot com>)
+
+=head1 COPYRIGHT
+
+Copyright (C) 2009 Red Hat Inc.
+L<http://fedoraproject.org/wiki/Features/Hostinfo>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.