X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=guestfs-actions.pod;h=1dce3f33afd66e305d2847efc0e1b1958d1d7575;hb=b5ff6816face6f8c1700d4f1df752c710620ff95;hp=0eb24838a5110c9f6b8b8c81afda4716d2eee98c;hpb=8d0068a752ee8e6bc223de5cb7cac5d190a8855e;p=libguestfs.git diff --git a/guestfs-actions.pod b/guestfs-actions.pod index 0eb2483..1dce3f3 100644 --- a/guestfs-actions.pod +++ b/guestfs-actions.pod @@ -1,6 +1,110 @@ +=head2 guestfs_cat + + char *guestfs_cat (guestfs_h *handle, + const char *path); + +Return the contents of the file named C. + +Note that this function cannot correctly handle binary files +(specifically, files containing C<\0> character which is treated +as end of string). For those you need to use the C +function which has a more complex interface. + +This function returns a string or NULL on error. +I. + +Because of the message protocol, there is a transfer limit +of somewhere between 2MB and 4MB. To transfer large files you should use +FTP. + +=head2 guestfs_list_devices + + char **guestfs_list_devices (guestfs_h *handle); + +List all the block devices. + +The full block device names are returned, eg. C + +This function returns a NULL-terminated array of strings +(like L), or NULL if there was an error. +I. + +=head2 guestfs_list_partitions + + char **guestfs_list_partitions (guestfs_h *handle); + +List all the partitions detected on all block devices. + +The full partition device names are returned, eg. C + +This does not return logical volumes. For that you will need to +call C. + +This function returns a NULL-terminated array of strings +(like L), or NULL if there was an error. +I. + +=head2 guestfs_ll + + char *guestfs_ll (guestfs_h *handle, + const char *directory); + +List the files in C (relative to the root directory, +there is no cwd) in the format of 'ls -la'. + +This command is mostly useful for interactive sessions. It +is I intended that you try to parse the output string. + +This function returns a string or NULL on error. +I. + +=head2 guestfs_ls + + char **guestfs_ls (guestfs_h *handle, + const char *directory); + +List the files in C (relative to the root directory, +there is no cwd). The '.' and '..' entries are not returned, but +hidden files are shown. + +This command is mostly useful for interactive sessions. Programs +should probably use C instead. + +This function returns a NULL-terminated array of strings +(like L), or NULL if there was an error. +I. + +=head2 guestfs_lvs + + char **guestfs_lvs (guestfs_h *handle); + +List all the logical volumes detected. This is the equivalent +of the L command. + +This returns a list of the logical volume device names +(eg. C). + +See also C. + +This function returns a NULL-terminated array of strings +(like L), or NULL if there was an error. +I. + +=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 command. The "full" version includes all fields. + +This function returns a C. +I after use.>. + =head2 guestfs_mount - int guestfs_mount (guestfs_h *handle, const char *device, const char *mountpoint); + int guestfs_mount (guestfs_h *handle, + const char *device, + const char *mountpoint); Mount a guest disk at a position in the filesystem. Block devices are named C, C and so on, as they were added to @@ -13,6 +117,40 @@ first be mounted on C before others can be mounted. Other filesystems can only be mounted on directories which already exist. +The mounted filesystem is writable, if we have sufficient permissions +on the underlying device. + +The filesystem options C and C are set with this +call, in order to improve reliability. + +This function returns 0 on success or -1 on error. + +=head2 guestfs_pvs + + char **guestfs_pvs (guestfs_h *handle); + +List all the physical volumes detected. This is the equivalent +of the L command. + +This returns a list of just the device names that contain +PVs (eg. C). + +See also C. + +This function returns a NULL-terminated array of strings +(like L), or NULL if there was an error. +I. + +=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 command. The "full" version includes all fields. + +This function returns a C. +I after use.>. + =head2 guestfs_sync int guestfs_sync (guestfs_h *handle); @@ -21,13 +159,44 @@ This syncs the disk, so that any writes are flushed through to the underlying disk image. You should always call this if you have modified a disk image, before -calling C. +closing the handle. + +This function returns 0 on success or -1 on error. =head2 guestfs_touch - int guestfs_touch (guestfs_h *handle, const char *path); + int guestfs_touch (guestfs_h *handle, + const char *path); Touch acts like the L command. It can be used to -update the filesystems on a file, or, if the file does not exist, +update the timestamps on a file, or, if the file does not exist, to create a new zero-length file. +This function returns 0 on success or -1 on error. + +=head2 guestfs_vgs + + char **guestfs_vgs (guestfs_h *handle); + +List all the volumes groups detected. This is the equivalent +of the L command. + +This returns a list of just the volume group names that were +detected (eg. C). + +See also C. + +This function returns a NULL-terminated array of strings +(like L), or NULL if there was an error. +I. + +=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 command. The "full" version includes all fields. + +This function returns a C. +I after use.>. +