summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rwxr-xr-xMakefile1
-rw-r--r--docs/func-inventory.pod2
-rw-r--r--docs/func-transmit.pod39
-rw-r--r--docs/func.pod2
-rw-r--r--docs/funcd.pod2
-rw-r--r--func.spec1
-rw-r--r--setup.py1
7 files changed, 45 insertions, 3 deletions
diff --git a/Makefile b/Makefile
index 74b7f6e..96424a6 100755
--- a/Makefile
+++ b/Makefile
@@ -17,6 +17,7 @@ manpage:
pod2man --center="funcd" --release="" ./docs/funcd.pod | gzip -c > ./docs/funcd.1.gz
pod2man --center="func" --release="" ./docs/func.pod | gzip -c > ./docs/func.1.gz
pod2man --center="func-inventory" --release="" ./docs/func-inventory.pod | gzip -c > ./docs/func-inventory.1.gz
+ pod2man --center="func-transmit" --release="" ./docs/func-transmit.pod | gzip -c > ./docs/func-transmit.1.gz
messages: func/minion/*.py
xgettext -k_ -kN_ -o $(MESSAGESPOT) func/minion/*.py
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
diff --git a/func.spec b/func.spec
index a5193c5..b4b1410 100644
--- a/func.spec
+++ b/func.spec
@@ -88,6 +88,7 @@ rm -fr $RPM_BUILD_ROOT
%{_mandir}/man1/func.1.gz
%{_mandir}/man1/func-inventory.1.gz
%{_mandir}/man1/funcd.1.gz
+%{_mandir}/man1/func-transmit.1.gz
%post
diff --git a/setup.py b/setup.py
index 83d98d5..992992a 100644
--- a/setup.py
+++ b/setup.py
@@ -58,6 +58,7 @@ if __name__ == "__main__":
(manpath, ["docs/func.1.gz"]),
(manpath, ["docs/func-inventory.1.gz"]),
(manpath, ["docs/funcd.1.gz"]),
+ (manpath, ["docs/func-transmit.1.gz"]),
(rotpath, ['etc/func_rotate']),
(logpath, []),
(etcmodpath, []),