summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMichael DeHaan <mdehaan@mdehaan.rdu.redhat.com>2007-09-25 18:22:40 -0400
committerMichael DeHaan <mdehaan@mdehaan.rdu.redhat.com>2007-09-25 18:22:40 -0400
commite3493766701ac84e6d76257659be27c209ecb12e (patch)
tree24ed711a936f2f6a23d62bc5a71010064471dfe6 /docs
parent6c38c3128afd8542d086ba998494e02872781b77 (diff)
downloadthird_party-func-e3493766701ac84e6d76257659be27c209ecb12e.zip
third_party-func-e3493766701ac84e6d76257659be27c209ecb12e.tar.gz
third_party-func-e3493766701ac84e6d76257659be27c209ecb12e.tar.xz
Adding manpages and misc spec/build cleanup
Diffstat (limited to 'docs')
-rw-r--r--docs/certmaster.pod27
-rw-r--r--docs/func.pod32
-rw-r--r--docs/funcd.pod23
3 files changed, 82 insertions, 0 deletions
diff --git a/docs/certmaster.pod b/docs/certmaster.pod
new file mode 100644
index 0000000..7c6df0b
--- /dev/null
+++ b/docs/certmaster.pod
@@ -0,0 +1,27 @@
+=head1 NAME
+
+certmaster -- hands out certificates to funcd and other components.
+
+=head1 SYNOPSIS
+
+certmaster (it's a daemon and takes no arguments)
+
+=head1 DESCRIPTION
+
+See https://hosted.fedoraproject.org/projects/func/
+
+Certmaster is run on the master-control machine on a network being
+controlled by func. It hands out certificates to machines running
+funcd.
+
+Certmaster is configured by /etc/func/certmaster.conf
+
+=head1 ADDITONAL RESOURCES
+
+See https://hosted.fedoraproject.org/projects/func/. It's a Wiki.
+
+=head1 AUTHOR
+
+Various. See https://hosted.fedoraproject.org/projects/func
+
+
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
+
+
diff --git a/docs/funcd.pod b/docs/funcd.pod
new file mode 100644
index 0000000..d4bdc44
--- /dev/null
+++ b/docs/funcd.pod
@@ -0,0 +1,23 @@
+=head1 NAME
+
+funcd -- deaemon for the Fedora Universal Network Controller
+
+=head1 SYNOPSIS
+
+funcd (it's a daemon and takes no arguments)
+
+=head1 DESCRIPTION
+
+funcd registers itself to a server listed in /etc/func/minion.conf and takes orders from it. See /etc/func/minion.conf for other configuration options.
+
+Modules and capabilities are specified at https://hosted.fedoraproject.org/projects/func/
+
+=head1 ADDITONAL RESOURCES
+
+See https://hosted.fedoraproject.org/projects/func/. It's a Wiki.
+
+=head1 AUTHOR
+
+Various. See https://hosted.fedoraproject.org/projects/func
+
+