X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=fish%2Fguestfish.pod;h=65fccc8dad93a6fb277aca69fe72c9ecf453dcd0;hb=ab7f296b63280d183b6574c896cab6d6cafb660a;hp=6f272450457d52f65d8bb44bce1c838a1763b1c1;hpb=be26864cc2b44a7c3a1ebec8908e2706c655a3e6;p=libguestfs.git diff --git a/fish/guestfish.pod b/fish/guestfish.pod index 6f27245..65fccc8 100644 --- a/fish/guestfish.pod +++ b/fish/guestfish.pod @@ -178,7 +178,7 @@ If the mountpoint is omitted, it defaults to C. You have to mount something on C before most commands will work. -If any C<-m> or C<--mount> options are given, the guest is +If any I<-m> or I<--mount> options are given, the guest is automatically launched. If you don't know what filesystems a disk image contains, you @@ -198,7 +198,7 @@ L below. =item B<-r> | B<--ro> -This changes the C<-a> and C<-m> options so that disks are added and +This changes the I<-a> and I<-m> options so that disks are added and mounts are done read-only (see L). The option must always be used if the disk image or virtual machine @@ -272,7 +272,7 @@ any other commands C is a synonym for C. You must C (or C) your guest before mounting or performing any other commands. -The only exception is that if the C<-m> or C<--mount> option was +The only exception is that if the I<-m> or I<--mount> option was given, the guest is automatically run for you (simply because guestfish can't mount the disks you asked for without doing this). @@ -428,6 +428,25 @@ This syntax implicitly calls C (q.v.) so it also handles case insensitivity like Windows would. This only works in argument positions that expect a path. +=head1 UPLOADING AND DOWNLOADING FILES + +For commands such as C, C, C, C and +others which upload from or download to a local file, you can use the +special filename C<-> to mean "from stdin" or "to stdout". For example: + + upload - /foo + +reads stdin and creates from that a file C in the disk image, +and: + + tar-out /etc - | tar tf - + +writes the tarball to stdout and then pipes that into the external +"tar" command (see L). + +When using C<-> to read from stdin, the input is read up to the end of +stdin. + =head1 EXIT ON ERROR BEHAVIOUR By default, guestfish will ignore any errors when in interactive mode @@ -465,7 +484,7 @@ L. =head2 CONTROLLING MULTIPLE GUESTFISH PROCESSES The C statement sets the environment variable C<$GUESTFISH_PID>, -which is how the C<--remote> option knows where to send the commands. +which is how the I<--remote> option knows where to send the commands. You can have several guestfish listener processes running using: eval `guestfish --listen` @@ -734,8 +753,8 @@ enough. =head1 EXIT CODE -guestfish returns I<0> if the commands completed without error, or -I<1> if there was an error. +guestfish returns 0 if the commands completed without error, or +1 if there was an error. =head1 SEE ALSO @@ -759,7 +778,7 @@ Richard W.M. Jones (C) =head1 COPYRIGHT -Copyright (C) 2009 Red Hat Inc. +Copyright (C) 2009-2010 Red Hat Inc. L This program is free software; you can redistribute it and/or modify