X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=fish%2Fguestfish.pod;h=5b641ead79389cc2242a6c39cdc6652288c3cda7;hp=7319bd72ee782a27fa171791a5471c5908f64754;hb=6cabc1cd02e181063596b48df55c3f6db51a6bb9;hpb=74f7c9e4b7e27787e2052166eeedfbac5814200b diff --git a/fish/guestfish.pod b/fish/guestfish.pod index 7319bd7..5b641ea 100644 --- a/fish/guestfish.pod +++ b/fish/guestfish.pod @@ -10,13 +10,13 @@ guestfish - the libguestfs Filesystem Interactive SHell guestfish - guestfish -a disk.img + guestfish [--ro|--rw] -a disk.img - guestfish -a disk.img -m dev[:mountpoint] + guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint] guestfish -d libvirt-domain - guestfish -a disk.img -i + guestfish [--ro|--rw] -a disk.img -i guestfish -d libvirt-domain -i @@ -99,7 +99,7 @@ Update C in a guest: Edit C interactively: - guestfish --add disk.img \ + guestfish --rw --add disk.img \ --mount /dev/vg_guest/lv_root \ --mount /dev/sda1:/boot \ edit /boot/grub/grub.conf @@ -115,7 +115,7 @@ disks from a virtual machine: Another way to edit C interactively is: - guestfish -a disk.img -i edit /boot/grub/grub.conf + guestfish --rw -a disk.img -i edit /boot/grub/grub.conf =head2 As a script interpreter @@ -140,7 +140,7 @@ To list what is available do: =head2 Remote control - eval `guestfish --listen` + eval "`guestfish --listen`" guestfish --remote add-ro disk.img guestfish --remote run guestfish --remote lvs @@ -153,34 +153,61 @@ To list what is available do: Displays general help on options. -=item B<-h> | B<--cmd-help> +=item B<-h> + +=item B<--cmd-help> Lists all available guestfish commands. -=item B<-h cmd> | B<--cmd-help cmd> +=item B<-h cmd> + +=item B<--cmd-help cmd> Displays detailed help on a single command C. -=item B<-a image> | B<--add image> +=item B<-a image> + +=item B<--add image> Add a block device or virtual machine image to the shell. The format of the disk image is auto-detected. To override this and force a particular format use the I<--format=..> option. -=item B<-c URI> | B<--connect URI> +Using this flag is mostly equivalent to using the C command, +with C if the I<--ro> flag was given, and +with C if the I<--format=...> flag was given. + +=item B<-c URI> + +=item B<--connect URI> When used in conjunction with the I<-d> option, this specifies the libvirt URI to use. The default is to use the default libvirt connection. -=item B<-d libvirt-domain> | B<--domain libvirt-domain> +=item B<--csh> + +If using the I<--listen> option and a csh-like shell, use this option. +See section L below. + +=item B<-d libvirt-domain> + +=item B<--domain libvirt-domain> Add disks from the named libvirt domain. If the I<--ro> option is also used, then any libvirt domain can be used. However in write mode, only libvirt domains which are shut down can be named here. -=item B<-D> | B<--no-dest-paths> +Domain UUIDs can be used instead of names. + +Using this flag is mostly equivalent to using the C command, +with C if the I<--ro> flag was given, and +with C if the I<--format:...> flag was given. + +=item B<-D> + +=item B<--no-dest-paths> Don't tab-complete paths on the guest filesystem. It is useful to be able to hit the tab key to complete paths on the guest filesystem, but @@ -194,14 +221,18 @@ echoing off so you cannot see what you are typing. If you are not worried about Tempest attacks and there is no one else in the room you can specify this flag to see what you are typing. -=item B<-f file> | B<--file file> +=item B<-f file> + +=item B<--file file> Read commands from C. To write pure guestfish scripts, use: #!/usr/bin/guestfish -f -=item B<--format=raw|qcow2|..> | B<--format> +=item B<--format=raw|qcow2|..> + +=item B<--format> The default for the I<-a> option is to auto-detect the format of the disk image. Using this forces the disk format for I<-a> options which @@ -224,7 +255,9 @@ this option to specify the disk format. This avoids a possible security problem with malicious guests (CVE-2010-3851). See also L. -=item B<-i> | B<--inspector> +=item B<-i> + +=item B<--inspector> Using L code, inspect the disks looking for an operating system and mount filesystems as they would be @@ -240,7 +273,7 @@ Typical usage is either: (for active domains, readonly), or specify the block device directly: - guestfish -a /dev/Guests/MyGuest -i + guestfish --rw -a /dev/Guests/MyGuest -i Note that the command line syntax changed slightly over older versions of guestfish. You can still use the old syntax: @@ -249,6 +282,10 @@ versions of guestfish. You can still use the old syntax: guestfish [--ro] -i libvirt-domain +Using this flag is mostly equivalent to using the C +command and then using other commands to mount the filesystems that +were found. + =item B<--keys-from-stdin> Read key or passphrase parameters from stdin. The default is @@ -259,7 +296,14 @@ to try to read passphrases from the user by opening C. Fork into the background and listen for remote commands. See section L below. -=item B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]> +=item B<--live> + +Connect to a live virtual machine. +(Experimental, see L). + +=item B<-m dev[:mountpoint[:options]]> + +=item B<--mount dev[:mountpoint[:options]]> Mount the named partition or logical volume on the given mountpoint. @@ -270,17 +314,36 @@ You have to mount something on C before most commands will work. If any I<-m> or I<--mount> options are given, the guest is automatically launched. -If you don't know what filesystems a disk image contains, you -can either run guestfish without this option, then list the partitions -and LVs available (see L and L commands), -or you can use the L program. +If you don't know what filesystems a disk image contains, you can +either run guestfish without this option, then list the partitions, +filesystems and LVs available (see L, +L and L commands), or you can use the +L program. -=item B<-n> | B<--no-sync> +The third (and rarely used) part of the mount parameter is the list of +mount options used to mount the underlying filesystem. If this is not +given, then the mount options are either the empty string or C +(the latter if the I<--ro> flag is used). By specifying the mount +options, you override this default choice. Probably the only time you +would use this is to enable ACLs and/or extended attributes if the +filesystem can support them: + + -m /dev/sda1:/:acl,user_xattr + +Using this flag is equivalent to using the C command. + +=item B<-n> + +=item B<--no-sync> Disable autosync. This is enabled by default. See the discussion of autosync in the L manpage. -=item B<-N type> | B<--new type> | B<-N help> +=item B<-N type> + +=item B<--new type> + +=item B<-N help> Prepare a fresh disk image formatted as "type". This is an alternative to the I<-a> option: whereas I<-a> adds an existing disk, @@ -303,31 +366,49 @@ Disable progress bars. Send remote commands to C<$GUESTFISH_PID> or C. See section L below. -=item B<-r> | B<--ro> +=item B<-r> -This changes the I<-a> and I<-m> options so that disks are added and -mounts are done read-only (see L). +=item B<--ro> + +This changes the I<-a>, I<-d> and I<-m> options so that disks are +added and mounts are done read-only. The option must always be used if the disk image or virtual machine might be running, and is generally recommended in cases where you don't need write access to the disk. Note that prepared disk images created with I<-N> are not affected by -the I<--ro> option. +this option. Also commands like C are not affected - you have to +specify the C option explicitly if you need it. + +See also L below. =item B<--selinux> Enable SELinux support for the guest. See L. -=item B<-v> | B<--verbose> +=item B<-v> + +=item B<--verbose> Enable very verbose messages. This is particularly useful if you find a bug. -=item B<-V> | B<--version> +=item B<-V> + +=item B<--version> Display the guestfish / libguestfs version number and exit. +=item B<-w> + +=item B<--rw> + +This changes the I<-a>, I<-d> and I<-m> options so that disks are +added and mounts are done read-write. + +See L below. + =item B<-x> Echo each command before executing it. @@ -387,6 +468,36 @@ I<-N> or I<--new> options were given then C is done automatically, simply because guestfish can't perform the action you asked for without doing this. +=head1 OPENING DISKS FOR READ AND WRITE + +The guestfish, L and L options I<--ro> +and I<--rw> affect whether the other command line options I<-a>, +I<-c>, I<-d>, I<-i> and I<-m> open disk images read-only or for +writing. + +In libguestfs E 1.10, guestfish, guestmount and virt-rescue +defaulted to opening disk images supplied on the command line for +write. To open a disk image read-only you have to do I<-a image --ro>. + +This matters: If you accidentally open a live VM disk image writable +then you will cause irreversible disk corruption. + +In a future libguestfs we intend to change the default the other way. +Disk images will be opened read-only. You will have to either specify +I, I, I, or change +the configuration file C in order to get +write access for disk images specified by those other command line +options. + +This version of guestfish, guestmount and virt-rescue has a I<--rw> +option which does nothing (it is already the default). However it is +highly recommended that you use this option to indicate that you need +write access, and prepare your scripts for the day when this option +will be required for write access. + +B This does I affect commands like L and L, +or any other libguestfs program apart from guestfish and guestmount. + =head1 QUOTING You can quote ordinary parameters using either single or double @@ -407,6 +518,64 @@ must be escaped with a backslash. command "/bin/echo 'foo bar'" command "/bin/echo \'foo\'" +=head2 ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS + +In double-quoted arguments (only) use backslash to insert special +characters: + +=over 4 + +=item C<\a> + +Alert (bell) character. + +=item C<\b> + +Backspace character. + +=item C<\f> + +Form feed character. + +=item C<\n> + +Newline character. + +=item C<\r> + +Carriage return character. + +=item C<\t> + +Horizontal tab character. + +=item C<\v> + +Vertical tab character. + +=item C<\"> + +A literal double quote character. + +=item C<\ooo> + +A character with octal value I. There must be precisely 3 octal +digits (unlike C). + +=item C<\xhh> + +A character with hex value I. There must be precisely 2 hex +digits. + +In the current implementation C<\000> and C<\x00> cannot be used +in strings. + +=item C<\\> + +A literal backslash character. + +=back + =head1 OPTIONAL ARGUMENTS Some commands take optional arguments. These arguments appear in this @@ -586,6 +755,32 @@ C. (See C). To change the local directory, use the C command. C will have no effect, due to the way that subprocesses work in Unix. +=head2 LOCAL COMMANDS WITH INLINE EXECUTION + +If a line starts with I!> then the shell command is executed (as +for I), but subsequently any output (stdout) of the shell command +is parsed and executed as guestfish commands. + +Thus you can use shell script to construct arbitrary guestfish +commands which are then parsed by guestfish. + +For example it is tedious to create a sequence of files +(eg. C through C) using guestfish commands +alone. However this is simple if we use a shell script to +create the guestfish commands for us: + + : + + > character so it is +just an ordinary I local command), see what guestfish commands it +would run, and when you are happy with those prepend the C> +character to run the guestfish commands for real. + =head1 PIPES Use CspaceE | command> to pipe the output of the @@ -663,19 +858,24 @@ on each one. Then you can close the mapper device: =head1 WINDOWS PATHS If a path is prefixed with C then you can use Windows-style -paths (with some limitations). The following commands are equivalent: +drive letters and paths (with some limitations). The following +commands are equivalent: file /WINDOWS/system32/config/system.LOG - file win:/windows/system32/config/system.log - file win:\windows\system32\config\system.log - file WIN:C:\Windows\SYSTEM32\conFIG\SYSTEM.LOG + file WIN:C:\Windows\SYSTEM32\CONFIG\SYSTEM.LOG + +The parameter is rewritten "behind the scenes" by looking up the +position where the drive is mounted, prepending that to the path, +changing all backslash characters to forward slash, then resolving the +result using L. For example if the E: drive +was mounted on C then the parameter might be rewritten like this: -This syntax implicitly calls C (q.v.) so it also -handles case insensitivity like Windows would. This only works in -argument positions that expect a path. + win:e:\foo\bar => /e/FOO/bar + +This only works in argument positions that expect a path. =head1 UPLOADING AND DOWNLOADING FILES @@ -730,7 +930,7 @@ up a guestfish process each time. Start a guestfish server process using: - eval `guestfish --listen` + eval "`guestfish --listen`" and then send it commands by doing: @@ -750,14 +950,21 @@ The C statement sets the environment variable C<$GUESTFISH_PID>, which is how the I<--remote> option knows where to send the commands. You can have several guestfish listener processes running using: - eval `guestfish --listen` + eval "`guestfish --listen`" pid1=$GUESTFISH_PID - eval `guestfish --listen` + eval "`guestfish --listen`" pid2=$GUESTFISH_PID ... guestfish --remote=$pid1 cmd guestfish --remote=$pid2 cmd +=head2 REMOTE CONTROL AND CSH + +When using csh-like shells (csh, tcsh etc) you have to add the +I<--csh> option: + + eval "`guestfish --listen --csh`" + =head2 REMOTE CONTROL DETAILS Remote control happens over a Unix domain socket called @@ -766,6 +973,17 @@ user ID of the process, and C<$PID> is the process ID of the server. Guestfish client and server versions must match exactly. +=head2 REMOTE CONTROL RUN COMMAND HANGING + +Using the C (or C) command remotely in a command +substitution context hangs, ie. don't do (note the backquotes): + + a=`guestfish --remote run` + +Since the C command produces no output on stdout, this is not +useful anyway. For further information see +L. + =head1 PREPARED DISK IMAGES Use the I<-N type> or I<--new type> parameter to select one of a set @@ -874,6 +1092,21 @@ guestfish returns 0 if the commands completed without error, or The C command uses C<$EDITOR> as the editor. If not set, it uses C. +=item FEBOOTSTRAP_KERNEL + +=item FEBOOTSTRAP_MODULES + +These two environment variables allow the kernel that libguestfs uses +in the appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not +set, then the most recent host kernel is chosen. For more information +about kernel selection, see L. This +feature is only available in febootstrap E 3.8. + +=item GUESTFISH_DISPLAY_IMAGE + +The C command uses C<$GUESTFISH_DISPLAY_IMAGE> to +display images. If not set, it uses L. + =item GUESTFISH_PID Used with the I<--remote> option to specify the remote guestfish @@ -929,12 +1162,13 @@ set, it uses C. =item TMPDIR -Location of temporary directory, defaults to C. +Location of temporary directory, defaults to C except for the +cached supermin appliance which defaults to C. If libguestfs was compiled to use the supermin appliance then the real appliance is cached in this directory, shared between all handles belonging to the same EUID. You can use C<$TMPDIR> to -configure another directory to use in case C is not large +configure another directory to use in case C is not large enough. =back @@ -943,6 +1177,15 @@ enough. =over 4 +=item $HOME/.libguestfs-tools.rc + +=item /etc/libguestfs-tools.conf + +This configuration file controls the default read-only or read-write +mode (I<--ro> or I<--rw>). + +See L. + =item $HOME/.guestfish If compiled with GNU readline support, then the command history @@ -982,9 +1225,9 @@ to make guestfish case sensitive. =item test2.img (etc) -When using the C<-N> or C<--new> option, the prepared disk or +When using the I<-N> or I<--new> option, the prepared disk or filesystem will be created in the file C in the current -directory. The second use of C<-N> will use C and so on. +directory. The second use of I<-N> will use C and so on. Any existing file with the same name will be overwritten. =back @@ -994,8 +1237,12 @@ Any existing file with the same name will be overwritten. L, L, L, +L, +L, L, L, +L, +L, L, L, L, @@ -1003,8 +1250,12 @@ L, L, L, L, +L, +L, L, -L. +L, +L, +L. =head1 AUTHORS @@ -1012,7 +1263,7 @@ Richard W.M. Jones (C) =head1 COPYRIGHT -Copyright (C) 2009-2010 Red Hat Inc. +Copyright (C) 2009-2011 Red Hat Inc. L This program is free software; you can redistribute it and/or modify