Add 'set-kernel'/'get-kernel'/LIBGUESTFS_KERNEL to override appliance kernel.

[libguestfs.git] / guestfish.pod

diff --git a/guestfish.pod b/guestfish.pod
index 4f8cf95..6f35ac4 100644 (file)
--- a/guestfish.pod
+++ b/guestfish.pod
@@ -328,6 +328,20 @@ to quote it, eg:
 
  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
@@ -539,6 +553,10 @@ Pass additional options to the guest kernel.
 Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages.  This has the
 same effect as using the B<-v> option.
 
+=item LIBGUESTFS_KERNEL
+
+Override the ordinary selection of appliance kernel.
+
 =item LIBGUESTFS_MEMSIZE
 
 Set the memory allocated to the qemu process, in megabytes.  For
@@ -562,6 +580,16 @@ used.
 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