From 0f60a2387aa57cb30179a78661bee3b6f786afb9 Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Sun, 20 Mar 2011 00:51:45 +0100 Subject: [PATCH] document cdist-remote-explorer-run.text Signed-off-by: Nico Schottelius --- Makefile | 1 + doc/changelog | 1 + doc/dev/todo/niconext | 7 ++++-- doc/man/cdist-remote-explorer-run.text | 33 ++++++++++++++++++++++++++ 4 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 doc/man/cdist-remote-explorer-run.text diff --git a/Makefile b/Makefile index 20f961cd..9168fc9f 100644 --- a/Makefile +++ b/Makefile @@ -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 \ diff --git a/doc/changelog b/doc/changelog index 054b9f71..a799335d 100644 --- a/doc/changelog +++ b/doc/changelog @@ -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 diff --git a/doc/dev/todo/niconext b/doc/dev/todo/niconext index 4e90e2b1..e299766b 100644 --- a/doc/dev/todo/niconext +++ b/doc/dev/todo/niconext @@ -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% + diff --git a/doc/man/cdist-remote-explorer-run.text b/doc/man/cdist-remote-explorer-run.text new file mode 100644 index 00000000..64951e2c --- /dev/null +++ b/doc/man/cdist-remote-explorer-run.text @@ -0,0 +1,33 @@ +cdist-remote-explorer-run(1) +============================ +Nico Schottelius + + +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).