Implement RString and RStringList return types.

[libguestfs.git] / guestfs-actions.pod

diff --git a/guestfs-actions.pod b/guestfs-actions.pod
index 0eb2483..352760d 100644 (file)
--- a/guestfs-actions.pod
+++ b/guestfs-actions.pod
@@ -1,6 +1,52 @@
+=head2 guestfs_cat
+
+ char *guestfs_cat (guestfs_h *handle,
+               const char *path);
+
+Return the contents of the file named C<path>.
+
+This function returns a string or NULL on error.  The caller
+must free the returned string after use.
+
+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_ll
+
+ char *guestfs_ll (guestfs_h *handle,
+               const char *directory);
+
+List the files in C<directory> (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<not> intended that you try to parse the output string.
+
+This function returns a string or NULL on error.  The caller
+must free the returned string after use.
+
+=head2 guestfs_ls
+
+ char **guestfs_ls (guestfs_h *handle,
+               const char *directory);
+
+List the files in C<directory> (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.
+
+This function returns a NULL-terminated array of strings
+(like L<environ(3)>), or NULL if there was an error.
+
+The caller must free the strings I<and> the array after use.
+

 =head2 guestfs_mount
 
 =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</dev/sda>, C</dev/sdb> and so on, as they were added to
 
 Mount a guest disk at a position in the filesystem.  Block devices
 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to


@@ -13,6 +59,14 @@ first be mounted on C</> before others can be mounted.  Other
 filesystems can only be mounted on directories which already
 exist.
 
 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<sync> and C<noatime> are set with this
+call, in order to improve reliability.
+
+This function returns 0 on success or -1 on error.
+

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


@@ -23,11 +77,16 @@ underlying disk image.
 You should always call this if you have modified a disk image, before
 calling C<guestfs_close>.
 
 You should always call this if you have modified a disk image, before
 calling C<guestfs_close>.
 

+This function returns 0 on success or -1 on error.
+

 =head2 guestfs_touch
 
 =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<touch(1)> command.  It can be used to
 
 Touch acts like the L<touch(1)> 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.
 
 to create a new zero-length file.
 

+This function returns 0 on success or -1 on error.
+