chef 11.10.0.rc.0-x86-mingw32 → 11.10.0.rc.1-x86-mingw32

data/distro/common/man/man1/knife-exec.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-EXEC" "1" "Chef 11.8.0" "" "knife exec"
+.TH "KNIFE-EXEC" "1" "Chef 11.10.0" "" "knife exec"
 .SH NAME
 knife-exec \- The man page for the knife exec subcommand.
 .
@@ -33,20 +33,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .sp
 The \fBknife exec\fP 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.
 .sp
-For Ruby scripts that will be run using the \fBexec\fP subcommand, note the following:
-.INDENT 0.0
-.INDENT 3.5
-.INDENT 0.0
-.IP \(bu 2
-The Ruby script must be located on the system from which Knife is run (and not be located on any of the systems that Knife will be managing).
-.IP \(bu 2
-Shell commands will be run from a management workstation. For example, something like \fB%x[ls \-lash /opt/only\-on\-a\-node]\fP would give you the directory listing for the "opt/only\-on\-a\-node" directory or a "No such file or directory" error if the file does not already exist locally.
-.IP \(bu 2
-When the chef\-shell DSL is available, the chef\-client DSL will not be (unless the management workstation is also a chef\-client). Without the chef\-client DSL, a bash block cannot be used to run bash commands.
-.UNINDENT
-.UNINDENT
-.UNINDENT
-.sp
 \fBAuthenticated API Requests\fP
 .sp
 The \fBknife exec\fP subcommand can be used to make authenticated API requests to the server using the following methods:

data/distro/common/man/man1/knife-index-rebuild.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-INDEX-REBUILD" "1" "Chef 11.8.0" "" "knife index rebuild"
+.TH "KNIFE-INDEX-REBUILD" "1" "Chef 11.10.0" "" "knife index rebuild"
 .SH NAME
 knife-index-rebuild \- The man page for the knife index rebuild subcommand.
 .

data/distro/common/man/man1/knife-list.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-LIST" "1" "Chef 11.8.0" "" "knife list"
+.TH "KNIFE-LIST" "1" "Chef 11.10.0" "" "knife list"
 .SH NAME
 knife-list \- The man page for the knife list subcommand.
 .

data/distro/common/man/man1/knife-node.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-NODE" "1" "Chef 11.8.0" "" "knife node"
+.TH "KNIFE-NODE" "1" "Chef 11.10.0" "" "knife node"
 .SH NAME
 knife-node \- The man page for the knife node subcommand.
 .
@@ -34,14 +34,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 A node is any physical, virtual, or cloud machine that is configured to be maintained by a chef\-client.
 .sp
 The \fBknife node\fP subcommand is used to manage the nodes that exist on a server.
-.sp
-This subcommand has the following syntax:
-.sp
-.nf
-.ft C
-$ knife node [ARGUMENT] (options)
-.ft P
-.fi
 .SH COMMON OPTIONS
 .sp
 The following options may be used with any of the arguments available to the \fBknife node\fP subcommand:
@@ -118,7 +110,7 @@ This command does not have any specific options.
 .sp
 \fBExamples\fP
 .sp
-To bulk delete many nodes, use a regular expression to define the pattern:
+Use a regular expression to define the pattern used to bulk delete nodes:
 .sp
 .nf
 .ft C
@@ -204,11 +196,9 @@ This command does not have any specific options.
 .sp
 \fBExamples\fP
 .sp
-To delete a node called "dev", enter:
-.sp
 .nf
 .ft C
-$ knife node delete dev
+$ knife node delete node_name
 .ft P
 .fi
 .SH EDIT

data/distro/common/man/man1/knife-raw.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-RAW" "1" "Chef 11.8.0" "" "knife raw"
+.TH "KNIFE-RAW" "1" "Chef 11.10.0" "" "knife raw"
 .SH NAME
 knife-raw \- The man page for the knife raw subcommand.
 .

data/distro/common/man/man1/knife-recipe-list.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-RECIPE-LIST" "1" "Chef 11.8.0" "" "knife recipe list"
+.TH "KNIFE-RECIPE-LIST" "1" "Chef 11.10.0" "" "knife recipe list"
 .SH NAME
 knife-recipe-list \- The man page for the knife recipe list subcommand.
 .

data/distro/common/man/man1/knife-role.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-ROLE" "1" "Chef 11.8.0" "" "knife role"
+.TH "KNIFE-ROLE" "1" "Chef 11.10.0" "" "knife role"
 .SH NAME
 knife-role \- The man page for the knife role subcommand.
 .
@@ -34,14 +34,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 A role is a way to define certain patterns and processes that exist across nodes in an organization as belonging to a single job function. Each role consists of zero (or more) attributes and a run list. Each node can have zero (or more) roles assigned to it. When a role is run against a node, the configuration details of that node are compared against the attributes of the role, and then the contents of that role\(aqs run list are applied to the node\(aqs configuration details. When a chef\-client runs, it merges its own attributes and run lists with those contained within each assigned role.
 .sp
 The \fBknife role\fP subcommand is used to manage the roles that are associated with one or more nodes on a server.
-.sp
-This subcommand has the following syntax:
-.sp
-.nf
-.ft C
-$ knife role [ARGUMENT] (options)
-.ft P
-.fi
 .SH COMMON OPTIONS
 .sp
 The following options may be used with any of the arguments available to the \fBknife role\fP subcommand:
@@ -118,7 +110,7 @@ This command does not have any specific options.
 .sp
 \fBExamples\fP
 .sp
-To bulk delete roles using a regular expression:
+Use a regular expression to define the pattern used to bulk delete roles:
 .sp
 .nf
 .ft C
@@ -200,8 +192,6 @@ This command does not have any specific options.
 .sp
 \fBExamples\fP
 .sp
-To delete a role:
-.sp
 .nf
 .ft C
 $ knife role delete devops

data/distro/common/man/man1/knife-search.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-SEARCH" "1" "Chef 11.8.0" "" "knife search"
+.TH "KNIFE-SEARCH" "1" "Chef 11.10.0" "" "knife search"
 .SH NAME
 knife-search \- The man page for the knife search subcommand.
 .
@@ -31,7 +31,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" Man page generated from reStructuredText.
 .
 .sp
-Search indexes allow queries to be made for any type of data that is indexed by the server, including data bags (and data bag items), environments, nodes, and roles. A defined query syntax is used to support search patterns like exact, wildcard, range, and fuzzy. A search is a full\-text query that can be done from several locations, including from within a recipe, by using the \fBsearch\fP subcommand in Knife, by using the search functionality in the Chef Manager, or by using the \fB/search\fP or \fB/search/INDEX\fP endpoints in the Chef Server API. The search engine is based on Apache Solr and is run from the server.
+Search indexes allow queries to be made for any type of data that is indexed by the server, including data bags (and data bag items), environments, nodes, and roles. A defined query syntax is used to support search patterns like exact, wildcard, range, and fuzzy. A search is a full\-text query that can be done from several locations, including from within a recipe, by using the \fBsearch\fP subcommand in Knife, by using the search functionality in the Chef Manage, or by using the \fB/search\fP or \fB/search/INDEX\fP endpoints in the Chef Server API. The search engine is based on Apache Solr and is run from the server.
 .sp
 The \fBknife search\fP subcommand is used run a search query for information that is indexed on a server.
 .sp
@@ -76,7 +76,7 @@ and is the same search as:
 .sp
 .nf
 .ft C
-$ knife node search \(aq*:*" \-i
+$ knife search node \(aq*:*" \-i
 .ft P
 .fi
 .sp
@@ -264,7 +264,7 @@ $ knife search node <query_to_run> \-a <main_attribute>.<nested_attribute>
 .ft P
 .fi
 .sp
-To build a search query to use more than one attribute, use an underscore ( _ ) to separate each attribute. For example, the following query will search for all nodes running a specific version of Ruby:
+To build a search query to use more than one attribute, use an underscore (\fB_\fP) to separate each attribute. For example, the following query will search for all nodes running a specific version of Ruby:
 .sp
 .nf
 .ft C
@@ -284,7 +284,7 @@ To test a search query that will be used in a \fBknife ssh\fP command:
 .sp
 .nf
 .ft C
-$ knife search node "role:web AND NOT name:web03"
+$ knife search node "role:web NOT name:web03"
 .ft P
 .fi
 .sp

data/distro/common/man/man1/knife-show.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-SHOW" "1" "Chef 11.8.0" "" "knife show"
+.TH "KNIFE-SHOW" "1" "Chef 11.10.0" "" "knife show"
 .SH NAME
 knife-show \- The man page for the knife show subcommand.
 .
@@ -133,8 +133,6 @@ $ knife show
 .ft P
 .fi
 .sp
-To show roles and environments:
-.sp
 .nf
 .ft C
 $ knife show roles/ environments/

data/distro/common/man/man1/knife-ssh.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-SSH" "1" "Chef 11.8.0" "" "knife ssh"
+.TH "KNIFE-SSH" "1" "Chef 11.10.0" "" "knife ssh"
 .SH NAME
 knife-ssh \- The man page for the knife ssh subcommand.
 .
@@ -161,8 +161,6 @@ ec2\-184\-73\-60\-141.compute\-1.amazonaws.com    13:50:48 up 1 day, 23:30,  1 u
 .ft P
 .fi
 .sp
-To run the chef\-client on all nodes, enter:
-.sp
 .nf
 .ft C
 $ knife ssh \(aqname:*\(aq \(aqsudo chef\-client\(aq
@@ -217,8 +215,6 @@ $ knife ssh "role:webserver" "sudo chef\-client"
 .ft P
 .fi
 .sp
-To upgrade all nodes, enter:
-.sp
 .nf
 .ft C
 $ knife ssh name:* "sudo aptitude upgrade \-y"

data/distro/common/man/man1/knife-status.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-STATUS" "1" "Chef 11.8.0" "" "knife status"
+.TH "KNIFE-STATUS" "1" "Chef 11.10.0" "" "knife status"
 .SH NAME
 knife-status \- The man page for the knife status subcommand.
 .

data/distro/common/man/man1/knife-tag.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-TAG" "1" "Chef 11.8.0" "" "knife tag"
+.TH "KNIFE-TAG" "1" "Chef 11.10.0" "" "knife tag"
 .SH NAME
 knife-tag \- The man page for the knife tag subcommand.
 .
@@ -34,14 +34,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 A tag is a custom description that is applied to a node. A tag, once applied, can be helpful when managing nodes using Knife or when building recipes by providing alternate methods of grouping similar types of information.
 .sp
 The \fBknife tag\fP subcommand is used to apply tags to nodes on a server.
-.sp
-This subcommand has the following syntax:
-.sp
-.nf
-.ft C
-$ knife tag [ARGUMENT]
-.ft P
-.fi
 .SH COMMON OPTIONS
 .sp
 The following options may be used with any of the arguments available to the \fBknife tag\fP subcommand:

data/distro/common/man/man1/knife-upload.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-UPLOAD" "1" "Chef 11.8.0" "" "knife upload"
+.TH "KNIFE-UPLOAD" "1" "Chef 11.10.0" "" "knife upload"
 .SH NAME
 knife-upload \- The man page for the knife upload subcommand.
 .
@@ -129,7 +129,7 @@ Indicates that the chef\-client will be run in local mode, which allows all comm
 .sp
 \fBExamples\fP
 .sp
-To upload the entire chef\-repo to the server, browse to the top level of the chef\-repo and enter:
+Browse to the top level of the chef\-repo and enter:
 .sp
 .nf
 .ft C
@@ -145,7 +145,7 @@ $ knife upload /
 .ft P
 .fi
 .sp
-To upload the \fBcookbooks/\fP directory to the server, browse to the top level of the chef\-repo and enter:
+Browse to the top level of the chef\-repo and enter:
 .sp
 .nf
 .ft C
@@ -161,7 +161,7 @@ $ knife upload /cookbooks
 .ft P
 .fi
 .sp
-To upload the \fBenvironments/\fP directory to the server, browse to the top level of the chef\-repo and enter:
+Browse to the top level of the chef\-repo and enter:
 .sp
 .nf
 .ft C
@@ -177,7 +177,7 @@ $ knife upload /environments
 .ft P
 .fi
 .sp
-To upload an environment named "production" to the server, browse to the top level of the chef\-repo and enter:
+Browse to the top level of the chef\-repo and enter:
 .sp
 .nf
 .ft C
@@ -193,7 +193,7 @@ $ knife upload production.json
 .ft P
 .fi
 .sp
-To upload the \fBroles/\fP directory to the server, browse to the top level of the chef\-repo and enter:
+Browse to the top level of the chef\-repo and enter:
 .sp
 .nf
 .ft C
@@ -209,7 +209,7 @@ $ knife upload /roles
 .ft P
 .fi
 .sp
-To upload all cookbooks that start with "apache" and belong to the "webserver" role, browse to the top level of the chef\-repo and enter:
+Browse to the top level of the chef\-repo and enter:
 .sp
 .nf
 .ft C
@@ -217,8 +217,6 @@ $ knife upload cookbooks/apache\e* roles/webserver.json
 .ft P
 .fi
 .sp
-Use the output of \fBknife deps\fP to pass a command to \fBknife upload\fP. For example:
-.sp
 .nf
 .ft C
 $ knife upload \(gaknife deps nodes/*.json\(ga

data/distro/common/man/man1/knife-user.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-USER" "1" "Chef 11.8.0" "" "knife user"
+.TH "KNIFE-USER" "1" "Chef 11.10.0" "" "knife user"
 .SH NAME
 knife-user \- The man page for the knife user subcommand.
 .
@@ -33,16 +33,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .sp
 The \fBknife user\fP subcommand is used to manage the list of users and their associated RSA public key\-pairs.
 .IP Note
-This subcommand ONLY works when run against the open source server and will not run against Enterprise Chef (including hosted Enterprise Chef), or Private Chef.
+This subcommand ONLY works when run against the open source server version 10.x. This subcommand will NOT run against open source server 11, Enterprise Chef (including hosted Enterprise Chef), or Private Chef.
 .RE
-.sp
-This subcommand has the following syntax:
-.sp
-.nf
-.ft C
-$ knife user [ARGUMENT] (options)
-.ft P
-.fi
 .SH COMMON OPTIONS
 .sp
 The following options may be used with any of the arguments available to the \fBknife user\fP subcommand:
@@ -139,8 +131,6 @@ All users are assigned a public key. Use to write the public key to a file.
 .sp
 \fBExamples\fP
 .sp
-To create a new user named "Radio Birdman" with a private key saved to "/keys/user_name", enter:
-.sp
 .nf
 .ft C
 $ knife user create "Radio Birdman" \-f /keys/user_name
@@ -166,8 +156,6 @@ This command does not have any specific options.
 .sp
 \fBExamples\fP
 .sp
-To delete a user named "Steve Danno", enter:
-.sp
 .nf
 .ft C
 $ knife user delete "Steve Danno"
@@ -248,8 +236,6 @@ Indicates that the private key will be saved to a specified file name.
 .sp
 \fBExamples\fP
 .sp
-To regenerate the RSA key pair for a user named "Robert Younger", enter:
-.sp
 .nf
 .ft C
 $ knife user reregister "Robert Younger"
@@ -307,7 +293,7 @@ $ knife user show "Dennis Teck" \-F json
 .ft P
 .fi
 .sp
-Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP.
+(Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP, e.g. \fB\-F yaml\fP for YAML.)
 .SH AUTHOR
 Chef
 .\" Generated by docutils manpage writer.

data/distro/common/man/man1/knife-xargs.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-XARGS" "1" "Chef 11.8.0" "" "knife xargs"
+.TH "KNIFE-XARGS" "1" "Chef 11.10.0" "" "knife xargs"
 .SH NAME
 knife-xargs \- The man page for the knife xargs subcommand.
 .
@@ -144,8 +144,6 @@ Indicates that the chef\-client will be run in local mode, which allows all comm
 .sp
 \fBExamples\fP
 .sp
-To use the output of \fBknife deps\fP to pass a command to \fBknife xargs\fP. For example:
-.sp
 .nf
 .ft C
 $ knife deps nodes/*.json | xargs knife upload

data/distro/common/man/man8/chef-client.8

@@ -1,4 +1,4 @@
-.TH "CHEF-CLIENT" "8" "Chef 11.8.0" "" "chef-client"
+.TH "CHEF-CLIENT" "8" "Chef 11.10.0" "" "chef-client"
 .SH NAME
 chef-client \- The man page for the chef-client command line tool.
 .
@@ -67,20 +67,17 @@ This command has the following options:
 .B \fB\-A\fP, \fB\-\-fatal\-windows\-admin\-check\fP
 Indicates that a chef\-client run should fail if 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\-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\-\-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.
+.B \fB\-\-chef\-zero\-port PORT\fP
+The port on which chef\-zero will listen.
 .TP
 .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
-The output format: \fBdoc\fP (default) or \fBmin\fP. Other formatting options are available by using 3rd party formatters.
+The output format: \fBdoc\fP (default) or \fBmin\fP.
+.sp
+Use \fBdoc\fP to print the progress of the chef\-client run using full strings that display a summary of updates as they occur.
+.sp
+Use \fBmin\fP to print the progress of the chef\-client run using single characters. A summary of updates is printed at the end of the chef\-client run. A dot (\fB.\fP) is printed for events that do not have meaningful status information, such as loading a file or synchronizing a cookbook. For resources, a dot (\fB.\fP) is printed when the resource is up to date, an \fBS\fP is printed when the resource is skipped by \fBnot_if\fP or \fBonly_if\fP, and a \fBU\fP is printed when the resource is updated.
+.sp
+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.
@@ -98,7 +95,7 @@ Shows help for the command.
 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.
+The path to a file that contains JSON data.
 .TP
 .B \fB\-k KEY_FILE\fP, \fB\-\-client_key KEY_FILE\fP
 The location of the file which contains the client key. Default value: \fB/etc/chef/client.pem\fP.
@@ -107,13 +104,13 @@ The location of the file which contains the client key. Default value: \fB/etc/c
 The location of the file which contains the key used when a chef\-client is registered with a server. A validation key is signed using the \fBvalidation_client_name\fP for authentication. Default value: \fB/etc/chef/validation.pem\fP.
 .TP
 .B \fB\-l LEVEL\fP, \fB\-\-log_level LEVEL\fP
-The level of logging that will be stored in a log file: \fBdebug\fP, \fBinfo\fP, \fBwarn\fP, \fBerror\fP, or \fBfatal\fP.
+The level of logging that will be stored in a log file.
 .TP
 .B \fB\-L LOGLOCATION\fP, \fB\-\-logfile c\fP
 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 that color will not be used in the output. Default setting: \fB\-\-color\fP.
+Indicates whether colored output will be used. Default setting: \fB\-\-color\fP.
 .TP
 .B \fB\-N NODE_NAME\fP, \fB\-\-node\-name NODE_NAME\fP
 The name of the node.
@@ -130,6 +127,9 @@ The location in which a process identification number (pid) is saved. An executa
 .B \fB\-R\fP, \fB\-\-enable\-reporting\fP
 Indicates that data collection reporting is enabled 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\-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
@@ -146,7 +146,7 @@ The version of the chef\-client.
 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.
+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
@@ -268,6 +268,6 @@ $ sudo kill \-USR1 66066
 .ft P
 .fi
 .SH AUTHOR
-Opscode
+Chef
 .\" Generated by docutils manpage writer.
 .