diff --git a/software/cdist/man/cdist-best-practice.html b/software/cdist/man/cdist-best-practice.html index 925794fa..a82d10fd 100644 --- a/software/cdist/man/cdist-best-practice.html +++ b/software/cdist/man/cdist-best-practice.html @@ -1,6 +1,6 @@ -cdist-best-practice(7)

cdist-best-practice(7)

Nico Schottelius

Table of Contents

1. NAME
2. PASSWORDLESS CONNECTIONS
3. SPEEDING UP SSH CONNECTIONS
4. MULTI MASTER OR ENVIRONMENT SETUPS
5. SEE ALSO
6. COPYING

1. NAME

cdist-best-practice - Practices used in real environments

2. PASSWORDLESS CONNECTIONS

It is recommended to run cdist with public key authentication. +cdist-best-practice(7)

cdist-best-practice(7)

Table of Contents

1. NAME
2. PASSWORDLESS CONNECTIONS
3. SPEEDING UP SSH CONNECTIONS
4. MULTI MASTER OR ENVIRONMENT SETUPS
5. SEE ALSO
6. COPYING

1. NAME

cdist-best-practice - Practices used in real environments

2. PASSWORDLESS CONNECTIONS

It is recommended to run cdist with public key authentication. This requires a private/public key pair and the entry "PermitRootLogin without-password" in the sshd server. See sshd_config(5) and ssh-keygen(1).

3. SPEEDING UP SSH CONNECTIONS

When connecting to a new host, the initial delay with ssh connections diff --git a/software/cdist/man/cdist-cache.html b/software/cdist/man/cdist-cache.html index 9229be09..34d0dd07 100644 --- a/software/cdist/man/cdist-cache.html +++ b/software/cdist/man/cdist-cache.html @@ -1,6 +1,6 @@ -cdist-cache(1)

cdist-cache(1)

Table of Contents

1. NAME
2. SYNOPSIS
3. DESCRIPTION
4. SEE ALSO
5. COPYING

1. NAME

cdist-cache - Cache output of last run

2. SYNOPSIS

cdist-cache TARGET_HOST

3. DESCRIPTION

cdist-cache moves away the objects created during last run so the +cdist-cache(1)

cdist-cache(1)

Table of Contents

1. NAME
2. SYNOPSIS
3. DESCRIPTION
4. SEE ALSO
5. COPYING

1. NAME

cdist-cache - Cache output of last run

2. SYNOPSIS

cdist-cache TARGET_HOST

3. 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.

4. SEE ALSO

cdist(7)

5. 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).

diff --git a/software/cdist/man/cdist-code-run.html b/software/cdist/man/cdist-code-run.html index 7c22e746..c0388e0c 100644 --- a/software/cdist/man/cdist-code-run.html +++ b/software/cdist/man/cdist-code-run.html @@ -1,6 +1,6 @@ -cdist-code-run(1)

cdist-code-run(1)

Table of Contents

1. NAME
2. SYNOPSIS
3. DESCRIPTION
4. SEE ALSO
5. COPYING

1. NAME

cdist-code-run - Run explorer remotely

2. SYNOPSIS

cdist-code-run OBJECT_DIR OBJECT TYPE

3. DESCRIPTION

cdist-code-run executes generated code from a given OBJECT. +cdist-code-run(1)

cdist-code-run(1)

Table of Contents

1. NAME
2. SYNOPSIS
3. DESCRIPTION
4. SEE ALSO
5. COPYING

1. NAME

cdist-code-run - Run explorer remotely

2. SYNOPSIS

cdist-code-run OBJECT_DIR OBJECT TYPE

3. 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.

