X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=guestfish.pod;h=4341e2aea4a89047361fc341c32eb1db0c6caa21;hp=9f4bdbf95ccc03e042cc7cbe08ce3c9dc113cdbf;hb=0cc0e9e39f816c3f6174c74bf4cb136a5b4e13ea;hpb=f339cb33703fc1b561d9956c29c4eb0e57334a91 diff --git a/guestfish.pod b/guestfish.pod index 9f4bdbf..4341e2a 100644 --- a/guestfish.pod +++ b/guestfish.pod @@ -49,13 +49,13 @@ Remove C (in reality not such a great idea): =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 - + > help =head2 As a script interpreter @@ -319,19 +319,10 @@ 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 - - help - help cmd - -Without any parameter, this lists all commands. With a C -parameter, this displays detailed help for a command. +=head1 GUESTFISH COMMANDS -=head2 quit | exit - -This exits guestfish. You can also use C<^D> key. +The commands in this section are guestfish convenience commands, in +other words, they are not part of the L API. =head2 alloc | allocate @@ -384,15 +375,6 @@ editors. 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 won't do what you might expect. - =head2 glob glob command args... @@ -402,6 +384,23 @@ repeatedly on each matching path. See section WILDCARDS AND GLOBBING. +=head2 help + + help + help cmd + +Without any parameter, this lists all commands. With a C +parameter, this displays detailed help for a command. + +=head2 lcd + + lcd directory + +Change the local directory, ie. the current directory of guestfish +itself. + +Note that C won't do what you might expect. + =head2 more | less more filename @@ -416,17 +415,51 @@ command C you will get the C command specifically. NOTE: This will not work reliably for large files (> 2 MB) or binary files containing \0 bytes. +=head2 quit | exit + +This exits guestfish. You can also use C<^D> key. + +=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@ =head1 ENVIRONMENT VARIABLES =over 4 +=item EDITOR + +The C command uses C<$EDITOR> as the editor. If not +set, it uses C. + +=item HOME + +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 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 +example: + + LIBGUESTFS_MEMSIZE=700 + =item LIBGUESTFS_PATH Set the path that guestfish uses to search for kernel and initrd.img. @@ -438,19 +471,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. -=item LIBGUESTFS_APPEND - -Pass additional options to the guest kernel. +=item PAGER -=item HOME - -If compiled with GNU readline support, then the command history -is saved in C<$HOME/.guestfish> - -=item EDITOR - -The C command uses C<$EDITOR> as the editor. If not -set, it uses C. +The C command uses C<$PAGER> as the pager. If not +set, it uses C. =back