X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=guestfish-actions.pod;h=62688eed114a46fa588ee08c0377647ac2f91595;hp=4ca02fdafd506b801b52b12ff1bc0b35d3f15a74;hb=41b959fd9b057354f642d84398b875d02b88b864;hpb=0d112d58af8b2c28de9ee4ae5b0ed3527757bdfe diff --git a/guestfish-actions.pod b/guestfish-actions.pod index 4ca02fd..62688ee 100644 --- a/guestfish-actions.pod +++ b/guestfish-actions.pod @@ -1,3 +1,286 @@ +=head2 add-cdrom | cdrom + + add-cdrom filename + +This function adds a virtual CD-ROM disk image to the guest. + +This is equivalent to the qemu parameter C<-cdrom filename>. + +=head2 add-drive | add + + add-drive filename + +This function adds a virtual machine disk image C to the +guest. The first time you call this function, the disk appears as IDE +disk 0 (C) in the guest, the second time as C, and +so on. + +You don't necessarily need to be root when using libguestfs. However +you obviously do need sufficient permissions to access the filename +for whatever operations you want to perform (ie. read access if you +just want to read the image or write access if you want to modify the +image). + +This is equivalent to the qemu parameter C<-drive file=filename>. + +=head2 aug-close + + aug-close + +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 +Augeas functions. + +=head2 aug-defnode + + aug-defnode name expr val + +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. +C will be the nodeset containing that single node. + +On success this returns a pair containing the +number of nodes in the nodeset, and a boolean flag +if a node was created. + +=head2 aug-defvar + + aug-defvar name expr + +Defines an Augeas variable C whose value is the result +of evaluating C. If C is NULL, then C is +undefined. + +On success this returns the number of nodes in C, or +C<0> if C evaluates to something which is not a nodeset. + +=head2 aug-get + + aug-get path + +Look up the value associated with C. If C +matches exactly one node, the C is returned. + +=head2 aug-init + + aug-init root flags + +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 +commands. + +C is the filesystem root. C must not be NULL, +use C instead. + +The flags are the same as the flags defined in +Eaugeas.hE, the logical I of the following +integers: + +=over 4 + +=item C = 1 + +Keep the original file with a C<.augsave> extension. + +=item C = 2 + +Save changes into a file with extension C<.augnew>, and +do not overwrite original. Overrides C. + +=item C = 4 + +Typecheck lenses (can be expensive). + +=item C = 8 + +Do not use standard load path for modules. + +=item C = 16 + +Make save a no-op, just record what would have been changed. + +=item C = 32 + +Do not load the tree in C. + +=back + +To close the handle, you can call C. + +To find out more about Augeas, see L. + +=head2 aug-insert + + aug-insert path label true|false + +Create a new sibling C