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

[libguestfs.git] / guestfish.pod

diff --git a/guestfish.pod b/guestfish.pod
index 9dadc94..0e9967f 100644 (file)
--- a/guestfish.pod
+++ b/guestfish.pod
@@ -97,6 +97,11 @@ automatically launched.
 Disable autosync.  This is enabled by default.  See the discussion
 of autosync in the L<guestfs(3)> manpage.
 
 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
 =item B<-v> | B<--verbose>
 
 Enable very verbose messages.  This is particularly useful if you find


@@ -172,6 +177,18 @@ a space-separated list, enclosed in quotes.  For example:
 
  vgcreate VG "/dev/sda1 /dev/sdb1"
 
 
  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
 =head1 COMMANDS
 
 =head2 help