X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=guestfish-actions.pod;h=62be2a918ac30970d20e5e1dcf40f83cca0e02c2;hp=a79e33638160aeb7eccff181024ea4d61d50b2e8;hb=60258700e81a6a68875496f365d9f9cec19c8df2;hpb=8f9f02d483b87c787d089cf9329f5f1b81d3a77e
diff --git a/guestfish-actions.pod b/guestfish-actions.pod
index a79e336..62be2a9 100644
--- a/guestfish-actions.pod
+++ b/guestfish-actions.pod
@@ -403,6 +403,20 @@ The first character of C string must be a C<-> (dash).
C can be NULL.
+=head2 cp
+
+ cp src dest
+
+This copies a file from C to C where C is
+either a destination filename or destination directory.
+
+=head2 cp-a
+
+ cp-a src dest
+
+This copies a file or directory from C to C
+recursively using the C command.
+
=head2 debug
debug subcmd 'extraargs ...'
@@ -415,6 +429,19 @@ 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.
+=head2 dmesg
+
+ 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 or by setting
+the environment variable C before
+running the program.
+
=head2 download
download remotefilename (filename|-)
@@ -428,6 +455,29 @@ See also C, C.
Use C<-> instead of a filename to read/write from stdin/stdout.
+=head2 drop-caches
+
+ 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.
+
+=head2 equal
+
+ 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.
+
=head2 exists
exists path
@@ -449,12 +499,58 @@ The exact command which runs is C. Note in
particular that the filename is not prepended to the output
(the C<-b> option).
+=head2 fsck
+
+ 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.
+
=head2 get-autosync
get-autosync
Get the autosync flag.
+=head2 get-e2label
+
+ get-e2label device
+
+This returns the ext2/3/4 filesystem label of the filesystem on
+C.
+
+=head2 get-e2uuid
+
+ get-e2uuid device
+
+This returns the ext2/3/4 filesystem UUID of the filesystem on
+C.
+
=head2 get-path
get-path
@@ -488,6 +584,13 @@ For more information on states, see L.
This returns the verbose messages flag.
+=head2 grub-install
+
+ grub-install root device
+
+This command installs GRUB (the Grand Unified Bootloader) on
+C, with the root directory being C.
+
=head2 is-busy
is-busy
@@ -629,6 +732,16 @@ and physical volumes.
B.
+=head2 lvremove
+
+ 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.
+
=head2 lvs
lvs
@@ -666,7 +779,7 @@ as necessary. This is like the C shell command.
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.
=head2 mount
@@ -722,6 +835,22 @@ the list of devices (eg. C, C).
Some internal mounts are not shown.
+=head2 mv
+
+ mv src dest
+
+This moves a file from C to C where C is
+either a destination filename or destination directory.
+
+=head2 ping-daemon
+
+ 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.
+
=head2 pvcreate
pvcreate device
@@ -730,6 +859,17 @@ This creates an LVM physical volume on the named C,
where C should usually be a partition name such
as C.
+=head2 pvremove
+
+ 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.
+
=head2 pvs
pvs
@@ -788,9 +928,36 @@ Remove the single directory C.
set-autosync true|false
If C is true, this enables autosync. Libguestfs will make a
-best effort attempt to run C when the handle is closed
+best effort attempt to run C followed by
+C 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).
+
+=head2 set-e2label
+
+ set-e2label device label
+
+This sets the ext2/3/4 filesystem label of the filesystem on
+C to C