TODO: Attach method for disconnected operation.

[libguestfs.git] / fuse / guestmount.pod

diff --git a/fuse/guestmount.pod b/fuse/guestmount.pod
index 567a270..cada4cc 100644 (file)
--- a/fuse/guestmount.pod
+++ b/fuse/guestmount.pod
@@ -70,6 +70,16 @@ If you want to debug the program, we recommend:
 
  guestmount [...] --trace --verbose /mnt
 
 
  guestmount [...] --trace --verbose /mnt
 

+=head1 NOTES
+
+=head2 Other users cannot see the filesystem by default
+
+If you mount a filesystem as one user (eg. root), then other users
+will not be able to see it by default.  The fix is to add the FUSE
+C<allow_other> option when mounting:
+
+ sudo guestmount [...] -o allow_other /mnt
+

 =head1 OPTIONS
 
 =over 4
 =head1 OPTIONS
 
 =over 4


@@ -93,6 +103,8 @@ 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.
 
 also used, then any libvirt domain can be used.  However in write
 mode, only libvirt domains which are shut down can be named here.
 

+Domain UUIDs can be used instead of names.
+

 =item B<--dir-cache-timeout N>
 
 Set the readdir cache timeout to I<N> seconds, the default being 60
 =item B<--dir-cache-timeout N>
 
 Set the readdir cache timeout to I<N> seconds, the default being 60


@@ -143,7 +155,14 @@ mounted on the real virtual machine.
 Read key or passphrase parameters from stdin.  The default is
 to try to read passphrases from the user by opening C</dev/tty>.
 
 Read key or passphrase parameters from stdin.  The default is
 to try to read passphrases from the user by opening C</dev/tty>.
 

-=item B<-m dev[:mnt]> | B<--mount dev[:mnt]>
+=item B<--live>
+
+Connect to a live virtual machine.
+(Experimental, see L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>).
+
+=item B<-m dev[:mountpoint[:options]]>
+
+=item B<--mount dev[:mountpoint[:options]]>

 
 Mount the named partition or logical volume on the given mountpoint
 B<in the guest> (this has nothing to do with mountpoints in the host).
 
 Mount the named partition or logical volume on the given mountpoint
 B<in the guest> (this has nothing to do with mountpoints in the host).


@@ -151,6 +170,16 @@ B<in the guest> (this has nothing to do with mountpoints in the host).
 If the mountpoint is omitted, it defaults to C</>.  You have to mount
 something on C</>.
 
 If the mountpoint is omitted, it defaults to C</>.  You have to mount
 something on C</>.
 

+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<ro>
+(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
+

 =item B<-n> | B<--no-sync>
 
 By default, we attempt to sync the guest disk when the FUSE mountpoint
 =item B<-n> | B<--no-sync>
 
 By default, we attempt to sync the guest disk when the FUSE mountpoint


@@ -219,7 +248,9 @@ Display the program version and exit.
 
 =item B<-w> | B<--rw>
 
 
 =item B<-w> | 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<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
 
 =item B<-x> | B<--trace>
 See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
 
 =item B<-x> | B<--trace>


@@ -230,6 +261,21 @@ This also stops the daemon from forking into the background.
 
 =back
 
 
 =back
 

+=head1 FILES
+
+=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<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
+
+=back
+

 =head1 SEE ALSO
 
 L<guestfish(1)>,
 =head1 SEE ALSO
 
 L<guestfish(1)>,