Generated files for 1.0.46 release.

[libguestfs.git] / guestfish.pod

diff --git a/guestfish.pod b/guestfish.pod
index 746922f..28daa0a 100644 (file)
--- a/guestfish.pod
+++ b/guestfish.pod
@@ -189,6 +189,30 @@ but B<not> by a command.  For example:
 
 Blank lines are also ignored.
 
 
 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


@@ -254,6 +278,15 @@ editors.
 NOTE: This will not work reliably for large files
 (> 2 MB) or binary files containing \0 bytes.
 
 NOTE: This will not work reliably for large files
 (> 2 MB) or binary files containing \0 bytes.
 

+=head2 lcd
+
+ lcd directory
+
+Change the local directory, ie. the current directory of guestfish
+itself.
+
+Note that C<!cd> won't do what you might expect.
+

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


@@ -276,6 +309,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.
 
 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
 =item HOME
 
 If compiled with GNU readline support, then the command history


@@ -288,10 +325,15 @@ 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)>,

-L<http://et.redhat.com/~rjones/libguestfs>.
+L<http://libguestfs.org/>.

 
 =head1 AUTHORS
 
 
 =head1 AUTHORS
 


@@ -300,7 +342,7 @@ Richard W.M. Jones (C<rjones at redhat dot com>)
 =head1 COPYRIGHT
 
 Copyright (C) 2009 Red Hat Inc.
 =head1 COPYRIGHT
 
 Copyright (C) 2009 Red Hat Inc.

-L<http://et.redhat.com/~rjones/libguestfs>
+L<http://libguestfs.org/>

 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by