From: Richard W.M. Jones Date: Wed, 18 May 2011 14:27:20 +0000 (+0100) Subject: Remove guestfish recipes. X-Git-Tag: 1.11.9~15 X-Git-Url: http://git.annexia.org/?a=commitdiff_plain;h=00d34429e5f343bcc3f6afbd27aa3a2ca7820086;p=libguestfs.git Remove guestfish recipes. These were out of date. We will replace them with more up to date information. --- diff --git a/.gitignore b/.gitignore index 969aa08..80f3f18 100644 --- a/.gitignore +++ b/.gitignore @@ -120,7 +120,6 @@ html/guestfs-perl.3.html html/guestfs-python.3.html html/guestfs-ruby.3.html html/guestmount.1.html -html/recipes.html html/virt-cat.1.html html/virt-copy-in.1.html html/virt-copy-out.1.html diff --git a/Makefile.am b/Makefile.am index 3756409..523cd7b 100644 --- a/Makefile.am +++ b/Makefile.am @@ -119,27 +119,13 @@ EXTRA_DIST = \ debian/shlibs.local \ debian/watch \ html/pod.css \ - html/recipes.css \ libguestfs.pc libguestfs.pc.in \ libtool-kill-dependency_libs.sh \ logo/fish.svg logo/fish.png \ - make-recipes.sh \ m4/.gitignore \ - recipes/LICENSE \ - recipes/README \ - recipes/*.html \ - recipes/*.sh \ - recipes/*.example \ run \ update-bugs.sh -# Recipes web page. -html/recipes.html: $(wildcard recipes/*.sh) $(wildcard recipes/*.html) $(wildcard recipes/*.example) Makefile make-recipes.sh - mkdir -p html - rm -f $@ $@-t - sh make-recipes.sh recipes/*.sh > $@-t - mv $@-t $@ - HTMLFILES = \ html/guestfs.3.html \ html/guestfs-examples.3.html \ @@ -165,9 +151,7 @@ HTMLFILES = \ html/virt-tar.1.html \ html/virt-tar-in.1.html \ html/virt-tar-out.1.html \ - html/virt-win-reg.1.html \ - html/recipes.html \ - html/pod.css html/recipes.css + html/virt-win-reg.1.html TEXTFILES = BUGS README RELEASE-NOTES ROADMAP TODO diff --git a/html/recipes.css b/html/recipes.css deleted file mode 100644 index c207355..0000000 --- a/html/recipes.css +++ /dev/null @@ -1,8 +0,0 @@ -/* CSS to make pod2html files look a little bit better. */ -@import url("http://people.redhat.com/~rjones/css/standard.css"); - -div.example pre { - /*font-weight: bold;*/ - width: 40em; - border: 1px solid #c00; -} \ No newline at end of file diff --git a/make-recipes.sh b/make-recipes.sh deleted file mode 100755 index 7bd8114..0000000 --- a/make-recipes.sh +++ /dev/null @@ -1,80 +0,0 @@ -#!/bin/sh - -# libguestfs -# 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. - -cat < - - guestfish recipes - - - -

guestfish recipes

-

You can also find these in the - recipes/ - subdirectory of the source.

- -

- Download - libguestfs and guestfish here or - go to the - libguestfs home page. -

- -

Table of recipes

- ' -echo -echo - -for f in recipes/*.sh; do - b=`basename $f .sh` - echo -n '' - echo -n '

'$b'.sh' - if [ -r recipes/$b.title ]; then - echo -n ': ' - cat recipes/$b.title - fi - echo -n 'permalink' - echo '

' - if [ -r recipes/$b.html ]; then - cat recipes/$b.html - fi - echo '

'$b'.sh

' - echo '
' - source-highlight --output=STDOUT --src-lang=sh --input=$f - echo '
' - if [ -r recipes/$b.example ]; then - echo '

Example output

