marcoduif/cdist
1
0
Fork 0
forked from ungleich-public/cdist
Code Issues Pull requests 1 Projects Releases Wiki Activity

rephrase and cleanup cdist-explorers.text

Browse source 
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
Nico Schottelius 2011-02-22 23:58:04 +01:00
parent f87472e65d
commit d3e2c4a3e8
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
doc/man/cdist-explorers.text
View file

@ -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 ./<explorer_name> (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/<explorer_name>.
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).