diff options
Diffstat (limited to 'distro/common/html/ctl_chef_client.html')
| -rw-r--r-- | distro/common/html/ctl_chef_client.html | 28 |
1 files changed, 19 insertions, 9 deletions
diff --git a/distro/common/html/ctl_chef_client.html b/distro/common/html/ctl_chef_client.html index 4a3fa1d6ed..9a69eb28ec 100644 --- a/distro/common/html/ctl_chef_client.html +++ b/distro/common/html/ctl_chef_client.html @@ -23,7 +23,6 @@ <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> - <link rel="shortcut icon" href="_static/chef.ico"/> </head> @@ -51,11 +50,20 @@ <li>Taking the appropriate and required actions to configure the node</li> <li>Looking for exceptions and notifications, handling each as required</li> </ul> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">The chef-client executable can be run as a daemon.</p> +</div> <p>The chef-client executable is run as a command-line tool.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> -<p>A client.rb file is used to specify the configuration details for the chef-client. This file is the default configuration file and is loaded every time the chef-client executable is run. The chef-client executable can be run as a daemon.</p> -<p class="last">On UNIX- and Linux-based machines, the configuration file is located at: <tt class="docutils literal"><span class="pre">/etc/chef/client.rb</span></tt>. On Microsoft Windows machines, the configuration file is located at <tt class="docutils literal"><span class="pre">C:\chef\client.rb</span></tt>. When a client.rb file is present in this directory, the settings contained within that file will override the default configuration settings.</p> +<p>A client.rb file is used to specify the configuration details for the chef-client.</p> +<ul class="last simple"> +<li>This file is loaded every time this executable is run</li> +<li>On UNIX- and Linux-based machines, the default location for this file is <tt class="docutils literal"><span class="pre">/etc/chef/client.rb</span></tt>; on Microsoft Windows machines, the default location for this file is <tt class="docutils literal"><span class="pre">C:\chef\client.rb</span></tt>; use the <tt class="docutils literal"><span class="pre">--config</span></tt> option from the command line to change this location</li> +<li>This file is not created by default</li> +<li>When a client.rb file is present in this directory, the settings contained within that file will override the default configuration settings</li> +</ul> </div> <div class="section" id="options"> <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">ΒΆ</a></h2> @@ -67,6 +75,8 @@ <dl class="docutils"> <dt><tt class="docutils literal"><span class="pre">-A</span></tt>, <tt class="docutils literal"><span class="pre">--fatal-windows-admin-check</span></tt></dt> <dd>Use to cause a chef-client run to fail when the chef-client does not have administrator privileges in Microsoft Windows.</dd> +<dt><tt class="docutils literal"><span class="pre">-c</span> <span class="pre">CONFIG</span></tt>, <tt class="docutils literal"><span class="pre">--config</span> <span class="pre">CONFIG</span></tt></dt> +<dd>The configuration file to use.</dd> <dt><tt class="docutils literal"><span class="pre">--chef-zero-port</span> <span class="pre">PORT</span></tt></dt> <dd>The port on which chef-zero will listen.</dd> <dt><tt class="docutils literal"><span class="pre">-F</span> <span class="pre">FORMAT</span></tt>, <tt class="docutils literal"><span class="pre">--format</span> <span class="pre">FORMAT</span></tt></dt> @@ -76,9 +86,9 @@ <p class="last">Other formatting options are available when those formatters are configured in the client.rb file using the <tt class="docutils literal"><span class="pre">add_formatter</span></tt> option.</p> </dd> <dt><tt class="docutils literal"><span class="pre">--force-formatter</span></tt></dt> -<dd>Indicates that formatter output will be used instead of logger output.</dd> +<dd>Use to show formatter output instead of logger output.</dd> <dt><tt class="docutils literal"><span class="pre">--force-logger</span></tt></dt> -<dd>Indicates that logger output will be used instead of formatter output.</dd> +<dd>Use to show logger output instead of formatter output.</dd> <dt><tt class="docutils literal"><span class="pre">-g</span> <span class="pre">GROUP</span></tt>, <tt class="docutils literal"><span class="pre">--group</span> <span class="pre">GROUP</span></tt></dt> <dd>The name of the group that owns a process. This is required when starting any executable as a daemon.</dd> <dt><tt class="docutils literal"><span class="pre">-h</span></tt>, <tt class="docutils literal"><span class="pre">--help</span></tt></dt> @@ -96,13 +106,13 @@ <dt><tt class="docutils literal"><span class="pre">-L</span> <span class="pre">LOGLOCATION</span></tt>, <tt class="docutils literal"><span class="pre">--logfile</span> <span class="pre">c</span></tt></dt> <dd>The location in which log file output files will be saved. If this location is set to something other than <tt class="docutils literal"><span class="pre">STDOUT</span></tt>, standard output logging will still be performed (otherwise there would be no output other than to a file). This is recommended when starting any executable as a daemon. Default value: <tt class="docutils literal"><span class="pre">STDOUT</span></tt>.</dd> <dt><tt class="docutils literal"><span class="pre">--[no-]color</span></tt></dt> -<dd>Indicates whether colored output will be used. Default setting: <tt class="docutils literal"><span class="pre">--color</span></tt>.</dd> +<dd>Use to view colored output. Default setting: <tt class="docutils literal"><span class="pre">--color</span></tt>.</dd> <dt><tt class="docutils literal"><span class="pre">-N</span> <span class="pre">NODE_NAME</span></tt>, <tt class="docutils literal"><span class="pre">--node-name</span> <span class="pre">NODE_NAME</span></tt></dt> <dd>The name of the node.</dd> <dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">RUN_LIST_ITEM</span></tt>, <tt class="docutils literal"><span class="pre">--override-runlist</span> <span class="pre">RUN_LIST_ITEM</span></tt></dt> <dd>Replace the current run list with the specified items.</dd> <dt><tt class="docutils literal"><span class="pre">--once</span></tt></dt> -<dd>Indicates that the chef-client is run once and that interval and splay options are cancelled.</dd> +<dd>Use to run the chef-client only once and to cancel <tt class="docutils literal"><span class="pre">interval</span></tt> and <tt class="docutils literal"><span class="pre">splay</span></tt> options.</dd> <dt><tt class="docutils literal"><span class="pre">-P</span> <span class="pre">PID_FILE</span></tt>, <tt class="docutils literal"><span class="pre">--pid</span> <span class="pre">PID_FILE</span></tt></dt> <dd>The location in which a process identification number (pid) is saved. An executable, when started as a daemon, will write the pid to the specified file. Default value: <tt class="docutils literal"><span class="pre">/tmp/name-of-executable.pid</span></tt>.</dd> <dt><tt class="docutils literal"><span class="pre">-R</span></tt>, <tt class="docutils literal"><span class="pre">--enable-reporting</span></tt></dt> @@ -116,9 +126,9 @@ <dt><tt class="docutils literal"><span class="pre">-v</span></tt>, <tt class="docutils literal"><span class="pre">--version</span></tt></dt> <dd>The version of the chef-client.</dd> <dt><tt class="docutils literal"><span class="pre">-W</span></tt>, <tt class="docutils literal"><span class="pre">--why-run</span></tt></dt> -<dd>Indicates that the executable will be run in why-run mode, which is a type of chef-client run that does everything except modify the system. Use why-run mode to understand why the chef-client makes the decisions that it makes and to learn more about the current and proposed state of the system.</dd> +<dd>Use to run the executable in why-run mode, which is a type of chef-client run that does everything except modify the system. Use why-run mode to understand why the chef-client makes the decisions that it makes and to learn more about the current and proposed state of the system.</dd> <dt><tt class="docutils literal"><span class="pre">-z</span></tt>, <tt class="docutils literal"><span class="pre">--local-mode</span></tt></dt> -<dd>Indicates that the chef-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef-repo.</dd> +<dd>Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo.</dd> </dl> </div> <div class="section" id="run-with-elevated-privileges"> |