From: Richard W.M. Jones <rjones@redhat.com>
Date: Fri, 7 Oct 2011 18:20:36 +0000 (+0100)
Subject: fish: Add man page section on calling guestfish remote robustly from bash.
X-Git-Tag: 1.12.8~13
X-Git-Url: http://git.annexia.org/?a=commitdiff_plain;h=14b66ed2a02e2f47b165034a86cb86691340db34;p=libguestfs.git

fish: Add man page section on calling guestfish remote robustly from bash.
(cherry picked from commit 3a546663655abfcd6399d4fdb7febc6b0d83b822)
---

diff --git a/fish/guestfish.pod b/fish/guestfish.pod
index 254daad..c09dffc 100644
--- a/fish/guestfish.pod
+++ b/fish/guestfish.pod
@@ -973,6 +973,38 @@ user ID of the process, and C<$PID> is the process ID of the server.
 
 Guestfish client and server versions must match exactly.
 
+=head2 USING REMOTE CONTROL ROBUSTLY FROM SHELL SCRIPTS
+
+From Bash, you can use the following code which creates a guestfish
+instance, correctly quotes the command line, handles failure to start,
+and cleans up guestfish when the script exits:
+
+ #!/bin/bash -
+ 
+ set -e
+ 
+ guestfish[0]="guestfish"
+ guestfish[1]="--listen"
+ guestfish[2]="--ro"
+ guestfish[3]="-a"
+ guestfish[4]="disk.img"
+ 
+ GUESTFISH_PID=
+ eval $("${guestfish[@]}")
+ if [ -z "$GUESTFISH_PID" ]; then
+     echo "error: guestfish didn't start up, see error messages above"
+     exit 1
+ fi
+ 
+ kill_guestfish ()
+ {
+     kill $GUESTFISH_PID >/dev/null 2>&1 ||:
+ }
+ trap kill_guestfish EXIT
+ 
+ guestfish --remote run
+ # etc.
+
 =head2 REMOTE CONTROL RUN COMMAND HANGING
 
 Using the C<run> (or C<launch>) command remotely in a command