diff options
Diffstat (limited to 'distro/common/html/knife_cookbook.html')
| -rw-r--r-- | distro/common/html/knife_cookbook.html | 426 |
1 files changed, 59 insertions, 367 deletions
diff --git a/distro/common/html/knife_cookbook.html b/distro/common/html/knife_cookbook.html index 28afbf0eed..0568be98bb 100644 --- a/distro/common/html/knife_cookbook.html +++ b/distro/common/html/knife_cookbook.html @@ -1,5 +1,4 @@ - <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> @@ -8,9 +7,9 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>knife cookbook — Knife Man Pages</title> + <title>knife cookbook — chef-client Man Pages</title> - <link rel="stylesheet" href="_static/chef.css" type="text/css" /> + <link rel="stylesheet" href="_static/guide.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript"> @@ -26,131 +25,20 @@ <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <link rel="shortcut icon" href="_static/chef.ico"/> - <link rel="top" title="Knife Man Pages" href="index.html" /> + + </head> <body> <div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px"> <a href="http://docs.opscode.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a> </div> - <div class="related"> - <h3>Navigation</h3> - <ul> - <li><a href="http://docs.opscode.com/chef/knife.html" target="_products">Knife</a>•</li> - <li><a href="http://docs.opscode.com/chef/resources.html" target="_products">Resources</a>•</li> - <li><a href="http://docs.opscode.com/chef/dsl_recipe.html" target="_products">Recipe DSL</a>•</li> - <li><a href="http://docs.opscode.com/chef/lwrps_custom.html" target="_products">LWRPs</a>•</li> - <li><a href="http://docs.opscode.com/search.html">Search the Docs</a>•</li> - <li><a href="http://docs.opscode.com/">Home</a> »</li> - - </ul> - </div> - - <div class="sphinxsidebar"> - <div class="sphinxsidebarwrapper"> - <p class="logo"><a href="knife.html"> - <img class="logo" src="_static/chef_logo.png" alt="Logo"/> - </a></p> - <h3><a href="knife.html">Table Of Contents</a></h3> - <ul> -<li><a class="reference internal" href="#">knife cookbook</a><ul> -<li><a class="reference internal" href="#bulk-delete">bulk delete</a><ul> -<li><a class="reference internal" href="#syntax">Syntax</a></li> -<li><a class="reference internal" href="#options">Options</a><ul> -<li><a class="reference internal" href="#knife-rb-settings">knife.rb Settings</a></li> -</ul> -</li> -<li><a class="reference internal" href="#examples">Examples</a></li> -</ul> -</li> -<li><a class="reference internal" href="#create">create</a><ul> -<li><a class="reference internal" href="#id1">Syntax</a></li> -<li><a class="reference internal" href="#id2">Options</a><ul> -<li><a class="reference internal" href="#id3">knife.rb Settings</a></li> -</ul> -</li> -<li><a class="reference internal" href="#id4">Examples</a></li> -</ul> -</li> -<li><a class="reference internal" href="#delete">delete</a><ul> -<li><a class="reference internal" href="#id5">Syntax</a></li> -<li><a class="reference internal" href="#id6">Options</a><ul> -<li><a class="reference internal" href="#id7">knife.rb Settings</a></li> -</ul> -</li> -<li><a class="reference internal" href="#id8">Examples</a></li> -</ul> -</li> -<li><a class="reference internal" href="#download">download</a><ul> -<li><a class="reference internal" href="#id9">Syntax</a></li> -<li><a class="reference internal" href="#id10">Options</a><ul> -<li><a class="reference internal" href="#id11">knife.rb Settings</a></li> -</ul> -</li> -<li><a class="reference internal" href="#id12">Examples</a></li> -</ul> -</li> -<li><a class="reference internal" href="#list">list</a><ul> -<li><a class="reference internal" href="#id13">Syntax</a></li> -<li><a class="reference internal" href="#id14">Options</a><ul> -<li><a class="reference internal" href="#id15">knife.rb Settings</a></li> -</ul> -</li> -<li><a class="reference internal" href="#id16">Examples</a></li> -</ul> -</li> -<li><a class="reference internal" href="#metadata">metadata</a><ul> -<li><a class="reference internal" href="#id17">Syntax</a></li> -<li><a class="reference internal" href="#id18">Options</a><ul> -<li><a class="reference internal" href="#id19">knife.rb Settings</a></li> -</ul> -</li> -<li><a class="reference internal" href="#id20">Examples</a></li> -</ul> -</li> -<li><a class="reference internal" href="#metadata-from-file">metadata from file</a><ul> -<li><a class="reference internal" href="#id21">Syntax</a></li> -<li><a class="reference internal" href="#id22">Options</a></li> -<li><a class="reference internal" href="#id23">Examples</a></li> -</ul> -</li> -<li><a class="reference internal" href="#show">show</a><ul> -<li><a class="reference internal" href="#id24">Syntax</a></li> -<li><a class="reference internal" href="#id25">Options</a><ul> -<li><a class="reference internal" href="#id26">knife.rb Settings</a></li> -</ul> -</li> -<li><a class="reference internal" href="#id27">Examples</a></li> -</ul> -</li> -<li><a class="reference internal" href="#test">test</a><ul> -<li><a class="reference internal" href="#id28">Syntax</a></li> -<li><a class="reference internal" href="#id29">Options</a><ul> -<li><a class="reference internal" href="#id30">knife.rb Settings</a></li> -</ul> -</li> -<li><a class="reference internal" href="#id31">Examples</a></li> -</ul> -</li> -<li><a class="reference internal" href="#upload">upload</a><ul> -<li><a class="reference internal" href="#id32">Syntax</a></li> -<li><a class="reference internal" href="#id33">Options</a><ul> -<li><a class="reference internal" href="#id34">knife.rb Settings</a></li> -</ul> -</li> -<li><a class="reference internal" href="#id35">Examples</a></li> -</ul> -</li> -</ul> -</li> -</ul> - </div> - </div> + <div class="document"> <div class="documentwrapper"> - <div class="bodywrapper"> + <div class="body"> <div class="section" id="knife-cookbook"> @@ -189,20 +77,6 @@ <dt><tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--purge</span></tt></dt> <dd>Indicates that a cookbook (or cookbook version) will be removed entirely from the server. This action should be used carefully because only one copy of any single file is stored on the server. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged.</dd> </dl> -<div class="section" id="knife-rb-settings"> -<h4>knife.rb Settings<a class="headerlink" href="#knife-rb-settings" title="Permalink to this headline">¶</a></h4> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">See <tt class="xref doc docutils literal"><span class="pre">knife.rb</span></tt> for more information about how to add optional settings to the knife.rb file.</p> -</div> -<p>The following <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">cookbook</span> <span class="pre">bulk</span> <span class="pre">delete</span></tt> settings can be added to the knife.rb file:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">knife[:purge]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--purge</span></tt> option.</dd> -<dt><tt class="docutils literal"><span class="pre">knife[:yes]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--yes</span></tt> option.</dd> -</dl> -</div> </div> <div class="section" id="examples"> <h3>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3> @@ -255,21 +129,9 @@ <dt><tt class="docutils literal"><span class="pre">-r</span> <span class="pre">FORMAT</span></tt>, <tt class="docutils literal"><span class="pre">--readme-format</span> <span class="pre">FORMAT</span></tt></dt> <dd>The document format of the readme file: <tt class="docutils literal"><span class="pre">md</span></tt> (markdown) and <tt class="docutils literal"><span class="pre">rdoc</span></tt> (Ruby docs).</dd> </dl> -<div class="section" id="id3"> -<h4>knife.rb Settings<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h4> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">See <tt class="xref doc docutils literal"><span class="pre">knife.rb</span></tt> for more information about how to add optional settings to the knife.rb file.</p> -</div> -<p>The following <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">cookbook</span> <span class="pre">create</span></tt> settings can be added to the knife.rb file:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">knife[:readme_format]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--readme-format</span></tt> option.</dd> -</dl> -</div> </div> -<div class="section" id="id4"> -<h3>Examples<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id3"> +<h3>Examples<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3> <p>The following examples show how to use this Knife subcommand:</p> <p><strong>Create a cookbook</strong></p> <p>To create a cookbook named “my_cookbook” with copyright, email, license, and readme format options specified, enter:</p> @@ -287,15 +149,15 @@ <div class="section" id="delete"> <h2>delete<a class="headerlink" href="#delete" title="Permalink to this headline">¶</a></h2> <p>The <tt class="docutils literal"><span class="pre">delete</span></tt> argument is used to delete a specified cookbook or cookbook version on the server (and not locally).</p> -<div class="section" id="id5"> -<h3>Syntax<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id4"> +<h3>Syntax<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3> <p>This argument has the following syntax:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook delete COOKBOOK_NAME <span class="o">[</span>COOKBOOK_VERSION<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span> </pre></div> </div> </div> -<div class="section" id="id6"> -<h3>Options<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id5"> +<h3>Options<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3> <p>This argument has the following options:</p> <dl class="docutils"> <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt> @@ -305,25 +167,9 @@ <dt><tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--purge</span></tt></dt> <dd>Indicates that a cookbook (or cookbook version) will be removed entirely from the server. This action should be used carefully because only one copy of any single file is stored on the server. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged.</dd> </dl> -<div class="section" id="id7"> -<h4>knife.rb Settings<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h4> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">See <tt class="xref doc docutils literal"><span class="pre">knife.rb</span></tt> for more information about how to add optional settings to the knife.rb file.</p> -</div> -<p>The following <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">cookbook</span> <span class="pre">delete</span></tt> settings can be added to the knife.rb file:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">knife[:all]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--all</span></tt> option.</dd> -<dt><tt class="docutils literal"><span class="pre">knife[:print_after]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--print-after</span></tt> option.</dd> -<dt><tt class="docutils literal"><span class="pre">knife[:purge]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--purge</span></tt> option.</dd> -</dl> </div> -</div> -<div class="section" id="id8"> -<h3>Examples<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id6"> +<h3>Examples<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3> <p>The following examples show how to use this Knife subcommand:</p> <p><strong>Delete a cookbook</strong></p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook delete cookbook_name version @@ -339,15 +185,15 @@ <div class="section" id="download"> <h2>download<a class="headerlink" href="#download" title="Permalink to this headline">¶</a></h2> <p>The <tt class="docutils literal"><span class="pre">download</span></tt> argument is used to download a cookbook from the server to the current working directory.</p> -<div class="section" id="id9"> -<h3>Syntax<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id7"> +<h3>Syntax<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3> <p>This argument has the following syntax:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook download COOKBOOK_NAME <span class="o">[</span>COOKBOOK_VERSION<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span> </pre></div> </div> </div> -<div class="section" id="id10"> -<h3>Options<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id8"> +<h3>Options<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3> <p>This argument has the following options:</p> <dl class="docutils"> <dt><tt class="docutils literal"><span class="pre">-d</span> <span class="pre">DOWNLOAD_DIRECTORY</span></tt>, <tt class="docutils literal"><span class="pre">--dir</span> <span class="pre">DOWNLOAD_DIRECTORY</span></tt></dt> @@ -357,25 +203,9 @@ <dt><tt class="docutils literal"><span class="pre">-N</span></tt>, <tt class="docutils literal"><span class="pre">--latest</span></tt></dt> <dd>Indicates that the most recent version of a cookbook will be downloaded.</dd> </dl> -<div class="section" id="id11"> -<h4>knife.rb Settings<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h4> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">See <tt class="xref doc docutils literal"><span class="pre">knife.rb</span></tt> for more information about how to add optional settings to the knife.rb file.</p> -</div> -<p>The following <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">cookbook</span> <span class="pre">download</span></tt> settings can be added to the knife.rb file:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">knife[:download_directory]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--dir</span></tt> option.</dd> -<dt><tt class="docutils literal"><span class="pre">knife[:force]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--force</span></tt> option.</dd> -<dt><tt class="docutils literal"><span class="pre">knife[:latest]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--latest</span></tt> option.</dd> -</dl> -</div> </div> -<div class="section" id="id12"> -<h3>Examples<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id9"> +<h3>Examples<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3> <p>The following examples show how to use this Knife subcommand:</p> <p><strong>Download a cookbook</strong></p> <p>To download a cookbook named “smartmon”, enter:</p> @@ -387,15 +217,15 @@ <div class="section" id="list"> <h2>list<a class="headerlink" href="#list" title="Permalink to this headline">¶</a></h2> <p>The <tt class="docutils literal"><span class="pre">list</span></tt> argument is used to view a list of cookbooks that are currently available on the server. The list will contain only the most recent version for each cookbook by default.</p> -<div class="section" id="id13"> -<h3>Syntax<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id10"> +<h3>Syntax<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3> <p>This argument has the following syntax:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook list <span class="o">(</span>options<span class="o">)</span> </pre></div> </div> </div> -<div class="section" id="id14"> -<h3>Options<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id11"> +<h3>Options<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3> <p>This argument has the following options:</p> <dl class="docutils"> <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt> @@ -403,23 +233,9 @@ <dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt> <dd>Indicates that the corresponding URIs will be shown.</dd> </dl> -<div class="section" id="id15"> -<h4>knife.rb Settings<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h4> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">See <tt class="xref doc docutils literal"><span class="pre">knife.rb</span></tt> for more information about how to add optional settings to the knife.rb file.</p> -</div> -<p>The following <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">cookbook</span> <span class="pre">list</span></tt> settings can be added to the knife.rb file:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">knife[:all]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--all</span></tt> option.</dd> -<dt><tt class="docutils literal"><span class="pre">knife[:environment]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--environment</span></tt> option.</dd> -</dl> -</div> </div> -<div class="section" id="id16"> -<h3>Examples<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id12"> +<h3>Examples<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3> <p>The following examples show how to use this Knife subcommand:</p> <p><strong>View a list of cookbooks</strong></p> <p>To view a list of cookbooks:</p> @@ -431,15 +247,15 @@ <div class="section" id="metadata"> <h2>metadata<a class="headerlink" href="#metadata" title="Permalink to this headline">¶</a></h2> <p>The <tt class="docutils literal"><span class="pre">metadata</span></tt> argument is used to generate the metadata for one or more cookbooks.</p> -<div class="section" id="id17"> -<h3>Syntax<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id13"> +<h3>Syntax<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3> <p>This argument has the following syntax:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata <span class="o">(</span>options<span class="o">)</span> </pre></div> </div> </div> -<div class="section" id="id18"> -<h3>Options<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id14"> +<h3>Options<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3> <p>This argument has the following options:</p> <dl class="docutils"> <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt> @@ -447,21 +263,9 @@ <dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH:PATH</span></tt></dt> <dd>The directory in which cookbook are created. This can be a colon-separated path.</dd> </dl> -<div class="section" id="id19"> -<h4>knife.rb Settings<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h4> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">See <tt class="xref doc docutils literal"><span class="pre">knife.rb</span></tt> for more information about how to add optional settings to the knife.rb file.</p> -</div> -<p>The following <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">cookbook</span> <span class="pre">metadata</span></tt> settings can be added to the knife.rb file:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">knife[:all]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--all</span></tt> option.</dd> -</dl> </div> -</div> -<div class="section" id="id20"> -<h3>Examples<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id15"> +<h3>Examples<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3> <p>The following examples show how to use this Knife subcommand:</p> <p><strong>Generate metadata</strong></p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata -a @@ -472,19 +276,19 @@ <div class="section" id="metadata-from-file"> <h2>metadata from file<a class="headerlink" href="#metadata-from-file" title="Permalink to this headline">¶</a></h2> <p>The <tt class="docutils literal"><span class="pre">metadata</span> <span class="pre">from</span> <span class="pre">file</span></tt> argument is used to load the metadata for a cookbook from a file.</p> -<div class="section" id="id21"> -<h3>Syntax<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id16"> +<h3>Syntax<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3> <p>This argument has the following syntax:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata from file FILE </pre></div> </div> </div> -<div class="section" id="id22"> -<h3>Options<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id17"> +<h3>Options<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3> <p>This command does not have any specific options.</p> </div> -<div class="section" id="id23"> -<h3>Examples<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id18"> +<h3>Examples<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3> <p>The following examples show how to use this Knife subcommand:</p> <p><strong>View metadata</strong></p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadta from file /path/to/file @@ -495,15 +299,15 @@ <div class="section" id="show"> <h2>show<a class="headerlink" href="#show" title="Permalink to this headline">¶</a></h2> <p>The <tt class="docutils literal"><span class="pre">show</span></tt> argument is used to view information about a cookbook, parts of a cookbook (attributes, definitions, files, libraries, providers, recipes, resources, and templates), or a file that is associated with a cookbook (including attributes such as checksum or specificity).</p> -<div class="section" id="id24"> -<h3>Syntax<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id19"> +<h3>Syntax<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h3> <p>This argument has the following syntax:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook show COOKBOOK_NAME <span class="o">[</span>COOKBOOK_VERSION<span class="o">]</span> <span class="o">[</span>PART...<span class="o">]</span> <span class="o">[</span>FILE_NAME<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span> </pre></div> </div> </div> -<div class="section" id="id25"> -<h3>Options<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id20"> +<h3>Options<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h3> <p>This argument has the following options:</p> <dl class="docutils"> <dt><tt class="docutils literal"><span class="pre">COOKBOOK_VERSION</span></tt></dt> @@ -521,25 +325,9 @@ <dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt> <dd>Indicates that the corresponding URIs will be shown.</dd> </dl> -<div class="section" id="id26"> -<h4>knife.rb Settings<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h4> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">See <tt class="xref doc docutils literal"><span class="pre">knife.rb</span></tt> for more information about how to add optional settings to the knife.rb file.</p> </div> -<p>The following <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">cookbook</span> <span class="pre">show</span></tt> settings can be added to the knife.rb file:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">knife[:fqdn]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--fqdn</span></tt> option.</dd> -<dt><tt class="docutils literal"><span class="pre">knife[:platform]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--platform</span></tt> option.</dd> -<dt><tt class="docutils literal"><span class="pre">knife[:platform_version]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--platform-version</span></tt> option.</dd> -</dl> -</div> -</div> -<div class="section" id="id27"> -<h3>Examples<a class="headerlink" href="#id27" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id21"> +<h3>Examples<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h3> <p>The following examples show how to use this Knife subcommand:</p> <p><strong>Show cookbook data</strong></p> <p>To get the list of available versions of a cookbook named “getting-started”, enter:</p> @@ -595,15 +383,15 @@ url: https://someurlhere.com <div class="section" id="test"> <h2>test<a class="headerlink" href="#test" title="Permalink to this headline">¶</a></h2> <p>The <tt class="docutils literal"><span class="pre">test</span></tt> argument is used to test a cookbook for syntax errors. This argument uses Ruby syntax checking to verify every file in a cookbook that ends in .rb and Embedded Ruby (ERB).</p> -<div class="section" id="id28"> -<h3>Syntax<a class="headerlink" href="#id28" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id22"> +<h3>Syntax<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3> <p>This argument has the following syntax:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook <span class="nb">test </span>COOKBOOK_NAME <span class="o">(</span>options<span class="o">)</span> </pre></div> </div> </div> -<div class="section" id="id29"> -<h3>Options<a class="headerlink" href="#id29" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id23"> +<h3>Options<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3> <p>This argument has the following options:</p> <dl class="docutils"> <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt> @@ -611,21 +399,9 @@ url: https://someurlhere.com <dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH:PATH</span></tt></dt> <dd>The directory in which cookbook are created. This can be a colon-separated path.</dd> </dl> -<div class="section" id="id30"> -<h4>knife.rb Settings<a class="headerlink" href="#id30" title="Permalink to this headline">¶</a></h4> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">See <tt class="xref doc docutils literal"><span class="pre">knife.rb</span></tt> for more information about how to add optional settings to the knife.rb file.</p> -</div> -<p>The following <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">cookbook</span> <span class="pre">test</span></tt> settings can be added to the knife.rb file:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">knife[:all]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--all</span></tt> option.</dd> -</dl> -</div> </div> -<div class="section" id="id31"> -<h3>Examples<a class="headerlink" href="#id31" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id24"> +<h3>Examples<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3> <p>The following examples show how to use this Knife subcommand:</p> <p><strong>Test a cookbook</strong></p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook <span class="nb">test </span>cookbook_name @@ -640,15 +416,15 @@ url: https://someurlhere.com <p class="first admonition-title">Note</p> <p class="last">Use a chefignore file to prevent the upload of specific files and file types, such as temporary files or files placed in folders by version control systems. The chefignore file must be located in the root of the cookbook repository and must use rules similar to filename globbing (as defined by the Ruby <tt class="docutils literal"><span class="pre">File.fnmatch</span></tt> syntax).</p> </div> -<div class="section" id="id32"> -<h3>Syntax<a class="headerlink" href="#id32" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id25"> +<h3>Syntax<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h3> <p>This argument has the following syntax:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook upload <span class="o">[</span>COOKBOOK_NAME...<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span> </pre></div> </div> </div> -<div class="section" id="id33"> -<h3>Options<a class="headerlink" href="#id33" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id26"> +<h3>Options<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h3> <p>This argument has the following options:</p> <dl class="docutils"> <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt> @@ -662,29 +438,9 @@ url: https://someurlhere.com <dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH:PATH</span></tt></dt> <dd>The directory in which cookbook are created. This can be a colon-separated path.</dd> </dl> -<div class="section" id="id34"> -<h4>knife.rb Settings<a class="headerlink" href="#id34" title="Permalink to this headline">¶</a></h4> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">See <tt class="xref doc docutils literal"><span class="pre">knife.rb</span></tt> for more information about how to add optional settings to the knife.rb file.</p> -</div> -<p>The following <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">cookbook</span> <span class="pre">upload</span></tt> settings can be added to the knife.rb file:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">knife[:all]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--all</span></tt> option.</dd> -<dt><tt class="docutils literal"><span class="pre">knife[:depends]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--include-dependencies</span></tt> option.</dd> -<dt><tt class="docutils literal"><span class="pre">knife[:environment]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--environment</span></tt> option.</dd> -<dt><tt class="docutils literal"><span class="pre">knife[:force]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--force</span></tt> option.</dd> -<dt><tt class="docutils literal"><span class="pre">knife[:freeze]</span></tt></dt> -<dd>Use to add the <tt class="docutils literal"><span class="pre">--freeze</span></tt> option.</dd> -</dl> -</div> </div> -<div class="section" id="id35"> -<h3>Examples<a class="headerlink" href="#id35" title="Permalink to this headline">¶</a></h3> +<div class="section" id="id27"> +<h3>Examples<a class="headerlink" href="#id27" title="Permalink to this headline">¶</a></h3> <p>The following examples show how to use this Knife subcommand:</p> <p><strong>Upload a cookbook</strong></p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook upload cookbook_name @@ -711,78 +467,14 @@ ERROR: Version 0.1.6 of cookbook redis is frozen. Use --force to override. </div> - </div> - </div> - <div class="clearer"></div> - </div> - <div class="related"> - <h3>Navigation</h3> - <ul> - <li><a href="http://docs.opscode.com/chef/knife.html" target="_products">Knife</a>•</li> - <li><a href="http://docs.opscode.com/chef/resources.html" target="_products">Resources</a>•</li> - <li><a href="http://docs.opscode.com/chef/dsl_recipe.html" target="_products">Recipe DSL</a>•</li> - <li><a href="http://docs.opscode.com/chef/lwrps_custom.html" target="_products">LWRPs</a>•</li> - <li><a href="http://docs.opscode.com/search.html">Search the Docs</a>•</li> - <li><a href="http://docs.opscode.com/">Home</a> »</li> - - </ul> - </div> - - <div class="footer"> - Documentation for current man pages for Knife. - - Send feedback to <a href="mailto:docs@getchef.com">docs@getchef.com</a>. - This work is licensed under a Creative Commons Attribution 3.0 Unported License. + </div> + + <div class="clearer"></div> </div> -<!-- Start of Async Google Analytics Code --> -<script type="text/javascript"> -var _gaq = _gaq || []; -var pluginUrl = (('https:' == document.location.protocol) ? 'https://ssl.' : 'http://www.') + 'google-analytics.com/plugins/ga/inpage_linkid.js'; -_gaq.push(['_setAccount', 'UA-6369228-7']); -_gaq.push(['_setDomainName', '.opscode.com']); -_gaq.push(['_setAllowHash', false]); -_gaq.push(['_setAllowLinker', true]); -_gaq.push(['_addIgnoredRef','opscode.com']); -_gaq.push(['_trackPageview']); - -(function() { - var ga = document.createElement('script'); ga.type = 'text/javascript'; - ga.async = true; - ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; - var s = document.getElementsByTagName('script')[0]; - s.parentNode.insertBefore(ga, s); })(); -</script> -<!-- End of Async Google Analytics Code --> - - -<!-- Start of Contact Analytics Code --> -<script type="text/javascript"> -(function() { - var didInit = false; - function initMunchkin() { - if(didInit === false) { - didInit = true; - Munchkin.init('255-VFB-268'); - } - } - var s = document.createElement('script'); - s.type = 'text/javascript'; - s.async = true; - s.src = document.location.protocol + '//munchkin.marketo.net/munchkin.js'; - s.onreadystatechange = function() { - if (this.readyState == 'complete' || this.readyState == 'loaded') { - initMunchkin(); - } - }; - s.onload = initMunchkin; - document.getElementsByTagName('head')[0].appendChild(s); -})(); -</script> -<!-- End of Contact Analytics Code --> </body> |