summaryrefslogtreecommitdiffstats
path: root/python/examples/guestfs-python.pod
blob: 520101557a667ee895174662f530260b24548b31 (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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
=encoding utf8

=head1 NAME

guestfs-python - How to use libguestfs from Python

=head1 SYNOPSIS

 import guestfs
 g = guestfs.GuestFS ()
 g.add_drive_opts ("disk.img", format="raw", readonly=1)
 g.launch ()

=head1 DESCRIPTION

This manual page documents how to call libguestfs from the Python
programming language.  This page just documents the differences from
the C API and gives some examples.  If you are not familiar with using
libguestfs, you also need to read L<guestfs(3)>.

=head2 EXCEPTIONS

Errors from libguestfs functions are mapped into C<RuntimeException>
with a single string argument which is the error message.

=head2 MORE DOCUMENTATION

Type:

 $ python
 >>> import guestfs
 >>> help (guestfs)

=head1 EXAMPLE 1: CREATE A DISK IMAGE

@EXAMPLE1@

=head1 EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE

@EXAMPLE2@

=head1 SEE ALSO

L<guestfs(3)>,
L<guestfs-examples(3)>,
L<guestfs-erlang(3)>,
L<guestfs-java(3)>,
L<guestfs-ocaml(3)>,
L<guestfs-perl(3)>,
L<guestfs-recipes(1)>,
L<guestfs-ruby(3)>,
L<http://libguestfs.org/>.

=head1 AUTHORS

Richard W.M. Jones (C<rjones at redhat dot com>)

=head1 COPYRIGHT

Copyright (C) 2010-2012 Red Hat Inc.
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
thisconfigdir=./..
myfulldir=lib
mydir=lib
SUBDIRS=crypto krb5 des425 @KRB4@ gssapi rpc kdb kadm5 apputils
BUILDTOP=$(REL)..

all-unix::

CLEANLIBS = libkrb5.a libkdb5.a libcrypto.a libgssapi_krb5.a libdes425.a \
	libkrb425.a libkadm.a libkrb4.a libcom_err.a libpty.a \
	libss.a libgssapi.a libapputils.a \
	libkrb5.so libcrypto.so libkrb4.so libdes425.so

clean-unix::

clean-windows::

# Windows stuff to make krb5 and gssapi DLLs.

##MIT##!if !defined(VS_INC)
##MIT##!message Must define VS_INC to point to version server include dir!
##MIT##!error
##MIT##!endif
##MIT##!if !defined(VS_LIB)
##MIT##!message Must define VS_LIB to point to version server library!
##MIT##!error
##MIT##!endif
##MIT##MITLIBS=$(VS_LIB)
##MIT##MITFLAGS=-I$(VS_INC) /DVERSERV=1



##WIN32##!if  ("$(CPU)" == "IA64" ) || ("$(CPU)" == "AMD64" ) || ("$(CPU)" == "ALPHA64" )
##WIN32##SLIBS = $(BUILDTOP)\util\support\$(OUTPRE)k5sprt64.lib
##WIN32##!else
##WIN32##SLIBS = $(BUILDTOP)\util\support\$(OUTPRE)k5sprt32.lib
##WIN32##!endif
##WIN32##CLIBS = $(BUILDTOP)\util\et\$(OUTPRE)comerr.lib
##WIN32##PLIBS = $(BUILDTOP)\util\profile\$(OUTPRE)profile.lib
##WIN32##KLIBS = krb5\$(OUTPRE)krb5.lib crypto\$(OUTPRE)crypto.lib \
##WIN32##	$(BUILDTOP)\util\profile\$(OUTPRE)profile.lib \
##WIN32##	des425\$(OUTPRE)des425.lib
##WIN32##GLIBS = gssapi\$(OUTPRE)gssapi.lib
##WIN32##K4LIBS = krb4\$(OUTPRE)krb4.lib


##WIN32##SDEF = k5sprt32.def
##WIN32##CDEF = comerr32.def
##WIN32##PDEF = xpprof32.def
##WIN32##KDEF = krb5_32.def
##WIN32##GDEF = gssapi32.def
##WIN32##K4DEF = krb4_32.def



##WIN32##KRB5RC = krb5.rc
##WIN32##VERSIONRC = $(BUILDTOP)\windows\version.rc

##WIN32##WINLIBS = kernel32.lib ws2_32.lib user32.lib shell32.lib oldnames.lib \
##WIN32##	version.lib secur32.lib advapi32.lib gdi32.lib delayimp.lib
##WIN32##WINDLLFLAGS = $(DLL_LINKOPTS) -base:0x1c000000 /DELAYLOAD:secur32.dll \
##WIN32##	/DELAYLOAD:advapi32.dll /DELAY:UNLOAD /DELAY:NOBIND

##WIN32##S_GLUE=$(OUTPRE)support_glue.obj
##WIN32##K5_GLUE=$(OUTPRE)k5_glue.obj
##WIN32##K4_GLUE=$(OUTPRE)k4_glue.obj
##WIN32##GSS_GLUE=$(OUTPRE)gss_glue.obj
##WIN32##COMERR_GLUE=$(OUTPRE)comerr_glue.obj
##WIN32##PROF_GLUE=$(OUTPRE)prof_glue.obj

##WIN32##SGLUE=$(S_GLUE)
##WIN32##CGLUE=$(COMERR_GLUE)
##WIN32##PGLUE=$(PROF_GLUE)
##WIN32##KGLUE=$(K5_GLUE)
##WIN32##GGLUE=$(GSS_GLUE)
##WIN32##K4GLUE=$(K4_GLUE)

##WIN32##RCFLAGS=$(CPPFLAGS) -I$(SRCTOP) -D_WIN32 -DRES_ONLY

##WIN32##SRES=$(SLIB:.lib=.res)
##WIN32##CRES=$(CLIB:.lib=.res)
##WIN32##PRES=$(PLIB:.lib=.res)
##WIN32##KRES=$(KLIB:.lib=.res)
##WIN32##GRES=$(GLIB:.lib=.res)
##WIN32##K4RES=$(K4LIB:.lib=.res)

##WIN32##$(SRES): $(VERSIONRC)
##WIN32##	$(RC) $(RCFLAGS) -DSUPPORT_LIB -fo $@ -r $**
##WIN32##$(CRES): $(VERSIONRC)
##WIN32##	$(RC) $(RCFLAGS) -DCE_LIB -fo $@ -r $**
##WIN32##$(PRES): $(VERSIONRC)
##WIN32##	$(RC) $(RCFLAGS) -DPROF_LIB -fo $@ -r $**
##WIN32##$(KRES): $(KRB5RC)
##WIN32##	$(RC) $(RCFLAGS) -DKRB5_LIB -fo $@ -r $**
##WIN32##$(K4RES): $(VERSIONRC)
##WIN32##	$(RC) $(RCFLAGS) -DKRB4_LIB -fo $@ -r $**
##WIN32##$(GRES): $(VERSIONRC)
##WIN32##	$(RC) $(RCFLAGS) -DGSSAPI_LIB -fo $@ -r $**
##WIN32##$(KRB5RC): $(VERSIONRC)

##WIN32##$(SLIB): $(SDEF) $(SLIBS) $(SGLUE) $(SRES)
##WIN32##	link $(WINDLLFLAGS) -def:$(SDEF) -out:$*.dll \
##WIN32##	  $(SLIBS) $(SGLUE) $(SRES) $(WINLIBS) $(SCLIB)
##WIN32##        $(_VC_MANIFEST_EMBED_DLL)
##WIN32##$(SDEF): ..\util\support\libkrb5support.exports
##WIN32##	echo EXPORTS > $(SDEF).new
##WIN32##	type ..\util\support\libkrb5support.exports >> $(SDEF).new
##WIN32##	-$(RM) $(SDEF)
##WIN32##	ren $(SDEF).new $(SDEF)

##WIN32##$(CLIB): $(CDEF) $(CLIBS) $(CGLUE) $(CRES) $(SLIB)
##WIN32##	link $(WINDLLFLAGS) -def:$(CDEF) -out:$*.dll \
##WIN32##	  $(CLIBS) $(CGLUE) $(CRES) $(SLIB) $(WINLIBS) $(SCLIB)
##WIN32##	$(_VC_MANIFEST_EMBED_DLL)

##WIN32##$(PLIB): $(PDEF) $(PLIBS) $(PGLUE) $(PRES) $(CLIB) $(SLIB)
##WIN32##	link $(WINDLLFLAGS) -def:$(PDEF) -out:$*.dll \
##WIN32##	  $(PLIBS) $(PGLUE) $(PRES) $(CLIB) $(SLIB) $(WINLIBS)
##WIN32##	$(_VC_MANIFEST_EMBED_DLL)

##WIN32##$(KLIB): $(KDEF) $(KLIBS) $(KGLUE) $(KRES) $(CLIB) $(SLIB) $(MITLIBS) $(DNSLIBS)
##WIN32##	link $(WINDLLFLAGS) -def:$(KDEF) -out:$*.dll \
##WIN32##	  $(KLIBS) $(KGLUE) $(KRES) $(CLIB) $(SLIB) $(MITLIBS) $(DNSLIBS) $(WINLIBS) $(SCLIB)
##WIN32##	$(_VC_MANIFEST_EMBED_DLL)

##WIN32##$(GLIB): $(GDEF) $(GLIBS) $(GGLUE) $(GRES) $(KLIB) $(CLIB) $(SLIB)
##WIN32##	link $(WINDLLFLAGS) -def:$(GDEF) -out:$*.dll \
##WIN32##	  $(GLIBS) $(GGLUE) $(GRES) $(KLIB) $(CLIB) $(SLIB) $(WINLIBS) $(SCLIB)
##WIN32##		$(_VC_MANIFEST_EMBED_DLL)

##WIN32##$(K4LIB): $(K4DEF) $(K4LIBS) $(K4GLUE) $(K4RES) $(KLIB) $(CLIB) $(PLIB)
##WIN32##	link $(WINDLLFLAGS) -def:$(K4DEF) -out:$*.dll \
##WIN32##	  $(K4LIBS) $(K4GLUE) $(K4RES) $(KLIB) $(CLIB) $(PLIB) $(WINLIBS) $(SCLIB)
##WIN32##  	$(_VC_MANIFEST_EMBED_DLL)

##WIN32##$(K5_GLUE): win_glue.c
##WIN32##	$(CC) $(ALL_CFLAGS) $(MITFLAGS) /c /DKRB5=1 /Fo$@ $**
##WIN32##$(K4_GLUE): win_glue.c
##WIN32##	$(CC) $(ALL_CFLAGS) /c /DKRB4=1 /Fo$@ $**
##WIN32##$(GSS_GLUE): win_glue.c
##WIN32##	$(CC) $(ALL_CFLAGS) /c /DGSSAPI=1 /Fo$@ $**
##WIN32##$(COMERR_GLUE): win_glue.c
##WIN32##	$(CC) $(ALL_CFLAGS) /c /DCOMERR=1 /Fo$@ $**
##WIN32##$(PROF_GLUE): win_glue.c
##WIN32##	$(CC) $(ALL_CFLAGS) /c /DPROFILELIB=1 /Fo$@ $**
##WIN32##$(S_GLUE): win_glue.c
##WIN32##	$(CC) $(ALL_CFLAGS) /c /DSUPPORTLIB=1 /Fo$@ $**

##WIN32### Build Convenience
##WIN32##comerr.lib: $(CLIB)
##WIN32##krb4.lib:   $(K4LIB)
##WIN32##krb5.lib:   $(KLIB)
##WIN32##gssapi.lib: $(GLIB)
##WIN32##profile.lib: $(PLIB)

##WIN32##all-windows:: 
##WIN32##	@echo Making in lib\crypto
##WIN32##	cd crypto
##WIN32##	$(MAKE) -$(MFLAGS)
##WIN32##	@echo Making in lib\krb5
##WIN32##	cd ..\krb5
##WIN32##	$(MAKE) -$(MFLAGS)
##WIN32##	@echo Making in lib\des425
##WIN32##	cd ..\des425
##WIN32##	$(MAKE) -$(MFLAGS) 
##WIN32##	@echo Making in lib\krb4
##WIN32##	cd ..\krb4
##WIN32##	$(MAKE) -$(MFLAGS) 
##WIN32##	@echo Making in lib\gssapi
##WIN32##	cd ..\gssapi
##WIN32##	$(MAKE) -$(MFLAGS) 
##WIN32##	@echo Making in lib
##WIN32##	cd ..

##WIN32##all-windows:: lib-windows
##WIN32##lib-windows:: krb5.lib gssapi.lib krb4.lib 

##WIN32##clean-windows::
##WIN32##	@echo Making clean in lib\crypto
##WIN32##	cd crypto
##WIN32##	$(MAKE) -$(MFLAGS) clean
##WIN32##	@echo Making clean in lib\krb5
##WIN32##	cd ..\krb5
##WIN32##	$(MAKE) -$(MFLAGS) clean
##WIN32##	@echo Making clean in lib\des425
##WIN32##	cd ..\des425
##WIN32##	$(MAKE) -$(MFLAGS) clean
##WIN32##	@echo Making clean in lib\krb4
##WIN32##	cd ..\krb4
##WIN32##	$(MAKE) -$(MFLAGS) clean
##WIN32##	@echo Making clean in lib\gssapi
##WIN32##	cd ..\gssapi
##WIN32##	$(MAKE) -$(MFLAGS) clean
##WIN32##	@echo Making clean in lib
##WIN32##	cd ..