=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
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
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
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@
=over 4
-=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_PATH
+=item EDITOR
-Set the path that guestfish uses to search for kernel and initrd.img.
-See the discussion of paths in L<guestfs(3)>.
+The C<edit> command uses C<$EDITOR> as the editor. If not
+set, it uses C<vi>.
-=item LIBGUESTFS_QEMU
+=item HOME
-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.
+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
LIBGUESTFS_MEMSIZE=700
-=item HOME
+=item LIBGUESTFS_PATH
-If compiled with GNU readline support, then the command history
-is saved in C<$HOME/.guestfish>
+Set the path that guestfish uses to search for kernel and initrd.img.
+See the discussion of paths in L<guestfs(3)>.
-=item EDITOR
+=item LIBGUESTFS_QEMU
-The C<edit> command uses C<$EDITOR> as the editor. If not
-set, it uses C<vi>.
+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 PAGER