X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=guestfish-actions.pod;h=87ba0181e5dce772446e3ed9eabce8d878c8a3f0;hp=4ff574fbdb6734a810f4954fada7c5b825d60a61;hb=713283f4a67b3a1960ca96ce6608d046fc202d2d;hpb=228e71fe10128c6f91a6935e6b148c49801bb17f diff --git a/guestfish-actions.pod b/guestfish-actions.pod index 4ff574f..87ba018 100644 --- a/guestfish-actions.pod +++ b/guestfish-actions.pod @@ -29,7 +29,7 @@ This is equivalent to the qemu parameter C<-drive file=filename>. Close the current Augeas handle and free up any resources used by it. After calling this, you have to call -C again before you can use any other +C again before you can use any other Augeas functions. =head2 aug-defnode @@ -40,7 +40,7 @@ Defines a variable C whose value is the result of evaluating C. If C evaluates to an empty nodeset, a node is created, -equivalent to calling C C, C. +equivalent to calling C C, C. C will be the nodeset containing that single node. On success this returns a pair containing the @@ -73,7 +73,7 @@ Create a new Augeas handle for editing configuration files. If there was any previous Augeas handle associated with this guestfs session, then it is closed. -You must call this before using any other C +You must call this before using any other C commands. C is the filesystem root. C must not be NULL, @@ -108,11 +108,11 @@ Make save a no-op, just record what would have been changed. =item C = 32 -Do not load the tree in C. +Do not load the tree in C. =back -To close the handle, you can call C. +To close the handle, you can call C. To find out more about Augeas, see L. @@ -141,7 +141,7 @@ details. aug-ls path -This is just a shortcut for listing C +This is just a shortcut for listing C C and sorting the resulting nodes into alphabetical order. =head2 aug-match @@ -173,7 +173,7 @@ On success this returns the number of entries which were removed. This writes all pending changes to disk. -The flags which were passed to C affect exactly +The flags which were passed to C affect exactly how files are saved. =head2 aug-set @@ -217,7 +217,7 @@ This uses the L command. This returns the size of the device in bytes. -See also C. +See also C. This uses the L command. @@ -228,7 +228,7 @@ This uses the L command. This returns the size of sectors on a block device. Usually 512, but can be larger for modern devices. -(Note, this is not the size in sectors, use C +(Note, this is not the size in sectors, use C for that). This uses the L command. @@ -240,8 +240,8 @@ This uses the L command. This returns the size of the device in units of 512-byte sectors (even if the sectorsize isn't 512 bytes ... weird). -See also C for the real sector size of -the device, and C for the more +See also C for the real sector size of +the device, and C for the more useful I. This uses the L command. @@ -423,7 +423,7 @@ Use C<-> instead of a filename to read/write from stdin/stdout. This returns C if and only if there is a file, directory (or anything) with the given C name. -See also C, C, C. +See also C, C, C. =head2 file @@ -627,7 +627,7 @@ of the L command. This returns a list of the logical volume device names (eg. C). -See also C. +See also C. =head2 lvs-full @@ -678,6 +678,29 @@ on the underlying device. The filesystem options C and C are set with this call, in order to improve reliability. +=head2 mount-options + + mount-options options device mountpoint + +This is the same as the C command, but it +allows you to set the mount options as for the +L I<-o> flag. + +=head2 mount-ro + + mount-ro device mountpoint + +This is the same as the C command, but it +mounts the filesystem with the read-only (I<-o ro>) flag. + +=head2 mount-vfs + + mount-vfs options vfstype device mountpoint + +This is the same as the C command, but it +allows you to set both the mount options and the vfstype +as for the L I<-o> and I<-t> flags. + =head2 mounts mounts @@ -705,7 +728,7 @@ of the L command. This returns a list of just the device names that contain PVs (eg. C). -See also C. +See also C. =head2 pvs-full @@ -725,7 +748,7 @@ C and C character sequences are I returned. Note that this function cannot correctly handle binary files (specifically, files containing C<\0> character which is treated -as end of line). For those you need to use the C +as end of line). For those you need to use the C function which has a more complex interface. =head2 rm @@ -858,7 +881,7 @@ closing the handle. This command uploads and unpacks local file C (an I tar file) into C. -To upload a compressed tarball, use C. +To upload a compressed tarball, use C. Use C<-> instead of a filename to read/write from stdin/stdout. @@ -869,7 +892,7 @@ Use C<-> instead of a filename to read/write from stdin/stdout. This command packs the contents of C and downloads it to local file C. -To download a compressed tarball, use C. +To download a compressed tarball, use C. Use C<-> instead of a filename to read/write from stdin/stdout. @@ -880,7 +903,7 @@ Use C<-> instead of a filename to read/write from stdin/stdout. This command uploads and unpacks local file C (a I tar file) into C. -To upload an uncompressed tarball, use C. +To upload an uncompressed tarball, use C. Use C<-> instead of a filename to read/write from stdin/stdout. @@ -891,7 +914,7 @@ Use C<-> instead of a filename to read/write from stdin/stdout. This command packs the contents of C and downloads it to local file C. -To download an uncompressed tarball, use C. +To download an uncompressed tarball, use C. Use C<-> instead of a filename to read/write from stdin/stdout. @@ -961,7 +984,7 @@ of the L command. This returns a list of just the volume group names that were detected (eg. C). -See also C. +See also C. =head2 vgs-full