chef 11.12.8 → 11.14.0.alpha.2

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

@@ -1,4 +1,6 @@
-.TH "KNIFE-RAW" "1" "Chef 11.10.0" "" "knife raw"
+.\" Man page generated from reStructuredText.
+.
+.TH "KNIFE-RAW" "1" "Chef 11.12.0" "" "knife raw"
 .SH NAME
 knife-raw \- The man page for the knife raw subcommand.
 .
@@ -28,20 +30,22 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.\" Man page generated from reStructuredText.
-.
 .sp
-The \fBknife raw\fP subcommand is used to send a REST request to a specified path using the Chef Server API.
+The \fBknife raw\fP subcommand is used to send a REST request to a specified path using the Chef Server API\&.
 .sp
 \fBSyntax\fP
 .sp
-This argument has the following syntax:
+This subcommand has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife raw REQUEST_PATH (options)
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 \fBOptions\fP
 .sp
@@ -70,7 +74,7 @@ The $EDITOR that is used for all interactive commands.
 The name of the environment. When this option is added to a command, the command will run only against the named environment.
 .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: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&.
 .TP
 .B \fB\-h\fP, \fB\-\-help\fP
 Shows help for the command.
@@ -79,25 +83,25 @@ Shows help for the command.
 The name of a file to be used with the \fBPUT\fP or a \fBPOST\fP request.
 .TP
 .B \fB\-k KEY\fP, \fB\-\-key KEY\fP
-The private key that Knife will use to sign requests made by the API client to the server.
+The private key that Knife will use to sign requests made by the API client to the Chef server\&.
 .TP
 .B \fB\-m METHOD\fP, \fB\-\-method METHOD\fP
-The request method: \fBDELETE\fP, \fBGET\fP, \fBPOST\fP, or \fBPUT\fP. Default value: \fBGET\fP.
+The request method: \fBDELETE\fP, \fBGET\fP, \fBPOST\fP, or \fBPUT\fP\&. Default value: \fBGET\fP\&.
 .TP
 .B \fB\-\-[no\-]pretty\fP
-Use \fB\-\-no\-pretty\fP to disable pretty\-print output for JSON. Default: \fB\-\-pretty\fP.
+Use \fB\-\-no\-pretty\fP to disable pretty\-print output for JSON\&. Default: \fB\-\-pretty\fP\&.
 .TP
 .B \fB\-\-print\-after\fP
 Indicates that data will be shown after a destructive operation.
 .TP
 .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
-The URL for the server.
+The URL for the Chef server\&.
 .TP
 .B \fB\-u USER\fP, \fB\-\-user USER\fP
-The user name used by Knife to sign requests made by the API client to the server. Authentication will fail if the user name does not match the private key.
+The user name used by Knife to sign requests made by the API client to the Chef server\&. Authentication will fail if the user name does not match the private key.
 .TP
 .B \fB\-v\fP, \fB\-\-version\fP
-The version of the chef\-client.
+The version of the chef\-client\&.
 .TP
 .B \fB\-V\fP, \fB\-\-verbose\fP
 Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
@@ -106,36 +110,50 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
 Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
 .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 Chef server to also work against the local chef\-repo\&.
 .UNINDENT
 .sp
 \fBExamples\fP
 .sp
 To view information about a client:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 knife raw /clients/<client_name>
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 To view information about a node:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 knife raw /nodes/<node_name>
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 To delete a data bag, enter a command similar to:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife raw \-m DELETE /data/foo
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 to return something similar to:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
@@ -146,6 +164,8 @@ to return something similar to:
 }
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .SH AUTHOR
 Chef
 .\" Generated by docutils manpage writer.

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

@@ -1,4 +1,6 @@
-.TH "KNIFE-RECIPE-LIST" "1" "Chef 11.10.0" "" "knife recipe list"
+.\" Man page generated from reStructuredText.
+.
+.TH "KNIFE-RECIPE-LIST" "1" "Chef 11.12.0" "" "knife recipe list"
 .SH NAME
 knife-recipe-list \- The man page for the knife recipe list subcommand.
 .
