diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/func-inventory.pod | 2 | ||||
| -rw-r--r-- | docs/func-transmit.pod | 39 | ||||
| -rw-r--r-- | docs/func.pod | 2 | ||||
| -rw-r--r-- | docs/funcd.pod | 2 |
4 files changed, 42 insertions, 3 deletions
diff --git a/docs/func-inventory.pod b/docs/func-inventory.pod index cfe362d..d768f3b 100644 --- a/docs/func-inventory.pod +++ b/docs/func-inventory.pod @@ -60,7 +60,7 @@ RPM be installed. See https://hosted.fedoraproject.org/projects/func/ for more information. -See also the manpages for "func", "funcd", "certmaster", and "certmaster-ca". +See also the manpages for "func", "funcd", "certmaster", "certmaster-ca", and "func-transmit". =head1 AUTHOR diff --git a/docs/func-transmit.pod b/docs/func-transmit.pod new file mode 100644 index 0000000..df475ae --- /dev/null +++ b/docs/func-transmit.pod @@ -0,0 +1,39 @@ +=head1 NAME + +Func-transmit -- cross-language func adapter + +=head1 SYNOPSIS + +func-transmit < yaml_in > yaml_out + +=head1 DESCRIPTION + +Func includes a powerful Python API for addressing the overlord via software. When writing an app in a language other than Python, func-transmit can be used +to operate the overlord and recieve structured results from it. + +This tool, func-transmit, is intended to be called using pipes, sending formatted data into stdin and recieving return codes via stdout. It also can be invoked using the shell. + +=head1 FORMATS AND USAGE + +The input and output format is YAML 1.0. + +The data formats used by Func transmit are described in more detail (with +examples) at https://fedorahosted.org/func/wiki/FuncTransmit + +=head1 EXIT_STATUS + +Generally func-transmit should always return 0 if loading is successful. Return data is then expressed in the output stream, to be interpreted by a YAML module at the other end of the pipe. Non-zero return codes indicate more serious setup problems. + +Func-transmit will exit after every command issued to the overlord, it does not await further input on the pipes. + +=head1 ADDITONAL RESOURCES + +See https://hosted.fedoraproject.org/projects/func/ for more information. + +See also the manpages for "func-inventory", "funcd", "certmaster", and "certmaster-ca". + +=head1 AUTHOR + +Various. See https://hosted.fedoraproject.org/projects/func + + diff --git a/docs/func.pod b/docs/func.pod index 21ffb7e..5abffb0 100644 --- a/docs/func.pod +++ b/docs/func.pod @@ -105,7 +105,7 @@ called. See the project page (linked below) for more information. See https://hosted.fedoraproject.org/projects/func/ for more information, including information on scripting func from Python. -See also the manpages for "func-inventory", "funcd", "certmaster", and "certmaster-ca". +See also the manpages for "func-inventory", "funcd", "certmaster", "certmaster-ca", and "func-transmit". =head1 AUTHOR diff --git a/docs/funcd.pod b/docs/funcd.pod index 231caef..62fd57a 100644 --- a/docs/funcd.pod +++ b/docs/funcd.pod @@ -16,7 +16,7 @@ Modules and capabilities provided by funcd are specified at https://hosted.fedor See https://hosted.fedoraproject.org/projects/func/. It's a Wiki. -See also the manpages for "func", "certmaster", and "certmaster-ca". +See also the manpages for "func", "certmaster", "certmaster-ca", and "func-transmit". =head1 AUTHOR |