From 5e8a544441697edbae712658bd5229c85912c6b4 Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Wed, 2 Feb 2011 22:15:54 +0100 Subject: [PATCH] [doc] create new explorer manpage Signed-off-by: Nico Schottelius --- doc/man/cdist-explorer-coordinator.text | 34 +++++++++++++++++++++++++ doc/man/cdist-explorer.text | 22 ++++++---------- 2 files changed, 42 insertions(+), 14 deletions(-) create mode 100644 doc/man/cdist-explorer-coordinator.text diff --git a/doc/man/cdist-explorer-coordinator.text b/doc/man/cdist-explorer-coordinator.text new file mode 100644 index 00000000..23a94eef --- /dev/null +++ b/doc/man/cdist-explorer-coordinator.text @@ -0,0 +1,34 @@ +cdist-explorer-coordinator(1) +============================= +Nico Schottelius + + +NAME +---- +cdist-explorer-coordinator - Coordinate explorer on target systems + +DESCRIPTION +----------- + +The cdist-explorer-coordinator is responsible for getting information +about the target system. Its job is to find locally the available +explorers and prepare them for execution on the remote host. + +Each and every explorer may return the information from the target system, +which is assigned to a local variable of the name __explorer_EXPLORERNAME. + +NOTES +----- +The first version of the cdist-explorer-coordinator (named cdist-build-explorer) +used to create strings remote, taken literally. saves ssh, insecure. + +SEE ALSO +-------- +cdist(7) + + +COPYING +------- +Copyright \(C) 2010 Nico Schottelius. Free use of this software is +granted under the terms of the GNU General Public License version 3 (GPLv3). + diff --git a/doc/man/cdist-explorer.text b/doc/man/cdist-explorer.text index 23a94eef..d3141cd4 100644 --- a/doc/man/cdist-explorer.text +++ b/doc/man/cdist-explorer.text @@ -1,26 +1,20 @@ -cdist-explorer-coordinator(1) -============================= +cdist-explorer(7) +================= Nico Schottelius NAME ---- -cdist-explorer-coordinator - Coordinate explorer on target systems +cdist-explorer - Explore the target systems DESCRIPTION ----------- +Cdist explorer are small shell scripts, which will be executed +on the target host. The aim of the explorer is to give hints +to types on how to act on the target system. -The cdist-explorer-coordinator is responsible for getting information -about the target system. Its job is to find locally the available -explorers and prepare them for execution on the remote host. - -Each and every explorer may return the information from the target system, -which is assigned to a local variable of the name __explorer_EXPLORERNAME. - -NOTES ------ -The first version of the cdist-explorer-coordinator (named cdist-build-explorer) -used to create strings remote, taken literally. saves ssh, insecure. +Explorer are located below $config_dir/explorer. Their name +must be usable as a environment variable. SEE ALSO --------