summaryrefslogtreecommitdiffstats
path: root/guestfish-actions.pod
diff options
context:
space:
mode:
authorRichard Jones <rjones@redhat.com>2009-05-12 17:16:59 +0100
committerRichard Jones <rjones@redhat.com>2009-05-12 17:16:59 +0100
commit45d78361d791f4a752fca9472b81bdc75f9f92a4 (patch)
treea9e2f22bca4bb8958d818f100bbba65a5ec89b4c /guestfish-actions.pod
parent8a7a6180a865e6895fa531865c5016d793271dfe (diff)
downloadlibguestfs-45d78361d791f4a752fca9472b81bdc75f9f92a4.tar.gz
libguestfs-45d78361d791f4a752fca9472b81bdc75f9f92a4.tar.xz
libguestfs-45d78361d791f4a752fca9472b81bdc75f9f92a4.zip
Test the 'command' and 'command_lines' functions thoroughly.
Diffstat (limited to 'guestfish-actions.pod')
-rw-r--r--guestfish-actions.pod15
1 files changed, 15 insertions, 0 deletions
diff --git a/guestfish-actions.pod b/guestfish-actions.pod
index 04343af2..7d46206b 100644
--- a/guestfish-actions.pod
+++ b/guestfish-actions.pod
@@ -372,6 +372,13 @@ The first element is the name of the program to run.
Subsequent elements are parameters. The list must be
non-empty (ie. must contain a program name).
+The return value is anything printed to I<stdout> by
+the command.
+
+If the command returns a non-zero exit status, then
+this function returns an error message. The error message
+string is the content of I<stderr> from the command.
+
The C<$PATH> environment variable will contain at least
C</usr/bin> and C</bin>. If you require a program from
another location, you should provide the full path in the
@@ -383,6 +390,10 @@ correct places. It is the caller's responsibility to ensure
all filesystems that are needed are mounted at the right
locations.
+Because of the message protocol, there is a transfer limit
+of somewhere between 2MB and 4MB. To transfer large files you should use
+FTP.
+
=head2 command-lines
command-lines 'arguments ...'
@@ -390,6 +401,10 @@ locations.
This is the same as C<command>, but splits the
result into a list of lines.
+Because of the message protocol, there is a transfer limit
+of somewhere between 2MB and 4MB. To transfer large files you should use
+FTP.
+
=head2 config
config qemuparam qemuvalue