3 char *guestfs_cat (guestfs_h *handle,
6 Return the contents of the file named C<path>.
8 Note that this function cannot correctly handle binary files
9 (specifically, files containing C<\0> character which is treated
10 as end of string). For those you need to use the C<guestfs_read>
11 function which has a more complex interface.
13 This function returns a string or NULL on error. The caller
14 must free the returned string after use.
16 Because of the message protocol, there is a transfer limit
17 of somewhere between 2MB and 4MB. To transfer large files you should use
22 char *guestfs_ll (guestfs_h *handle,
23 const char *directory);
25 List the files in C<directory> (relative to the root directory,
26 there is no cwd) in the format of 'ls -la'.
28 This command is mostly useful for interactive sessions. It
29 is I<not> intended that you try to parse the output string.
31 This function returns a string or NULL on error. The caller
32 must free the returned string after use.
36 char **guestfs_ls (guestfs_h *handle,
37 const char *directory);
39 List the files in C<directory> (relative to the root directory,
40 there is no cwd). The '.' and '..' entries are not returned, but
41 hidden files are shown.
43 This command is mostly useful for interactive sessions. Programs
44 should probably use C<guestfs_readdir> instead.
46 This function returns a NULL-terminated array of strings
47 (like L<environ(3)>), or NULL if there was an error.
49 The caller must free the strings I<and> the array after use.
53 int guestfs_mount (guestfs_h *handle,
55 const char *mountpoint);
57 Mount a guest disk at a position in the filesystem. Block devices
58 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
59 the guest. If those block devices contain partitions, they will have
60 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
63 The rules are the same as for L<mount(2)>: A filesystem must
64 first be mounted on C</> before others can be mounted. Other
65 filesystems can only be mounted on directories which already
68 The mounted filesystem is writable, if we have sufficient permissions
69 on the underlying device.
71 The filesystem options C<sync> and C<noatime> are set with this
72 call, in order to improve reliability.
74 This function returns 0 on success or -1 on error.
78 int guestfs_sync (guestfs_h *handle);
80 This syncs the disk, so that any writes are flushed through to the
81 underlying disk image.
83 You should always call this if you have modified a disk image, before
84 calling C<guestfs_close>.
86 This function returns 0 on success or -1 on error.
90 int guestfs_touch (guestfs_h *handle,
93 Touch acts like the L<touch(1)> command. It can be used to
94 update the timestamps on a file, or, if the file does not exist,
95 to create a new zero-length file.
97 This function returns 0 on success or -1 on error.