blob: 878deb6bd41fd9cdd0759f6f1416662383e0b3c9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
=head1 NAME
Func-transmit -- cross-language func adapter
=head1 SYNOPSIS
func-transmit [-h|--help] [-j|--json] [-y|--yaml] < data_in > data_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 either JSON or YAML 1.0. The default is JSON. The [--yaml] option enables YAML support.
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 JSON or 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
|
