Added a comment syntax to guestfish (# ...).

[libguestfs.git] / guestfish.pod

diff --git a/guestfish.pod b/guestfish.pod
index d5a7e5a..0e9967f 100644 (file)
--- a/guestfish.pod
+++ b/guestfish.pod
@@ -18,7 +18,7 @@ Create a new C</etc/motd> file in a guest:
  add disk.img
  run
  mount /dev/VolGroup00/LogVol00 /
- upload new_motd /etc/motd
+ write_file /etc/motd "Hello users" 0
  _EOF_
 
 List the LVs in a guest:
@@ -97,6 +97,11 @@ automatically launched.
 Disable autosync.  This is enabled by default.  See the discussion
 of autosync in the L<guestfs(3)> manpage.
 
+=item B<-r> | B<--ro>
+
+This changes the C<-m> option so that mounts are done read-only
+(see C<guestfs_mount_ro> in the L<guestfs(3)> manpage).
+
 =item B<-v> | B<--verbose>
 
 Enable very verbose messages.  This is particularly useful if you find
@@ -156,6 +161,34 @@ The only exception is that if the C<-m> or C<--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).
 
+=head1 QUOTING
+
+You can quote ordinary parameters using either single or double
+quotes.  For example:
+
+ add "file with a space.img"
+
+ rm '/file name'
+
+ rm '/"'
+
+A few commands require a list of strings to be passed.  For these, use
+a space-separated list, enclosed in quotes.  For example:
+
+ vgcreate VG "/dev/sda1 /dev/sdb1"
+
+=head1 COMMENTS
+
+Any line which starts with a I<#> character is treated as a comment
+and ignored.  The I<#> can optionally be preceeded by whitespace,
+but B<not> by a command.  For example:
+
+ # this is a comment
+         # this is a comment
+ foo # NOT a comment
+
+Blank lines are also ignored.
+
 =head1 COMMANDS
 
 =head2 help
@@ -183,14 +216,10 @@ Size can be specified (where C<nn> means a number):
 
 =over 4
 
-=item C<nn>
+=item C<nn> or C<nn>K or C<nn>KB
 
 number of kilobytes, eg: C<1440> = standard 3.5in floppy
 
-=item C<nn>K or C<nn>KB
-
-number of kilobytes
-
 =item C<nn>M or C<nn>MB
 
 number of megabytes
@@ -221,6 +250,17 @@ same effect as using the B<-v> option.
 Set the path that guestfish uses to search for kernel and initrd.img.
 See the discussion of paths in L<guestfs(3)>.
 
+=item LIBGUESTFS_QEMU
+
+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 HOME
+
+If compiled with GNU readline support, then the command history
+is saved in C<$HOME/.guestfish>
+
 =back
 
 =head1 SEE ALSO