X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=perl%2Flib%2FSys%2FGuestfs.pm;h=0249a412807f595eb080468bffc8380204131477;hp=d059ae42684100e48d6c6a546f95e61df87e8cb4;hb=5cd39c83e23eb300d1bdfa806902a31b409ff420;hpb=0faa5dde7b992ba11bb88f77b3424676c7c492e4 diff --git a/perl/lib/Sys/Guestfs.pm b/perl/lib/Sys/Guestfs.pm index d059ae4..0249a41 100644 --- a/perl/lib/Sys/Guestfs.pm +++ b/perl/lib/Sys/Guestfs.pm @@ -405,6 +405,13 @@ The first element is the name of the program to run. Subsequent elements are parameters. The list must be non-empty (ie. must contain a program name). +The return value is anything printed to I by +the command. + +If the command returns a non-zero exit status, then +this function returns an error message. The error message +string is the content of I from the command. + The C<$PATH> environment variable will contain at least C and C. If you require a program from another location, you should provide the full path in the @@ -416,11 +423,19 @@ correct places. It is the caller's responsibility to ensure all filesystems that are needed are mounted at the right locations. +Because of the message protocol, there is a transfer limit +of somewhere between 2MB and 4MB. To transfer large files you should use +FTP. + =item @lines = $h->command_lines (\@arguments); This is the same as C<$h-Ecommand>, but splits the result into a list of lines. +Because of the message protocol, there is a transfer limit +of somewhere between 2MB and 4MB. To transfer large files you should use +FTP. + =item $h->config ($qemuparam, $qemuvalue); This can be used to add arbitrary qemu command line parameters @@ -484,6 +499,14 @@ Setting C to 3 should drop everything. This automatically calls L before the operation, so that the maximum guest memory is freed. +=item $h->end_busy (); + +This sets the state to C, or if in C then it leaves the +state as is. This is only used when implementing +actions using the low-level API. + +For more information on states, see L. + =item $equality = $h->equal ($file1, $file2); This compares the two files C and C and returns @@ -538,6 +561,13 @@ Checking or repairing NTFS volumes is not supported This command is entirely equivalent to running C. +=item $append = $h->get_append (); + +Return the additional kernel options which are added to the +guest kernel command line. + +If C then no options are added. + =item $autosync = $h->get_autosync (); Get the autosync flag. @@ -810,6 +840,11 @@ The implementation uses the C command which refuses to wipe physical volumes that contain any volume groups, so you have to remove those first. +=item $h->pvresize ($device); + +This resizes (expands or shrinks) an existing LVM physical +volume to match the new size of the underlying device. + =item @physvols = $h->pvs (); List all the physical volumes detected. This is the equivalent @@ -851,6 +886,17 @@ command. Remove the single directory C. +=item $h->set_append ($append); + +This function is used to add additional options to the +guest kernel command line. + +The default is C unless overridden by setting +C environment variable. + +Setting C to C means I additional options +are passed (libguestfs always adds a few of its own). + =item $h->set_autosync ($autosync); If C is true, this enables autosync. Libguestfs will make a @@ -894,9 +940,6 @@ Set the path that libguestfs searches for kernel and initrd.img. The default is C<$libdir/guestfs> unless overridden by setting C environment variable. -The string C is stashed in the libguestfs handle, so the caller -must make sure it remains valid for the lifetime of the handle. - Setting C to C restores the default path. =item $h->set_qemu ($qemu); @@ -909,9 +952,6 @@ configure script. You can also override this by setting the C environment variable. -The string C is stashed in the libguestfs handle, so the caller -must make sure it remains valid for the lifetime of the handle. - Setting C to C restores the default qemu binary. =item $h->set_ready (); @@ -950,9 +990,45 @@ To create a single partition occupying the whole disk, you would pass C as a single element list, when the single element being the string C<,> (comma). +See also: C<$h-Esfdisk_l>, C<$h-Esfdisk_N> + B. +=item $h->sfdisk_N ($device, $n, $cyls, $heads, $sectors, $line); + +This runs L option to modify just the single +partition C (note: C counts from 1). + +For other parameters, see C<$h-Esfdisk>. You should usually +pass C<0> for the cyls/heads/sectors parameters. + +B. + +=item $partitions = $h->sfdisk_disk_geometry ($device); + +This displays the disk geometry of C read from the +partition table. Especially in the case where the underlying +block device has been resized, this can be different from the +kernel's idea of the geometry (see C<$h-Esfdisk_kernel_geometry>). + +The result is in human-readable format, and not designed to +be parsed. + +=item $partitions = $h->sfdisk_kernel_geometry ($device); + +This displays the kernel's idea of the geometry of C. + +The result is in human-readable format, and not designed to +be parsed. + +=item $partitions = $h->sfdisk_l ($device); + +This displays the partition table on C, in the +human-readable output of the L command. It is +not intended to be parsed. + =item %statbuf = $h->stat ($path); Returns file information for the given C. @@ -1127,6 +1203,19 @@ How many blocks are zeroed isn't specified (but it's I enough to securely wipe the device). It should be sufficient to remove any partition tables, filesystem superblocks and so on. +=item $h->zerofree ($device); + +This runs the I program on C. This program +claims to zero unused inodes and disk blocks on an ext2/3 +filesystem, thus making it possible to compress the filesystem +more effectively. + +You should B run this program if the filesystem is +mounted. + +It is possible that using this program can damage the filesystem +or data on the filesystem. + =cut 1;