Order alphabetically the options in guestfish.1 manpage.
[libguestfs.git] / guestfish.pod
index 1e32799..0100311 100644 (file)
@@ -49,13 +49,13 @@ Remove C</boot/grub/menu.lst> (in reality not such a great idea):
 =head2 As an interactive shell
 
  $ guestfish
+
  Welcome to guestfish, the libguestfs filesystem interactive shell for
  editing virtual machine filesystems.
+
  Type: 'help' for help with commands
        'quit' to quit the shell
+
  ><fs> help
 
 =head2 As a script interpreter
@@ -92,6 +92,13 @@ Displays detailed help on a single command C<cmd>.
 
 Add a block device or virtual machine image to the shell.
 
+=item B<-D> | B<--no-dest-paths>
+
+Don't tab-complete paths on the guest filesystem.  It is useful to be
+able to hit the tab key to complete paths on the guest filesystem, but
+this causes extra "hidden" guestfs calls to be made, so this option is
+here to allow this feature to be disabled.
+
 =item B<-f file> | B<--file file>
 
 Read commands from C<file>.  To write pure guestfish
@@ -149,17 +156,14 @@ This changes the C<-m> option so that mounts are done read-only
 Enable very verbose messages.  This is particularly useful if you find
 a bug.
 
-=item B<-D> | B<--no-dest-paths>
-
-Don't tab-complete paths on the guest filesystem.  It is useful to be
-able to hit the tab key to complete paths on the guest filesystem, but
-this causes extra "hidden" guestfs calls to be made, so this option is
-here to allow this feature to be disabled.
-
 =item B<-V> | B<--version>
 
 Display the guestfish / libguestfs version number and exit.
 
+=item B<-x>
+
+Echo each command before executing it.
+
 =back
 
 =head1 COMMANDS ON COMMAND LINE
@@ -419,6 +423,21 @@ NOTE: This will not work reliably for large files
 
 This exits guestfish.  You can also use C<^D> key.
 
+=head2 reopen
+
+ reopen
+
+Close and reopen the libguestfs handle.  It is not necessary to use
+this normally, because the handle is closed properly when guestfish
+exits.  However this is occasionally useful for testing.
+
+=head2 time
+
+ time command args...
+
+Run the command as usual, but print the elapsed time afterwards.  This
+can be useful for benchmarking operations.
+
 =head1 COMMANDS
 
 @ACTIONS@
@@ -427,11 +446,32 @@ This exits guestfish.  You can also use C<^D> key.
 
 =over 4
 
+=item EDITOR
+
+The C<edit> command uses C<$EDITOR> as the editor.  If not
+set, it uses C<vi>.
+
+=item HOME
+
+If compiled with GNU readline support, then the command history
+is saved in C<$HOME/.guestfish>
+
+=item LIBGUESTFS_APPEND
+
+Pass additional options to the guest kernel.
+
 =item LIBGUESTFS_DEBUG
 
 Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages.  This has the
 same effect as using the B<-v> option.
 
+=item LIBGUESTFS_MEMSIZE
+
+Set the memory allocated to the qemu process, in megabytes.  For
+example:
+
+ LIBGUESTFS_MEMSIZE=700
+
 =item LIBGUESTFS_PATH
 
 Set the path that guestfish uses to search for kernel and initrd.img.
@@ -443,19 +483,10 @@ 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.
 
-=item LIBGUESTFS_APPEND
-
-Pass additional options to the guest kernel.
+=item PAGER
 
-=item HOME
-
-If compiled with GNU readline support, then the command history
-is saved in C<$HOME/.guestfish>
-
-=item EDITOR
-
-The C<edit> command uses C<$EDITOR> as the editor.  If not
-set, it uses C<vi>.
+The C<more> command uses C<$PAGER> as the pager.  If not
+set, it uses C<more>.
 
 =back