@@ -28,20 +30,22 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.\" Man page generated from reStructuredText.
-.
 .sp
-The \fBknife recipe list\fP subcommand is used to view all of the recipes that are on a server. A regular expression can be used to limit the results to recipes that match a specific pattern. The regular expression must be within quotes and not be surrounded by forward slashes (/).
+The \fBknife recipe list\fP subcommand is used to view all of the recipes that are on a Chef server\&. A regular expression can be used to limit the results to recipes that match a specific pattern. The regular expression must be within quotes and not be surrounded by forward slashes (/).
 .sp
 \fBSyntax\fP
 .sp
-This argument has the following syntax:
+This subcommand has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife recipe list REGEX
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 \fBOptions\fP
 .sp
@@ -50,14 +54,20 @@ This command does not have any specific options.
 \fBExamples\fP
 .sp
 To view a list of recipes:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife recipe list \(aqcouchdb::*\(aq
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 to return:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
@@ -67,6 +77,8 @@ couchdb::default
 couchdb::org_cleanu
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .SH AUTHOR
 Chef
 .\" Generated by docutils manpage writer.

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

@@ -1,4 +1,6 @@
-.TH "KNIFE-ROLE" "1" "Chef 11.10.0" "" "knife role"
+.\" Man page generated from reStructuredText.
+.
+.TH "KNIFE-ROLE" "1" "Chef 11.12.0" "" "knife role"
 .SH NAME
 knife-role \- The man page for the knife role subcommand.
 .
@@ -28,12 +30,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.\" Man page generated from reStructuredText.
-.
 .sp
 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.
+The \fBknife role\fP subcommand is used to manage the roles that are associated with one or more nodes on a Chef server\&.
 .SH COMMON OPTIONS
 .sp
 The following options may be used with any of the arguments available to the \fBknife role\fP subcommand:
@@ -58,13 +58,13 @@ The $EDITOR that is used for all interactive commands.
 The name of the environment. When this option is added to a command, the command will run only against the named environment.
 .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: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&.
 .TP
 .B \fB\-h\fP, \fB\-\-help\fP
 Shows help for the command.
 .TP
 .B \fB\-k KEY\fP, \fB\-\-key KEY\fP
-The private key that Knife will use to sign requests made by the API client to the server.
+The private key that Knife will use to sign requests made by the API client to the Chef server\&.
 .TP
 .B \fB\-\-[no\-]color\fP
 Indicates whether colored output will be used.
@@ -73,22 +73,22 @@ Indicates whether colored output will be used.
 Indicates that data will be shown after a destructive operation.
 .TP
 .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
-The URL for the server.
+The URL for the Chef server\&.
 .TP
 .B \fB\-u USER\fP, \fB\-\-user USER\fP
-The user name used by Knife to sign requests made by the API client to the server. Authentication will fail if the user name does not match the private key.
+The user name used by Knife to sign requests made by the API client to the Chef server\&. Authentication will fail if the user name does not match the private key.
 .TP
 .B \fB\-V\fP, \fB\-\-verbose\fP
 Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
 .TP
 .B \fB\-v\fP, \fB\-\-version\fP
-The version of the chef\-client.
+The version of the chef\-client\&.
 .TP
 .B \fB\-y\fP, \fB\-\-yes\fP
 Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
 .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 Chef server to also work against the local chef\-repo\&.
 .UNINDENT
 .SH BULK DELETE
 .sp
@@ -97,12 +97,16 @@ The \fBbulk delete\fP argument is used to delete one or more roles that match a
 \fBSyntax\fP
 .sp
 This argument has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role bulk delete REGEX
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 \fBOptions\fP
 .sp
@@ -111,25 +115,33 @@ This command does not have any specific options.
 \fBExamples\fP
 .sp
 Use a regular expression to define the pattern used to bulk delete roles:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role bulk delete "^[0\-9]{3}$"
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .SH CREATE
 .sp
-The \fBcreate\fP argument is used to add a role to the server. Role data is saved as JSON on the server.
+The \fBcreate\fP argument is used to add a role to the Chef server\&. Role data is saved as JSON on the Chef server\&.
 .sp
 \fBSyntax\fP
 .sp
 This argument has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role create ROLE_NAME (options)
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 \fBOptions\fP
 .sp
@@ -137,20 +149,26 @@ This argument has the following options:
 .INDENT 0.0
 .TP
 .B \fB\-d DESCRIPTION\fP, \fB\-\-description DESCRIPTION\fP
-The description of the role. This value will populate the description field for the role on the server.
+The description of the role. This value will populate the description field for the role on the Chef server\&.
 .UNINDENT
 .sp
 \fBExamples\fP
 .sp
 To add a role named "role1", enter:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role create role1
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 In the $EDITOR enter the role data in JSON:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
@@ -170,48 +188,62 @@ In the $EDITOR enter the role data in JSON:
 }
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 When finished, save it.
 .SH DELETE
 .sp
-The \fBdelete\fP argument is used to delete a role from the server.
+The \fBdelete\fP argument is used to delete a role from the Chef server\&.
 .sp
 \fBSyntax\fP
 .sp
 This argument has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role delete ROLE_NAME
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 \fBOptions\fP
 .sp
 This command does not have any specific options.
 .sp
 \fBExamples\fP
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role delete devops
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 Type \fBY\fP to confirm a deletion.
 .SH EDIT
 .sp
-The \fBedit\fP argument is used to edit role details on the server.
+The \fBedit\fP argument is used to edit role details on the Chef server\&.
 .sp
 \fBSyntax\fP
 .sp
 This argument has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role edit ROLE_NAME
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 \fBOptions\fP
 .sp
@@ -220,14 +252,20 @@ This command does not have any specific options.
 \fBExamples\fP
 .sp
 To edit the data for a role named "role1", enter:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role edit role1
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 Update the role data in JSON:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
@@ -247,6 +285,8 @@ Update the role data in JSON:
 }
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 When finished, save it.
 .SH FROM FILE
