X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=guestfish.pod;h=07c7cd0e3446bb65a8977ce7ca19e6395870b1bb;hp=26312fe4b68cf20693f137c0a6f90e3f7b645707;hb=11d8dd84d475c89c7fff702e7f7ac5bf57971ac4;hpb=88da5cf8a32e683ed1d78419fcde609a389a2f65 diff --git a/guestfish.pod b/guestfish.pod index 26312fe..07c7cd0 100644 --- a/guestfish.pod +++ b/guestfish.pod @@ -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 +=head1 GUESTFISH COMMANDS -Without any parameter, this lists all commands. With a C -parameter, this displays detailed help for a command. - -=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,6 +375,23 @@ editors. NOTE: This will not work reliably for large files (> 2 MB) or binary files containing \0 bytes. +=head2 glob + + glob command args... + +Expand wildcards in any paths in the args list, and run C +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 @@ -393,14 +401,25 @@ itself. Note that C won't do what you might expect. -=head2 glob +=head2 more | less - glob command args... + more filename -Expand wildcards in any paths in the args list, and run C -repeatedly on each matching path. + less filename -See section WILDCARDS AND GLOBBING. +This is used to view a file. + +The default viewer is C<$PAGER>. However if you use the alternate +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. + +=head1 COMMANDS @ACTIONS@ @@ -408,11 +427,32 @@ See section WILDCARDS AND GLOBBING. =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. @@ -424,19 +464,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 HOME - -If compiled with GNU readline support, then the command history -is saved in C<$HOME/.guestfish> +=item PAGER -=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