summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael DeHaan <mdehaan@redhat.com>2007-10-25 15:52:00 -0400
committerMichael DeHaan <mdehaan@redhat.com>2007-10-25 15:52:00 -0400
commiteddfd94580895a64a54a9e7cb3fa099c0489574f (patch)
tree49157aedbd5650300ea83dd0e94806c84ae8a9b3
parentc77dc9b98dcb8635937caa7089e631e19b7fcb7e (diff)
downloadthird_party-func-eddfd94580895a64a54a9e7cb3fa099c0489574f.tar.gz
third_party-func-eddfd94580895a64a54a9e7cb3fa099c0489574f.tar.xz
third_party-func-eddfd94580895a64a54a9e7cb3fa099c0489574f.zip
Added docs about call's various output parameters.
-rw-r--r--docs/func.pod8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/func.pod b/docs/func.pod
index 8d4f4bb..c95788f 100644
--- a/docs/func.pod
+++ b/docs/func.pod
@@ -78,9 +78,17 @@ func "*.example.org" copyfile --file=/tmp/foo --remotepath=/tmp/foo
While these helper modules will grow over time, usage of "call" syntax
directly is fine also. See the Wiki for more examples as they evolve.
+=head1 OUTPUT COMMANDS
+
+The "call" command by default outputs data using a "pretty printer". Other
+display options include --raw, --json, and --xmlrpc, which may be more
+desirable if you are running func inside another script or prefer to read
+those display formats.
+
=head1 --verbose
Use this flag to output extra information from func while it is running.
+All func commands can take this flag.
=head1 EXIT_STATUS