' - echo '
'
-        sed -e 's,&,\&,g' -e 's,<,\<,g' -e 's,>,\>,g' < recipes/$b.example
-        echo '
' - fi -done - -echo '' diff --git a/recipes/LICENSE b/recipes/LICENSE deleted file mode 100644 index d15411e..0000000 --- a/recipes/LICENSE +++ /dev/null @@ -1,2 +0,0 @@ -All the scripts in the recipes/ subdirectory may be freely -copied without any restrictions. diff --git a/recipes/README b/recipes/README deleted file mode 100644 index 4361327..0000000 --- a/recipes/README +++ /dev/null @@ -1,26 +0,0 @@ -This directory contains guestfish-based shell which give some useful -recipes to follow. - -These also get copied to the website here: -http://libguestfs.org/recipes.html - -The format for each recipe is: - - foo.sh Shell script, using guestfish. - foo.title The title of the recipe. - foo.html HTML snippet describing 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=../appliance 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 ... diff --git a/recipes/clone.example b/recipes/clone.example deleted file mode 100644 index 70be57d..0000000 --- a/recipes/clone.example +++ /dev/null @@ -1,18 +0,0 @@ -$ clone.sh /tmp/test.img /tmp/new.img /dev/sda1 192.168.1.1 newmachine -204800+0 records in -204800+0 records out -104857600 bytes (105 MB) copied, 2.02821 s, 51.7 MB/s - -$ guestfish -a /tmp/new.img -m /dev/sda1 - -Welcome to guestfish, the libguestfs filesystem interactive shell for -editing virtual machine filesystems. - -Type: 'help' for a list of commands - 'man' to read the manual - 'quit' to quit the shell - -> cat /etc/resolv.conf -nameserver 192.168.1.1 -> cat /etc/HOSTNAME -newmachine diff --git a/recipes/clone.html b/recipes/clone.html deleted file mode 100644 index 7079f3f..0000000 --- a/recipes/clone.html +++ /dev/null @@ -1,22 +0,0 @@ -

-This script shows how you might have a library of premade -virtual machines ready for cloning, but as a final step you -use libguestfs or guestfish to customize some configuration -files inside the VM before it's ready to go. -

- -

-In this simple recipe, we overwrite the /etc/resolv.conf file -with a new nameserver entry, and change /etc/HOSTNAME. -

- -

-There are lots of possible improvements to this script, such as -using qcow2 snapshots so that cloned VMs share storage with their -"parent" preimages. -

- -

-For more information about cloning images using libvirt and libguestfs -see Richard Jones's procedure for cloning a Fedora VM. -

diff --git a/recipes/clone.sh b/recipes/clone.sh deleted file mode 100755 index 85acf1f..0000000 --- a/recipes/clone.sh +++ /dev/null @@ -1,14 +0,0 @@ -#!/bin/sh - - -preimage="$1" ;# original guest -newimage="$2" ;# new guest -root="$3" ;# root filesystem -nameserver="$4" ;# new nameserver -hostname="$5" ;# new hostname - -dd if="$preimage" of="$newimage" bs=1M - -guestfish -a "$newimage" -m "$root" < -If you messed up your VM and made it unbootable, it's -often useful to be able to go in and edit /boot/grub/grub.conf. -This guestfish script shows how to do that. -

- -
-editgrub.sh broken-guest.img
-
- -

-See also virt-edit. -

diff --git a/recipes/editgrub.sh b/recipes/editgrub.sh deleted file mode 100755 index 14a7861..0000000 --- a/recipes/editgrub.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/sh - - -guestfish -a "$1" -i edit /boot/grub/grub.conf diff --git a/recipes/editgrub.title b/recipes/editgrub.title deleted file mode 100644 index 2c93a0f..0000000 --- a/recipes/editgrub.title +++ /dev/null @@ -1 +0,0 @@ -Fix an unbootable VM by editing /boot/grub/grub.conf \ No newline at end of file diff --git a/recipes/export2tar.example b/recipes/export2tar.example deleted file mode 100644 index 7f222f3..0000000 --- a/recipes/export2tar.example +++ /dev/null @@ -1,14 +0,0 @@ -$ ./export2tar.sh /dev/mapper/Guests-RHEL53PV32 /dev/VolGroup00/LogVol00 \ - /home /tmp/home.tar.gz -$ ll /tmp/home.tar.gz --rw-rw-r--. 1 rjones rjones 824 2009-04-25 12:33 /tmp/home.tar.gz -$ tar ztf /tmp/home.tar.gz -./ -./rjones/ -./rjones/.bash_profile -./rjones/.mozilla/ -./rjones/.mozilla/extensions/ -./rjones/.mozilla/plugins/ -./rjones/.bash_logout -./rjones/.bashrc -./rjones/.emacs diff --git a/recipes/export2tar.html b/recipes/export2tar.html deleted file mode 100644 index 9d9f2d4..0000000 --- a/recipes/export2tar.html +++ /dev/null @@ -1,20 +0,0 @@ -

