New API: part-to-partnum

[libguestfs.git] / fuse / guestmount.pod

diff --git a/fuse/guestmount.pod b/fuse/guestmount.pod
index 6a2f39b..9756a8b 100644 (file)
--- a/fuse/guestmount.pod
+++ b/fuse/guestmount.pod
@@ -70,24 +70,49 @@ 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
+
+=head2 Enabling FUSE
+
+On some distros, you may need to add yourself to a special group
+(eg. C<fuse>) before you can use any FUSE filesystem.  This is
+necessary on Debian and derivatives.
+
+On other distros, no special group is required.  It is not necessary
+on Fedora or Red Hat Enterprise Linux.
+

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

-=item B<-a image> | B<--add image>
+=item B<-a image>
+
+=item B<--add image>

 
 Add a block device or virtual machine image.
 
 The format of the disk image is auto-detected.  To override this and
 force a particular format use the I<--format=..> option.
 
 
 Add a block device or virtual machine image.
 
 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>
+=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.
 
 
 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<-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
 
 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


@@ -114,7 +139,9 @@ 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.
 
 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<--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
 
 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


@@ -134,7 +161,9 @@ Display help on special FUSE options (see I<-o> below).
 
 Display brief help and exit.
 
 
 Display brief help and exit.
 

-=item B<-i> | B<--inspector>
+=item B<-i>
+
+=item B<--inspector>

 
 Using L<virt-inspector(1)> code, inspect the disks looking for
 an operating system and mount filesystems as they would be
 
 Using L<virt-inspector(1)> code, inspect the disks looking for
 an operating system and mount filesystems as they would be


@@ -170,14 +199,18 @@ filesystem can support them:
 
  -m /dev/sda1:/:acl,user_xattr
 
 
  -m /dev/sda1:/:acl,user_xattr
 

-=item B<-n> | B<--no-sync>
+=item B<-n>
+
+=item B<--no-sync>

 
 By default, we attempt to sync the guest disk when the FUSE mountpoint
 is unmounted.  If you specify this option, then we don't attempt to
 sync the disk.  See the discussion of autosync in the L<guestfs(3)>
 manpage.
 
 
 By default, we attempt to sync the guest disk when the FUSE mountpoint
 is unmounted.  If you specify this option, then we don't attempt to
 sync the disk.  See the discussion of autosync in the L<guestfs(3)>
 manpage.
 

-=item B<-o option> | B<--option option>
+=item B<-o option>
+
+=item B<--option option>

 
 Pass extra options to FUSE.
 
 
 Pass extra options to FUSE.
 


@@ -212,7 +245,9 @@ to the chosen values.
 
 =back
 
 
 =back
 

-=item B<-r> | B<--ro>
+=item B<-r>
+
+=item B<--ro>

 
 Add devices and mount everything read-only.  Also disallow writes and
 make the disk appear read-only to FUSE.
 
 Add devices and mount everything read-only.  Also disallow writes and
 make the disk appear read-only to FUSE.


@@ -228,22 +263,30 @@ See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
 
 Enable SELinux support for the guest.
 
 
 Enable SELinux support for the guest.
 

-=item B<-v> | B<--verbose>
+=item B<-v>
+
+=item B<--verbose>

 
 Enable verbose messages from underlying libguestfs.
 
 
 Enable verbose messages from underlying libguestfs.
 

-=item B<-V> | B<--version>
+=item B<-V>
+
+=item B<--version>

 
 Display the program version and exit.
 
 
 Display the program version and exit.
 

-=item B<-w> | B<--rw>
+=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<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
 
 
 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>
+=item B<-x>
+
+=item B<--trace>

 
 Trace libguestfs calls and entry into each FUSE function.
 
 
 Trace libguestfs calls and entry into each FUSE function.
 


@@ -266,6 +309,11 @@ See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
 
 =back
 
 
 =back
 

+=head1 EXIT STATUS
+
+This program returns 0 if successful, or non-zero if there was an
+error.
+

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