Added notes to the 'fsck' command documentation.

[libguestfs.git] / guestfs-actions.pod

diff --git a/guestfs-actions.pod b/guestfs-actions.pod
index 260cb4f..6fc51f0 100644 (file)
--- a/guestfs-actions.pod
+++ b/guestfs-actions.pod
@@ -582,6 +582,42 @@ particular that the filename is not prepended to the output
 This function returns a string, or NULL on error.
 I<The caller must free the returned string after use>.
 
 This function returns a string, or NULL on error.
 I<The caller must free the returned string after use>.
 

+=head2 guestfs_fsck
+
+ int guestfs_fsck (guestfs_h *handle,
+               const char *fstype,
+               const char *device);
+
+This runs the filesystem checker (fsck) on C<device> which
+should have filesystem type C<fstype>.
+
+The returned integer is the status.  See L<fsck(8)> for the
+list of status codes from C<fsck>.
+
+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<fsck -a -t fstype device>.
+
+On error this function returns -1.
+

 =head2 guestfs_get_autosync
 
  int guestfs_get_autosync (guestfs_h *handle);
 =head2 guestfs_get_autosync
 
  int guestfs_get_autosync (guestfs_h *handle);


@@ -1099,9 +1135,13 @@ This function returns 0 on success or -1 on error.
                int autosync);
 
 If C<autosync> is true, this enables autosync.  Libguestfs will make a
                int autosync);
 
 If C<autosync> is true, this enables autosync.  Libguestfs will make a

-best effort attempt to run C<guestfs_sync> when the handle is closed
+best effort attempt to run C<guestfs_umount_all> followed by
+C<guestfs_sync> when the handle is closed

 (also if the program exits without closing handles).
 
 (also if the program exits without closing handles).
 

+This is disabled by default (except in guestfish where it is
+enabled by default).
+

 This function returns 0 on success or -1 on error.
 
 =head2 guestfs_set_busy
 This function returns 0 on success or -1 on error.
 
 =head2 guestfs_set_busy


@@ -1484,3 +1524,16 @@ Because of the message protocol, there is a transfer limit
 of somewhere between 2MB and 4MB.  To transfer large files you should use
 FTP.
 
 of somewhere between 2MB and 4MB.  To transfer large files you should use
 FTP.
 

+=head2 guestfs_zero
+
+ int guestfs_zero (guestfs_h *handle,
+               const char *device);
+
+This command writes zeroes over the first few blocks of C<device>.
+
+How many blocks are zeroed isn't specified (but it's I<not> enough
+to securely wipe the device).  It should be sufficient to remove
+any partition tables, filesystem superblocks and so on.
+
+This function returns 0 on success or -1 on error.
+