diff --git a/docs/src/cdist-quickstart.rst b/docs/src/cdist-quickstart.rst index 20c33cb8..7c967691 100644 --- a/docs/src/cdist-quickstart.rst +++ b/docs/src/cdist-quickstart.rst @@ -68,6 +68,12 @@ code into your shell to get started and configure localhost:: # Find out that cdist created /etc/cdist-configured ls -l /etc/cdist-configured +Note: cdist/conf is configuration directory shipped with cdist distribution. +If exists, ~/.cdist, is also automatically used as cdist configuration +directory. So in the above example you could create ~/.cdist directory, +then ~/.cdist/manifest sub-directory and create init manifest +~/.cdist/manifest/init. + That's it, you've successfully used cdist to configure your first host! Continue reading the next sections, to understand what you did and how to create a more sophisticated configuration. diff --git a/docs/src/man1/cdist.rst b/docs/src/man1/cdist.rst index 5b821d46..9ac3b1f4 100644 --- a/docs/src/man1/cdist.rst +++ b/docs/src/man1/cdist.rst @@ -102,8 +102,21 @@ usage. Its primary use is for debugging type parameters. .. option:: -s/--shell - Select shell to use, defaults to current shell + Select shell to use, defaults to current shell. Used shell should + be POSIX compatible shell. +FILES +----- +~/.cdist + Your personal cdist config directory. If exists it will be + automatically used. +${cdist_prefix}/cdist/conf + The distribution configuration directory. ${cdist_prefix} is + installation-dependent. If you install cdist using git it is + equal to your cloned directory. If you install it using python + pip then it is equal to + ${prefix}/lib/python/site-packages/cdist sub-directory + where ${prefix}, by default, is /usr/local (see :strong:`python`\ (1)). EXAMPLES --------