-This script lets you export any directory you like from a virtual -machine as a tarball. For example, to export /home -from a standard Fedora or RHEL virtual machine you would do: -

- -
-export2tar.sh guest.img /dev/VolGroup00/LogVol00 /home home.tar.gz
-
- -

-/dev/VolGroup00/LogVol00 is the partition or LV inside -the VM which contains the directory you want. -

- -

-See also virt-tar -and Richard -Jones's complete list of ways to upload and download files. -

diff --git a/recipes/export2tar.sh b/recipes/export2tar.sh deleted file mode 100755 index fa79b3e..0000000 --- a/recipes/export2tar.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/sh - - -guestfish --ro -a "$1" -m "$2" tgz-out "$3" "$4" diff --git a/recipes/export2tar.title b/recipes/export2tar.title deleted file mode 100644 index 98a9e91..0000000 --- a/recipes/export2tar.title +++ /dev/null @@ -1 +0,0 @@ -Export the /home directory from a virtual machine into a tarball \ No newline at end of file diff --git a/recipes/iso2tar.example b/recipes/iso2tar.example deleted file mode 100644 index 5c796e1..0000000 --- a/recipes/iso2tar.example +++ /dev/null @@ -1,16 +0,0 @@ -$ ll -h /tmp/Fedora-11-Beta-i386-netinst.iso --r--r--r--. 1 rjones rjones 168M 2009-04-25 22:38 /tmp/Fedora-11-Beta-i386-netinst.iso -$ ./iso2tar.sh /tmp/Fedora-11-Beta-i386-netinst.iso /tmp/cd.tar.gz -$ ls -lh /tmp/cd.tar.gz --rw-rw-r--. 1 rjones rjones 177M 2009-04-25 22:50 /tmp/cd.tar.gz -$ tar ztf /tmp/cd.tar.gz -./ -./EFI/ -./EFI/BOOT/ -./EFI/BOOT/BOOT.conf -./EFI/BOOT/BOOTIA32.conf -./EFI/BOOT/splash.xpm.gz -./EFI/BOOT/TRANS.TBL -./images/ -./images/efiboot.img -[etc] diff --git a/recipes/iso2tar.html b/recipes/iso2tar.html deleted file mode 100644 index b1fe0aa..0000000 --- a/recipes/iso2tar.html +++ /dev/null @@ -1,17 +0,0 @@ -

-Convert a CD-ROM or DVD ISO to a tarball. -

- -

-Usage is very simple: -

- -
-iso2tar.sh cd.iso output.tar.gz
-
- -

-See also virt-tar -and Richard -Jones's complete list of ways to upload and download files. -

