X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;ds=inline;f=perl%2Flib%2FSys%2FGuestfs.pm;h=5aac2e91c9a78c9b2ce6198659278d7a2fc58fe0;hb=15e0fd573a87488c66cb3a6f0da01f3ab5f2f6ed;hp=ad200881834d8ef628c1ee438d5242535da83801;hpb=24ccbb29ac475187f51a27dcd318db2b4824a0c1;p=libguestfs.git
diff --git a/perl/lib/Sys/Guestfs.pm b/perl/lib/Sys/Guestfs.pm
index ad20088..5aac2e9 100644
--- a/perl/lib/Sys/Guestfs.pm
+++ b/perl/lib/Sys/Guestfs.pm
@@ -432,6 +432,37 @@ 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 $kmsgs = $h->dmesg ();
+
+This returns the kernel messages (C output) from
+the guest kernel. This is sometimes useful for extended
+debugging of problems.
+
+Another way to get the same information is to enable
+verbose messages with C<$h-Eset_verbose> or by setting
+the environment variable C before
+running the program.
+
=item $h->download ($remotefilename, $filename);
Download file C and save it as C
@@ -441,6 +472,33 @@ 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 $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
+true if their content is exactly equal, or false otherwise.
+
+The external L program is used for the comparison.
+
=item $existsflag = $h->exists ($path);
This returns C if and only if there is a file, directory
@@ -458,10 +516,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 +567,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 +585,20 @@ 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 $dump = $h->hexdump ($path);
+
+This runs C on the given C. The result is
+the human-readable, canonical hex dump of the file.
+
+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 $busy = $h->is_busy ();
This returns true iff this handle is busy processing a command
@@ -591,6 +710,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
@@ -618,7 +745,7 @@ as necessary. This is like the C shell command.
=item $h->mkfs ($fstype, $device);
This creates a filesystem on C (usually a partition
-of LVM logical volume). The filesystem type is C, for
+or LVM logical volume). The filesystem type is C, for
example C.
=item $h->mount ($device, $mountpoint);
@@ -640,6 +767,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 +791,33 @@ 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->ping_daemon ();
+
+This is a test probe into the guestfs daemon running inside
+the qemu subprocess. Calling this function checks that the
+daemon responds to the ping message, without affecting the daemon
+or attached block device(s) in any other way.
+
=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 +862,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 +876,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