From: Richard Jones <rjones@redhat.com>
Date: Sun, 19 Apr 2009 13:39:19 +0000 (+0100)
Subject: Document initial message.
X-Git-Tag: 1.0.2~7
X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=commitdiff_plain;h=13465753d3ed056609ec1e3137750a05d0497a66

Document initial message.
---

diff --git a/guestfs.pod b/guestfs.pod
index a462431..db8887e 100644
--- a/guestfs.pod
+++ b/guestfs.pod
@@ -615,6 +615,13 @@ parameters, but with the roles of daemon and library reversed.
  sequence of chunks for FileOut param #0
  sequence of chunks for FileOut param #1 etc.
 
+=head3 INITIAL MESSAGE
+
+Because the underlying channel (QEmu -net channel) doesn't have any
+sort of connection control, when the daemon launches it sends an
+initial word (C<GUESTFS_LAUNCH_FLAG>) which indicates that the guest
+and daemon is alive.  This is what C<guestfs_wait_ready> waits for.
+
 =head1 ENVIRONMENT VARIABLES
 
 =over 4