Add 'glob' command for guestfish.

[libguestfs.git] / guestfish.pod

diff --git a/guestfish.pod b/guestfish.pod
index 746922f..d83a61c 100644 (file)
--- a/guestfish.pod
+++ b/guestfish.pod
@@ -107,6 +107,13 @@ 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.
 
 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.
+

 =back
 
 =head1 COMMANDS ON COMMAND LINE
 =back
 
 =head1 COMMANDS ON COMMAND LINE


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

+=head1 WILDCARDS AND GLOBBING
+
+Neither guestfish nor the underlying guestfs API performs
+wildcard expansion (globbing) by default.  So for example the
+following will not do what you expect:
+
+ rm-rf /home/*
+
+Assuming you don't have a directory literally called C</home/*>
+then the above command will return an error.
+
+To perform wildcard expansion, use the C<glob> command.
+
+ glob rm-rf /home/*
+
+runs C<rm-rf> on each path that matches (ie. potentially running
+the command many times), equivalent to:
+
+ rm-rf /home/jim
+ rm-rf /home/joe
+ rm-rf /home/mary
+
+C<glob> only works on simple guest paths and not on device names.
+
+If you have several parameters, each containing a wildcard, then glob
+will perform a cartesian product.
+

 =head1 COMMENTS
 
 Any line which starts with a I<#> character is treated as a comment
 =head1 COMMENTS
 
 Any line which starts with a I<#> character is treated as a comment


@@ -189,6 +223,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 +312,24 @@ 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.
+
+=head2 glob
+
+ glob command args...
+
+Expand wildcards in any paths in the args list, and run C<command>
+repeatedly on each matching path.
+
+See section WILDCARDS AND GLOBBING.
+

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


@@ -276,6 +352,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 +368,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 +385,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