diff options
| author | Michael DeHaan <mdehaan@mdehaan.rdu.redhat.com> | 2007-09-27 18:37:08 -0400 |
|---|---|---|
| committer | Michael DeHaan <mdehaan@mdehaan.rdu.redhat.com> | 2007-09-27 18:37:08 -0400 |
| commit | f45db33f393ba171fa8fe8b53a348e25d14b5e6c (patch) | |
| tree | ba80ea605593559358f01b83799a3cae9099d049 /docs/func.pod | |
| parent | 7fe6283c49670bc7f4e99afaec03d759e5fedca1 (diff) | |
| download | third_party-func-f45db33f393ba171fa8fe8b53a348e25d14b5e6c.tar.gz third_party-func-f45db33f393ba171fa8fe8b53a348e25d14b5e6c.tar.xz third_party-func-f45db33f393ba171fa8fe8b53a348e25d14b5e6c.zip | |
Updated wiki pages to mention one another, plus some miscellaneous cleanup and elaboration.
Most of the content still lives on the Wiki as we expect it will change rather rapidly for
a while.
Diffstat (limited to 'docs/func.pod')
| -rw-r--r-- | docs/func.pod | 26 |
1 files changed, 22 insertions, 4 deletions
diff --git a/docs/func.pod b/docs/func.pod index 50e4221..b73bcf9 100644 --- a/docs/func.pod +++ b/docs/func.pod @@ -10,21 +10,39 @@ 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" allows remote control of machines running funcd (called "minions") +that are set to obey this machine (called the "overlord"). This includes +performing various remote operations and gathering data. -Func can address multiple machines at the same time by specifying +"func" can address multiple machines at the same time by specifying their names with globs, which follow shell glob syntax. +See the project homepage (below) for a list of modules available +and a more in-depth description of what each of them do. + +=head1 LISTING REMOTE MODULES AVAILABLE + +func target.example.org system list_modules + +=head1 LISTING REMOTE FUNCTIONS AVAILABLE IN A MODULE + +func target.example.org modulename list_methods + +=head1 CALLING A REMOTE COMMAND + +func target.example.org modulename methodname + =head1 EXIT_STATUS Func commands have return values that vary based on the module being -called. +called. See the project page (linked below) for more information. =head1 ADDITONAL RESOURCES See https://hosted.fedoraproject.org/projects/func/ for more information, including information on scripting func from Python. +See also the manpages for "funcd", "certmaster", and "certmaster-ca". + =head1 AUTHOR Various. See https://hosted.fedoraproject.org/projects/func |