[DOC] add manpage for cdist-quickstart
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
parent
24eb626ca8
commit
2389dde9f5
5 changed files with 54 additions and 45 deletions
3
Makefile
3
Makefile
|
@ -11,9 +11,7 @@ WEBPAGE=software/cdist.mdwn
|
|||
MANDIR=doc/man
|
||||
# Unchecked
|
||||
MANSRC=$(MANDIR)/cdist-config-layout.text \
|
||||
$(MANDIR)/cdist-quickstart.text \
|
||||
$(MANDIR)/cdist-stages.text \
|
||||
$(MANDIR)/cdist-terms.text \
|
||||
|
||||
# Clean documentation
|
||||
MANGENERATED=$(MANDIR)/cdist-reference.text
|
||||
|
@ -26,6 +24,7 @@ MANSRC=$(MANDIR)/cdist.text \
|
|||
$(MANDIR)/cdist-deploy-to.text \
|
||||
$(MANDIR)/cdist-explorer.text \
|
||||
$(MANDIR)/cdist-manifest.text \
|
||||
$(MANDIR)/cdist-quickstart.text \
|
||||
$(MANDIR)/cdist-stages.text \
|
||||
$(MANDIR)/cdist-type.text \
|
||||
$(MANDIR)/cdist-type-template.text \
|
||||
|
|
|
@ -2,6 +2,8 @@
|
|||
* Replace type __file with __file, __directory, __link
|
||||
* Document cdist-env
|
||||
* Document cdist-config
|
||||
* Document cdist-dir
|
||||
* Document cdist-quickstart
|
||||
|
||||
1.0.4: 2011-03-15
|
||||
* New type __motd
|
||||
|
|
|
@ -38,7 +38,6 @@ Documentation:
|
|||
- cdist-object-codegen
|
||||
- cdist-object-codegen-all
|
||||
- cdist-object-explorer-all
|
||||
- cdist-quickstart
|
||||
- cdist-remote-code-run-all
|
||||
- cdist-remote-explorer-run
|
||||
- cdist-run-remote
|
||||
|
|
51
doc/man/cdist-quickstart.text
Normal file
51
doc/man/cdist-quickstart.text
Normal file
|
@ -0,0 +1,51 @@
|
|||
cdist-quickstart(1)
|
||||
===================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-quickstart - Make use of cinit in 5 minutes
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-quickstart
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
cdist-quickstart is an interactive guide to cdist. It should be one
|
||||
of the first tools you use when you begin with cdist.
|
||||
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
To use cdist-quickstart, add the bin directory to your PATH,
|
||||
execute cdist-quickstart and enjoy cdist:
|
||||
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
# Bourne shell example
|
||||
export PATH=$(pwd -P)/bin:$PATH
|
||||
|
||||
# Alternatively, usable for csh and bsh, set's up PATH and MANPATH
|
||||
eval `./bin/cdist-env`
|
||||
|
||||
# Let's go!
|
||||
cdist-quickstart
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-env(1)
|
||||
|
||||
|
||||
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).
|
||||
## How to use cdist?
|
|
@ -1,42 +0,0 @@
|
|||
cdist-quickstart(1)
|
||||
===================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-quickstart - Make use of cinit in 5 minutes
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This document helps you to take the first steps with cdist.
|
||||
We'll begin to configure the host "localhost" to have two files
|
||||
in place, /etc/DO-NOT-CHANGE and /root/CDIST-ENABLED-HOST, which
|
||||
both are used to warn other sysadmins that this system is managed
|
||||
by configuration management and manual changes may get overwritten.
|
||||
|
||||
Begin to execute cdist-quickstart, it will show you the steps it
|
||||
takes and explains what it does:
|
||||
|
||||
% cdist-quickstart
|
||||
|
||||
mkdir -p /etc/cdist/manifests
|
||||
|
||||
# Create
|
||||
|
||||
Cdist uses
|
||||
kgives you an impression of
|
||||
0. Create a host specification (/etc/cdist/hosts/**hostname**)
|
||||
0. Add functionalilty to add
|
||||
0. Run ***cdist-apply***
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
cdist-config-layout(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).
|
||||
## How to use cdist?
|
Loading…
Reference in a new issue