2019-05-22 16:44:06 +00:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2020-04-03 17:56:46 +00:00
< title > 11. cdist-new-type(1) — cdist 6.5.3 documentation< / title >
2019-05-22 16:44:06 +00:00
< script type = "text/javascript" src = "../_static/js/modernizr.min.js" > < / script >
< script type = "text/javascript" >
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
2020-04-03 17:56:46 +00:00
VERSION:'6.5.3',
2019-05-22 16:44:06 +00:00
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
< / script >
< script type = "text/javascript" src = "../_static/jquery.js" > < / script >
< script type = "text/javascript" src = "../_static/underscore.js" > < / script >
< script type = "text/javascript" src = "../_static/doctools.js" > < / script >
< script type = "text/javascript" src = "../_static/js/theme.js" > < / script >
< link rel = "stylesheet" href = "../_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "../_static/pygments.css" type = "text/css" / >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
< link rel = "next" title = "12. Bootstrap" href = "../cdist-bootstrap.html" / >
< link rel = "prev" title = "10. cdist-dump(1)" href = "cdist-dump.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "../index.html" class = "icon icon-home" > cdist
< img src = "../_static/cdist-logo.jpeg" class = "logo" alt = "Logo" / >
< / a >
< div class = "version" >
2020-04-03 17:56:46 +00:00
6.5.3
2019-05-22 16:44:06 +00:00
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< ul class = "current" >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-why.html" > 1. Why should I use cdist?< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-features.html" > 2. Features< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-os.html" > 3. Supported operating systems< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-install.html" > 4. How to install cdist< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-upgrade.html" > 5. How to upgrade cdist< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-support.html" > 6. Support< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-quickstart.html" > 7. Quickstart< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-real-world.html" > 8. Dive into real world cdist< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist.html" > 9. cdist(1)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-dump.html" > 10. cdist-dump(1)< / a > < / li >
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > 11. cdist-new-type(1)< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "#name" > 11.1. NAME< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#synopsis" > 11.2. SYNOPSIS< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#description" > 11.3. DESCRIPTION< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#arguments" > 11.4. ARGUMENTS< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#examples" > 11.5. EXAMPLES< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#see-also" > 11.6. SEE ALSO< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#authors" > 11.7. AUTHORS< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#copying" > 11.8. COPYING< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-bootstrap.html" > 12. Bootstrap< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-configuration.html" > 13. Configuration< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-manifest.html" > 14. Manifest< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-type.html" > 15. cdist type< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-types.html" > 16. cdist types< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-explorer.html" > 17. Explorer< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-messaging.html" > 18. Messaging< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-parallelization.html" > 19. Parallelization< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-inventory.html" > 20. Inventory< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-trigger.html" > 21. Trigger< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-preos.html" > 22. PreOS< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-integration.html" > 23. cdist integration / using cdist as library< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-reference.html" > 24. Reference< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-best-practice.html" > 25. Best practice< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-stages.html" > 26. Execution stages< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-cache.html" > 27. Local cache overview< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-saving-output-streams.html" > 28. Saving output streams< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-remote-exec-copy.html" > 29. Remote exec and copy commands< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-hacker.html" > 30. Hacking< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../cdist-troubleshooting.html" > 31. Troubleshooting< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "../index.html" > cdist< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "../index.html" > Docs< / a > » < / li >
< li > 11. cdist-new-type(1)< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "../_sources/man1/cdist-new-type.rst.txt" rel = "nofollow" > View page source< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< div class = "section" id = "cdist-new-type-1" >
< h1 > 11. cdist-new-type(1)< a class = "headerlink" href = "#cdist-new-type-1" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "name" >
< h2 > 11.1. NAME< a class = "headerlink" href = "#name" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > cdist-new-type - Create new type skeleton< / p >
< / div >
< div class = "section" id = "synopsis" >
< h2 > 11.2. SYNOPSIS< a class = "headerlink" href = "#synopsis" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "highlight-default" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > cdist< / span > < span class = "o" > -< / span > < span class = "n" > new< / span > < span class = "o" > -< / span > < span class = "nb" > type< / span > < span class = "n" > TYPE< / span > < span class = "o" > -< / span > < span class = "n" > NAME< / span > < span class = "n" > AUTHOR< / span > < span class = "o" > -< / span > < span class = "n" > NAME< / span > < span class = "n" > AUTHOR< / span > < span class = "o" > -< / span > < span class = "n" > EMAIL< / span > < span class = "p" > [< / span > < span class = "n" > TYPE< / span > < span class = "o" > -< / span > < span class = "n" > BASE< / span > < span class = "o" > -< / span > < span class = "n" > PATH< / span > < span class = "p" > ]< / span >
< / pre > < / div >
< / div >
< / div >
< div class = "section" id = "description" >
< h2 > 11.3. DESCRIPTION< a class = "headerlink" href = "#description" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > cdist-new-type is a helper script that creates new type skeleton.
It is then up to the type author to finish the type.< / p >
< p > It creates skeletons for the following files:< / p >
< ul class = "simple" >
< li > man.rst< / li >
< li > manifest< / li >
< li > gencode-remote.< / li >
< / ul >
< p > Upon creation it prints the path to the newly created type directory.< / p >
< / div >
< div class = "section" id = "arguments" >
< h2 > 11.4. ARGUMENTS< a class = "headerlink" href = "#arguments" title = "Permalink to this headline" > ¶< / a > < / h2 >
< dl class = "docutils" >
< dt > < strong > TYPE-NAME< / strong > < / dt >
< dd > Name of the new type.< / dd >
< dt > < strong > AUTHOR-NAME< / strong > < / dt >
< dd > Type author's full name.< / dd >
< dt > < strong > AUTHOR-NAME< / strong > < / dt >
< dd > Type author's email.< / dd >
< dt > < strong > TYPE-BASE-PATH< / strong > < / dt >
< dd > Path to the base directory of the type. If not set it defaults
to '$PWD/type'.< / dd >
< / dl >
< / div >
< div class = "section" id = "examples" >
< h2 > 11.5. EXAMPLES< a class = "headerlink" href = "#examples" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "highlight-sh" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # Create new type __foo in ~/.cdist directory.< / span >
$ < span class = "nb" > cd< / span > ~/.cdist
$ cdist-new-type < span class = "s1" > ' __foo' < / span > < span class = "s1" > ' Foo Bar' < / span > < span class = "s1" > ' foo.bar at foobar.org' < / span >
/home/foo/.cdist/type/__foo
< / pre > < / div >
< / div >
< / div >
< div class = "section" id = "see-also" >
< h2 > 11.6. SEE ALSO< a class = "headerlink" href = "#see-also" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > < strong > cdist< / strong > (1)< / p >
< / div >
< div class = "section" id = "authors" >
< h2 > 11.7. AUTHORS< a class = "headerlink" href = "#authors" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "line-block" >
< div class = "line" > Steven Armstrong < < a class = "reference external" href = "mailto:steven-cdist--%40--armstrong.cc" > steven-cdist--< span > @ < / span > --armstrong< span > . < / span > cc< / a > > < / div >
< div class = "line" > Darko Poljak < < a class = "reference external" href = "mailto:darko.poljak--%40--ungleich.ch" > darko< span > . < / span > poljak--< span > @ < / span > --ungleich< span > . < / span > ch< / a > > < / div >
< / div >
< / div >
< div class = "section" id = "copying" >
< h2 > 11.8. COPYING< a class = "headerlink" href = "#copying" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Copyright (C) 2019 Steven Armstrong, Darko Poljak. Free use of this software is
granted under the terms of the GNU General Public License v3 or later (GPLv3+).< / p >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "../cdist-bootstrap.html" class = "btn btn-neutral float-right" title = "12. Bootstrap" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
< a href = "cdist-dump.html" class = "btn btn-neutral float-left" title = "10. cdist-dump(1)" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2020-02-15 13:54:41 +00:00
© Copyright ungleich GmbH 2020
2019-05-22 16:44:06 +00:00
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/rtfd/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >