daemon/readdir: avoid a small leak
[libguestfs.git] / guestfish.pod
index 26312fe..0c3fda6 100644 (file)
@@ -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.
 
 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<cmd>
-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<guestfs(3)> API.
 
 =head2 alloc | allocate
 
 
 =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.
 
 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<command>
+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<cmd>
+parameter, this displays detailed help for a command.
+
 =head2 lcd
 
  lcd directory
 =head2 lcd
 
  lcd directory
@@ -393,14 +401,32 @@ itself.
 
 Note that C<!cd> won't do what you might expect.
 
 
 Note that C<!cd> 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<command>
-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<less> you will get the C<less> 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@
 
 
 @ACTIONS@
 
@@ -408,11 +434,32 @@ See section WILDCARDS AND GLOBBING.
 
 =over 4
 
 
 =over 4
 
+=item EDITOR
+
+The C<edit> command uses C<$EDITOR> as the editor.  If not
+set, it uses C<vi>.
+
+=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<LIBGUESTFS_DEBUG=1> to enable verbose messages.  This has the
 same effect as using the B<-v> option.
 
 =item LIBGUESTFS_DEBUG
 
 Set C<LIBGUESTFS_DEBUG=1> 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.
 =item LIBGUESTFS_PATH
 
 Set the path that guestfish uses to search for kernel and initrd.img.
@@ -424,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.
 
 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<edit> command uses C<$EDITOR> as the editor.  If not
-set, it uses C<vi>.
+The C<more> command uses C<$PAGER> as the pager.  If not
+set, it uses C<more>.
 
 =back
 
 
 =back