diff options
author | jamescott <jscott@Ettores-MacBook-Pro.local> | 2014-07-02 12:17:49 -0700 |
---|---|---|
committer | jamescott <jscott@Ettores-MacBook-Pro.local> | 2014-07-02 12:18:11 -0700 |
commit | 59b0c230c9192ff13842a576d4d3a42df75230f4 (patch) | |
tree | e034a6a9ba9005f1b49314850c69e91bab84dcdd /distro | |
parent | d3217fd9e1e8d4838321786ed9ff6e536d857cd6 (diff) | |
download | chef-59b0c230c9192ff13842a576d4d3a42df75230f4.tar.gz |
update chef-client man page
Diffstat (limited to 'distro')
-rw-r--r-- | distro/common/man/man8/chef-client.8 | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/distro/common/man/man8/chef-client.8 b/distro/common/man/man8/chef-client.8 index 4cb8fc2710..569e986913 100644 --- a/distro/common/man/man8/chef-client.8 +++ b/distro/common/man/man8/chef-client.8 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "CHEF-CLIENT" "8" "Chef 11.12.0" "" "chef-client" +.TH "CHEF-CLIENT" "8" "Chef 11.14" "" "chef-client" .SH NAME chef-client \- The man page for the chef-client command line tool. . @@ -92,9 +92,6 @@ This command has the following options: .B \fB\-A\fP, \fB\-\-fatal\-windows\-admin\-check\fP Use to cause a chef\-client run to fail when the chef\-client does not have administrator privileges in Microsoft Windows\&. .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. -.TP .B \fB\-\-chef\-zero\-port PORT\fP The port on which chef\-zero will listen. .TP @@ -108,10 +105,10 @@ Use \fBmin\fP to print the progress of the chef\-client run using single charact Other formatting options are available when those formatters are configured in the client.rb file using the \fBadd_formatter\fP option. .TP .B \fB\-\-force\-formatter\fP -Indicates that formatter output will be used instead of logger output. +Use to show formatter output instead of logger output. .TP .B \fB\-\-force\-logger\fP -Indicates that logger output will be used instead of formatter output. +Use to show logger output instead of formatter output. .TP .B \fB\-g GROUP\fP, \fB\-\-group GROUP\fP The name of the group that owns a process. This is required when starting any executable as a daemon. @@ -138,7 +135,7 @@ The level of logging that will be stored in a log file. The location in which log file output files will be saved. If this location is set to something other than \fBSTDOUT\fP, 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: \fBSTDOUT\fP\&. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. Default setting: \fB\-\-color\fP\&. +Use to view colored output. Default setting: \fB\-\-color\fP\&. .TP .B \fB\-N NODE_NAME\fP, \fB\-\-node\-name NODE_NAME\fP The name of the node. @@ -147,17 +144,23 @@ The name of the node. Replace the current run list with the specified items. .TP .B \fB\-\-once\fP -Indicates that the chef\-client is run once and that interval and splay options are cancelled. +Use to run the chef\-client only once and to cancel \fBinterval\fP and \fBsplay\fP options. .TP .B \fB\-P PID_FILE\fP, \fB\-\-pid PID_FILE\fP 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: \fB/tmp/name\-of\-executable.pid\fP\&. .TP +.B \fB\-r RUN_LIST_ITEM\fP, \fB\-\-runlist RUN_LIST_ITEM\fP +Use to permanently replace the current run\-list with the specified run\-list items. +.TP .B \fB\-R\fP, \fB\-\-enable\-reporting\fP Use to enable data collection reporting during a chef\-client run. .TP .B \fBRECIPE_FILE\fP The path to a recipe. For example, if a recipe file is in the current directory, use \fBrecipe_file.rb\fP\&. This is typically used with the \fB\-\-local\-mode\fP option. .TP +.B \fB\-\-run\-lock\-timeout SECONDS\fP +The amount of time (in seconds) to wait for a chef\-client run to finish. Default value: not set (indefinite). Set to \fB0\fP to cause a second chef\-client to exit immediately. +.TP .B \fB\-s SECONDS\fP, \fB\-\-splay SECONDS\fP A number (in seconds) to add to the \fBinterval\fP that is used to determine the frequency of chef\-client runs. This number can help prevent server load when there are many clients running at the same time. .TP @@ -171,10 +174,10 @@ The user that owns a process. This is required when starting any executable as a 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. +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. .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 Chef server to also work against the local chef\-repo\&. +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\&. .UNINDENT .SH RUN WITH ELEVATED PRIVILEGES .sp |