From 48058925d64db639c715417a6c1cea4efe8d06ec Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Sat, 26 Feb 2011 20:01:51 +0100 Subject: [PATCH] finished cdist.text, mark all other manpages to be checked Signed-off-by: Nico Schottelius --- Makefile | 2 +- doc/man/cdist.text | 34 +++++++------------ .../{ => to_check}/cdist-config-layout.text | 0 doc/man/{ => to_check}/cdist-config.text | 0 doc/man/{ => to_check}/cdist-deploy-to.text | 0 doc/man/{ => to_check}/cdist-explorer.text | 0 doc/man/{ => to_check}/cdist-manifest.text | 0 doc/man/{ => to_check}/cdist-quickstart.text | 0 doc/man/{ => to_check}/cdist-stages.text | 0 doc/man/{ => to_check}/cdist-terms.text | 0 .../{ => to_check}/cdist-type-manifest.text | 0 doc/man/{ => to_check}/cdist-type.text | 0 12 files changed, 13 insertions(+), 23 deletions(-) rename doc/man/{ => to_check}/cdist-config-layout.text (100%) rename doc/man/{ => to_check}/cdist-config.text (100%) rename doc/man/{ => to_check}/cdist-deploy-to.text (100%) rename doc/man/{ => to_check}/cdist-explorer.text (100%) rename doc/man/{ => to_check}/cdist-manifest.text (100%) rename doc/man/{ => to_check}/cdist-quickstart.text (100%) rename doc/man/{ => to_check}/cdist-stages.text (100%) rename doc/man/{ => to_check}/cdist-terms.text (100%) rename doc/man/{ => to_check}/cdist-type-manifest.text (100%) rename doc/man/{ => to_check}/cdist-type.text (100%) diff --git a/Makefile b/Makefile index 5edca67a..02c585a1 100644 --- a/Makefile +++ b/Makefile @@ -41,7 +41,7 @@ clean: # FIXME: some distro nerd, can you make this more beautiful? # Like integrating install, ... # I'm just a hacker, I don't really care... -install: +install: install-man cp bin/* $(BINDIR) install-man: diff --git a/doc/man/cdist.text b/doc/man/cdist.text index ac12c8f7..099e01b5 100644 --- a/doc/man/cdist.text +++ b/doc/man/cdist.text @@ -8,34 +8,23 @@ NAME cdist - Configuration management system -NEW DESCRIPTION ------------ -- is cm -- quickstart - cdist-quickstart -- configured in shell dsl - pointers to posix and problems (sh != bash), os specific -- how to apply - cdist-deploy-to -- how to write - cdist-manifest, cdist-type -- - - DESCRIPTION ----------- Cdist is a very simple, elegant, cleanly designed configuration management -system. Cdist allows you to centrally define configurations for UNIX systems -Cdist generally uses the push approach (a server pushes out the -configuration to the clients), but can also be used the pull way. - -Cdist-deploy-to is the main command to be used to configure a host. +system. The easiest way to get started with cdist is to run cdist-quickstart. +Cdist configurations are written in the shell scripting language. The mapping of configurations to hosts is defined in so called manifests, -which are written in shell script language. +logical units of functionality are called "types" in cdist jargon. +Cdist ships with some types included. You can use or change them, create new +ones or even submit your types for inclusion into cdist. -Logical units of functionality are called "types" in cdist jargon. Cdist ships -with some types, which you can change or create new ones or even submit your -types for inclusion into cdist. - -The fastest way to get a host configured using cdist is probably using -cdist-quickstart. +The main command is cdist-deploy-to, which runs several stages to push +configurations to a host. If you want to deeply understand cdist, reading +the source of cdist-deploy-to is recommended. +Cdist currently uses the push approach (a server pushes out the +configuration to the clients), but future version will also support the +pull mechanism (client requests configuration). SEE ALSO @@ -44,6 +33,7 @@ Website: http://www.nico.schottelius.org/cdist/[], cdist-push-pull(7), cdist-deploy-to(1), cdist-manifest(7), cdist-types(7), cdist-type-inclusion(7), cdist-quickstart(1) + COPYING ------- Copyright \(C) 2010-2011 Nico Schottelius. Free use of this software is diff --git a/doc/man/cdist-config-layout.text b/doc/man/to_check/cdist-config-layout.text similarity index 100% rename from doc/man/cdist-config-layout.text rename to doc/man/to_check/cdist-config-layout.text diff --git a/doc/man/cdist-config.text b/doc/man/to_check/cdist-config.text similarity index 100% rename from doc/man/cdist-config.text rename to doc/man/to_check/cdist-config.text diff --git a/doc/man/cdist-deploy-to.text b/doc/man/to_check/cdist-deploy-to.text similarity index 100% rename from doc/man/cdist-deploy-to.text rename to doc/man/to_check/cdist-deploy-to.text diff --git a/doc/man/cdist-explorer.text b/doc/man/to_check/cdist-explorer.text similarity index 100% rename from doc/man/cdist-explorer.text rename to doc/man/to_check/cdist-explorer.text diff --git a/doc/man/cdist-manifest.text b/doc/man/to_check/cdist-manifest.text similarity index 100% rename from doc/man/cdist-manifest.text rename to doc/man/to_check/cdist-manifest.text diff --git a/doc/man/cdist-quickstart.text b/doc/man/to_check/cdist-quickstart.text similarity index 100% rename from doc/man/cdist-quickstart.text rename to doc/man/to_check/cdist-quickstart.text diff --git a/doc/man/cdist-stages.text b/doc/man/to_check/cdist-stages.text similarity index 100% rename from doc/man/cdist-stages.text rename to doc/man/to_check/cdist-stages.text diff --git a/doc/man/cdist-terms.text b/doc/man/to_check/cdist-terms.text similarity index 100% rename from doc/man/cdist-terms.text rename to doc/man/to_check/cdist-terms.text diff --git a/doc/man/cdist-type-manifest.text b/doc/man/to_check/cdist-type-manifest.text similarity index 100% rename from doc/man/cdist-type-manifest.text rename to doc/man/to_check/cdist-type-manifest.text diff --git a/doc/man/cdist-type.text b/doc/man/to_check/cdist-type.text similarity index 100% rename from doc/man/cdist-type.text rename to doc/man/to_check/cdist-type.text