From d2c4ffb5f00ea30382c92e1d1b2432d0d19a6729 Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Wed, 16 Mar 2011 08:45:01 +0100 Subject: [PATCH] cleanup manpages for new types Signed-off-by: Nico Schottelius --- conf/type/__directory/man.text | 15 ++++----------- conf/type/__file/man.text | 13 +++---------- conf/type/__link/man.text | 9 +++++---- 3 files changed, 12 insertions(+), 25 deletions(-) diff --git a/conf/type/__directory/man.text b/conf/type/__directory/man.text index a619666d..f7272df9 100644 --- a/conf/type/__directory/man.text +++ b/conf/type/__directory/man.text @@ -37,18 +37,11 @@ EXAMPLES -------- -------------------------------------------------------------------------------- -# Create /etc/cdist-configured as an empty file -__file /etc/cdist-configured --type file +# A silly example +__directory /tmp/foobar -# Same but with a different object id -__file cdist-marker --type file --destination /etc/cdist-configured - -# Use __file from another type -__file /etc/issue --source "$__type/files/archlinux" --type file - -# Supply some more settings -__file /etc/shadow --source "$__type/files/shadow" --type file \ - --owner root --group shadow --mode 0640 +# Ensure /etc exists correctly +__file /etc --owner root --group root --mode 0755 -------------------------------------------------------------------------------- diff --git a/conf/type/__file/man.text b/conf/type/__file/man.text index 22b367cb..67ab53d1 100644 --- a/conf/type/__file/man.text +++ b/conf/type/__file/man.text @@ -20,10 +20,6 @@ None. OPTIONAL PARAMETERS ------------------- -destination:: - If supplied, use this as the destination on the target. Otherwise the - object_id is used. - group:: Group to chgrp to. @@ -43,16 +39,13 @@ EXAMPLES -------------------------------------------------------------------------------- # Create /etc/cdist-configured as an empty file -__file /etc/cdist-configured --type file - -# Same but with a different object id -__file cdist-marker --type file --destination /etc/cdist-configured +__file /etc/cdist-configured # Use __file from another type -__file /etc/issue --source "$__type/files/archlinux" --type file +__file /etc/issue --source "$__type/files/archlinux" # Supply some more settings -__file /etc/shadow --source "$__type/files/shadow" --type file \ +__file /etc/shadow --source "$__type/files/shadow" \ --owner root --group shadow --mode 0640 -------------------------------------------------------------------------------- diff --git a/conf/type/__link/man.text b/conf/type/__link/man.text index db124cb9..fb914298 100644 --- a/conf/type/__link/man.text +++ b/conf/type/__link/man.text @@ -27,20 +27,21 @@ OPTIONAL PARAMETERS ------------------- None. + EXAMPLES -------- -------------------------------------------------------------------------------- # Create hard link of /etc/shadow -__file /root/shadow --source /etc/shadow --type hard +__link /root/shadow --source /etc/shadow --type hard # Relative symbolic link -__file /etc/apache2/sites-enabled/www.test.ch \ +__link /etc/apache2/sites-enabled/www.test.ch \ --source ../sites-available/www.test.ch \ --type symbolic -# Relative absolute link -__file /opt/plone --source /home/services/plone --type symbolic +# Absolute symbolic link +__link /opt/plone --source /home/services/plone --type symbolic --------------------------------------------------------------------------------