Add compilation/linking example to guestfs(3) man page.

[libguestfs.git] / fish / guestfish.pod

diff --git a/fish/guestfish.pod b/fish/guestfish.pod
index 13a9fa7..e5f0bba 100644 (file)
--- a/fish/guestfish.pod
+++ b/fish/guestfish.pod
@@ -98,7 +98,7 @@ the functionality of the guestfs API, see L<guestfs(3)>.
 
 Guestfish gives you structured access to the libguestfs API, from
 shell scripts or the command line or interactively.  If you want to
 
 Guestfish gives you structured access to the libguestfs API, from
 shell scripts or the command line or interactively.  If you want to

-rescue a broken virtual machine image, you might want to look at the
+rescue a broken virtual machine image, you should look at the

 L<virt-rescue(1)> command.
 
 Using guestfish in read/write mode on live virtual machines can be
 L<virt-rescue(1)> command.
 
 Using guestfish in read/write mode on live virtual machines can be


@@ -296,6 +296,25 @@ must be escaped with a backslash.
  command "/bin/echo 'foo      bar'"
  command "/bin/echo \'foo\'"
 
  command "/bin/echo 'foo      bar'"
  command "/bin/echo \'foo\'"
 

+=head1 NUMBERS
+
+Commands which take integers as parameters use the C convention which
+is to use C<0> to prefix an octal number or C<0x> to prefix a
+hexadecimal number.  For example:
+
+ 1234      decimal number 1234
+ 02322     octal number, equivalent to decimal 1234
+ 0x4d2     hexadecimal number, equivalent to decimal 1234
+
+When using the C<chmod> command, you almost always want to specify an
+octal number for the mode, and you must prefix it with C<0> (unlike
+the Unix L<chmod(1)> program):
+
+ chmod 0777 /public  # OK
+ chmod 777 /public   # WRONG! This is mode 777 decimal = 01411 octal.
+
+Commands that return numbers currently always print them in decimal.
+

 =head1 WILDCARDS AND GLOBBING
 
 Neither guestfish nor the underlying guestfs API performs
 =head1 WILDCARDS AND GLOBBING
 
 Neither guestfish nor the underlying guestfs API performs


@@ -348,6 +367,9 @@ will create a directory C<local> on the host, and then export
 the contents of C</remote> on the mounted filesystem to
 C<local/remote-data.tar.gz>.  (See C<tgz-out>).
 
 the contents of C</remote> on the mounted filesystem to
 C<local/remote-data.tar.gz>.  (See C<tgz-out>).
 

+To change the local directory, use the C<lcd> command.  C<!cd> will
+have no effect, due to the way that subprocesses work in Unix.
+

 =head1 PIPES
 
 Use C<command E<lt>spaceE<gt> | command> to pipe the output of the
 =head1 PIPES
 
 Use C<command E<lt>spaceE<gt> | command> to pipe the output of the


@@ -363,6 +385,7 @@ Other examples:
 
  hexdump /bin/ls | head
  list-devices | tail -1
 
  hexdump /bin/ls | head
  list-devices | tail -1

+ tgz-out / - | tar ztf -

 
 The space before the pipe symbol is required, any space after the pipe
 symbol is optional.  Everything after the pipe symbol is just passed
 
 The space before the pipe symbol is required, any space after the pipe
 symbol is optional.  Everything after the pipe symbol is just passed


@@ -719,11 +742,15 @@ I<1> if there was an error.
 L<guestfs(3)>,
 L<http://libguestfs.org/>,
 L<virt-cat(1)>,
 L<guestfs(3)>,
 L<http://libguestfs.org/>,
 L<virt-cat(1)>,

+L<virt-df(1)>,

 L<virt-edit(1)>,
 L<virt-list-filesystems(1)>,
 L<virt-edit(1)>,
 L<virt-list-filesystems(1)>,

+L<virt-list-partitions(1)>,

 L<virt-ls(1)>,
 L<virt-ls(1)>,

+L<virt-make-fs(1)>,

 L<virt-rescue(1)>,
 L<virt-rescue(1)>,

-L<virt-tar(1)>.
+L<virt-tar(1)>,
+L<virt-win-reg(1)>.

 
 =head1 AUTHORS
 
 
 =head1 AUTHORS