diff --git a/recipes/iso2tar.sh b/recipes/iso2tar.sh deleted file mode 100755 index b3de8db..0000000 --- a/recipes/iso2tar.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/sh - - -guestfish -a "$1" --ro -m /dev/sda tgz-out / "$2" diff --git a/recipes/iso2tar.title b/recipes/iso2tar.title deleted file mode 100644 index b8e95ac..0000000 --- a/recipes/iso2tar.title +++ /dev/null @@ -1 +0,0 @@ -Convert a CD-ROM or DVD ISO to a tarball \ No newline at end of file diff --git a/recipes/list-apps.example b/recipes/list-apps.example deleted file mode 100644 index c37063c..0000000 --- a/recipes/list-apps.example +++ /dev/null @@ -1,29 +0,0 @@ -$ list-apps.sh win7.img -[0] = { - app_name: Mozilla Firefox (3.6.12) - app_display_name: Mozilla Firefox (3.6.12) - app_epoch: 0 - app_version: 3.6.12 (en-GB) - app_release: - app_install_path: C:\Program Files\Mozilla Firefox - app_trans_path: - app_publisher: Mozilla - app_url: http://www.mozilla.com/en-GB/ - app_source_package: - app_summary: - app_description: Mozilla Firefox -} -[1] = { - app_name: VLC media player - app_display_name: VLC media player 1.1.5 - app_epoch: 0 - app_version: 1.1.5 - app_release: - app_install_path: C:\Program Files\VideoLAN\VLC - app_trans_path: - app_publisher: VideoLAN - app_url: http://www.videolan.org/ - app_source_package: - app_summary: - app_description: -} diff --git a/recipes/list-apps.html b/recipes/list-apps.html deleted file mode 100644 index 0a1c4b0..0000000 --- a/recipes/list-apps.html +++ /dev/null @@ -1,9 +0,0 @@ -

-The command lists the applications (eg. RPMs, debs, Windows programs) -installed inside a virtual machine. It does this using the -inspection API. -

- -

-See also virt-inspector. -

diff --git a/recipes/list-apps.sh b/recipes/list-apps.sh deleted file mode 100755 index f781a7d..0000000 --- a/recipes/list-apps.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/sh - - -eval "$(guestfish --ro -a "$1" --i --listen)" -root="$(guestfish --remote inspect-get-roots)" -guestfish --remote inspect-list-applications "$root" -guestfish --remote exit diff --git a/recipes/list-apps.title b/recipes/list-apps.title deleted file mode 100644 index 104ffe8..0000000 --- a/recipes/list-apps.title +++ /dev/null @@ -1 +0,0 @@ -List the apps (eg. RPMs) installed inside a virtual machine \ No newline at end of file diff --git a/recipes/list-files.html b/recipes/list-files.html deleted file mode 100644 index c8f8c88..0000000 --- a/recipes/list-files.html +++ /dev/null @@ -1,3 +0,0 @@ -

-List the files in a virtual machine. -

diff --git a/recipes/list-files.sh b/recipes/list-files.sh deleted file mode 100755 index 2f91f28..0000000 --- a/recipes/list-files.sh +++ /dev/null @@ -1,5 +0,0 @@ -#!/bin/sh - - -guestfish --ro -a "$1" -i find0 / - | - tr '\000' '\n' | - sort diff --git a/recipes/list-files.title b/recipes/list-files.title deleted file mode 100644 index 0e8c0d0..0000000 --- a/recipes/list-files.title +++ /dev/null @@ -1 +0,0 @@ -List the files and directories in a virtual machine diff --git a/recipes/product-name.example b/recipes/product-name.example deleted file mode 100644 index 55b77fe..0000000 --- a/recipes/product-name.example +++ /dev/null @@ -1,2 +0,0 @@ -$ product-name.sh win.img -Windows 7 Enterprise diff --git a/recipes/product-name.html b/recipes/product-name.html deleted file mode 100644 index 509ada1..0000000 --- a/recipes/product-name.html +++ /dev/null @@ -1,9 +0,0 @@ -

-Get the string which describes the operating system installed in a -virtual machine. This uses the -inspection API. -

- -

-See also virt-inspector. -

diff --git a/recipes/product-name.sh b/recipes/product-name.sh deleted file mode 100755 index 7dcc7da..0000000 --- a/recipes/product-name.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/sh - - -eval "$(guestfish --ro -a "$1" --i --listen)" -root="$(guestfish --remote inspect-get-roots)" -guestfish --remote inspect-get-product-name "$root" -guestfish --remote exit diff --git a/recipes/product-name.title b/recipes/product-name.title deleted file mode 100644 index ed64090..0000000 --- a/recipes/product-name.title +++ /dev/null @@ -1 +0,0 @@ -Get the operating system "Product Name" string \ No newline at end of file diff --git a/recipes/show-devices.example b/recipes/show-devices.example deleted file mode 100644 index d93857e..0000000 --- a/recipes/show-devices.example +++ /dev/null @@ -1,8 +0,0 @@ -$ show-devices.sh /dev/mapper/Guests-RHEL53PV32 -/dev/sda -/dev/sda1 -/dev/sda2 -/dev/sda2 -VolGroup00 -/dev/VolGroup00/LogVol00 -/dev/VolGroup00/LogVol01 diff --git a/recipes/show-devices.html b/recipes/show-devices.html deleted file mode 100644 index e27443f..0000000 --- a/recipes/show-devices.html +++ /dev/null @@ -1,10 +0,0 @@ -

-This very simple script shows how you can display an overview -of what devices, partitions and LVM data are found in a -guest image. -

- -

-See -also virt-filesystems. -

diff --git a/recipes/show-devices.sh b/recipes/show-devices.sh deleted file mode 100755 index 6fd2b75..0000000 --- a/recipes/show-devices.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/bin/sh - - -guestfish -a "$1" < -You can use squashfs to import large amounts of data -into a guest. First you prepare the squashfs image: -

- -
-/sbin/mksquashfs data [...] data.sqsh
-
- -

-and then you can add it to the guest as an extra data -drive. In the example below, we show how to make a -squashfs from the contents of some local directory -(/usr/share/man/man8 in this example) -and then make that appear in the guest. -

- -

-See also virt-tar -and Richard -Jones's complete list of ways to upload and download files. -

diff --git a/recipes/squashfs.sh b/recipes/squashfs.sh deleted file mode 100755 index ac5bfca..0000000 --- a/recipes/squashfs.sh +++ /dev/null @@ -1,18 +0,0 @@ -#!/bin/sh - - -datadir=/usr/share/man/man8 -rm -f test.sqsh -/sbin/mksquashfs $datadir test.sqsh - -guestfish -N fs -a test.sqsh <<'EOF' - mkmountpoint /output - mkmountpoint /squash - mount-options "" /dev/sda1 /output - mount-options "" /dev/sdb /squash - cp-a /squash /output/man8 - umount /squash - df-h - umount /output -EOF - -rm test.sqsh diff --git a/recipes/squashfs.title b/recipes/squashfs.title deleted file mode 100644 index b2701c6..0000000 --- a/recipes/squashfs.title +++ /dev/null @@ -1 +0,0 @@ -Mount data in a guest using squashfs \ No newline at end of file diff --git a/recipes/tar2vm.example b/recipes/tar2vm.example deleted file mode 100644 index 1ca0379..0000000 --- a/recipes/tar2vm.example +++ /dev/null @@ -1 +0,0 @@ -$ ./tar2vm.sh ../libguestfs-1.0.10.tar.gz /tmp/test.img 10M diff --git a/recipes/tar2vm.html b/recipes/tar2vm.html deleted file mode 100644 index ecb5c55..0000000 --- a/recipes/tar2vm.html +++ /dev/null @@ -1,25 +0,0 @@ -

-This script shows how you might generate a whole virtual -machine, or a disk image for a virtual machine, starting -with a tarball that contains the content for the machine. -

- -

-The usage is: -

- -
-tar2vm.sh input.tar.gz output.img 100M
-
- -

-where (for example) 100M is the size of the output -disk image. You have to specify a size that is large enough to contain all -the contents of the tarball, but not too large that there is too much -wasted space (unless you want to give the VM extra working space of -course). -

- -

-See also virt-make-fs. -

diff --git a/recipes/tar2vm.sh b/recipes/tar2vm.sh deleted file mode 100755 index 12d8c7a..0000000 --- a/recipes/tar2vm.sh +++ /dev/null @@ -1,11 +0,0 @@ -#!/bin/sh - - -guestfish < -A simple way to see which home directory is using most -space. Note this just counts the contents of directories -in /home and doesn't include other files that a user may -have. -

diff --git a/recipes/user-quota.sh b/recipes/user-quota.sh deleted file mode 100755 index 1913bbe..0000000 --- a/recipes/user-quota.sh +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/sh - - -vmfile="$1" -dir=/home - -eval $(guestfish --ro -a "$vmfile" -i --listen) - -for d in $(guestfish --remote ls "$dir"); do - echo -n "$dir/$d" - echo -ne '\t' - guestfish --remote du "$dir/$d"; -done | sort -nr -k 2 -guestfish --remote exit diff --git a/recipes/user-quota.title b/recipes/user-quota.title deleted file mode 100644 index 774c166..0000000 --- a/recipes/user-quota.title +++ /dev/null @@ -1 +0,0 @@ -See which user is using most space \ No newline at end of file