diff options
Diffstat (limited to 'distro/common/html/knife_exec.html')
| -rw-r--r-- | distro/common/html/knife_exec.html | 19 |
1 files changed, 9 insertions, 10 deletions
diff --git a/distro/common/html/knife_exec.html b/distro/common/html/knife_exec.html index e458205356..0528554458 100644 --- a/distro/common/html/knife_exec.html +++ b/distro/common/html/knife_exec.html @@ -1,4 +1,3 @@ - <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> @@ -14,7 +13,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { - URL_ROOT: '', + URL_ROOT: './', VERSION: '', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', @@ -43,10 +42,10 @@ <div class="section" id="knife-exec"> <h1>knife exec<a class="headerlink" href="#knife-exec" title="Permalink to this headline">¶</a></h1> -<p>The <strong>knife exec</strong> subcommand uses the Knife configuration file to execute Ruby scripts in the context of a fully configured chef-client. This subcommand is most often used to run scripts that will only access server one time (or otherwise very infrequently). Use this subcommand any time that an operation does not warrant full usage of the Knife subcommand library.</p> +<p>The <strong>knife exec</strong> subcommand uses the Knife configuration file to execute Ruby scripts in the context of a fully configured chef-client. This subcommand is most often used to run scripts that will only access Chef server one time (or otherwise very infrequently). Use this subcommand any time that an operation does not warrant full usage of the Knife subcommand library.</p> <div class="section" id="authenticated-api-requests"> <h2>Authenticated API Requests<a class="headerlink" href="#authenticated-api-requests" title="Permalink to this headline">¶</a></h2> -<p>The <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">exec</span></tt> subcommand can be used to make authenticated API requests to the server using the following methods:</p> +<p>The <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">exec</span></tt> subcommand can be used to make authenticated API requests to the Chef server using the following methods:</p> <table border="1" class="docutils"> <colgroup> <col width="13%" /> @@ -59,16 +58,16 @@ </thead> <tbody valign="top"> <tr class="row-even"><td><tt class="docutils literal"><span class="pre">api.delete</span></tt></td> -<td>Use to delete an object from the server.</td> +<td>Use to delete an object from the Chef server.</td> </tr> <tr class="row-odd"><td><tt class="docutils literal"><span class="pre">api.get</span></tt></td> -<td>Use to get the details of an object on the server.</td> +<td>Use to get the details of an object on the Chef server.</td> </tr> <tr class="row-even"><td><tt class="docutils literal"><span class="pre">api.post</span></tt></td> -<td>Use to add an object to the server.</td> +<td>Use to add an object to the Chef server.</td> </tr> <tr class="row-odd"><td><tt class="docutils literal"><span class="pre">api.put</span></tt></td> -<td>Use to update an object on the server.</td> +<td>Use to update an object on the Chef server.</td> </tr> </tbody> </table> @@ -114,7 +113,7 @@ </div> <div class="section" id="syntax"> <h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<p>This argument has the following syntax:</p> +<p>This subcommand has the following syntax:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife <span class="nb">exec </span>SCRIPT <span class="o">(</span>options<span class="o">)</span> </pre></div> </div> @@ -130,7 +129,7 @@ <dt><tt class="docutils literal"><span class="pre">-E</span> <span class="pre">CODE</span></tt>, <tt class="docutils literal"><span class="pre">--exec</span> <span class="pre">CODE</span></tt></dt> <dd>A string of code that will be executed.</dd> <dt><tt class="docutils literal"><span class="pre">-p</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--script-path</span> <span class="pre">PATH:PATH</span></tt></dt> -<dd>A colon-separated path at which Ruby scripts are located.</dd> +<dd>A colon-separated path at which Ruby scripts are located. Use to override the default location for scripts. When this option is not specified, Knife will look for scripts located in <tt class="docutils literal"><span class="pre">chef-repo/.chef/scripts</span></tt> directory.</dd> </dl> </div> <div class="section" id="examples"> |