summaryrefslogtreecommitdiff
path: root/distro
diff options
context:
space:
mode:
authorjamescott <jamescott@opscode.com>2014-01-31 11:46:13 -0800
committerjamescott <jamescott@opscode.com>2014-01-31 11:46:21 -0800
commit64be5010f200a302e6efe8bbb2376a93e215ecab (patch)
tree7f74200bbec70507418e3b20569644d6830d3743 /distro
parent960463222e123c25a6a6701437a8f375794ac71c (diff)
downloadchef-64be5010f200a302e6efe8bbb2376a93e215ecab.tar.gz
update man pages
Diffstat (limited to 'distro')
-rw-r--r--distro/common/man/man1/chef-shell.18
-rw-r--r--distro/common/man/man1/knife-bootstrap.113
-rw-r--r--distro/common/man/man1/knife-client.18
-rw-r--r--distro/common/man/man1/knife-configure.114
-rw-r--r--distro/common/man/man1/knife-cookbook-site.18
-rw-r--r--distro/common/man/man1/knife-cookbook.130
-rw-r--r--distro/common/man/man1/knife-data-bag.128
-rw-r--r--distro/common/man/man1/knife-deps.114
-rw-r--r--distro/common/man/man1/knife-download.12
-rw-r--r--distro/common/man/man1/knife-environment.18
-rw-r--r--distro/common/man/man1/knife-exec.114
-rw-r--r--distro/common/man/man1/knife-index-rebuild.13
-rw-r--r--distro/common/man/man1/knife-node.114
-rw-r--r--distro/common/man/man1/knife-role.112
-rw-r--r--distro/common/man/man1/knife-search.18
-rw-r--r--distro/common/man/man1/knife-show.12
-rw-r--r--distro/common/man/man1/knife-ssh.14
-rw-r--r--distro/common/man/man1/knife-tag.18
-rw-r--r--distro/common/man/man1/knife-upload.114
-rw-r--r--distro/common/man/man1/knife-user.119
-rw-r--r--distro/common/man/man1/knife-xargs.12
-rw-r--r--distro/common/man/man8/chef-client.834
-rw-r--r--distro/common/man/man8/chef-solo.816
23 files changed, 81 insertions, 202 deletions
diff --git a/distro/common/man/man1/chef-shell.1 b/distro/common/man/man1/chef-shell.1
index d865ce52ae..b502657148 100644
--- a/distro/common/man/man1/chef-shell.1
+++ b/distro/common/man/man1/chef-shell.1
@@ -92,10 +92,10 @@ The configuration file to use.
Shows help for the command.
.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\-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.
+.B \fB\-l LEVEL\fP, \fB\-\-log\-level LEVEL\fP
+The level of logging that will be stored in a log file.
.TP
.B \fB\-s\fP, \fB\-\-solo\fP
Indicates that chef\-shell will be run in chef\-solo mode.
@@ -110,6 +110,6 @@ The version of the chef\-client.
Indicates that chef\-shell will be run in chef\-client mode.
.UNINDENT
.SH AUTHOR
-Opscode
+Chef
.\" Generated by docutils manpage writer.
.
diff --git a/distro/common/man/man1/knife-bootstrap.1 b/distro/common/man/man1/knife-bootstrap.1
index c6c86a26b0..cbbaa8095e 100644
--- a/distro/common/man/man1/knife-bootstrap.1
+++ b/distro/common/man/man1/knife-bootstrap.1
@@ -34,9 +34,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
A bootstrap is a process that installs the chef\-client on a target system so that it can run as a chef\-client and communicate with a server.
.sp
The \fBknife bootstrap\fP subcommand is used run a bootstrap operation that installs the chef\-client on the target system. The bootstrap operation must specify the IP address or FQDN of the target system.
-.IP Note
-To bootstrap the chef\-client on Microsoft Windows machines, the \fI\%knife-windows\fP plugins is required, which includes the necessary bootstrap scripts that are used to do the actual installation.
-.RE
.sp
\fBSyntax\fP
.sp
@@ -75,6 +72,10 @@ The port on which chef\-zero will listen.
Indicates whether colored output will be used.
.TP
.B \fB\-d DISTRO\fP, \fB\-\-distro DISTRO\fP
+.IP Warning
+The default bootstrap operation uses the omnibus installer, which means the default template file (\fBchef\-full\fP) should work on all supported platforms. It is recommended to use custom bootstrap templates only when the omnibus installer cannot be used.
+.RE
+.sp
The template file to be used during a bootstrap operation. The following distributions are supported: \fBchef\-full\fP (the default bootstrap), \fBcentos5\-gems\fP, \fBfedora13\-gems\fP, \fBubuntu10.04\-gems\fP, \fBubuntu10.04\-apt\fP, \fBubuntu12.04\-gems\fP, and the name of a custom bootstrap template file. When this option is used, Knife will search for the template file in the following order: the \fBbootstrap/\fP folder in the current working directory, the \fBbootstrap/\fP folder in the chef\-repo, the \fBbootstrap/\fP folder in the \fB~/.chef/\fP directory, or a default bootstrap file. Do not use the \fB\-\-template\-file\fP option when \fB\-\-distro\fP is specified.
.TP
.B \fB\-\-defaults\fP
@@ -135,7 +136,7 @@ A comma\-separated list of roles and/or recipes to be applied.
The URL for the server.
.TP
.B \fB\-\-secret SECRET\fP
-The encryption key that is used for values contained within a data bag.
+The encryption key that is used for values contained within a data bag item.
.TP
.B \fB\-\-secret\-file FILE\fP
The path to the file that contains the encryption key.
@@ -170,16 +171,12 @@ Indicates that the chef\-client will be run in local mode, which allows all comm
.sp
\fBExamples\fP
.sp
-To pass an SSH password as part of the command:
-.sp
.nf
.ft C
$ knife bootstrap 192.168.1.1 \-x username \-P PASSWORD \-\-sudo
.ft P
.fi
.sp
-To use a file that contains a private key:
-.sp
.nf
.ft C
$ knife bootstrap 192.168.1.1 \-x username \-i ~/.ssh/id_rsa \-\-sudo
diff --git a/distro/common/man/man1/knife-client.1 b/distro/common/man/man1/knife-client.1
index 3431e35067..b8f09a6dcd 100644
--- a/distro/common/man/man1/knife-client.1
+++ b/distro/common/man/man1/knife-client.1
@@ -36,14 +36,6 @@ When a node runs the chef\-client for the first time, it generally does not yet
Once the chef\-client has registered itself with the server, it no longer uses the validation client for anything. It is recommended that you delete the private key for the chef\-validator from the host after the host has registered or use the \fBdelete_validation\fP recipe that can be found in the \fBchef\-client\fP cookbook (\fI\%https://github.com/opscode-cookbooks/chef-client\fP).
.sp
The \fBknife client\fP subcommand is used to manage an API client list and their associated RSA public key\-pairs. This allows authentication requests to be made to the server by any entity that uses the Chef Server API, such as the chef\-client and Knife.
-.sp
-This subcommand has the following syntax:
-.sp
-.nf
-.ft C
-$ knife client [ARGUMENT] (options)
-.ft P
-.fi
.SH COMMON OPTIONS
.sp
The following options may be used with any of the arguments available to the \fBknife client\fP subcommand:
diff --git a/distro/common/man/man1/knife-configure.1 b/distro/common/man/man1/knife-configure.1
index 33feb16c0c..fe9e859e9d 100644
--- a/distro/common/man/man1/knife-configure.1
+++ b/distro/common/man/man1/knife-configure.1
@@ -35,7 +35,7 @@ The \fBknife configure\fP subcommand is used to create the knife.rb and client.r
.sp
\fBSyntax\fP
.sp
-This argument has the following syntax:
+This argument has the following syntax when creating a knife.rb file:
.sp
.nf
.ft C
@@ -43,6 +43,14 @@ $ knife configure (options)
.ft P
.fi
.sp
+and the following syntax when creating a client.rb file:
+.sp
+.nf
+.ft C
+$ knife configure client DIRECTORY
+.ft P
+.fi
+.sp
\fBOptions\fP
.sp
This subcommand has the following options:
@@ -120,16 +128,12 @@ Indicates that the chef\-client will be run in local mode, which allows all comm
.sp
\fBExamples\fP
.sp
-To create a knife.rb file, enter:
-.sp
.nf
.ft C
$ knife configure
.ft P
.fi
.sp
-To configure a client.rb, enter:
-.sp
.nf
.ft C
$ knife configure client \(aq/directory\(aq
diff --git a/distro/common/man/man1/knife-cookbook-site.1 b/distro/common/man/man1/knife-cookbook-site.1
index ae76688144..25e349ca20 100644
--- a/distro/common/man/man1/knife-cookbook-site.1
+++ b/distro/common/man/man1/knife-cookbook-site.1
@@ -34,14 +34,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
The Cookbooks Site API is used to provide access to the cookbooks community hosted at \fI\%https://cookbooks.opscode.com\fP. All of the cookbooks in the community are accessible through a REST API located at \fI\%https://cookbooks.opscode.com/api/v1/\fP by using any of the supported endpoints. In most cases, using Knife and the \fBknife cookbook site\fP sub\-command (and any of its arguments) is the recommended method of interacting with these cookbooks, but in some cases, using the REST API directly may make sense.
.sp
The \fBknife cookbook site\fP subcommand is used to interact with cookbooks that are located at \fI\%https://cookbooks.opscode.com\fP. A user account is required for any community actions that write data to this site. The following arguments do not require a user account: \fBdownload\fP, \fBsearch\fP, \fBinstall\fP, and \fBlist\fP.
-.sp
-This subcommand has the following syntax:
-.sp
-.nf
-.ft C
-$ knife cookbook site [ARGUMENT] (options)
-.ft P
-.fi
.SH COMMON OPTIONS
.sp
The following options may be used with any of the arguments available to the \fBknife cookbook site\fP subcommand:
diff --git a/distro/common/man/man1/knife-cookbook.1 b/distro/common/man/man1/knife-cookbook.1
index 7e4c643f78..ac1e939511 100644
--- a/distro/common/man/man1/knife-cookbook.1
+++ b/distro/common/man/man1/knife-cookbook.1
@@ -54,14 +54,6 @@ Metadata about recipes (including dependencies), version constraints, supported
.UNINDENT
.sp
The \fBknife cookbook\fP subcommand is used to interact with cookbooks that are located on the server or the local chef\-repo.
-.sp
-This subcommand has the following syntax:
-.sp
-.nf
-.ft C
-$ knife cookbook [ARGUMENT] (options)
-.ft P
-.fi
.SH COMMON OPTIONS
.sp
The following options may be used with any of the arguments available to the \fBknife cookbook\fP subcommand:
@@ -143,7 +135,7 @@ Indicates that a cookbook (or cookbook version) will be removed entirely from th
.sp
\fBExamples\fP
.sp
-To bulk delete many cookbooks, use a regular expression to define the pattern:
+Use a regular expression to define the pattern used to bulk delete cookbooks:
.sp
.nf
.ft C
@@ -265,7 +257,13 @@ Indicates that a cookbook (or cookbook version) will be removed entirely from th
.sp
\fBExamples\fP
.sp
-To delete version "0.8" from a cookbook named "smartmon", enter:
+.nf
+.ft C
+$ knife cookbook delete cookbook_name version
+.ft P
+.fi
+.sp
+For example:
.sp
.nf
.ft C
@@ -375,8 +373,6 @@ The directory in which cookbook are created. This can be a colon\-separated path
.sp
\fBExamples\fP
.sp
-To generate metadata for all cookbooks:
-.sp
.nf
.ft C
$ knife cookbook metadata \-a
@@ -402,8 +398,6 @@ This command does not have any specific options.
.sp
\fBExamples\fP
.sp
-To view cookbook metadata from a JSON file:
-.sp
.nf
.ft C
$ knife cookbook metadta from file /path/to/file
@@ -553,11 +547,9 @@ The directory in which cookbook are created. This can be a colon\-separated path
.sp
\fBExamples\fP
.sp
-To test a cookbook named "getting\-started", enter:
-.sp
.nf
.ft C
-$ knife cookbook test getting\-started
+$ knife cookbook test cookbook_name
.ft P
.fi
.SH UPLOAD
@@ -600,11 +592,9 @@ The directory in which cookbook are created. This can be a colon\-separated path
.sp
\fBExamples\fP
.sp
-To upload a cookbook named "getting\-started":
-.sp
.nf
.ft C
-$ knife cookbook upload getting\-started
+$ knife cookbook upload cookbook_name
.ft P
.fi
.sp
diff --git a/distro/common/man/man1/knife-data-bag.1 b/distro/common/man/man1/knife-data-bag.1
index 88864af721..66c819b86c 100644
--- a/distro/common/man/man1/knife-data-bag.1
+++ b/distro/common/man/man1/knife-data-bag.1
@@ -33,17 +33,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.sp
A data bag is a global variable that is stored as JSON data and is accessible from a server. A data bag is indexed for searching and can be loaded by a recipe or accessed during a search. The contents of a data bag can vary, but they often include sensitive information (such as database passwords).
.sp
-The contents of a data bag can be encrypted using \fI\%shared secret encryption\fP. This allows a data bag to store confidential information (such as a database password) or to be managed in a source control system (without plain\-text data appearing in revision history).
+A data bag item may be encrypted using \fI\%shared secret encryption\fP. This allows each data bag item to store confidential information (such as a database password) or to be managed in a source control system (without plain\-text data appearing in revision history). Each data bag item may be encrypted individually; if a data bag contains multiple encrypted data bag items, these data bag items are not required to share the same encryption keys.
.sp
The \fBknife data bag\fP subcommand is used to manage arbitrary stores of globally available JSON data.
-.sp
-This subcommand has the following syntax:
-.sp
-.nf
-.ft C
-$ knife data bag [ARGUMENT] (options)
-.ft P
-.fi
.SH COMMON OPTIONS
.sp
The following options may be used with any of the arguments available to the \fBknife data bag\fP subcommand:
@@ -123,7 +115,7 @@ This argument has the following options:
The name of a specific item within a data bag.
.TP
.B \fB\-\-secret SECRET\fP
-The encryption key that is used for values contained within a data bag.
+The encryption key that is used for values contained within a data bag item.
.TP
.B \fB\-\-secret\-file FILE\fP
The path to the file that contains the encryption key.
@@ -174,11 +166,9 @@ The name of a specific item within a data bag.
.sp
\fBExamples\fP
.sp
-To a data bag named "admins", enter:
-.sp
.nf
.ft C
-$ knife data bag delete admins
+$ knife data bag delete data_bag_name
.ft P
.fi
.sp
@@ -214,7 +204,7 @@ This argument has the following options:
The name of a specific item within a data bag.
.TP
.B \fB\-\-secret SECRET\fP
-The encryption key that is used for values contained within a data bag.
+The encryption key that is used for values contained within a data bag item.
.TP
.B \fB\-\-secret\-file FILE\fP
The path to the file that contains the encryption key.
@@ -298,7 +288,7 @@ This argument has the following options:
Indicates that all data bags found at the specified path will be uploaded.
.TP
.B \fB\-\-secret SECRET\fP
-The encryption key that is used for values contained within a data bag.
+The encryption key that is used for values contained within a data bag item.
.TP
.B \fB\-\-secret\-file FILE\fP
The path to the file that contains the encryption key.
@@ -349,8 +339,6 @@ Indicates that the corresponding URIs will be shown.
.sp
\fBExamples\fP
.sp
-For example, to view a list of data bags on the server, enter:
-.sp
.nf
.ft C
$ knife data bag list
@@ -379,7 +367,7 @@ This argument has the following options:
The name of a specific item within a data bag.
.TP
.B \fB\-\-secret SECRET\fP
-The encryption key that is used for values contained within a data bag.
+The encryption key that is used for values contained within a data bag item.
.TP
.B \fB\-\-secret\-file FILE\fP
The path to the file that contains the encryption key.
@@ -390,15 +378,13 @@ For encrypted data bag items, use \fIeither\fP \fB\-\-secret\fP or \fB\-\-secret
.sp
\fBExamples\fP
.sp
-To show the contents of a data bag, enter:
-.sp
.nf
.ft C
$ knife data bag show admins
.ft P
.fi
.sp
-to return:
+to return something like:
.sp
.nf
.ft C
diff --git a/distro/common/man/man1/knife-deps.1 b/distro/common/man/man1/knife-deps.1
index 1de4aa4b33..b22d73678b 100644
--- a/distro/common/man/man1/knife-deps.1
+++ b/distro/common/man/man1/knife-deps.1
@@ -120,32 +120,24 @@ Indicates that the chef\-client will be run in local mode, which allows all comm
.sp
\fBExamples\fP
.sp
-To find the dependencies for a node:
-.sp
.nf
.ft C
$ knife deps nodes/node_name.json
.ft P
.fi
.sp
-To find the dependencies for a role:
-.sp
.nf
.ft C
$ knife deps roles/role_name.json
.ft P
.fi
.sp
-To find the dependencies for a cookbook:
-.sp
.nf
.ft C
$ knife deps cookbooks/cookbook_name.json
.ft P
.fi
.sp
-To find the dependencies for an environment:
-.sp
.nf
.ft C
$ knife deps environments/environment_name.json
@@ -160,7 +152,7 @@ $ knife deps cookbooks/git.json cookbooks/github.json roles/base.json environmen
.ft P
.fi
.sp
-To use a wildcard to return all the child nodes:
+A wildcard can be used to return all of the child nodes. For example, all of the environments:
.sp
.nf
.ft C
@@ -189,7 +181,7 @@ roles/webserver.json
.ft P
.fi
.sp
-To pass the output of \fBknife deps\fP to \fBknife upload\fP, do something like the following:
+The output of \fBknife deps\fP can be passed to \fBknife upload\fP:
.sp
.nf
.ft C
@@ -197,7 +189,7 @@ $ knife upload \(gaknife deps nodes/*.json
.ft P
.fi
.sp
-To pass the output of \fBknife deps\fP to \fBknife xargs\fP:
+The output of \fBknife deps\fP can be passed to \fBknife xargs\fP:
.sp
.nf
.ft C
diff --git a/distro/common/man/man1/knife-download.1 b/distro/common/man/man1/knife-download.1
index 29daeec0ed..1336dc2bc1 100644
--- a/distro/common/man/man1/knife-download.1
+++ b/distro/common/man/man1/knife-download.1
@@ -31,7 +31,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" Man page generated from reStructuredText.
.
.sp
-The \fBknife download\fP subcommand is used to download roles, cookbooks, environments, nodes, and data bags from the server to the current working directory.. It can be used to back up data on the server, inspect the state of one or more files, or to extract out\-of\-process changes users may have made to files on the server, such as if a user made a change that bypassed version source control. This subcommand is often used in conjunction with \fBknife diff\fP, which can be used to see exactly what changes will be downloaded, and then \fBknife upload\fP, which does the opposite of \fBknife download\fP.
+The \fBknife download\fP subcommand is used to download roles, cookbooks, environments, nodes, and data bags from the server to the current working directory. It can be used to back up data on the server, inspect the state of one or more files, or to extract out\-of\-process changes users may have made to files on the server, such as if a user made a change that bypassed version source control. This subcommand is often used in conjunction with \fBknife diff\fP, which can be used to see exactly what changes will be downloaded, and then \fBknife upload\fP, which does the opposite of \fBknife download\fP.
.sp
\fBSyntax\fP
.sp
diff --git a/distro/common/man/man1/knife-environment.1 b/distro/common/man/man1/knife-environment.1
index 32ff9fb7a4..1672c4eaba 100644
--- a/distro/common/man/man1/knife-environment.1
+++ b/distro/common/man/man1/knife-environment.1
@@ -34,14 +34,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
An environment is a way to map an organization\(aqs real\-life workflow to what can be configured and managed when using server. Every organization begins with a single environment called the \fB_default\fP environment, which cannot be modified (or deleted). Additional environments can be created to reflect each organization\(aqs patterns and workflow. For example, creating \fBproduction\fP, \fBstaging\fP, \fBtesting\fP, and \fBdevelopment\fP environments. Generally, an environment is also associated with one (or more) cookbook versions.
.sp
The \fBknife environment\fP subcommand is used to manage environments within a single organization on the server.
-.sp
-This subcommand has the following syntax:
-.sp
-.nf
-.ft C
-$ knife environment [ARGUMENT] (options)
-.ft P
-.fi
.SH COMMON OPTIONS
.sp
The following options may be used with any of the arguments available to the \fBknife environment\fP subcommand:
diff --git a/distro/common/man/man1/knife-exec.1 b/distro/common/man/man1/knife-exec.1
index d931615119..8e52c2ffe1 100644
--- a/distro/common/man/man1/knife-exec.1
+++ b/distro/common/man/man1/knife-exec.1
@@ -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:
diff --git a/distro/common/man/man1/knife-index-rebuild.1 b/distro/common/man/man1/knife-index-rebuild.1
index c3d3411ae0..35daf0c347 100644
--- a/distro/common/man/man1/knife-index-rebuild.1
+++ b/distro/common/man/man1/knife-index-rebuild.1
@@ -32,9 +32,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.
.sp
The \fBknife index rebuild\fP subcommand is used to rebuild the search indexes for the open source server. This operation is destructive and may take some time.
-.IP Note
-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
\fBSyntax\fP
.sp
diff --git a/distro/common/man/man1/knife-node.1 b/distro/common/man/man1/knife-node.1
index 0e1b46b655..3144a0f277 100644
--- a/distro/common/man/man1/knife-node.1
+++ b/distro/common/man/man1/knife-node.1
@@ -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
diff --git a/distro/common/man/man1/knife-role.1 b/distro/common/man/man1/knife-role.1
index c26d953b2d..e591d770c1 100644
--- a/distro/common/man/man1/knife-role.1
+++ b/distro/common/man/man1/knife-role.1
@@ -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
diff --git a/distro/common/man/man1/knife-search.1 b/distro/common/man/man1/knife-search.1
index 689e2f14b4..f44cb09121 100644
--- a/distro/common/man/man1/knife-search.1
+++ b/distro/common/man/man1/knife-search.1
@@ -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
diff --git a/distro/common/man/man1/knife-show.1 b/distro/common/man/man1/knife-show.1
index 2723ae431b..cf7fb236c3 100644
--- a/distro/common/man/man1/knife-show.1
+++ b/distro/common/man/man1/knife-show.1
@@ -133,8 +133,6 @@ $ knife show
.ft P
.fi
.sp
-To show roles and environments:
-.sp
.nf
.ft C
$ knife show roles/ environments/
diff --git a/distro/common/man/man1/knife-ssh.1 b/distro/common/man/man1/knife-ssh.1
index 1c4b2adf54..d65981ea1e 100644
--- a/distro/common/man/man1/knife-ssh.1
+++ b/distro/common/man/man1/knife-ssh.1
@@ -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"
diff --git a/distro/common/man/man1/knife-tag.1 b/distro/common/man/man1/knife-tag.1
index f2cb86dcfc..cfa4a8425e 100644
--- a/distro/common/man/man1/knife-tag.1
+++ b/distro/common/man/man1/knife-tag.1
@@ -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:
diff --git a/distro/common/man/man1/knife-upload.1 b/distro/common/man/man1/knife-upload.1
index 7cd0fb5fdf..eb1eb0ba5e 100644
--- a/distro/common/man/man1/knife-upload.1
+++ b/distro/common/man/man1/knife-upload.1
@@ -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
diff --git a/distro/common/man/man1/knife-user.1 b/distro/common/man/man1/knife-user.1
index 344fa55029..cb062f0502 100644
--- a/distro/common/man/man1/knife-user.1
+++ b/distro/common/man/man1/knife-user.1
@@ -32,17 +32,6 @@ 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.
-.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 +128,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 +153,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 +233,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 +290,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.
diff --git a/distro/common/man/man1/knife-xargs.1 b/distro/common/man/man1/knife-xargs.1
index ead1c680d9..c8406959c2 100644
--- a/distro/common/man/man1/knife-xargs.1
+++ b/distro/common/man/man1/knife-xargs.1
@@ -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
diff --git a/distro/common/man/man8/chef-client.8 b/distro/common/man/man8/chef-client.8
index ffe6fdbb28..431d903a22 100644
--- a/distro/common/man/man8/chef-client.8
+++ b/distro/common/man/man8/chef-client.8
@@ -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.
.
diff --git a/distro/common/man/man8/chef-solo.8 b/distro/common/man/man8/chef-solo.8
index 96225627a1..54c10b8caf 100644
--- a/distro/common/man/man8/chef-solo.8
+++ b/distro/common/man/man8/chef-solo.8
@@ -74,7 +74,13 @@ The name of the environment.
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: \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.
@@ -92,16 +98,16 @@ Shows help for the command.
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.
+The path to a file that contains JSON data. Use this option to override \fBnormal\fP attributes set elsewhere.
.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.
.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.
@@ -156,6 +162,6 @@ $ chef\-solo \-c ~/solo.rb \-j http://www.example.com/node.json \-r http://www.e
.sp
where \fB\-r\fP corresponds to \fBrecipe_url\fP and \fB\-j\fP corresponds to \fBjson_attribs\fP, both of which are configuration options in solo.rb.
.SH AUTHOR
-Opscode
+Chef
.\" Generated by docutils manpage writer.
.