4. SEE ALSO

  • diff --git a/software/cdist/man/cdist-config.html b/software/cdist/man/cdist-config.html index d42e7f8f..d1d9034f 100644 --- a/software/cdist/man/cdist-config.html +++ b/software/cdist/man/cdist-config.html @@ -1,6 +1,6 @@ -cdist-config(1)

    cdist-config(1)

    Table of Contents

    1. NAME
    2. DESCRIPTION
    3. SEE ALSO
    4. COPYING

    1. NAME

    cdist-config - Read basic cdist configuration

    2. DESCRIPTION

    Cdist-config is sourced by cdist programs and provides hints on where to find +cdist-config(1)

    cdist-config(1)

    Table of Contents

    1. NAME
    2. DESCRIPTION
    3. SEE ALSO
    4. COPYING

    1. NAME

    cdist-config - Read basic cdist configuration

    2. DESCRIPTION

    Cdist-config is sourced by cdist programs and provides hints on where to find types, manifests, etc. Generally speaking, it’s just usable from within the core and is only of interest for cdist-developers.

    3. SEE ALSO

    cdist(7)

    4. 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).

    diff --git a/software/cdist/man/cdist-deploy-to.html b/software/cdist/man/cdist-deploy-to.html index fb741733..e9c7d555 100644 --- a/software/cdist/man/cdist-deploy-to.html +++ b/software/cdist/man/cdist-deploy-to.html @@ -1,6 +1,6 @@ -cdist-deploy-to(1)

    cdist-deploy-to(1)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. ENVIRONMENT
    5. SEE ALSO
    6. COPYING

    1. NAME

    cdist-deploy-to - Deploy configuration to host

    2. SYNOPSIS

    cdist-deploy-to HOSTNAME

    3. DESCRIPTION

    Deploy configurations to the specified host, as configured in the initial +cdist-deploy-to(1)

    cdist-deploy-to(1)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. ENVIRONMENT
    5. SEE ALSO
    6. COPYING

    1. NAME

    cdist-deploy-to - Deploy configuration to host

    2. SYNOPSIS

    cdist-deploy-to HOSTNAME

    3. 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.

    4. ENVIRONMENT

    If the environment variable cdist_conf_dir is not set, the configuration is read from /etc/cdist. The local output directory can diff --git a/software/cdist/man/cdist-dir.html b/software/cdist/man/cdist-dir.html index ea49ed88..22e5960a 100644 --- a/software/cdist/man/cdist-dir.html +++ b/software/cdist/man/cdist-dir.html @@ -1,6 +1,6 @@ -cdist-dir(1)

    cdist-dir(1)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. SEE ALSO
    5. COPYING

    1. NAME

    cdist-dir - Poor man’s directory synchronisation

    2. SYNOPSIS

    cdist-dir <push|pull> TARGET_HOST SRC_DIR DST_DIR

    3. DESCRIPTION

    cdist-dir either pushes a local directory to the target host +cdist-dir(1)

    cdist-dir(1)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. SEE ALSO
    5. COPYING

    1. NAME

    cdist-dir - Poor man’s directory synchronisation

    2. SYNOPSIS

    cdist-dir <push|pull> TARGET_HOST SRC_DIR DST_DIR

    3. 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 diff --git a/software/cdist/man/cdist-env.html b/software/cdist/man/cdist-env.html index a4051698..81bc87b9 100644 --- a/software/cdist/man/cdist-env.html +++ b/software/cdist/man/cdist-env.html @@ -1,6 +1,6 @@ -cdist-env(1)

    cdist-env(1)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. EXAMPLES
    5. SEE ALSO
    6. COPYING

    1. NAME

    cdist-env - Setup environment for using cdist

    2. SYNOPSIS

    cdist-env

    3. DESCRIPTION

    cdist-env outputs two strings suitable for usage in your current shell, +cdist-env(1)

    cdist-env(1)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. EXAMPLES
    5. SEE ALSO
    6. COPYING

    1. NAME

    cdist-env - Setup environment for using cdist

    2. SYNOPSIS

    cdist-env

    3. DESCRIPTION

    cdist-env outputs two strings suitable for usage in your current shell, so you can use cdist from the checkout. cdist-env essentially helps you to easily setup PATH and MANPATH.

    If you’ve multiple checkouts of cdist and run cdist-env from the various checkouts, a new run will prepend the last directory, thus ensures you diff --git a/software/cdist/man/cdist-explorer-run-global.html b/software/cdist/man/cdist-explorer-run-global.html index a8f4e4f5..73ba7c3d 100644 --- a/software/cdist/man/cdist-explorer-run-global.html +++ b/software/cdist/man/cdist-explorer-run-global.html @@ -1,6 +1,6 @@ -cdist-explorer-run-global(1)

    cdist-explorer-run-global(1)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. SEE ALSO
    5. COPYING

    1. NAME

    cdist-explorer-run-global - Run the global explorers

    2. SYNOPSIS

    cdist-explorer-run-global HOSTNAME

    3. DESCRIPTION

    Transfer the global explorers to HOSTNAME, execute them and transfer +cdist-explorer-run-global(1)

    cdist-explorer-run-global(1)

    Table of Contents

    1. NAME
    2. SYNOPSIS
    3. DESCRIPTION
    4. SEE ALSO
    5. COPYING

    1. NAME

    cdist-explorer-run-global - Run the global explorers

    2. SYNOPSIS

    cdist-explorer-run-global HOSTNAME

    3. DESCRIPTION

    Transfer the global explorers to HOSTNAME, execute them and transfer back the results.

    4. SEE ALSO

    • cdist(7)
    • diff --git a/software/cdist/man/cdist-explorer.html b/software/cdist/man/cdist-explorer.html index 4127e251..811c3636 100644 --- a/software/cdist/man/cdist-explorer.html +++ b/software/cdist/man/cdist-explorer.html @@ -1,6 +1,6 @@ -cdist-explorer(7)

      cdist-explorer(7)

      Table of Contents

      1. NAME
      2. DESCRIPTION
      3. EXAMPLES
      4. SEE ALSO
      5. COPYING

      1. NAME

      cdist-explorer - Explore the target systems

      2. DESCRIPTION

      Explorer are small shell scripts, which will be executed on the target +cdist-explorer(7)

      cdist-explorer(7)

      Table of Contents

      1. NAME
      2. DESCRIPTION
      3. EXAMPLES
      4. SEE ALSO
      5. COPYING

      1. NAME

      cdist-explorer - Explore the target systems

      2. DESCRIPTION

      Explorer are small shell scripts, which will be executed on the target host. The aim of the explorer is to give hints to types on how to act on the target system. An explorer outputs the result to stdout, which is usually a one liner, but may be empty or multi line especially in the case of diff --git a/software/cdist/man/cdist-hacker.html b/software/cdist/man/cdist-hacker.html index d9f0d896..45854d77 100644 --- a/software/cdist/man/cdist-hacker.html +++ b/software/cdist/man/cdist-hacker.html @@ -1,6 +1,6 @@ -cdist-hacker(7)

      cdist-hacker(7)

      Table of Contents

      1. NAME
      2. WELCOME
      3. UNDERSTANDING CDIST INTERNALS
      4. CODING CONVENTIONS (CORE)
      5. HOW TO SUBMIT STUFF FOR INCLUSION INTO UPSTREAM CDIST
      6. HOW TO SUBMIT A NEW TYPE
      7. SEE ALSO
      8. COPYING

      1. NAME

      cdist-hacker - How to get (stuff) into cdist

      2. WELCOME

      Welcome dear hacker! I invite you to a tour of pointers to +cdist-hacker(7)

      cdist-hacker(7)

      Table of Contents

      1. NAME
      2. WELCOME
      3. UNDERSTANDING CDIST INTERNALS
      4. CODING CONVENTIONS (CORE)
      5. HOW TO SUBMIT STUFF FOR INCLUSION INTO UPSTREAM CDIST
      6. HOW TO SUBMIT A NEW TYPE
      7. SEE ALSO
      8. COPYING

      1. NAME

      cdist-hacker - How to get (stuff) into cdist

      2. WELCOME

      Welcome dear hacker! I invite you to a tour of pointers to get into the usable configuration mangament system, cdist.

      The first thing to know is probably that cdist is brought to you by people who care about how code looks like and who think twice before merging or implementing a feature: Less features diff --git a/software/cdist/man/cdist-manifest-run-init.html b/software/cdist/man/cdist-manifest-run-init.html index 3e75152e..28c38725 100644 --- a/software/cdist/man/cdist-manifest-run-init.html +++ b/software/cdist/man/cdist-manifest-run-init.html @@ -1,6 +1,6 @@ -cdist-manifest-run-init(1)

      cdist-manifest-run-init(1)

      Table of Contents

      1. NAME
      2. SYNOPSIS
      3. DESCRIPTION
      4. SEE ALSO
      5. COPYING

      1. NAME

      cdist-manifest-run-init - Run the initial manifest

      2. SYNOPSIS

      cdist-manifest-run-init HOSTNAME

      3. DESCRIPTION

      cdist-manifest-run-init executes the initial manifest, which creates +cdist-manifest-run-init(1)

      cdist-manifest-run-init(1)

      Table of Contents

      1. NAME
      2. SYNOPSIS
      3. DESCRIPTION
      4. SEE ALSO
      5. COPYING

      1. NAME

      cdist-manifest-run-init - Run the initial manifest

      2. SYNOPSIS

      cdist-manifest-run-init HOSTNAME

      3. DESCRIPTION

      cdist-manifest-run-init executes the initial manifest, which creates the first objects.

      4. SEE ALSO

      • cdist(7)
      • diff --git a/software/cdist/man/cdist-manifest-run.html b/software/cdist/man/cdist-manifest-run.html index 9839bac3..749c4629 100644 --- a/software/cdist/man/cdist-manifest-run.html +++ b/software/cdist/man/cdist-manifest-run.html @@ -1,6 +1,6 @@ -cdist-manifest-run(1)

        cdist-manifest-run(1)

        Table of Contents

        1. NAME
        2. SYNOPSIS
        3. DESCRIPTION
        4. SEE ALSO
        5. COPYING

        1. NAME

        cdist-manifest-run - Run a given manifest

        2. SYNOPSIS

        cdist-manifest-run HOSTNAME MANIFEST OUTPUT_DIR

        3. DESCRIPTION

        cdist-manifest-run executes the given MANIFEST and saves the output into +cdist-manifest-run(1)

        cdist-manifest-run(1)

        Table of Contents

        1. NAME
        2. SYNOPSIS
        3. DESCRIPTION
        4. SEE ALSO
        5. COPYING

        1. NAME

        cdist-manifest-run - Run a given manifest

        2. SYNOPSIS

        cdist-manifest-run HOSTNAME MANIFEST OUTPUT_DIR

        3. DESCRIPTION

        cdist-manifest-run executes the given MANIFEST and saves the output into OUTPUT_DIR.

        4. SEE ALSO

        • cdist(7)
        • diff --git a/software/cdist/man/cdist-manifest.html b/software/cdist/man/cdist-manifest.html index 8b56b788..b01d38aa 100644 --- a/software/cdist/man/cdist-manifest.html +++ b/software/cdist/man/cdist-manifest.html @@ -1,6 +1,6 @@ -cdist-manifest(7)

          cdist-manifest(7)

          Table of Contents

          1. NAME
          2. DESCRIPTION
          3. EXAMPLE
          4. DEPENDENCIES
          5. SEE ALSO
          6. COPYING

          1. NAME

          cdist-manifest - Define types to be used

          2. DESCRIPTION

          Manifests exist to define which configurations should be applied to a specific +cdist-manifest(7)

          cdist-manifest(7)

          Table of Contents

          1. NAME
          2. DESCRIPTION
          3. EXAMPLE
          4. DEPENDENCIES
          5. SEE ALSO
          6. COPYING

          1. NAME

          cdist-manifest - Define types to be used

          2. DESCRIPTION

          Manifests exist to define which configurations should be applied to a specific host as well as to define which configurations should be applied within a type. Manifests are executed locally and the resulting objects are stored in an internal database.

          The same object can be redefined in multiple different manifests as long as diff --git a/software/cdist/man/cdist-object-code-run.html b/software/cdist/man/cdist-object-code-run.html new file mode 100644 index 00000000..b2b56fc8 --- /dev/null +++ b/software/cdist/man/cdist-object-code-run.html @@ -0,0 +1,12 @@ + + +cdist-object-code-run(1)

          cdist-object-code-run(1)

          Table of Contents

          1. NAME
          2. SYNOPSIS
          3. DESCRIPTION
          4. SEE ALSO
          5. COPYING

          1. NAME

          cdist-object-code-run - Execute the generated code for a object

          2. SYNOPSIS

          cdist-object-code-run HOSTNAME OBJECT

          3. DESCRIPTION

          Execute the local and remote code for the given object.

          4. SEE ALSO

          • +cdist(7) +
          • +cdist-object-run-all(1) +
          • +cdist-code-run(1) +
          • +cdist-run-remote(1) +

          5. 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).

          diff --git a/software/cdist/man/cdist-object-explorer-run.html b/software/cdist/man/cdist-object-explorer-run.html new file mode 100644 index 00000000..5c354557 --- /dev/null +++ b/software/cdist/man/cdist-object-explorer-run.html @@ -0,0 +1,10 @@ + + +cdist-object-explorer-run(1)

          cdist-object-explorer-run(1)

          Table of Contents

          1. NAME
          2. SYNOPSIS
          3. DESCRIPTION
          4. SEE ALSO
          5. COPYING

          1. NAME

          cdist-object-explorer-run - Run type explorers for a object

          2. SYNOPSIS

          cdist-object-explorer-run HOSTNAME OBJECT

          3. DESCRIPTION

          Runs the explorers for the given object on the target host.

          4. SEE ALSO

          • +cdist(7) +
          • +cdist-deploy-to(1) +
          • +cdist-remote-explorer-run(1) +

          5. 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).

          diff --git a/software/cdist/man/cdist-object-gencode-run.html b/software/cdist/man/cdist-object-gencode-run.html new file mode 100644 index 00000000..3f1a045a --- /dev/null +++ b/software/cdist/man/cdist-object-gencode-run.html @@ -0,0 +1,12 @@ + + +cdist-object-gencode-run(1)

          cdist-object-gencode-run(1)

          Table of Contents

          1. NAME
          2. SYNOPSIS
          3. DESCRIPTION
          4. SEE ALSO
          5. COPYING

          1. NAME

          cdist-object-gencode-run - Generate code for a object

          2. SYNOPSIS

          cdist-object-gencode-run HOSTNAME OBJECT

          3. DESCRIPTION

          For the given object, generate the code for local and remote execution.

          4. SEE ALSO

          • +cdist(7) +
          • +cdist-code-run(1) +
          • +cdist-object-run-all(1) +
          • +cdist-object-gencode(1) +

          5. 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).

          diff --git a/software/cdist/man/cdist-object-gencode.html b/software/cdist/man/cdist-object-gencode.html index 09a9dc17..99d81f27 100644 --- a/software/cdist/man/cdist-object-gencode.html +++ b/software/cdist/man/cdist-object-gencode.html @@ -1,6 +1,6 @@ -cdist-object-gencode(1)

          cdist-object-gencode(1)

          Table of Contents

          1. NAME
          2. SYNOPSIS
          3. DESCRIPTION
          4. SEE ALSO
          5. COPYING

          1. NAME

          cdist-object-gencode - Generate code for a given object

          2. SYNOPSIS

          cdist-object-gencode HOSTNAME OBJECT

          3. DESCRIPTION

          For the given object, run the gencode executable. The output of this +cdist-object-gencode(1)

          cdist-object-gencode(1)

          Table of Contents

          1. NAME
          2. SYNOPSIS
          3. DESCRIPTION
          4. SEE ALSO
          5. COPYING

          1. NAME

          cdist-object-gencode - Generate code for a given object

          2. SYNOPSIS

          cdist-object-gencode HOSTNAME OBJECT

          3. 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).

          4. SEE ALSO

          • cdist(7)
          • diff --git a/software/cdist/man/cdist-object-manifest-run.html b/software/cdist/man/cdist-object-manifest-run.html new file mode 100644 index 00000000..0f3eae9c --- /dev/null +++ b/software/cdist/man/cdist-object-manifest-run.html @@ -0,0 +1,10 @@ + + +cdist-object-manifest-run(1)

            cdist-object-manifest-run(1)

            Table of Contents

            1. NAME
            2. SYNOPSIS
            3. DESCRIPTION
            4. SEE ALSO
            5. COPYING

            1. NAME

            cdist-object-manifest-run - Run an objects manifest

            2. SYNOPSIS

            cdist-object-manifest-run HOSTNAME OBJECT

            3. DESCRIPTION

            Run the manifest for the given object.

            4. SEE ALSO

            • +cdist(7) +
            • +cdist-deploy-to(1) +
            • +cdist-manifest-run(1) +

            5. 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).

            diff --git a/software/cdist/man/cdist-object-push.html b/software/cdist/man/cdist-object-push.html new file mode 100644 index 00000000..b4d97928 --- /dev/null +++ b/software/cdist/man/cdist-object-push.html @@ -0,0 +1,10 @@ + + +cdist-object-push(1)

            cdist-object-push(1)

            Table of Contents

            1. NAME
            2. SYNOPSIS
            3. DESCRIPTION
            4. SEE ALSO
            5. COPYING

            1. NAME

            cdist-object-push - Transfer a object to the target host

            2. SYNOPSIS

            cdist-object-push HOSTNAME OBJECT

            3. DESCRIPTION

            Transfers the given object to the target host.

            4. SEE ALSO

            • +cdist(7) +
            • +cdist-object-run-all(1) +
            • +cdist-type(1) +

            5. 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).

            diff --git a/software/cdist/man/cdist-object-run-all.html b/software/cdist/man/cdist-object-run-all.html new file mode 100644 index 00000000..5d6dc084 --- /dev/null +++ b/software/cdist/man/cdist-object-run-all.html @@ -0,0 +1,13 @@ + + +cdist-object-run-all(1)

            cdist-object-run-all(1)

            Table of Contents

            1. NAME
            2. SYNOPSIS
            3. DESCRIPTION
            4. SEE ALSO
            5. COPYING

            1. NAME

            cdist-object-run-all - Run all created objects on the target host

            2. SYNOPSIS

            cdist-object-run-all HOSTNAME

            3. DESCRIPTION

            Transfers type explorers to the target then runs cdist-object-run(1) +for each created object.

            4. SEE ALSO

            • +cdist(7) +
            • +cdist-type-explorer-push(1) +
            • +cdist-object-run(1) +
            • +cdist-type(1) +

            5. 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).

            diff --git a/software/cdist/man/cdist-object-run.html b/software/cdist/man/cdist-object-run.html new file mode 100644 index 00000000..ac5ad976 --- /dev/null +++ b/software/cdist/man/cdist-object-run.html @@ -0,0 +1,18 @@ + + +cdist-object-run(1)

            cdist-object-run(1)

            Table of Contents

            1. NAME
            2. SYNOPSIS
            3. DESCRIPTION
            4. SEE ALSO
            5. COPYING

            1. NAME

            cdist-object-run - Run an object

            2. SYNOPSIS

            cdist-object-run HOSTNAME OBJECT

            3. DESCRIPTION

            Runs the given object on the given target host. +The different subtasks are dispatched to specialized exectuables. +See related man pages for details.

            4. SEE ALSO

            • +cdist(7) +
            • +cdist-object-explorer-run(1) +
            • +cdist-object-gencode-run(1) +
            • +cdist-object-push(1) +
            • +cdist-object-code-run(1) +
            • +cdist-type(1) +

            5. 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).

            diff --git a/software/cdist/man/cdist-quickstart.html b/software/cdist/man/cdist-quickstart.html index bbfba5c2..d0fa33a7 100644 --- a/software/cdist/man/cdist-quickstart.html +++ b/software/cdist/man/cdist-quickstart.html @@ -1,6 +1,6 @@ -cdist-quickstart(1)

            cdist-quickstart(1)

            Table of Contents

            1. NAME
            2. SYNOPSIS
            3. DESCRIPTION
            4. EXAMPLES
            5. SEE ALSO
            6. COPYING

            1. NAME

            cdist-quickstart - Make use of cinit in 5 minutes

            2. SYNOPSIS

            cdist-quickstart

            3. DESCRIPTION

            cdist-quickstart is an interactive guide to cdist. It should be one +cdist-quickstart(1)

            cdist-quickstart(1)

            Table of Contents

            1. NAME
            2. SYNOPSIS
            3. DESCRIPTION
            4. EXAMPLES
            5. SEE ALSO
            6. COPYING

            1. NAME

            cdist-quickstart - Make use of cinit in 5 minutes

            2. SYNOPSIS

            cdist-quickstart

            3. DESCRIPTION

            cdist-quickstart is an interactive guide to cdist. It should be one of the first tools you use when you begin with cdist.

            4. 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
