recipes/README

   1 This directory contains guestfish-based shell which give some useful
   2 recipes to follow.
   3
   4 These also get copied to the website here:
   5 http://libguestfs.org/recipes.html
   6
   7 The format for each recipe is:
   8
   9   foo.sh           Shell script, using guestfish.
  10   foo.title        The title of the recipe.
  11   foo.html         HTML snippet describing the recipe.
  12   foo.example      Plain text snippet showing example output.
  13
  14 Everything in the recipes/ directory may be used and distributed
  15 without restrictions.
  16
  17 To run a script before libguestfs has been installed, you can do
  18 something like this:
  19
  20   LIBGUESTFS_PATH=../appliance PATH=../fish:$PATH ./show-devices.sh disk.img
  21
  22 You can apply these recipes in your own programs by translating the
  23 guestfish commands into API calls in the language of your choice.  The
  24 translation is a simple 1-1 mapping.
  25
  26 Got a useful tip or recipe?  Please contribute ...