Implementations of 'cat', 'ls', and some cleanups.

[libguestfs.git] / guestfs-actions.pod

diff --git a/guestfs-actions.pod b/guestfs-actions.pod
index 352760d..eec6697 100644 (file)
--- a/guestfs-actions.pod
+++ b/guestfs-actions.pod
@@ -5,6 +5,11 @@
 
 Return the contents of the file named C<path>.
 
+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<guestfs_read>
+function which has a more complex interface.
+
 This function returns a string or NULL on error.  The caller
 must free the returned string after use.
 
@@ -35,7 +40,8 @@ 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 command is mostly useful for interactive sessions.  Programs
+should probably use C<guestfs_readdir> instead.
 
 This function returns a NULL-terminated array of strings
 (like L<environ(3)>), or NULL if there was an error.