summaryrefslogtreecommitdiffstats
path: root/recipes/README
blob: 6a1f72889b37f7f16c56635e9c0f3b5be0c049cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
This directory contains guestfish-based shell which give some useful
recipes to follow.

These also get copied to the website here:
http://et.redhat.com/~rjones/libguestfs/recipes.html

The format for each recipe is:

  foo.sh           Shell script, using guestfish.
  foo.html         HTML snippet describing the recipe (should start
                   with <h2>..</h2> giving the title of the recipe)
  foo.example      Plain text snippet showing example output.

Everything in the recipes/ directory may be used and distributed
without restrictions.

To run a script before libguestfs has been installed, you can do
something like this:

  LIBGUESTFS_PATH=.. PATH=../fish:$PATH ./show-devices.sh disk.img

You can apply these recipes in your own programs by translating the
guestfish commands into API calls in the language of your choice.  The
translation is a simple 1-1 mapping.

Got a useful tip or recipe?  Please contribute ...