@@ -256,12 +296,16 @@ The \fBfrom file\fP argument is used to create a role using existing JSON data a
 \fBSyntax\fP
 .sp
 This argument has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role from file FILE
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 \fBOptions\fP
 .sp
@@ -270,25 +314,33 @@ This command does not have any specific options.
 \fBExamples\fP
 .sp
 To view role details based on the values contained in a JSON file:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role from file "path to JSON file"
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .SH LIST
 .sp
-The \fBlist\fP argument is used to view a list of roles that are currently available on the server.
+The \fBlist\fP argument is used to view a list of roles that are currently available on the Chef server\&.
 .sp
 \fBSyntax\fP
 .sp
 This argument has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role list
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 \fBOptions\fP
 .sp
@@ -301,13 +353,17 @@ Indicates that the corresponding URIs will be shown.
 .sp
 \fBExamples\fP
 .sp
-To view a list of roles on the server and display the URI for each role returned, enter:
+To view a list of roles on the Chef server and display the URI for each role returned, enter:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role list \-w
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .SH SHOW
 .sp
 The \fBshow\fP argument is used to view the details of a role.
@@ -315,12 +371,16 @@ The \fBshow\fP argument is used to view the details of a role.
 \fBSyntax\fP
 .sp
 This argument has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role show ROLE_NAME
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
 \fBOptions\fP
 .sp
@@ -334,24 +394,32 @@ The attribute (or attributes) to show.
 \fBExamples\fP
 .sp
 To view information in JSON format, use the \fB\-F\fP common option as part of the command like this:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role show devops \-F json
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
-Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP.
+Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&.
 .sp
 To view information in JSON format, use the \fB\-F\fP common option as part of the command like this:
+.INDENT 0.0
+.INDENT 3.5
 .sp
 .nf
 .ft C
 $ knife role show devops \-F json
 .ft P
 .fi
+.UNINDENT
+.UNINDENT
 .sp
-Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP.
+Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&.
 .SH AUTHOR
 Chef
 .\" Generated by docutils manpage writer.