diff --git a/software/cdist/man/cdist-reference.html b/software/cdist/man/cdist-reference.html
deleted file mode 100644
index 2e8fe947..00000000
--- a/software/cdist/man/cdist-reference.html
+++ /dev/null
@@ -1,148 +0,0 @@
-
-
-cdist-reference(7)
            cdist-reference(7)
            Table of Contents
            1. NAME
            2. DESCRIPTION
            3. PATHS
            4. TYPES
            5. VARIABLES
            6. SEE ALSO
            7. COPYING
            1. NAME
            cdist-reference - Variable, path and type reference for cdist
            2. DESCRIPTION
            Various scripts which are not in the core need information on how
-to find information. This manpage summarises the available environment
-variables, types and paths and clearifies with part may access which variables.
            3. PATHS
            If not specified otherwise, all paths are relative to the checkout directory.
            
-conf/
-
            
-   Contains the (static) configuration like manifests, types and explorers.
-
            
-conf/manifest/init
-
            
-   This is the central entry point used by cdist-manifest-init(1).
-   It is an executable (+x bit set) shell script that can use
-   values from the explorers to decide which configuration to create
-   for the specified target host.
-
            It should be primary used to define mapping from configurations to hosts.
            
-conf/manifest/*
-
            
-   All other files in this directory are not directly used by cdist, but you
-   can seperate configuration mappings, if you have a lot of code in the
-   manifest/init file. This may also be very helpful to have different admins
-   maintain different groups of hosts.
-
            
-conf/explorer/<name>
-
            
-   Contains explorers to be run on the target hosts, see cdist-explorer(7).
-
            
-conf/type/
-
            
-   Contains all available types, which are used to provide
-   some kind of functionality. See cdist-type(7).
-
            
-conf/type/<name>/
-
            
-   Home of the type <name>.
-
            This directory is referenced by the variable __type (see below).
            
-conf/type/<name>/man.text
-
            
-   Manpage in Asciidoc format (nequired for inclusion into upstream)
-
            
-conf/type/<name>/manifest
-
            
-   Used to generate additional objects from a type.
-
            
-conf/type/<name>/gencode-local
-
            
-   Used to generate code to be executed on the server.
-
            
-conf/type/<name>/gencode-remote
-
            
-   Used to generate code to be executed on the client.
-
            
-conf/type/<name>/parameters/required
-
            
-   Parameters required by type, \n seperated list.
-
            
-conf/type/<name>/parameters/optional
-
            
-   Parameters optionally accepted by type, \n seperated list.
-
            
-conf/type/<name>/explorer
-
            
-   Location of the type specific explorers.
-
            This directory is referenced by the variable __type_explorer (see below).
            See cdist-explorer(7).
            
-out/
-
            
-   This directory contains output of cdist and is usually located
-   in a temporary directory and thus will be removed after the run.
-
            This directory is referenced by the variable __global (see below).
            
-out/explorer
-
            
-   Output of general explorers.
-
            
-out/object
-
            
-   Objects created for the host.
-
            
-out/object/<object>
-
            
-   Contains all object specific information.
-
            This directory is referenced by the variable __object (see below).
            
-out/object/<object>/explorers
-
            
-   Output of type specific explorers, per object.
-
            
-tmp_dir
-
            
-   A tempdir and a tempfile is used by cdist internally,
-   which will be removed when the scripts end automatically.
-   See cdist-config(1).
-
            4. TYPES
            The following types are available:
            • 
-__*
-
            5. VARIABLES
            
-__explorer
-
            
-   Directory that contains all explorers.
-   Available for: explorer
-
            
-__manifest
-
            
-   Directory that contains the initial manifest.
-   Available for: initial manifest
-
            
-__global
-
            
-   Directory that contains generic output like explorer.
-   Available for: initial manifest, type manifest, type explorer, type codegen
-
            
-__object
-
            
-   Directory that contains the current object.
-   Available for: type manifest, type explorer, type codegen
-
            
-__object_id
-
            
-   The type unique object id.
-   Available for: type manifest, type explorer, type codegen
-
            
-__self
-
            
-   The full qualified name of the current object.
-   Available for: type manifest, type explorer, type codegen
-
            
-__target_host
-
            
-   The host we are deploying to.
-   Available for: initial manifest, type manifest, type codegen
-
            
-__target_user
-
            
-   User to use for authentication on remote host.
-   Currently static in core.
-
            
-__type
-
            
-   Path to the current type.
-   Available for: type manifest
-
            
-__type_explorers
-
            
-   Directory that contains the type explorers.
-   Available for: type explorer
-
            6. SEE ALSO
            • 
-cdist(7)
-
            • 
-cdist-type__*(7)
-
            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).
            
diff --git a/software/cdist/man/cdist-remote-explorer-run.html b/software/cdist/man/cdist-remote-explorer-run.html
index 25adddef..eb191cbf 100644
--- a/software/cdist/man/cdist-remote-explorer-run.html
+++ b/software/cdist/man/cdist-remote-explorer-run.html
@@ -1,6 +1,6 @@
 
 
-cdist-remote-explorer-run(1)
            cdist-remote-explorer-run(1)
            Table of Contents
            1. NAME
            2. SYNOPSIS
            3. DESCRIPTION
            4. SEE ALSO
            5. COPYING
            1. NAME
            cdist-remote-explorer-run - Run explorer remotely
            2. SYNOPSIS
            cdist-remote-explorer-run VARIABLE_NAME EXPLORER_DIR OUT_DIR
            3. DESCRIPTION
            cdist-remote-explorer-run is executed on the target.
+cdist-remote-explorer-run(1)
            cdist-remote-explorer-run(1)
            Table of Contents
            1. NAME
            2. SYNOPSIS
            3. DESCRIPTION
            4. SEE ALSO
            5. COPYING
            1. NAME
            cdist-remote-explorer-run - Run explorer remotely
            2. SYNOPSIS
            cdist-remote-explorer-run VARIABLE_NAME EXPLORER_DIR OUT_DIR
            3. 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.
            4. SEE ALSO