From d3e2c4a3e8f379640221a9272d66b114ca401499 Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Tue, 22 Feb 2011 23:58:04 +0100 Subject: [PATCH] rephrase and cleanup cdist-explorers.text Signed-off-by: Nico Schottelius --- doc/man/cdist-explorers.text | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/man/cdist-explorers.text b/doc/man/cdist-explorers.text index 99c7c609..659a01e1 100644 --- a/doc/man/cdist-explorers.text +++ b/doc/man/cdist-explorers.text @@ -7,37 +7,37 @@ NAME ---- 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 explorer output the result of its investigation +to stdout and should be a one-liner. The output may be empty, +though. -Explorer are located below $config_dir/explorer. Their name -must be usable as a environment variable. +Cdist knows about general explorers, which are run in an early +stage and type specific explorers. Both work exactly the same way, +with the difference that the values of the general explorers +are stored in a general location and the type specific below +the types. -The shell script must output the result of its investigation -to stdout. The output may be empty. +Explorers can reuse other explorers on the target system +by calling ./ (i.e. explorers are run +from their location). In case of significant errors, the shell script may exit non-zero and return an error message on stderr, which will cause the cdist run to abort. -Explorers can reuse other explorers on the target system -by calling $__cdist_explorer_path/. - -REQUIREMENTS ------------- -The directory $__cdist_remote_base_dir must be creatable -on the target host (i.e. requires read/write permission). SEE ALSO -------- -cdist(7) +cdist(7), cdist-config-layout(7), cdist-stages(7) COPYING ------- Copyright \(C) 2010-2011 Nico Schottelius. Free use of this software is granted under the terms of the GNU General Public License version 3 (GPLv3). -