summaryrefslogtreecommitdiffstats
path: root/guestfs-actions.pod
diff options
context:
space:
mode:
authorRichard Jones <rjones@redhat.com>2009-04-06 11:44:48 +0100
committerRichard Jones <rjones@redhat.com>2009-04-06 11:44:48 +0100
commit1cf85b1e60e85c4940869c6291d75ac44a5bd190 (patch)
tree1ee9a499264042801ffd73f4c999a48a5535973b /guestfs-actions.pod
parentbf17bf81fef275892d24458ce5f1e5290b426742 (diff)
downloadlibguestfs-1cf85b1e60e85c4940869c6291d75ac44a5bd190.tar.gz
libguestfs-1cf85b1e60e85c4940869c6291d75ac44a5bd190.tar.xz
libguestfs-1cf85b1e60e85c4940869c6291d75ac44a5bd190.zip
Implementations of 'cat', 'ls', and some cleanups.
Diffstat (limited to 'guestfs-actions.pod')
-rw-r--r--guestfs-actions.pod8
1 files changed, 7 insertions, 1 deletions
diff --git a/guestfs-actions.pod b/guestfs-actions.pod
index 352760dd..eec66977 100644
--- 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.