summaryrefslogtreecommitdiff
path: root/distro
diff options
context:
space:
mode:
authorjamescott <jamescott@opscode.com>2013-11-20 16:15:17 -0800
committerjamescott <jamescott@opscode.com>2013-11-20 16:15:17 -0800
commit12258c744290c58fc72036a486b4df8adb2886d6 (patch)
treea4cb4656eb0a4be6b926055031173b181de55a83 /distro
parent3ef7c26d428253c07f706f257ce005b689c81877 (diff)
downloadchef-12258c744290c58fc72036a486b4df8adb2886d6.tar.gz
CHEF-4715 and CHEF-4714
Diffstat (limited to 'distro')
-rw-r--r--distro/common/man/man8/chef-client.811
-rw-r--r--distro/common/man/man8/chef-solo.87
2 files changed, 12 insertions, 6 deletions
diff --git a/distro/common/man/man8/chef-client.8 b/distro/common/man/man8/chef-client.8
index 5d083bbd8f..ffe6fdbb28 100644
--- a/distro/common/man/man8/chef-client.8
+++ b/distro/common/man/man8/chef-client.8
@@ -49,7 +49,7 @@ Looking for exceptions and notifications, handling each as required
.sp
The chef\-client executable can be run as a command\-line tool.
.IP Note
-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. On UNIX\- and Linux\-based machines, the configuration file is located at: /etc/chef/client.rb. On Microsoft Windows machines, the configuration file is located at C:chefclient.rb.
+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. On UNIX\- and Linux\-based machines, the configuration file is located at: \fB/etc/chef/client.rb\fP. On Microsoft Windows machines, the configuration file is located at \fBC:\echef\eclient.rb\fP.
.RE
.SH OPTIONS
.sp
@@ -76,11 +76,11 @@ Indicates that the executable will be run as a daemon. This option is only avail
.B \fB\-E ENVIRONMENT_NAME\fP, \fB\-\-environment ENVIRONMENT_NAME\fP
The name of the environment.
.TP
-.B \fB\-f\fP, \fB\-\-[no\-]fork\fP
+.B \fB\-f\fP, \fB\-\-fork\fP
Indicates that a chef\-client run will be contained in a secondary process with dedicated RAM. When the chef\-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef\-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use \fB\-\-no\-fork\fP to disable running the chef\-client in fork node. Default value: \fB\-\-fork\fP.
.TP
.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
-The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP.
+The output format: \fBdoc\fP (default) or \fBmin\fP. Other formatting options are available by using 3rd party formatters.
.TP
.B \fB\-\-force\-formatter\fP
Indicates that formatter output will be used instead of logger output.
@@ -95,7 +95,7 @@ The name of the group that owns a process. This is required when starting any ex
Shows help for the command.
.TP
.B \fB\-i SECONDS\fP, \fB\-\-interval SECONDS\fP
-The frequency (in seconds) at which the chef\-client runs. This value is configured for the chef\-client application run time, rather than in \fBChef::Config\fP. Default value: \fB1800\fP.
+The frequency (in seconds) at which the chef\-client runs. Default value: \fB1800\fP.
.TP
.B \fB\-j PATH\fP, \fB\-\-json\-attributes PATH\fP
The path to a file that contains JSON data. Use this option to override attributes that are set from other locations, such as from within a cookbook or by a role.
@@ -144,6 +144,9 @@ The version of the chef\-client.
.TP
.B \fB\-W\fP, \fB\-\-why\-run\fP
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.
+.TP
+.B \fB\-z\fP, \fB\-\-local\-mode\fP
+Indicates that the chef\-client will be run in local mode, which allows all commands that work against the server to also work against the local chef\-repo.
.UNINDENT
.SH RUN WITH ELEVATED PRIVILEGES
.sp
diff --git a/distro/common/man/man8/chef-solo.8 b/distro/common/man/man8/chef-solo.8
index 541e7b6912..96225627a1 100644
--- a/distro/common/man/man8/chef-solo.8
+++ b/distro/common/man/man8/chef-solo.8
@@ -67,11 +67,14 @@ The configuration file to use.
.B \fB\-d\fP, \fB\-\-daemonize\fP
Indicates that the executable will be run as a daemon. This option is only available on machines that run in UNIX or Linux environments. For machines that are running Microsoft Windows that require similar functionality, use the \fBchef\-client::service\fP recipe in the \fBchef\-client\fP cookbook: \fI\%http://community.opscode.com/cookbooks/chef-client\fP. This will install a chef\-client service under Microsoft Windows using the Windows Service Wrapper.
.TP
+.B \fB\-E ENVIRONMENT_NAME\fP, \fB\-\-environment ENVIRONMENT_NAME\fP
+The name of the environment.
+.TP
.B \fB\-f\fP, \fB\-\-[no\-]fork\fP
Indicates that a chef\-client run will be contained in a secondary process with dedicated RAM. When the chef\-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef\-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use \fB\-\-no\-fork\fP to disable running the chef\-client in fork node. Default value: \fB\-\-fork\fP.
.TP
.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
-The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP.
+The output format: \fBdoc\fP (default) or \fBmin\fP. Other formatting options are available by using 3rd party formatters.
.TP
.B \fB\-\-force\-formatter\fP
Indicates that formatter output will be used instead of logger output.
@@ -86,7 +89,7 @@ The name of the group that owns a process. This is required when starting any ex
Shows help for the command.
.TP
.B \fB\-i SECONDS\fP, \fB\-\-interval SECONDS\fP
-The frequency (in seconds) at which the chef\-client runs. This value is configured for the chef\-client application run time, rather than in \fBChef::Config\fP.
+The frequency (in seconds) at which the chef\-client runs.
.TP
.B \fB\-j PATH\fP, \fB\-\-json\-attributes PATH\fP
The path to a file that contains JSON data. Use this option to override attributes that are set from other locations, such as from within a cookbook or by a role.