Add 'append', LIBGUESTFS_APPEND to set additional kernel options.

[libguestfs.git] / guestfish.pod

diff --git a/guestfish.pod b/guestfish.pod
index 9dadc94..d44e3e3 100644 (file)
--- a/guestfish.pod
+++ b/guestfish.pod
@@ -97,6 +97,11 @@ automatically launched.
 Disable autosync.  This is enabled by default.  See the discussion
 of autosync in the L<guestfs(3)> manpage.
 
 Disable autosync.  This is enabled by default.  See the discussion
 of autosync in the L<guestfs(3)> manpage.
 

+=item B<-r> | B<--ro>
+
+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<-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


@@ -172,6 +177,42 @@ a space-separated list, enclosed in quotes.  For example:
 
  vgcreate VG "/dev/sda1 /dev/sdb1"
 
 
  vgcreate VG "/dev/sda1 /dev/sdb1"
 

+=head1 COMMENTS
+
+Any line which starts with a I<#> character is treated as a comment
+and ignored.  The I<#> can optionally be preceeded by whitespace,
+but B<not> by a command.  For example:
+
+ # this is a comment
+         # this is a comment
+ foo # NOT a comment
+
+Blank lines are also ignored.
+
+=head1 RUNNING COMMANDS LOCALLY
+
+Any line which starts with a I<!> character is treated as a command
+sent to the local shell (C</bin/sh> or whatever L<system(3)> uses).
+For example:
+
+ !mkdir local
+ tgz-out /remote local/remote-data.tar.gz
+
+will create a directory C<local> on the host, and then export
+the contents of C</remote> on the mounted filesystem to
+C<local/remote-data.tar.gz>.  (See C<tgz-out>).
+
+=head1 EXIT ON ERROR BEHAVIOUR
+
+By default, guestfish will ignore any errors when in interactive mode
+(ie. taking commands from a human over a tty), and will exit on the
+first error in non-interactive mode (scripts, commands given on the
+command line).
+
+If you prefix a command with a I<-> character, then that command will
+not cause guestfish to exit, even if that (one) command returns an
+error.
+

 =head1 COMMANDS
 
 =head2 help
 =head1 COMMANDS
 
 =head2 help


@@ -217,6 +258,26 @@ number of 512 byte sectors
 
 =back
 
 
 =back
 

+=head2 echo
+
+ echo [params ...]
+
+This echos the parameters to the terminal.
+
+=head2 edit | vi | emacs
+
+ edit filename
+
+This is used to edit a file.  It downloads the file, edits it
+locally using your editor, then uploads the result.
+
+The editor is C<$EDITOR>.  However if you use the alternate
+commands C<vi> or C<emacs> you will get those corresponding
+editors.
+
+NOTE: This will not work reliably for large files
+(> 2 MB) or binary files containing \0 bytes.
+

 @ACTIONS@
 
 =head1 ENVIRONMENT VARIABLES
 @ACTIONS@
 
 =head1 ENVIRONMENT VARIABLES


@@ -239,13 +300,27 @@ 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_APPEND
+
+Pass additional options to the guest kernel.
+

 =item HOME
 
 If compiled with GNU readline support, then the command history
 is saved in C<$HOME/.guestfish>
 
 =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>.
+

 =back
 
 =back
 

+=head1 EXIT CODE
+
+guestfish returns I<0> if the commands completed without error, or
+I<1> if there was an error.
+

 =head1 SEE ALSO
 
 L<guestfs(3)>,
 =head1 SEE ALSO
 
 L<guestfs(3)>,