From 226e9015df235ccb41b122bdac35abeb838051f8 Mon Sep 17 00:00:00 2001
From: Nico Schottelius <nico@kr.ethz.ch>
Date: Thu, 28 Oct 2010 15:07:42 +0200
Subject: [PATCH] cleanups

Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
---
 doc/man/.gitignore        |  1 +
 doc/man/cdist-design.text | 54 +++++++++++++++++++++++++++++----------
 2 files changed, 42 insertions(+), 13 deletions(-)

diff --git a/doc/man/.gitignore b/doc/man/.gitignore
index c495df5b..22d0a62d 100644
--- a/doc/man/.gitignore
+++ b/doc/man/.gitignore
@@ -1,2 +1,3 @@
 cdist.7
 *.html
+cdist-design.7
diff --git a/doc/man/cdist-design.text b/doc/man/cdist-design.text
index c8ad4d0b..c879978a 100644
--- a/doc/man/cdist-design.text
+++ b/doc/man/cdist-design.text
@@ -1,20 +1,48 @@
-cdist using the push principle (triggered by server)
+cdist-design(7)
+===============
+Nico Schottelius <nico-cdist--@--schottelius.org>
 
+
+NAME
+----
+cdist-design - Design ideas for cdist
+
+DESCRIPTION
+-----------
+
+When using cdist with the push principle, the execution tree looks likes this:
+
+--------------------------------------------------------------------------------
 % server
-   cdist-deploy-to <client-hostname>
-      cdist-build
-         cdist-preprocess  # fills up variables with content
-            cdist-explore  % client # explores client configuration
-         cdist-compile     # parses configuration, creates internal state in cconfig format, verifies
-         cdist-link        # uses cconfig output, creates executable
-      cdist-remote-exec # 
-         cdist-transfer    # transfer executable to client
-         cdist-execute     % client # execute resulting executable
+   cdist-deploy-to(1)
+      cdist-build(1)
+         cdist-preprocess(1)  # fills up variables with content
+            cdist-explore(1)  % client # explores client configuration
+         cdist-compile(1)     # parses configuration, creates internal state in cconfig format, verifies
+         cdist-link(1)        # uses cconfig output, creates executable
+      cdist-remote-exec(1) # 
+         cdist-transfer(1)    # transfer executable to client
+         cdist-execute(1)     % client # execute resulting executable
+--------------------------------------------------------------------------------
 
 Operation on the server is run as "cdist" user.
 Operation on the client is run as "root" user.
 
-cdist using the pull principle (triggered by client)
+When using cdist with the pull principle (configuration triggered by client):
+
+--------------------------------------------------------------------------------
 % client
-   cdist-trigger <server-hostname> # connects to server
-      cdist-deploy-to <client-hostname> % server: see above
+   cdist-trigger(1) <server-hostname> # connects to server
+      cdist-deploy-to(1) <client-hostname> % server: see above
+--------------------------------------------------------------------------------
+
+SEE ALSO
+--------
+cdist(7), website: http://www.nico.schottelius.org/cdist/[]
+
+
+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).
+