X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=perl%2Flib%2FSys%2FGuestfs.pm;h=63a49259320e6d79f9ebc733a28f765a9255cab8;hp=d16077e52b5bd89a22f26c8c1f8c2a19557a9763;hb=9222136ac9b2e404dba128b1ac74dacaa8bf1038;hpb=0232e722826cfda0f6042da983f9eb871f24e946
diff --git a/perl/lib/Sys/Guestfs.pm b/perl/lib/Sys/Guestfs.pm
index d16077e..63a4925 100644
--- a/perl/lib/Sys/Guestfs.pm
+++ b/perl/lib/Sys/Guestfs.pm
@@ -432,6 +432,26 @@ The first character of C string must be a C<-> (dash).
C can be NULL.
+=item $h->cp ($src, $dest);
+
+This copies a file from C to C where C is
+either a destination filename or destination directory.
+
+=item $h->cp_a ($src, $dest);
+
+This copies a file or directory from C to C
+recursively using the C command.
+
+=item $result = $h->debug ($subcmd, \@extraargs);
+
+The C<$h-Edebug> command exposes some internals of
+C (the guestfs daemon) that runs inside the
+qemu subprocess.
+
+There is no comprehensive help for this command. You have
+to look at the file C in the libguestfs source
+to find out what you can do.
+
=item $h->download ($remotefilename, $filename);
Download file C and save it as C
@@ -441,6 +461,18 @@ C can also be a named pipe.
See also C<$h-Eupload>, C<$h-Ecat>.
+=item $h->drop_caches ($whattodrop);
+
+This instructs the guest kernel to drop its page cache,
+and/or dentries and inode caches. The parameter C
+tells the kernel what precisely to drop, see
+L
+
+Setting C to 3 should drop everything.
+
+This automatically calls L before the operation,
+so that the maximum guest memory is freed.
+
=item $existsflag = $h->exists ($path);
This returns C if and only if there is a file, directory
@@ -458,10 +490,50 @@ The exact command which runs is C. Note in
particular that the filename is not prepended to the output
(the C<-b> option).
+=item $status = $h->fsck ($fstype, $device);
+
+This runs the filesystem checker (fsck) on C which
+should have filesystem type C.
+
+The returned integer is the status. See L for the
+list of status codes from C.
+
+Notes:
+
+=over 4
+
+=item *
+
+Multiple status codes can be summed together.
+
+=item *
+
+A non-zero return code can mean "success", for example if
+errors have been corrected on the filesystem.
+
+=item *
+
+Checking or repairing NTFS volumes is not supported
+(by linux-ntfs).
+
+=back
+
+This command is entirely equivalent to running C.
+
=item $autosync = $h->get_autosync ();
Get the autosync flag.
+=item $label = $h->get_e2label ($device);
+
+This returns the ext2/3/4 filesystem label of the filesystem on
+C.
+
+=item $uuid = $h->get_e2uuid ($device);
+
+This returns the ext2/3/4 filesystem UUID of the filesystem on
+C.
+
=item $path = $h->get_path ();
Return the current search path.
@@ -469,6 +541,13 @@ Return the current search path.
This is always non-NULL. If it wasn't set already, then this will
return the default path.
+=item $qemu = $h->get_qemu ();
+
+Return the current qemu binary.
+
+This is always non-NULL. If it wasn't set already, then this will
+return the default qemu binary name.
+
=item $state = $h->get_state ();
This returns the current state as an opaque integer. This is
@@ -480,6 +559,11 @@ For more information on states, see L.
This returns the verbose messages flag.
+=item $h->grub_install ($root, $device);
+
+This command installs GRUB (the Grand Unified Bootloader) on
+C, with the root directory being C.
+
=item $busy = $h->is_busy ();
This returns true iff this handle is busy processing a command
@@ -591,6 +675,14 @@ and physical volumes.
B.
+=item $h->lvremove ($device);
+
+Remove an LVM logical volume C, where C is
+the path to the LV, such as C.
+
+You can also remove all LVs in a volume group by specifying
+the VG name, C.
+
=item @logvols = $h->lvs ();
List all the logical volumes detected. This is the equivalent
@@ -640,6 +732,23 @@ on the underlying device.
The filesystem options C and C are set with this
call, in order to improve reliability.
+=item $h->mount_options ($options, $device, $mountpoint);
+
+This is the same as the C<$h-Emount> command, but it
+allows you to set the mount options as for the
+L I<-o> flag.
+
+=item $h->mount_ro ($device, $mountpoint);
+
+This is the same as the C<$h-Emount> command, but it
+mounts the filesystem with the read-only (I<-o ro>) flag.
+
+=item $h->mount_vfs ($options, $vfstype, $device, $mountpoint);
+
+This is the same as the C<$h-Emount> command, but it
+allows you to set both the mount options and the vfstype
+as for the L I<-o> and I<-t> flags.
+
=item @devices = $h->mounts ();
This returns the list of currently mounted filesystems. It returns
@@ -647,12 +756,26 @@ the list of devices (eg. C, C).
Some internal mounts are not shown.
+=item $h->mv ($src, $dest);
+
+This moves a file from C to C where C is
+either a destination filename or destination directory.
+
=item $h->pvcreate ($device);
This creates an LVM physical volume on the named C,
where C should usually be a partition name such
as C.
+=item $h->pvremove ($device);
+
+This wipes a physical volume C so that LVM will no longer
+recognise it.
+
+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 @physvols = $h->pvs ();
List all the physical volumes detected. This is the equivalent
@@ -697,9 +820,13 @@ Remove the single directory C.
=item $h->set_autosync ($autosync);
If C is true, this enables autosync. Libguestfs will make a
-best effort attempt to run C<$h-Esync> when the handle is closed
+best effort attempt to run C<$h-Eumount_all> followed by
+C<$h-Esync> when the handle is closed
(also if the program exits without closing handles).
+This is disabled by default (except in guestfish where it is
+enabled by default).
+
=item $h->set_busy ();
This sets the state to C. This is only used when implementing
@@ -707,6 +834,25 @@ actions using the low-level API.
For more information on states, see L.
+=item $h->set_e2label ($device, $label);
+
+This sets the ext2/3/4 filesystem label of the filesystem on
+C to C