'len' should be an unsigned 32 bit int.

[libguestfs.git] / guestfish.pod

diff --git a/guestfish.pod b/guestfish.pod
index 4f8cf95..affb83b 100644 (file)
--- a/guestfish.pod
+++ b/guestfish.pod
@@ -130,9 +130,9 @@ Typical usage is either:
 
  guestfish -i /dev/Guests/MyGuest
 
 
  guestfish -i /dev/Guests/MyGuest
 

-You cannot use I<-a>, I<-m>, I<--listen> or I<--remote> in conjunction
-with this option, and options other than I<--ro> might not behave
-correctly.
+You cannot use I<-a>, I<-m>, I<--listen>, I<--remote> or I<--selinux>
+in conjunction with this option, and options other than I<--ro> might
+not behave correctly.

 
 See also: L<virt-inspector(1)>.
 
 
 See also: L<virt-inspector(1)>.
 


@@ -167,6 +167,10 @@ I<REMOTE CONTROL GUESTFISH OVER A SOCKET> below.
 This changes the C<-m> option so that mounts are done read-only
 (see C<guestfs_mount_ro> in the L<guestfs(3)> manpage).
 
 This changes the C<-m> option so that mounts are done read-only
 (see C<guestfs_mount_ro> in the L<guestfs(3)> manpage).
 

+=item B<--selinux>
+
+Enable SELinux support for the guest.  See L<guestfs(3)/SELINUX>.
+

 =item B<-v> | B<--verbose>
 
 Enable very verbose messages.  This is particularly useful if you find
 =item B<-v> | B<--verbose>
 
 Enable very verbose messages.  This is particularly useful if you find


@@ -246,9 +250,13 @@ quotes.  For example:
  rm '/"'
 
 A few commands require a list of strings to be passed.  For these, use
  rm '/"'
 
 A few commands require a list of strings to be passed.  For these, use

-a space-separated list, enclosed in quotes.  For example:
+a whitespace-separated list, enclosed in quotes.  Strings containing whitespace
+to be passed through must be enclosed in single quotes.  A literal single quote
+must be escaped with a backslash.

 
  vgcreate VG "/dev/sda1 /dev/sdb1"
 
  vgcreate VG "/dev/sda1 /dev/sdb1"

+ command "/bin/echo 'foo      bar'"
+ command "/bin/echo \'foo\'"

 
 =head1 WILDCARDS AND GLOBBING
 
 
 =head1 WILDCARDS AND GLOBBING
 


@@ -328,6 +336,20 @@ to quote it, eg:
 
  echo "|"
 
 
  echo "|"
 

+=head1 HOME DIRECTORIES
+
+If a parameter starts with the character C<~> then the tilde may be
+expanded as a home directory path (either C<~> for the current user's
+home directory, or C<~user> for another user).
+
+Note that home directory expansion happens for users known I<on the
+host>, not in the guest filesystem.
+
+To use a literal argument which begins with a tilde, you have to quote
+it, eg:
+
+ echo "~"
+

 =head1 EXIT ON ERROR BEHAVIOUR
 
 By default, guestfish will ignore any errors when in interactive mode
 =head1 EXIT ON ERROR BEHAVIOUR
 
 By default, guestfish will ignore any errors when in interactive mode


@@ -376,13 +398,6 @@ You can have several guestfish listener processes running using:
  guestfish --remote=$pid1 cmd
  guestfish --remote=$pid2 cmd
 
  guestfish --remote=$pid1 cmd
  guestfish --remote=$pid2 cmd
 

-=head2 STANDARD OUTPUT DURING REMOTE CONTROL
-
-Because of limitations in the C<eval> statement, stdout from the
-listener is currently redirected to C</dev/null>.
-
-Stderr is unchanged.
-

 =head2 REMOTE CONTROL DETAILS
 
 Remote control happens over a Unix domain socket called
 =head2 REMOTE CONTROL DETAILS
 
 Remote control happens over a Unix domain socket called


@@ -557,11 +572,25 @@ Set the default qemu binary that libguestfs uses.  If not set, then
 the qemu which was found at compile time by the configure script is
 used.
 
 the qemu which was found at compile time by the configure script is
 used.
 

+=item LIBGUESTFS_TRACE
+
+Set C<LIBGUESTFS_TRACE=1> to enable command traces.
+

 =item PAGER
 
 The C<more> command uses C<$PAGER> as the pager.  If not
 set, it uses C<more>.
 
 =item PAGER
 
 The C<more> command uses C<$PAGER> as the pager.  If not
 set, it uses C<more>.
 

+=item TMPDIR
+
+Location of temporary directory, defaults to C</tmp>.
+
+If libguestfs was compiled to use the supermin appliance then each
+handle will require rather a large amount of space in this directory
+for short periods of time (~ 80 MB).  You can use C<$TMPDIR> to
+configure another directory to use in case C</tmp> is not large
+enough.
+

 =back
 
 =head1 EXIT CODE
 =back
 
 =head1 EXIT CODE