summaryrefslogtreecommitdiffstats
path: root/docs/func.pod
diff options
context:
space:
mode:
authorAdrian Likins <alikins@redhat.com>2007-09-25 18:14:30 -0400
committerAdrian Likins <alikins@redhat.com>2007-09-25 18:14:30 -0400
commitec74dd51d8eb3e580cf53fa45357cd7f8b788bdc (patch)
tree4f7ef6fe0aa021846f5e86af066fcfb566f40810 /docs/func.pod
parent14fd0d98b171169e58acf62c86ef1f3a5d5128ee (diff)
parente3493766701ac84e6d76257659be27c209ecb12e (diff)
downloadthird_party-func-ec74dd51d8eb3e580cf53fa45357cd7f8b788bdc.tar.gz
third_party-func-ec74dd51d8eb3e580cf53fa45357cd7f8b788bdc.tar.xz
third_party-func-ec74dd51d8eb3e580cf53fa45357cd7f8b788bdc.zip
Merge branch 'master' of ssh://git.fedoraproject.org/git/hosted/func
Diffstat (limited to 'docs/func.pod')
-rw-r--r--docs/func.pod32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/func.pod b/docs/func.pod
new file mode 100644
index 0000000..50e4221
--- /dev/null
+++ b/docs/func.pod
@@ -0,0 +1,32 @@
+=head1 NAME
+
+Func -- Fedora Unified Network Controller.
+
+=head1 SYNOPSIS
+
+func target.example.org module command [args ...] [--verbose]
+func "target*.example.org" module command [args ...] [--verbose]
+func "webserver1;mailserver2" module command [args ...] [--verbose]
+
+=head1 DESCRIPTION
+
+Func allows remote control of machines running funcd that are set
+to obey this machine.
+
+Func can address multiple machines at the same time by specifying
+their names with globs, which follow shell glob syntax.
+
+=head1 EXIT_STATUS
+
+Func commands have return values that vary based on the module being
+called.
+
+=head1 ADDITONAL RESOURCES
+
+See https://hosted.fedoraproject.org/projects/func/ for more information, including information on scripting func from Python.
+
+=head1 AUTHOR
+
+Various. See https://hosted.fedoraproject.org/projects/func
+
+