Implement simple lvs/vgs/pvs commands.

[libguestfs.git] / guestfs-actions.pod

diff --git a/guestfs-actions.pod b/guestfs-actions.pod
index a2a19ba..eb3898a 100644 (file)
--- a/guestfs-actions.pod
+++ b/guestfs-actions.pod
@@ -77,11 +77,27 @@ I<The caller must free the strings and the array after use>.
 
 =head2 guestfs_lvs
 
- struct guestfs_lvm_lv_list *guestfs_lvs (guestfs_h *handle);
+ char **guestfs_lvs (guestfs_h *handle);
 
 List all the logical volumes detected.  This is the equivalent
 of the L<lvs(8)> command.
 
+This returns a list of the logical volume device names
+(eg. C</dev/VolGroup00/LogVol00>).
+
+See also C<guestfs_lvs_full>.
+
+This function returns a NULL-terminated array of strings
+(like L<environ(3)>), or NULL if there was an error.
+I<The caller must free the strings and the array after use>.
+
+=head2 guestfs_lvs_full
+
+ struct guestfs_lvm_lv_list *guestfs_lvs_full (guestfs_h *handle);
+
+List all the logical volumes detected.  This is the equivalent
+of the L<lvs(8)> command.  The "full" version includes all fields.
+
 This function returns a C<struct guestfs_lvm_lv_list>.
 I<The caller must call C<guestfs_free_lvm_lv_list> after use.>.
 
@@ -112,11 +128,27 @@ This function returns 0 on success or -1 on error.
 
 =head2 guestfs_pvs
 
- struct guestfs_lvm_pv_list *guestfs_pvs (guestfs_h *handle);
+ char **guestfs_pvs (guestfs_h *handle);
 
 List all the physical volumes detected.  This is the equivalent
 of the L<pvs(8)> command.
 
+This returns a list of just the device names that contain
+PVs (eg. C</dev/sda2>).
+
+See also C<guestfs_pvs_full>.
+
+This function returns a NULL-terminated array of strings
+(like L<environ(3)>), or NULL if there was an error.
+I<The caller must free the strings and the array after use>.
+
+=head2 guestfs_pvs_full
+
+ struct guestfs_lvm_pv_list *guestfs_pvs_full (guestfs_h *handle);
+
+List all the physical volumes detected.  This is the equivalent
+of the L<pvs(8)> command.  The "full" version includes all fields.
+
 This function returns a C<struct guestfs_lvm_pv_list>.
 I<The caller must call C<guestfs_free_lvm_pv_list> after use.>.
 
@@ -145,11 +177,27 @@ This function returns 0 on success or -1 on error.
 
 =head2 guestfs_vgs
 
- struct guestfs_lvm_vg_list *guestfs_vgs (guestfs_h *handle);
+ char **guestfs_vgs (guestfs_h *handle);
 
 List all the volumes groups detected.  This is the equivalent
 of the L<vgs(8)> command.
 
+This returns a list of just the volume group names that were
+detected (eg. C<VolGroup00>).
+
+See also C<guestfs_vgs_full>.
+
+This function returns a NULL-terminated array of strings
+(like L<environ(3)>), or NULL if there was an error.
+I<The caller must free the strings and the array after use>.
+
+=head2 guestfs_vgs_full
+
+ struct guestfs_lvm_vg_list *guestfs_vgs_full (guestfs_h *handle);
+
+List all the volumes groups detected.  This is the equivalent
+of the L<vgs(8)> command.  The "full" version includes all fields.
+
 This function returns a C<struct guestfs_lvm_vg_list>.
 I<The caller must call C<guestfs_free_lvm_vg_list> after use.>.