forked from ungleich-public/cdist
begin to remove obsolete documentation
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
Nico Schottelius
parent
1a790edbf6
commit
3cf203a668
20 changed files with 0 additions and 672 deletions
|
|
@ -1,31 +0,0 @@
|
|||
cdist-cache(1)
|
||||
==============
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-cache - Cache output of last run
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-cache TARGET_HOST
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
cdist-cache moves away the objects created during last run so the
|
||||
next run can use the previous information and compare them with
|
||||
the current status.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
cdist(7)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,34 +0,0 @@
|
|||
cdist-code-run(1)
|
||||
=================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-code-run - Run explorer remotely
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-code-run OBJECT_DIR OBJECT TYPE
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
cdist-code-run executes generated code from a given OBJECT.
|
||||
The OBJECT must be located below OBJECT_DIR.
|
||||
TYPE must be either local or remote and determines which
|
||||
code part is to be executed.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-object-gencode(1)
|
||||
- cdist-object-gencode-all(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
cdist-deploy-to(1)
|
||||
==================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-deploy-to - Deploy configuration to host
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-deploy-to HOSTNAME
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Deploy configurations to the specified host, as configured in the initial
|
||||
manifest. This script triggers the execution of several other scripts, in so
|
||||
called stages. It is intented to run either from the command line or from cron.
|
||||
|
||||
|
||||
ENVIRONMENT
|
||||
-----------
|
||||
If the environment variable **__cdist_conf_dir** is not set, the
|
||||
configuration is read from <git-checkout>/conf. The local output directory can
|
||||
be changed by the variable **__cdist_local_base_dir**. All environment
|
||||
variables are handled by cdist-config.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-config(1)
|
||||
- cdist-mass-deploy(1)
|
||||
- cdist-reference(7)
|
||||
- cdist-stages(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).
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
cdist-dir(1)
|
||||
============
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-dir - Poor man's directory synchronisation
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-dir <push|pull> TARGET_HOST SRC_DIR DST_DIR
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
cdist-dir either pushes a local directory to the target host
|
||||
or pulls a remote directory from a target host to the local host.
|
||||
|
||||
In the push case SRC_DIR is local, in the pull case remote.
|
||||
In the push case DST_DIR is remote, in the pull case local.
|
||||
|
||||
cdist-dir does not cleanup DST_DIR and thus it may contain old
|
||||
stuff if used multiple times.
|
||||
|
||||
cdist-dir does not rely on rsync or other high level tools, because
|
||||
it cannot expect its existence on the local or target host.
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
cdist(7)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
cdist-explorer-run-global(1)
|
||||
============================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-explorer-run-global - Run the global explorers
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-explorer-run-global HOSTNAME
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Transfer the global explorers to HOSTNAME, execute them and transfer
|
||||
back the results.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-deploy-to(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
cdist-manifest-run-init(1)
|
||||
==========================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-manifest-run-init - Run the initial manifest
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-manifest-run-init HOSTNAME
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
cdist-manifest-run-init executes the initial manifest, which creates
|
||||
the first objects.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-deploy-to(1)
|
||||
- cdist-manifest-run-all(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
cdist-manifest-run(1)
|
||||
=====================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-manifest-run - Run a given manifest
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-manifest-run HOSTNAME MANIFEST
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
cdist-manifest-run executes the given MANIFEST.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-deploy-to(1)
|
||||
- cdist-manifest-run-init(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
cdist-mass-deploy(1)
|
||||
====================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-mass-deploy - Deploy configuration to many hosts
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-mass-deploy [-p] HOSTNAME [HOSTNAME ...]
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
cdist-mass-deploy is essentially a wrapper around cdist-deploy-to to
|
||||
be able to deploy to many hosts on one command line.
|
||||
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
Deploy in parallel to all hosts specfied in the dsh group configuration ikr,
|
||||
which is prefixed by "root@":
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
cdist-mass-deploy -p $(cat ~/.dsh/group/ikr | sed 's/^root@//')
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-deploy-to(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).
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
cdist-object-all(1)
|
||||
===================
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-object-all - Run the given command on all objects
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-object-all HOSTNAME COMMAND
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Iterates over all defined objects and executes the given command on each
|
||||
of them.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-type(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Steven Armstrong. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
cdist-object-code-run(1)
|
||||
========================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-object-code-run - Execute the generated code for a object
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-object-code-run HOSTNAME OBJECT
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Execute the local and remote code for the given object.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-object-run(1)
|
||||
- cdist-code-run(1)
|
||||
- cdist-run-remote(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius, Steven Armstrong. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
cdist-object-explorer-run(1)
|
||||
============================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-object-explorer-run - Run type explorers for a object
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-object-explorer-run HOSTNAME OBJECT
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Runs the explorers for the given object on the target host.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-deploy-to(1)
|
||||
- cdist-remote-explorer-run(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius, Steven Armstrong. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
cdist-object-gencode-run(1)
|
||||
===========================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-object-gencode-run - Generate code for a object
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-object-gencode-run HOSTNAME OBJECT
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
For the given object, generate the code for local and remote execution.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-code-run(1)
|
||||
- cdist-object-run(1)
|
||||
- cdist-object-gencode(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius, Steven Armstrong. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
cdist-object-gencode(1)
|
||||
=======================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-object-gencode - Generate code for a given object
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-object-gencode HOSTNAME OBJECT
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
For the given object, run the gencode executable. The output of this
|
||||
executable on stdout will be used by cdist-object-gencode-all(1).
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-code-run(1)
|
||||
- cdist-deploy-to(1)
|
||||
- cdist-object-gencode-all(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
cdist-object-manifest-run(1)
|
||||
============================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-object-manifest-run - Run an objects manifest
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-object-manifest-run HOSTNAME OBJECT
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Run the manifest for the given object.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-deploy-to(1)
|
||||
- cdist-manifest-run(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius, Steven Armstrong. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
cdist-object-prepare(1)
|
||||
=======================
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-object-prepare - Prepare an object
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-object-prepare HOSTNAME OBJECT
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Prepare the given object by running it through stage 3 (object information
|
||||
retrieval) and stage 4 (run the object manifest).
|
||||
See related man pages for details.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-stages(7)
|
||||
- cdist-object-explorer-run(1)
|
||||
- cdist-object-manifest-run(1)
|
||||
- cdist-type(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Steven Armstrong. Free use of this software is granted
|
||||
under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
cdist-object-push(1)
|
||||
====================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-object-push - Transfer a object to the target host
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-object-push HOSTNAME OBJECT
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Transfers the given object to the target host.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-object-run(1)
|
||||
- cdist-type(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius, Steven Armstrong. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
cdist-object-run(1)
|
||||
===================
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-object-run - Run an object
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-object-run HOSTNAME OBJECT
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Applies the given object on the target host by running it through stage 5
|
||||
(code generation) and stage 6 (code execution).
|
||||
See related man pages for details.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-stages(7)
|
||||
- cdist-object-gencode-run(1)
|
||||
- cdist-object-push(1)
|
||||
- cdist-object-code-run(1)
|
||||
- cdist-type(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Steven Armstrong. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
cdist-remote-explorer-run(1)
|
||||
============================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-remote-explorer-run - Run explorer remotely
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-remote-explorer-run VARIABLE_NAME EXPLORER_DIR OUT_DIR
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
cdist-remote-explorer-run is executed on the target.
|
||||
It sets up the variable VARIABLE_NAME to point to the given
|
||||
EXPLORER_DIR and runs all explorer found in EXPLORER_DIR.
|
||||
The output of every run explorer is saved into OUT_DIR.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-explorer-run-global(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
cdist-run-remote(1)
|
||||
===================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-run-remote - Execute something on the target
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-run-remote HOSTNAME EXECUTABLE [ARGUMENTS FOR EXECUTABLE]
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
cdist-run-remote runs the given executable on the remote host.
|
||||
It ensures PATH is setup correctly on the target side.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-object-code-run(1)
|
||||
- cdist-deploy-to(1)
|
||||
- cdist-remote-code-run-all(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
cdist-type-build-emulation(1)
|
||||
=============================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type-build-emulation - Build executables for types
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-type-build-emulation OUT_DIR
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
cdist-type-build-emulation creates a link to cdist-type-emulator
|
||||
for every TYPE. These links are placed in a OUT_DIR, which
|
||||
is prepended into $PATH. This way the user can use TYPE in the
|
||||
manifests like any other executable.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-type-emulator(1)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
Loading…
Reference in a new issue