document cdist-remote-explorer-run.text

Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
Nico Schottelius 2011-03-20 00:51:45 +01:00
parent bda2adb22c
commit 0f60a2387a
4 changed files with 40 additions and 2 deletions

View file

@ -28,6 +28,7 @@ MANSRC=$(MANDIR)/cdist.text \
$(MANDIR)/cdist-object-gencode.text \
$(MANDIR)/cdist-object-gencode-all.text \
$(MANDIR)/cdist-quickstart.text \
$(MANDIR)/cdist-remote-explorer-run.text \
$(MANDIR)/cdist-run-remote.text \
$(MANDIR)/cdist-stages.text \
$(MANDIR)/cdist-type.text \

View file

@ -1,6 +1,7 @@
1.3.1:
* Document cdist-type-build-emulation
* Document cdist-type-emulator
* Document cdist-remote-explorer-run
1.3.0: 2011-03-20
* Add support for local and remote code generation and execution

View file

@ -1,3 +1,6 @@
Ensure bin/* is documented
- cdist-remote-code-run-all
- cdist-remote-explorer-run
[0:43] kr:bin% for a in *; do test -f ../doc/man/${a}.text || echo $a missing ; done
cdist-code-run missing
[0:44] kr:bin%

View file

@ -0,0 +1,33 @@
cdist-remote-explorer-run(1)
============================
Nico Schottelius <nico-cdist--@--schottelius.org>
NAME
----
cdist-remote-explorer-run - Run explorer remotely
SYNOPSIS
--------
cdist-remote-explorer-run VARIABLE_NAME EXPLORER_DIR OUT_DIR
DESCRIPTION
-----------
cdist-remote-explorer-run is executed on the target.
It sets up the variable VARIABLE_NAME to point to the given
EXPLORER_DIR and runs all explorer found in EXPLORER_DIR.
The output of every run explorer is saved into OUT_DIR.
SEE ALSO
--------
- cdist(7)
- cdist-explorer-run-global(1)
COPYING
-------
Copyright \(C) 2011 Nico Schottelius. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).