X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=fish%2Fguestfish.pod;h=21680c71bad56eec5065e31ef26a04747549b9a5;hb=90b708cba263ab35e66852c1bc47674180142829;hp=5ec6689e3b1cc37f030231ed742f738c062cb940;hpb=c3887285abbb3606822626ba396a51cb5df80d43;p=libguestfs.git
diff --git a/fish/guestfish.pod b/fish/guestfish.pod
index 5ec6689..21680c7 100644
--- a/fish/guestfish.pod
+++ b/fish/guestfish.pod
@@ -176,7 +176,7 @@ force a particular format use the I<--format=..> option.
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.
+with C if the I<--format=...> flag was given.
=item B<-c URI>
@@ -294,9 +294,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]>
+=item B<--live>
+
+Connect to a live virtual machine.
+(Experimental, see L).
+
+=item B<-m dev[:mountpoint[:options]]>
-=item B<--mount dev[:mountpoint]>
+=item B<--mount dev[:mountpoint[:options]]>
Mount the named partition or logical volume on the given mountpoint.
@@ -313,8 +318,17 @@ filesystems and LVs available (see L,
L and L commands), or you can use the
L program.
-Using this flag is mostly equivalent to using the C
-command or the C command if the I<--ro> flag was given.
+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>
@@ -388,7 +402,9 @@ Display the guestfish / libguestfs version number and exit.
=item B<--rw>
-This option does nothing at the moment.
+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>
@@ -452,27 +468,30 @@ asked for without doing this.
=head1 OPENING DISKS FOR READ AND WRITE
-The guestfish (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.
+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.6.2, guestfish and guestmount 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>.
+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.
-By libguestfs 1.10 we intend to change the default the other way. Disk
-images will be opened read-only. You will have to either specify
-I or change a configuration file in order to get write
-access for disk images specified by those other command line options.
+By libguestfs 1.12 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 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 guestfish needs write access, and to
-prepare your scripts for the day when this option will be required for
-write access.
+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.
@@ -779,19 +798,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
@@ -889,6 +913,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
@@ -1052,12 +1087,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
@@ -1066,6 +1102,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
@@ -1105,9 +1150,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
@@ -1141,7 +1186,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