diff options
Diffstat (limited to 'distro/common/man')
32 files changed, 2361 insertions, 569 deletions
diff --git a/distro/common/man/man1/chef-shell.1 b/distro/common/man/man1/chef-shell.1 index 9b00184610..eba598ac48 100644 --- a/distro/common/man/man1/chef-shell.1 +++ b/distro/common/man/man1/chef-shell.1 @@ -1,4 +1,6 @@ -.TH "CHEF-SHELL" "1" "Chef 11.10.0" "" "chef-shell" +.\" Man page generated from reStructuredText. +. +.TH "CHEF-SHELL" "1" "Chef 11.12.0" "" "chef-shell" .SH NAME chef-shell \- The man page for the chef-shell command line tool. . @@ -28,15 +30,17 @@ 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 chef\-shell is a recipe debugging tool that allows the use of breakpoints within recipes. chef\-shell runs as an Interactive Ruby (IRb) session. chef\-shell supports both recipe and attribute file syntax, as well as interactive debugging features. -.IP Note -chef\-shell is the new name for Shef as of Chef 11.x. chef\-shell is backwards compatible and aside from the name change, has the same set of functionality as with previous releases. -.RE .sp -The chef\-shell executable can be run as a command\-line tool. +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +chef\-shell is the new name for Shef as of Chef 11.x\&. chef\-shell is backwards compatible and aside from the name change, has the same set of functionality as with previous releases. +.UNINDENT +.UNINDENT +.sp +The chef\-shell executable is run as a command\-line tool. .SH MODES .sp chef\-shell is tool that allows Knife to be run using an Interactive Ruby (IRb) session. chef\-shell currently supports recipe and attribute file syntax, as well as interactive debugging features. chef\-shell has three run modes: @@ -59,25 +63,29 @@ _ T{ Solo T} T{ -chef\-shell acts as a chef\-solo client. It attempts to load the chef\-solo configuration file and JSON attributes. If the JSON attributes set a run list, it will be honored. Cookbooks will be loaded in the same way that chef\-solo loads them. chef\-solo mode is activated with the \fB\-s\fP or \fB\-\-solo\fP command line option, and JSON attributes are specified in the same way as for chef\-solo, with \fB\-j /path/to/chef\-solo.json\fP. +chef\-shell acts as a chef\-solo client. It attempts to load the chef\-solo configuration file and JSON attributes. If the JSON attributes set a run list, it will be honored. Cookbooks will be loaded in the same way that chef\-solo loads them. chef\-solo mode is activated with the \fB\-s\fP or \fB\-\-solo\fP command line option, and JSON attributes are specified in the same way as for chef\-solo, with \fB\-j /path/to/chef\-solo.json\fP\&. T} _ T{ Client T} T{ -chef\-shell acts as a chef\-client. During startup, it reads the chef\-client configuration file and contacts the server to get attributes and cookbooks. The run list will be set in the same way as normal chef\-client runs. chef\-client mode is activated with the \fB\-z\fP or \fB\-\-client\fP options. You can also specify the configuration file with \fB\-c CONFIG\fP and the server URL with \fB\-S SERVER_URL\fP. +chef\-shell acts as a chef\-client\&. During startup, it reads the chef\-client configuration file and contacts the Chef server to get attributes and cookbooks. The run list will be set in the same way as normal chef\-client runs. chef\-client mode is activated with the \fB\-z\fP or \fB\-\-client\fP options. You can also specify the configuration file with \fB\-c CONFIG\fP and the server URL with \fB\-S SERVER_URL\fP\&. T} _ .TE .SH OPTIONS .sp This command has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C chef\-shell OPTION VALUE OPTION VALUE ... .ft P .fi +.UNINDENT +.UNINDENT .sp This command has the following options: .INDENT 0.0 @@ -101,10 +109,10 @@ The level of logging that will be stored in a log file. Indicates that chef\-shell will be run in chef\-solo mode. .TP .B \fB\-S CHEF_SERVER_URL\fP, \fB\-\-server CHEF_SERVER_URL\fP -The URL for the server. +The URL for the Chef server\&. .TP .B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client. +The version of the chef\-client\&. .TP .B \fB\-z\fP, \fB\-\-client\fP Indicates that chef\-shell will be run in chef\-client mode. diff --git a/distro/common/man/man1/knife-bootstrap.1 b/distro/common/man/man1/knife-bootstrap.1 index 8b934f8ed7..b3b5c51b7a 100644 --- a/distro/common/man/man1/knife-bootstrap.1 +++ b/distro/common/man/man1/knife-bootstrap.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-BOOTSTRAP" "1" "Chef 11.10.0" "" "knife bootstrap" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-BOOTSTRAP" "1" "Chef 11.12.0" "" "knife bootstrap" .SH NAME knife-bootstrap \- The man page for the knife bootstrap subcommand. . @@ -28,22 +30,24 @@ 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 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. +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 Chef 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. +The \fBknife bootstrap\fP subcommand is used to 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. .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 bootstrap FQDN_or_IP_ADDRESS (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -72,9 +76,13 @@ 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 +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +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. The \fB\&.erb\fP file extension is added automatically and should not be passed as part of the bootstrap command. +.UNINDENT +.UNINDENT .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 @@ -91,7 +99,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\-G GATEWAY\fP, \fB\-\-ssh\-gateway GATEWAY\fP The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation. @@ -100,19 +108,19 @@ The SSH tunnel or gateway that is used to run a bootstrap action on a machine th Shows help for the command. .TP .B \fB\-\-hint HINT_NAME[=HINT_FILE]\fP -An Ohai hint to be set on the target of the bootstrap. The hint is contained in a file and is formatted as JSON: \fB{"attribute":"value","attribute":"value"...}\fP. \fBHINT_NAME\fP is the name of the hint and \fBHINT_FILE\fP is the name of the hint file located at \fB/etc/chef/ohai/hints/HINT_FILE.json\fP. Use multiple \fB\-\-hint\fP options in the command to specify multiple hints. +An Ohai hint to be set on the target of the bootstrap. The hint is contained in a file and is formatted as JSON: \fB{"attribute":"value","attribute":"value"...}\fP\&. \fBHINT_NAME\fP is the name of the hint and \fBHINT_FILE\fP is the name of the hint file located at \fB/etc/chef/ohai/hints/HINT_FILE.json\fP\&. Use multiple \fB\-\-hint\fP options in the command to specify multiple hints. .TP .B \fB\-\-[no\-]host\-key\-verify\fP -Use \fB\-\-no\-host\-key\-verify\fP to disable host key verification. Default setting: \fB\-\-host\-key\-verify\fP. +Use \fB\-\-no\-host\-key\-verify\fP to disable host key verification. Default setting: \fB\-\-host\-key\-verify\fP\&. .TP .B \fB\-i IDENTITY_FILE\fP, \fB\-\-identity\-file IDENTITY_FILE\fP The SSH identity file used for authentication. Key\-based authentication is recommended. .TP .B \fB\-j JSON_ATTRIBS\fP, \fB\-\-json\-attributes JSON_ATTRIBS\fP -A JSON string that is added to the first run of a chef\-client. +A JSON string that is added to the first run of a chef\-client\&. .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\-N NAME\fP, \fB\-\-node\-name NAME\fP The name of the node. @@ -133,7 +141,7 @@ Indicates that data will be shown after a destructive operation. A comma\-separated list of roles and/or recipes to be applied. .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\-\-secret SECRET\fP The encryption key that is used for values contained within a data bag item. @@ -142,19 +150,19 @@ The encryption key that is used for values contained within a data bag item. The path to the file that contains the encryption key. .TP .B \fB\-\-sudo\fP -Indicates that a bootstrap operation should be executed using sudo. +Indicates that a bootstrap operation should be executed using sudo\&. .TP .B \fB\-\-template\-file TEMPLATE\fP The path to a template file that will be used during a bootstrap operation. Do not use the \fB\-\-distro\fP option when \fB\-\-template\-file\fP is specified. .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\-\-use\-sudo\-password\fP Indicates that a bootstrap operation is done using sudo, with the password specified by the \fB\-P\fP (or \fB\-\-ssh\-password\fP) option. .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. @@ -166,22 +174,30 @@ The SSH user name. 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 +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife bootstrap 192.168.1.1 \-x username \-P PASSWORD \-\-sudo .ft P .fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife bootstrap 192.168.1.1 \-x username \-i ~/.ssh/id_rsa \-\-sudo .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-client.1 b/distro/common/man/man1/knife-client.1 index 6303359f84..738198cd60 100644 --- a/distro/common/man/man1/knife-client.1 +++ b/distro/common/man/man1/knife-client.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-CLIENT" "1" "Chef 11.10.0" "" "knife client" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-CLIENT" "1" "Chef 11.12.0" "" "knife client" .SH NAME knife-client \- The man page for the knife client subcommand. . @@ -28,14 +30,16 @@ 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 -When a node runs the chef\-client for the first time, it generally does not yet have an API client identity, and so it cannot make authenticated requests to the server. This is where the validation client\-\-\-known as the chef\-validator\-\-\-comes in. When the chef\-client runs, it checks if it has a client key. If the client key does not exist, it then attempts to borrow the identity of the chef\-validator to register itself with the server. In order to register with the server, the private key for the chef\-validator needs to be copied to the host and placed in \fB/etc/chef/validation.pem\fP. +Every request made by the chef\-client to the Chef server must be an authenticated request using the Chef Server API and a private key. When the chef\-client makes a request to the Chef server, the chef\-client authenticates each request using a private key located in \fB/etc/chef/client.pem\fP\&. +.sp +However, during the first chef\-client run, this private key does not exist. Instead, the chef\-client will attempt to use the private key assigned to the chef\-validator, located in \fB/etc/chef/validation.pem\fP\&. (If, for any reason, the chef\-validator is unable to make an authenticated request to the Chef server, the initial chef\-client run will fail.) .sp -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). +During the initial chef\-client run, the chef\-client will register with the Chef server using the private key assigned to the chef\-validator, after which the chef\-client will obtain a \fBclient.pem\fP private key for all future authentication requests to the Chef server\&. .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. +After the initial chef\-client run has completed successfully, the chef\-validator is no longer required and may be deleted from the node. Use the \fBdelete_validation\fP recipe found in the \fBchef\-client\fP cookbook (\fI\%https://github.com/opscode\-cookbooks/chef\-client\fP) to remove the chef\-validator\&. +.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 Chef server by any entity that uses the Chef Server API, such as the chef\-client and Knife\&. .SH COMMON OPTIONS .sp The following options may be used with any of the arguments available to the \fBknife client\fP subcommand: @@ -60,13 +64,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. @@ -75,46 +79,50 @@ 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 -The \fBbulk delete\fP argument is used to delete any API client that matches a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (/). +The \fBbulk delete\fP argument is used to delete any API client that matches a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (\fB/\fP). .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client bulk delete REGEX .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp This command does not have any specific options. .SH CREATE .sp -The \fBcreate\fP argument is used to create a new API client. This process will generate an RSA key pair for the named API client. The public key will be stored on the server and the private key will be displayed on \fBSTDOUT\fP or written to a named file. +The \fBcreate\fP argument is used to create a new API client\&. This process will generate an RSA key pair for the named API client\&. The public key will be stored on the Chef server and the private key will be displayed on \fBSTDOUT\fP or written to a named file. .INDENT 0.0 .IP \(bu 2 -For the chef\-client, the private key should be copied to the system as \fB/etc/chef/client.pem\fP. +For the chef\-client, the private key should be copied to the system as \fB/etc/chef/client.pem\fP\&. .IP \(bu 2 For Knife, the private key is typically copied to \fB~/.chef/client_name.pem\fP and referenced in the knife.rb configuration file. .UNINDENT @@ -122,12 +130,16 @@ For Knife, the private key is typically copied to \fB~/.chef/client_name.pem\fP \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client create CLIENT_NAME (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -135,39 +147,54 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-a\fP, \fB\-\-admin\fP -Indicates that a client will be created as an admin client. This is required when users of the open source server need to access the Chef Server API as an administrator. This option only works when used with the open source server and will have no effect when used with Enterprise Chef. +Indicates that a client will be created as an admin client. This is required when users of the open source Chef server need to access the Chef Server API as an administrator. This option only works when used with the open source Chef server and will have no effect when used with Enterprise Chef\&. +.TP +.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP +Use to save a private key to the specified file name. .UNINDENT .sp \fBExamples\fP .sp To create a Chef Admin client with the name "exampleorg" and save its private key to a file, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client create exampleorg \-a \-f "/etc/chef/client.pem" .ft P .fi +.UNINDENT +.UNINDENT .sp When running the \fBcreate\fP argument on Enterprise Chef, be sure to omit the \fB\-a\fP option: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client create exampleorg \-f "/etc/chef/client.pem" .ft P .fi +.UNINDENT +.UNINDENT .SH DELETE .sp -The \fBdelete\fP argument is used to delete a registered API client. +The \fBdelete\fP argument is used to delete a registered API client\&. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client delete CLIENT_NAME .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -176,27 +203,35 @@ This command does not have any specific options. \fBExamples\fP .sp To delete a client with the name "client_foo", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client delete client_foo .ft P .fi +.UNINDENT +.UNINDENT .sp Type \fBY\fP to confirm a deletion. .SH EDIT .sp -The \fBedit\fP argument is used to edit the details of a registered API client. When this argument is run, Knife will open $EDITOR to enable editing of the \fBadmin\fP attribute. (None of the other attributes should be changed using this argument.) When finished, Knife will update the server with those changes. +The \fBedit\fP argument is used to edit the details of a registered API client\&. When this argument is run, Knife will open $EDITOR to enable editing of the \fBadmin\fP attribute. (None of the other attributes should be changed using this argument.) When finished, Knife will update the Chef server with those changes. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client edit CLIENT_NAME .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -205,25 +240,33 @@ This command does not have any specific options. \fBExamples\fP .sp To edit a client with the name "exampleorg", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client edit exampleorg .ft P .fi +.UNINDENT +.UNINDENT .SH LIST .sp -The \fBlist\fP argument is used to view a list of registered API client. +The \fBlist\fP argument is used to view a list of registered API client\&. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client list (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -236,15 +279,21 @@ Indicates that the corresponding URIs will be shown. .sp \fBExamples\fP .sp -To verify the API client list for the server, enter: +To verify the API client list for the Chef server, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client list .ft P .fi +.UNINDENT +.UNINDENT .sp to return something similar to: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -253,31 +302,45 @@ i\-12345678 rs\-123456 .ft P .fi +.UNINDENT +.UNINDENT .sp To verify that an API client can authenticate to the -server correctly, try getting a list of clients using \fB\-u\fP and \fB\-k\fP options to specify its name and private key: +Chef server correctly, try getting a list of clients using \fB\-u\fP and \fB\-k\fP options to specify its name and private key: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client list \-u ORGNAME \-k .chef/ORGNAME.pem .ft P .fi +.UNINDENT +.UNINDENT .SH REREGISTER .sp -The \fBreregister\fP argument is used to regenerate an RSA key pair for an API client. The public key will be stored on the server and the private key will be displayed on \fBSTDOUT\fP or written to a named file. -.IP Note -Running this argument will invalidate the previous RSA key pair, making it unusable during authentication to the server. -.RE +The \fBreregister\fP argument is used to regenerate an RSA key pair for an API client\&. The public key will be stored on the Chef server and the private key will be displayed on \fBSTDOUT\fP or written to a named file. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +Running this argument will invalidate the previous RSA key pair, making it unusable during authentication to the Chef server\&. +.UNINDENT +.UNINDENT .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client reregister CLIENT_NAME (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -285,31 +348,39 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. +Use to save a private key to the specified file name. .UNINDENT .sp \fBExamples\fP .sp To regenerate the RSA key pair for a client named "testclient" and save it to a file named "rsa_key", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client regenerate testclient \-f rsa_key .ft P .fi +.UNINDENT +.UNINDENT .SH SHOW .sp -The \fBshow\fP argument is used to show the details of an API client. +The \fBshow\fP argument is used to show the details of an API client\&. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client show CLIENT_NAME (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -323,14 +394,20 @@ The attribute (or attributes) to show. \fBExamples\fP .sp To view a client named "testclient", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife client show testclient .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -341,16 +418,22 @@ name: testclient public_key: .ft P .fi +.UNINDENT +.UNINDENT .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. diff --git a/distro/common/man/man1/knife-configure.1 b/distro/common/man/man1/knife-configure.1 index 49b7f9dac5..71db9aafb6 100644 --- a/distro/common/man/man1/knife-configure.1 +++ b/distro/common/man/man1/knife-configure.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-CONFIGURE" "1" "Chef 11.10.0" "" "knife configure" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-CONFIGURE" "1" "Chef 11.12.0" "" "knife configure" .SH NAME knife-configure \- The man page for the knife configure subcommand. . @@ -28,28 +30,34 @@ 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 configure\fP subcommand is used to create the knife.rb and client.rb files so that they can be distributed to workstations and nodes. .sp \fBSyntax\fP .sp -This argument has the following syntax when creating a knife.rb file: +This subcommand has the following syntax when creating a knife.rb file: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife configure (options) .ft P .fi +.UNINDENT +.UNINDENT .sp and the following syntax when creating a client.rb file: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife configure client DIRECTORY .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -57,7 +65,7 @@ This subcommand has the following options: .INDENT 0.0 .TP .B \fB\-\-admin\-client\-key PATH\fP -The path to the private key used by the client, typically a file named \fBadmin.pem\fP. +The path to the private key used by the client, typically a file named \fBadmin.pem\fP\&. .TP .B \fB\-\-admin\-client\-name NAME\fP The name of the client, typically the name of the admin client. @@ -84,31 +92,31 @@ 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\-i\fP, \fB\-\-initial\fP -Use to create a API client, typically an administrator client on a freshly\-installed server. +Use to create a API client, typically an administrator client on a freshly\-installed Chef server\&. .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\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .TP .B \fB\-r REPO\fP, \fB\-\-repository REPO\fP -The path to the chef\-repo. +The path to the chef\-repo\&. .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. @@ -117,28 +125,36 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. The name of the validation client. .TP .B \fB\-\-validation\-key PATH\fP -The path to the validation key used by the client, typically a file named \fBvalidation.pem\fP. +The path to the validation key used by the client, typically a file named \fBvalidation.pem\fP\&. .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 .sp \fBExamples\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife configure .ft P .fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife configure client \(aq/directory\(aq .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-cookbook-site.1 b/distro/common/man/man1/knife-cookbook-site.1 index d1a8a0a9da..d21aae1667 100644 --- a/distro/common/man/man1/knife-cookbook-site.1 +++ b/distro/common/man/man1/knife-cookbook-site.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-COOKBOOK-SITE" "1" "Chef 11.10.0" "" "knife cookbook site" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-COOKBOOK-SITE" "1" "Chef 11.12.0" "" "knife cookbook site" .SH NAME knife-cookbook-site \- The man page for the knife cookbook site 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 -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. +The Cookbooks Site API is used to provide access to the cookbooks community hosted at \fI\%http://community.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/cookbooks\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. +The \fBknife cookbook site\fP subcommand is used to interact with cookbooks that are located at \fI\%http://community.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\&. .SH COMMON OPTIONS .sp The following options may be used with any of the arguments available to the \fBknife cookbook site\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 DOWNLOAD .sp @@ -97,12 +97,16 @@ The \fBdownload\fP argument is used to download a cookbook from the community we \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook site download COOKBOOK_NAME [COOKBOOK_VERSION] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -112,21 +116,30 @@ This argument has the following options: .B \fBCOOKBOOK_VERSION\fP The version of a cookbook to be downloaded. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, Knife will prompt for a version. .TP -.B \fB\-f\fP, \fB\-\-force\fP +.B \fB\-f FILE\fP, \fB\-\-file FILE\fP +The file to which a cookbook download is written. +.TP +.B \fB\-\-force\fP Indicates that an existing directory will be overwritten. .UNINDENT .sp \fBExamples\fP .sp To download the cookbook "getting\-started", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook site download getting\-started .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -135,9 +148,11 @@ Downloading getting\-started from the cookbooks site at version 0.3.0 to Cookbook saved: /Users/sdanna/opscodesupport/getting\-started\-0.3.0.tar.gz .ft P .fi +.UNINDENT +.UNINDENT .SH INSTALL .sp -The \fBinstall\fP argument is used to install a cookbook that has been downloaded from the community site to a local git repository . This action uses the git version control system in conjunction with the \fI\%https://cookbooks.opscode.com\fP site to install community\-contributed cookbooks to the local chef\-repo. Using this argument does the following: +The \fBinstall\fP argument is used to install a cookbook that has been downloaded from the community site to a local git repository . This action uses the git version control system in conjunction with the \fI\%http://community.opscode.com/\fP site to install community\-contributed cookbooks to the local chef\-repo\&. Using this argument does the following: .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 @@ -146,7 +161,7 @@ A new "pristine copy" branch is created in git for tracking the upstream. .IP 2. 3 All existing versions of a cookbook are removed from the branch. .IP 3. 3 -The cookbook is downloaded from \fI\%https://cookbooks.opscode.com\fP in the tar.gz format. +The cookbook is downloaded from \fI\%http://community.opscode.com/\fP in the tar.gz format. .IP 4. 3 The downloaded cookbook is untarred and its contents are committed to git and a tag is created. .IP 5. 3 @@ -160,12 +175,16 @@ This process allows the upstream cookbook in the master branch to be modified wh \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook site install COOKBOOK_NAME [COOKBOOK_VERSION] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -191,14 +210,20 @@ The directory in which cookbook are created. This can be a colon\-separated path \fBExamples\fP .sp To install the cookbook "getting\-started", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook site install getting\-started .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -232,19 +257,25 @@ Fast\-forward Cookbook getting\-started version 0.3.0 successfully installed .ft P .fi +.UNINDENT +.UNINDENT .SH LIST .sp -The \fBlist\fP argument is used to view a list of cookbooks that are currently available at \fI\%https://cookbooks.opscode.com\fP. +The \fBlist\fP argument is used to view a list of cookbooks that are currently available at \fI\%http://community.opscode.com/\fP\&. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook site list .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -257,15 +288,21 @@ Indicates that the corresponding URIs will be shown. .sp \fBExamples\fP .sp -To view a list of cookbooks at \fI\%https://cookbooks.opscode.com\fP server, enter: +To view a list of cookbooks at \fI\%http://community.opscode.com/\fP server, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook site list .ft P .fi +.UNINDENT +.UNINDENT .sp to return: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -282,19 +319,25 @@ ant iis redmine [...truncated...] .ft P .fi +.UNINDENT +.UNINDENT .SH SEARCH .sp -The \fBsearch\fP argument is used to search for a cookbook at \fI\%https://cookbooks.opscode.com\fP. A search query is used to return a list of cookbooks at \fI\%https://cookbooks.opscode.com\fP and uses the same syntax as the \fBknife search\fP sub\-command. +The \fBsearch\fP argument is used to search for a cookbook at \fI\%http://community.opscode.com/\fP\&. A search query is used to return a list of cookbooks at \fI\%http://community.opscode.com/\fP and uses the same syntax as the \fBknife search\fP sub\-command. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook site search SEARCH_QUERY (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -303,14 +346,20 @@ This command does not have any specific options. \fBExamples\fP .sp To search for all of the cookbooks that can be used with Apache, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook site search apache* .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -332,19 +381,25 @@ kickstart: [...truncated...] .ft P .fi +.UNINDENT +.UNINDENT .SH SHARE .sp -The \fBshare\fP argument is used to add a cookbook to \fI\%https://cookbooks.opscode.com\fP. This action will require a user account and a certificate for \fI\%http://community.opscode.com\fP. By default, Knife will use the user name and API key that is identified in the configuration file used during the upload; otherwise these values must be specified on the command line or in an alternate configuration file. If a cookbook already exists on \fI\%https://cookbooks.opscode.com\fP, then only an owner or maintainer of that cookbook can make updates. +The \fBshare\fP argument is used to add a cookbook to \fI\%http://community.opscode.com/\fP\&. This action will require a user account and a certificate for \fI\%http://community.opscode.com\fP\&. By default, Knife will use the user name and API key that is identified in the configuration file used during the upload; otherwise these values must be specified on the command line or in an alternate configuration file. If a cookbook already exists on \fI\%http://community.opscode.com/\fP, then only an owner or maintainer of that cookbook can make updates. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook site share COOKBOOK_NAME CATEGORY (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -352,7 +407,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fBCATEGORY\fP -The cookbook category: \fBDatabases\fP, \fBWeb Servers\fP, \fBProcess Management\fP, \fBMonitoring and Trending\fP, \fBProgramming Languages\fP, \fBPackage Management\fP, \fBApplications\fP, \fBNetworking\fP, \fBOperations Systems and Virtualization\fP, \fBUtilities\fP, or \fBOther\fP. +The cookbook category: \fBDatabases\fP, \fBWeb Servers\fP, \fBProcess Management\fP, \fBMonitoring and Trending\fP, \fBProgramming Languages\fP, \fBPackage Management\fP, \fBApplications\fP, \fBNetworking\fP, \fBOperations Systems and Virtualization\fP, \fBUtilities\fP, or \fBOther\fP\&. .TP .B \fB\-o PATH:PATH\fP, \fB\-\-cookbook\-path PATH:PATH\fP The directory in which cookbook are created. This can be a colon\-separated path. @@ -361,25 +416,33 @@ The directory in which cookbook are created. This can be a colon\-separated path \fBExamples\fP .sp To share a cookbook named "apache2": +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook site share "apache2" "Web Servers" .ft P .fi +.UNINDENT +.UNINDENT .SH SHOW .sp -The \fBshow\fP argument is used to view information about a cookbook on \fI\%https://cookbooks.opscode.com\fP. +The \fBshow\fP argument is used to view information about a cookbook on \fI\%http://community.opscode.com/\fP\&. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook site show COOKBOOK_NAME [COOKBOOK_VERSION] .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -393,14 +456,20 @@ The version of a cookbook to be shown. If a cookbook has only one version, this \fBExamples\fP .sp To show the details for a cookbook named "haproxy": +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook site show haproxy .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -423,29 +492,39 @@ versions: http://cookbooks.opscode.com/api/v1/cookbooks/haproxy/versions/0_7_0 .ft P .fi +.UNINDENT +.UNINDENT .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 UNSHARE .sp -The \fBunshare\fP argument is used to stop the sharing of a cookbook at \fI\%https://cookbooks.opscode.com\fP. Only the maintainer of a cookbook may perform this action. +The \fBunshare\fP argument is used to stop the sharing of a cookbook at \fI\%http://community.opscode.com/\fP\&. Only the maintainer of a cookbook may perform this action. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook site unshare COOKBOOK_NAME .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -454,12 +533,16 @@ This command does not have any specific options. \fBExamples\fP .sp To unshare a cookbook named "getting\-started", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook site unshare getting\-started .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-cookbook.1 b/distro/common/man/man1/knife-cookbook.1 index 31648f0cd8..c64ac92710 100644 --- a/distro/common/man/man1/knife-cookbook.1 +++ b/distro/common/man/man1/knife-cookbook.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-COOKBOOK" "1" "Chef 11.10.0" "" "knife cookbook" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-COOKBOOK" "1" "Chef 11.12.0" "" "knife cookbook" .SH NAME knife-cookbook \- The man page for the knife cookbook subcommand. . @@ -28,8 +30,6 @@ 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 cookbook is the fundamental unit of configuration and policy distribution. Each cookbook defines a scenario, such as everything needed to install and configure MySQL, and then it contains all of the components that are required to support that scenario, including: .INDENT 0.0 @@ -53,7 +53,7 @@ Versions Metadata about recipes (including dependencies), version constraints, supported platforms, and so on .UNINDENT .sp -The \fBknife cookbook\fP subcommand is used to interact with cookbooks that are located on the server or the local chef\-repo. +The \fBknife cookbook\fP subcommand is used to interact with cookbooks that are located on the Chef server or the local chef\-repo\&. .SH COMMON OPTIONS .sp The following options may be used with any of the arguments available to the \fBknife cookbook\fP subcommand: @@ -78,13 +78,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. @@ -93,22 +93,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 @@ -117,12 +117,16 @@ The \fBbulk delete\fP argument is used to delete cookbook files that match a pat \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook bulk delete REGEX (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -130,18 +134,22 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-p\fP, \fB\-\-purge\fP -Indicates that a cookbook (or cookbook version) will be removed entirely from the server. This action should be used carefully because only one copy of any single file is stored on the server. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged. +Indicates that a cookbook (or cookbook version) will be removed entirely from the Chef server\&. This action should be used carefully because only one copy of any single file is stored on the Chef server\&. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged. .UNINDENT .sp \fBExamples\fP .sp Use a regular expression to define the pattern used to bulk delete cookbooks: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook bulk delete "^[0\-9]{3}$" \-p .ft P .fi +.UNINDENT +.UNINDENT .SH CREATE .sp The \fBcreate\fP argument is used to create a new cookbook directory on the local machine, including the following directories and files: @@ -174,17 +182,21 @@ cookbook/templates/default .UNINDENT .UNINDENT .sp -After the cookbook is created, it can be uploaded to the server using the \fBknife upload\fP argument. +After the cookbook is created, it can be uploaded to the Chef server using the \fBknife upload\fP argument. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook create COOKBOOK_NAME (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -210,14 +222,20 @@ The document format of the readme file: \fBmd\fP (markdown) and \fBrdoc\fP (Ruby \fBExamples\fP .sp To create a cookbook named "my_cookbook" with copyright, email, license, and readme format options specified, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook create my_cookbook \-C "My Name" \-m "my@email.com" \-I apachev2 \-r md .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -226,19 +244,25 @@ to return something like: ** Creating metadata for cookbook: my_cookbook .ft P .fi +.UNINDENT +.UNINDENT .SH DELETE .sp -The \fBdelete\fP argument is used to delete a specified cookbook or cookbook version on the server (and not locally). +The \fBdelete\fP argument is used to delete a specified cookbook or cookbook version on the Chef server (and not locally). .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook delete COOKBOOK_NAME [COOKBOOK_VERSION] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -252,39 +276,51 @@ Indicates that a cookbook and every version of that cookbook will be deleted. The version of a cookbook to be deleted. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, Knife will prompt for a version. .TP .B \fB\-p\fP, \fB\-\-purge\fP -Indicates that a cookbook (or cookbook version) will be removed entirely from the server. This action should be used carefully because only one copy of any single file is stored on the server. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged. +Indicates that a cookbook (or cookbook version) will be removed entirely from the Chef server\&. This action should be used carefully because only one copy of any single file is stored on the Chef server\&. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged. .UNINDENT .sp \fBExamples\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook delete cookbook_name version .ft P .fi +.UNINDENT +.UNINDENT .sp For example: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook delete smartmon 0.8 .ft P .fi +.UNINDENT +.UNINDENT .sp Type \fBY\fP to confirm a deletion. .SH DOWNLOAD .sp -The \fBdownload\fP argument is used to download a cookbook from the server to the current working directory. +The \fBdownload\fP argument is used to download a cookbook from the Chef server to the current working directory. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook download COOKBOOK_NAME [COOKBOOK_VERSION] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -304,25 +340,33 @@ Indicates that the most recent version of a cookbook will be downloaded. \fBExamples\fP .sp To download a cookbook named "smartmon", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook download smartmon .ft P .fi +.UNINDENT +.UNINDENT .SH LIST .sp -The \fBlist\fP argument is used to view a list of cookbooks that are currently available on the server. The list will contain only the most recent version for each cookbook by default. +The \fBlist\fP argument is used to view a list of cookbooks that are currently available on the Chef server\&. The list will contain only the most recent version for each cookbook by default. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook list (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -339,12 +383,16 @@ Indicates that the corresponding URIs will be shown. \fBExamples\fP .sp To view a list of cookbooks: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook list .ft P .fi +.UNINDENT +.UNINDENT .SH METADATA .sp The \fBmetadata\fP argument is used to generate the metadata for one or more cookbooks. @@ -352,12 +400,16 @@ The \fBmetadata\fP argument is used to generate the metadata for one or more coo \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook metadata (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -372,12 +424,16 @@ The directory in which cookbook are created. This can be a colon\-separated path .UNINDENT .sp \fBExamples\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook metadata \-a .ft P .fi +.UNINDENT +.UNINDENT .SH METADATA FROM FILE .sp The \fBmetadata from file\fP argument is used to load the metadata for a cookbook from a file. @@ -385,24 +441,32 @@ The \fBmetadata from file\fP argument is used to load the metadata for a cookboo \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook metadata from file FILE .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 cookbook metadta from file /path/to/file .ft P .fi +.UNINDENT +.UNINDENT .SH SHOW .sp The \fBshow\fP argument is used to view information about a cookbook, parts of a cookbook (attributes, definitions, files, libraries, providers, recipes, resources, and templates), or a file that is associated with a cookbook (including attributes such as checksum or specificity). @@ -410,12 +474,16 @@ The \fBshow\fP argument is used to view information about a cookbook, parts of a \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook show COOKBOOK_NAME [COOKBOOK_VERSION] [PART...] [FILE_NAME] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -435,7 +503,7 @@ The name of a file that is associated with a cookbook. The platform for which a cookbook is designed. .TP .B \fBPART\fP -The part of the cookbook to show: \fBattributes\fP, \fBdefinitions\fP, \fBfiles\fP, \fBlibraries\fP, \fBproviders\fP, \fBrecipes\fP, \fBresources\fP, or \fBtemplates\fP. More than one part can be specified. +The part of the cookbook to show: \fBattributes\fP, \fBdefinitions\fP, \fBfiles\fP, \fBlibraries\fP, \fBproviders\fP, \fBrecipes\fP, \fBresources\fP, or \fBtemplates\fP\&. More than one part can be specified. .TP .B \fB\-V PLATFORM_VERSION\fP, \fB\-\-platform\-version PLATFORM_VERSION\fP The version of the platform. @@ -447,30 +515,44 @@ Indicates that the corresponding URIs will be shown. \fBExamples\fP .sp To get the list of available versions of a cookbook named "getting\-started", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook show getting\-started .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C getting\-started 0.3.0 0.2.0 .ft P .fi +.UNINDENT +.UNINDENT .sp To show a list of data about a cookbook using the name of the cookbook and the version, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook show getting\-started 0.3.0 .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -489,16 +571,24 @@ json_class: Chef::CookbookVersion libraries: [] .ft P .fi +.UNINDENT +.UNINDENT .sp To only view data about "templates", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook show getting\-started 0.3.0 templates .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -509,29 +599,39 @@ specificity: default url: https://someurlhere.com .ft P .fi +.UNINDENT +.UNINDENT .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 TEST .sp -The \fBtest\fP argument is used to test a cookbook for syntax errors. This argument uses Ruby syntax checking to verify every file in a cookbook that ends in .rb and Embedded Ruby (ERB). +The \fBtest\fP argument is used to test a cookbook for syntax errors. This argument uses Ruby syntax checking to verify every file in a cookbook that ends in .rb and Embedded Ruby (ERB)\&. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook test COOKBOOK_NAME (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -546,28 +646,47 @@ The directory in which cookbook are created. This can be a colon\-separated path .UNINDENT .sp \fBExamples\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook test cookbook_name .ft P .fi +.UNINDENT +.UNINDENT .SH UPLOAD .sp -The \fBupload\fP argument is used to upload one or more cookbooks (and any files that are associated with those cookbooks) from a local repository to the server. Only files that do not already exist on the server will be uploaded. -.IP Note -Use a chefignore file to prevent the upload of specific files and file types, such as temporary files or files placed in folders by version control systems. The chefignore file must be located in the root of the cookbook repository and must use rules similar to filename globbing (as defined by the Ruby \fBFile.fnmatch\fP syntax). -.RE +The \fBupload\fP argument is used to upload one or more cookbooks (and any files that are associated with those cookbooks) from a local repository to the Chef server\&. Only files that do not already exist on the Chef server will be uploaded. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +Use a \&.chefignore file to prevent the upload of specific files and file types, such as temporary files or files placed in folders by version control systems. The \&.chefignore file must be located in the root of the cookbook repository and must use rules similar to filename globbing (as defined by the Ruby \fBFile.fnmatch\fP syntax). +.UNINDENT +.UNINDENT +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +Empty directories are not uploaded to the Chef server\&. To upload an empty directory, create a "dot" file\-\-\-e.g. \fB\&.keep\fP\-\-\-in that directory to ensure that the directory itself is not empty. +.UNINDENT +.UNINDENT .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook upload [COOKBOOK_NAME...] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -577,9 +696,15 @@ This argument has the following options: .B \fB\-a\fP, \fB\-\-all\fP Indicates that all cookbooks will be uploaded. .TP +.B \fB\-\-concurrency\fP +The number of allowed concurrent connections. Default: \fB10\fP\&. +.TP .B \fB\-d\fP, \fB\-\-include\-dependencies\fP Indicates that when a cookbook has a dependency on one (or more) cookbooks, those cookbooks will also be uploaded. .TP +.B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP +Use to set the environment version dependency to the cookbook version being uploaded. +.TP .B \fB\-\-force\fP Indicates that a cookbook should be updated even if the \fB\-\-freeze\fP flag has been set. .TP @@ -591,22 +716,32 @@ The directory in which cookbook are created. This can be a colon\-separated path .UNINDENT .sp \fBExamples\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook upload cookbook_name .ft P .fi +.UNINDENT +.UNINDENT .sp To upload a cookbook, and then prevent other users from being able to make changes to it, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife cookbook upload redis \-\-freeze .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -614,8 +749,12 @@ Uploading redis... Upload completed .ft P .fi +.UNINDENT +.UNINDENT .sp If a cookbook is frozen and the \fB\-\-force\fP option is not specified, Knife will return an error message similar to the following: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -623,6 +762,8 @@ Uploading redis... ERROR: Version 0.1.6 of cookbook redis is frozen. Use \-\-force to override. .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-data-bag.1 b/distro/common/man/man1/knife-data-bag.1 index 20f48dd2fa..f0ec22f722 100644 --- a/distro/common/man/man1/knife-data-bag.1 +++ b/distro/common/man/man1/knife-data-bag.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-DATA-BAG" "1" "Chef 11.10.0" "" "knife data bag" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-DATA-BAG" "1" "Chef 11.12.0" "" "knife data bag" .SH NAME knife-data-bag \- The man page for the knife data bag 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 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). +A data bag is a global variable that is stored as JSON data and is accessible from a Chef server\&. A data bag is indexed for searching and can be loaded by a recipe or accessed during a search. .sp -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. +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. .SH COMMON OPTIONS @@ -60,13 +60,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. @@ -75,36 +75,40 @@ 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 CREATE .sp -The \fBcreate\fP argument is used to add a data bag to the server. +The \fBcreate\fP argument is used to add a data bag to the Chef server\&. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag create DATA_BAG_NAME [DATA_BAG_ITEM] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -120,40 +124,56 @@ The encryption key that is used for values contained within a data bag item. .B \fB\-\-secret\-file FILE\fP The path to the file that contains the encryption key. .UNINDENT -.IP Note +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 For encrypted data bag items, use \fIeither\fP \fB\-\-secret\fP or \fB\-\-secret\-file\fP, not both. -.RE +.UNINDENT +.UNINDENT .sp \fBExamples\fP .sp To create a data bag named "admins", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag create admins .ft P .fi +.UNINDENT +.UNINDENT .sp to return: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C Created data_bag[admins] .ft P .fi +.UNINDENT +.UNINDENT .SH DELETE .sp -The \fBdelete\fP argument is used to delete a data bag or a data bag item from a server. +The \fBdelete\fP argument is used to delete a data bag or a data bag item from a Chef server\&. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag delete DATA_BAG_NAME [DATA_BAG_ITEM] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -165,35 +185,47 @@ The name of a specific item within a data bag. .UNINDENT .sp \fBExamples\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag delete data_bag_name .ft P .fi +.UNINDENT +.UNINDENT .sp To delete an item named "charlie", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag delete admins charlie .ft P .fi +.UNINDENT +.UNINDENT .sp Type \fBY\fP to confirm a deletion. .SH EDIT .sp -The \fBedit\fP argument is used to edit the data contained in a data bag. If encryption is being used, the data bag will be decrypted, the data will be made available in the $EDITOR, and then encrypted again before saving it to the server. +The \fBedit\fP argument is used to edit the data contained in a data bag. If encryption is being used, the data bag will be decrypted, the data will be made available in the $EDITOR, and then encrypted again before saving it to the Chef server\&. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag edit DATA_BAG_NAME [DATA_BAG_ITEM] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -209,29 +241,43 @@ The encryption key that is used for values contained within a data bag item. .B \fB\-\-secret\-file FILE\fP The path to the file that contains the encryption key. .UNINDENT -.IP Note +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 For encrypted data bag items, use \fIeither\fP \fB\-\-secret\fP or \fB\-\-secret\-file\fP, not both. -.RE +.UNINDENT +.UNINDENT .sp \fBExamples\fP .sp To edit the contents of a data bag, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag edit admins .ft P .fi +.UNINDENT +.UNINDENT .sp To edit an item named "charlie" that is contained in a data bag named "admins", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag edit admins charlie .ft P .fi +.UNINDENT +.UNINDENT .sp -to open the $EDITOR. Once opened, you can update the data before saving it to the server. For example, by changing: +to open the $EDITOR\&. Once opened, you can update the data before saving it to the Chef server\&. For example, by changing: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -240,23 +286,29 @@ to open the $EDITOR. Once opened, you can update the data before saving it to th } .ft P .fi +.UNINDENT +.UNINDENT .sp to: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C { "id": "charlie", "uid": 1005, - "gid":"ops", - "shell":"/bin/zsh", - "comment":"Crazy Charlie" + "gid": "ops", + "shell": "/bin/zsh", + "comment": "Crazy Charlie" } .ft P .fi +.UNINDENT +.UNINDENT .SH FROM FILE .sp -The \fBfrom file\fP argument is used to create a data bag on the server from a file. The path to the data bag file must specify one of the following: +The \fBfrom file\fP argument is used to create a data bag on the Chef server from a file. The path to the data bag file must specify one of the following: .INDENT 0.0 .IP \(bu 2 the name of a data bag @@ -264,20 +316,28 @@ the name of a data bag a relative or absolute path to a file .UNINDENT .sp -If the name of a data bag is specified, Knife will search for the data bag in \fB./data_bags/bag_name/file\fP. Once opened, the JSON file should be a hash that contains at least an ID key which represents the name of the data bag item. -.IP Warning +If the name of a data bag is specified, Knife will search for the data bag in \fB\&./data_bags/bag_name/file\fP\&. Once opened, the JSON file should be a hash that contains at least an ID key which represents the name of the data bag item. +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 A chef\-client must be version 11.6 (or higher) when using the \fBknife data bag from file\fP argument with the Enterprise Chef or Open Source Chef version 11 servers. -.RE +.UNINDENT +.UNINDENT .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag from file DATA_BAG_NAME_or_PATH .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -293,40 +353,56 @@ The encryption key that is used for values contained within a data bag item. .B \fB\-\-secret\-file FILE\fP The path to the file that contains the encryption key. .UNINDENT -.IP Note +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 For encrypted data bag items, use \fIeither\fP \fB\-\-secret\fP or \fB\-\-secret\-file\fP, not both. -.RE +.UNINDENT +.UNINDENT .sp \fBExamples\fP .sp -To create a data bag on the server from a file: +To create a data bag on the Chef server from a file: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag from file "path to JSON file" .ft P .fi +.UNINDENT +.UNINDENT .sp To create a data bag named "devops_data" that contains encrypted data, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag from file devops_data \-\-secret\-file "path to decryption file" .ft P .fi +.UNINDENT +.UNINDENT .SH LIST .sp -The \fBlist\fP argument is used to view a list of data bags that are currently available on the server. +The \fBlist\fP argument is used to view a list of data bags 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 data bag list .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -338,12 +414,16 @@ Indicates that the corresponding URIs will be shown. .UNINDENT .sp \fBExamples\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag list .ft P .fi +.UNINDENT +.UNINDENT .SH SHOW .sp The \fBshow\fP argument is used to view the contents of a data bag. @@ -351,12 +431,16 @@ The \fBshow\fP argument is used to view the contents of a data bag. \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag show DATA_BAG_NAME (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -372,35 +456,53 @@ The encryption key that is used for values contained within a data bag item. .B \fB\-\-secret\-file FILE\fP The path to the file that contains the encryption key. .UNINDENT -.IP Note +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 For encrypted data bag items, use \fIeither\fP \fB\-\-secret\fP or \fB\-\-secret\-file\fP, not both. -.RE +.UNINDENT +.UNINDENT .sp \fBExamples\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag show admins .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C charlie .ft P .fi +.UNINDENT +.UNINDENT .sp To show the contents of a specific item within data bag, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag show admins charlie .ft P .fi +.UNINDENT +.UNINDENT .sp to return: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -411,16 +513,24 @@ shell: /bin/zsh uid: 1005 .ft P .fi +.UNINDENT +.UNINDENT .sp To show the contents of a data bag named "passwords" with an item that contains encrypted data named "mysql", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag show passwords mysql .ft P .fi +.UNINDENT +.UNINDENT .sp to return: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -432,16 +542,24 @@ to return: } .ft P .fi +.UNINDENT +.UNINDENT .sp To show the decrypted contents of the same data bag, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag show \-\-secret\-file /path/to/decryption/file passwords mysql .ft P .fi +.UNINDENT +.UNINDENT .sp to return: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -453,16 +571,22 @@ to return: } .ft P .fi +.UNINDENT +.UNINDENT .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 data bag show admins \-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. diff --git a/distro/common/man/man1/knife-delete.1 b/distro/common/man/man1/knife-delete.1 index f5207b8dfc..0f3014bfa2 100644 --- a/distro/common/man/man1/knife-delete.1 +++ b/distro/common/man/man1/knife-delete.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-DELETE" "1" "Chef 11.10.0" "" "knife delete" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-DELETE" "1" "Chef 11.12.0" "" "knife delete" .SH NAME knife-delete \- The man page for the knife delete 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 delete\fP subcommand is used to delete an object from a server. This subcommand works similar to \fBknife cookbook delete\fP, \fBknife data bag delete\fP, \fBknife environment delete\fP, \fBknife node delete\fP, and \fBknife role delete\fP, but with a single verb (and a single action). +The \fBknife delete\fP subcommand is used to delete an object from a Chef server\&. This subcommand works similar to \fBknife cookbook delete\fP, \fBknife data bag delete\fP, \fBknife environment delete\fP, \fBknife node delete\fP, and \fBknife role delete\fP, but with a single verb (and a single action). .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 delete [PATTERN...] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -49,13 +53,13 @@ This subcommand has the following options: .INDENT 0.0 .TP .B \fB\-\-both\fP -Indicates that both local and remote copies of an object should be deleted. Default: \fBfalse\fP. +Indicates that both local and remote copies of an object should be deleted. Default: \fBfalse\fP\&. .TP .B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. .TP .B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb. +The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. .TP .B \fB\-\-chef\-zero\-port PORT\fP The port on which chef\-zero will listen. @@ -64,7 +68,7 @@ The port on which chef\-zero will listen. Indicates whether colored output will be used. .TP .B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP. +The number of allowed concurrent connections. Default: \fB10\fP\&. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -79,34 +83,34 @@ 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\-\-local\fP -Indicates that only the local copy of an object should be deleted. (The remote copy will not be deleted.) Default: \fBfalse\fP. +Indicates that only the local copy of an object should be deleted. (The remote copy will not be deleted.) Default: \fBfalse\fP\&. .TP .B \fB\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .TP .B \fB\-r\fP, \fB\-\-[no\-]recurse\fP -Use \fB\-\-recurse\fP to delete directories recursively. Default: \fB\-\-no\-recurse\fP. +Use \fB\-\-recurse\fP to delete directories recursively. Default: \fB\-\-no\-recurse\fP\&. .TP .B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP. +The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. .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. @@ -115,7 +119,7 @@ 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 .SH AUTHOR Chef diff --git a/distro/common/man/man1/knife-deps.1 b/distro/common/man/man1/knife-deps.1 index 9199556f9b..554bdae163 100644 --- a/distro/common/man/man1/knife-deps.1 +++ b/distro/common/man/man1/knife-deps.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-DEPS" "1" "Chef 11.10.0" "" "knife deps" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-DEPS" "1" "Chef 11.12.0" "" "knife deps" .SH NAME knife-deps \- The man page for the knife deps 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 deps\fP subcommand is used to identify dependencies for a node, role, or cookbook. .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 deps (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -52,7 +56,7 @@ This subcommand has the following options: The configuration file to use. .TP .B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb. +The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. .TP .B \fB\-\-chef\-zero\-port PORT\fP The port on which chef\-zero will listen. @@ -61,7 +65,7 @@ The port on which chef\-zero will listen. Indicates whether colored output will be used. .TP .B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP. +The number of allowed concurrent connections. Default: \fB10\fP\&. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -76,37 +80,37 @@ 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\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .TP .B \fB\-\-[no\-]recurse\fP -Use \fB\-\-recurse\fP to list dependencies recursively. This option can only be used when \fB\-\-tree\fP is set to \fBtrue\fP. Default: \fB\-\-no\-recurse\fP. +Use \fB\-\-recurse\fP to list dependencies recursively. This option can only be used when \fB\-\-tree\fP is set to \fBtrue\fP\&. Default: \fB\-\-no\-recurse\fP\&. .TP .B \fB\-\-remote\fP -Indicates that dependencies will be determined from objects located on the server instead of the local chef\-repo. Default: \fBfalse\fP. +Indicates that dependencies will be determined from objects located on the Chef server instead of the local chef\-repo\&. Default: \fBfalse\fP\&. .TP .B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP. +The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. .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\-\-tree\fP -Indicates that dependencies are shown in a visual tree structure (including duplicates, if they exist). Default: \fBfalse\fP. +Indicates that dependencies are shown in a visual tree structure (including duplicates, if they exist). Default: \fBfalse\fP\&. .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. @@ -115,60 +119,90 @@ 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 +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife deps nodes/node_name.json .ft P .fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife deps roles/role_name.json .ft P .fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife deps cookbooks/cookbook_name.json .ft P .fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife deps environments/environment_name.json .ft P .fi +.UNINDENT +.UNINDENT .sp To find the dependencies for a combination of nodes, cookbooks, roles, and/or environments: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife deps cookbooks/git.json cookbooks/github.json roles/base.json environments/desert.json nodes/mynode.json .ft P .fi +.UNINDENT +.UNINDENT .sp A wildcard can be used to return all of the child nodes. For example, all of the environments: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife deps environments/*.json .ft P .fi +.UNINDENT +.UNINDENT .sp Use the \fB\-\-tree\fP option to view the results with structure: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife deps roles/webserver.json .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -180,22 +214,32 @@ roles/webserver.json cookbooks/apache2 .ft P .fi +.UNINDENT +.UNINDENT .sp The output of \fBknife deps\fP can be passed to \fBknife upload\fP: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife upload \(gaknife deps nodes/*.json .ft P .fi +.UNINDENT +.UNINDENT .sp The output of \fBknife deps\fP can be passed to \fBknife xargs\fP: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife deps nodes/*.json | xargs knife upload .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-diff.1 b/distro/common/man/man1/knife-diff.1 index 0ffd499991..42f836987d 100644 --- a/distro/common/man/man1/knife-diff.1 +++ b/distro/common/man/man1/knife-diff.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-DIFF" "1" "Chef 11.10.0" "" "knife diff" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-DIFF" "1" "Chef 11.12.0" "" "knife diff" .SH NAME knife-diff \- The man page for the knife diff 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 diff\fP subcommand is used to compare the differences between files and directories on the server and in the chef\-repo. For example, to compare files on the server prior to an uploading or downloading files using the \fBknife download\fP and \fBknife upload\fP subcommands, or to ensure that certain files in multiple production environments are the same. This subcommand is similar to the \fBgit diff\fP command that can be used to diff what is in the chef\-repo with what is synced to a git repository. +The \fBknife diff\fP subcommand is used to compare the differences between files and directories on the Chef server and in the chef\-repo\&. For example, to compare files on the Chef server prior to an uploading or downloading files using the \fBknife download\fP and \fBknife upload\fP subcommands, or to ensure that certain files in multiple production environments are the same. This subcommand is similar to the \fBgit diff\fP command that can be used to diff what is in the chef\-repo with what is synced to a git repository. .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 diff [PATTERN...] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -52,7 +56,7 @@ This subcommand has the following options: The configuration file to use. .TP .B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb. +The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. .TP .B \fB\-\-chef\-zero\-port PORT\fP The port on which chef\-zero will listen. @@ -64,7 +68,7 @@ Indicates whether colored output will be used. The version of a cookbook to be downloaded. .TP .B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP. +The number of allowed concurrent connections. Default: \fB10\fP\&. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -73,7 +77,7 @@ Indicates that $EDITOR will not be opened; data will be accepted as\-is. Indicates that Knife will use the default value, instead of asking a user to provide one. .TP .B \fB\-\-diff\-filter=[(A|D|M|T)...[*]]\fP -Indicates that files will be selected that have been added (\fBA\fP), deleted (\fBD\fP), modified (\fBM\fP), and/or have had their type changed (\fBT\fP). Any combination of filter characters may be used, including no filter characters. Use \fB*\fP to select all paths if a file matches other criteria in the comparison. Default value: \fBnil\fP. +Indicates that files will be selected that have been added (\fBA\fP), deleted (\fBD\fP), modified (\fBM\fP), and/or have had their type changed (\fBT\fP). Any combination of filter characters may be used, including no filter characters. Use \fB*\fP to select all paths if a file matches other criteria in the comparison. Default value: \fBnil\fP\&. .TP .B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP The $EDITOR that is used for all interactive commands. @@ -82,13 +86,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\-\-name\-only\fP Indicates that only the names of modified files will be shown. @@ -97,22 +101,22 @@ Indicates that only the names of modified files will be shown. Indicates that only the names of files with a status of \fBAdded\fP, \fBDeleted\fP, \fBModified\fP, or \fBType Changed\fP will be shown. .TP .B \fB\-\-no\-recurse\fP -Use \fB\-\-no\-recurse\fP to disable listing a directory recursively. Default: \fB\-\-recurse\fP. +Use \fB\-\-no\-recurse\fP to disable listing a directory recursively. Default: \fB\-\-recurse\fP\&. .TP .B \fB\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .TP .B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP. +The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. .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. @@ -121,7 +125,7 @@ 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 \fBknife.rb File Settings\fP @@ -163,30 +167,44 @@ Use to add the \fB\-\-repo\-mode\fP option. \fBExamples\fP .sp To compare the "base.json" role to a "webserver.json" role, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife diff roles/base.json roles/webserver.json .ft P .fi +.UNINDENT +.UNINDENT .sp -To compare the differences between the local chef\-repo and the files that are on the server, enter: +To compare the differences between the local chef\-repo and the files that are on the Chef server, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife diff .ft P .fi +.UNINDENT +.UNINDENT .sp To diff a node named \fBnode\-lb\fP and then only return files that have been added, deleted, modified, or changed, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife diff \-\-name\-status node\-lb .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -200,6 +218,8 @@ node\-lb/.gitignore node\-lb/Rakefile .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-download.1 b/distro/common/man/man1/knife-download.1 index f76fe9530c..54188b244c 100644 --- a/distro/common/man/man1/knife-download.1 +++ b/distro/common/man/man1/knife-download.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-DOWNLOAD" "1" "Chef 11.10.0" "" "knife download" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-DOWNLOAD" "1" "Chef 11.12.0" "" "knife download" .SH NAME knife-download \- The man page for the knife download 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 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 Chef server to the current working directory. It can be used to back up data on the Chef server, inspect the state of one or more files, or to extract out\-of\-process changes users may have made to files on the Chef 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 -This argument has the following syntax: +This subcommand has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife download [PATTERN...] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -52,7 +56,7 @@ This subcommand has the following options: The configuration file to use. .TP .B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb. +The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. .TP .B \fB\-\-chef\-zero\-port PORT\fP The port on which chef\-zero will listen. @@ -61,7 +65,7 @@ The port on which chef\-zero will listen. Indicates whether colored output will be used. .TP .B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP. +The number of allowed concurrent connections. Default: \fB10\fP\&. .TP .B \fB\-\-cookbook\-version VERSION\fP The version of a cookbook to be downloaded. @@ -73,7 +77,7 @@ Indicates that $EDITOR will not be opened; data will be accepted as\-is. Indicates that Knife will use the default value, instead of asking a user to provide one. .TP .B \fB\-\-[no\-]diff\fP -Indicates that only new and modified files will be downloaded. Set to \fBfalse\fP to download all files. Default: \fB\-\-diff\fP. +Indicates that only new and modified files will be downloaded. Set to \fBfalse\fP to download all files. Default: \fB\-\-diff\fP\&. .TP .B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP The $EDITOR that is used for all interactive commands. @@ -82,40 +86,40 @@ 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\-\-[no\-]force\fP -Use \fB\-\-force\fP to download files even when the file on the hard drive is identical to the object on the server (role, cookbook, etc.). By default, files are compared to see if they have equivalent content, and local files are only overwritten if they are different. Default: \fB\-\-no\-force\fP. +Use \fB\-\-force\fP to download files even when the file on the hard drive is identical to the object on the server (role, cookbook, etc.). By default, files are compared to see if they have equivalent content, and local files are only overwritten if they are different. Default: \fB\-\-no\-force\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\-n\fP, \fB\-\-dry\-run\fP -Indicates that no action is taken and that results are only printed out. Default: \fBfalse\fP. +Indicates that no action is taken and that results are only printed out. Default: \fBfalse\fP\&. .TP .B \fB\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .TP .B \fB\-\-[no\-]purge\fP -Use \fB\-\-purge\fP to delete local files and directories that do not exist on the server. By default, if a role, cookbook, etc. does not exist on the server, the local file for said role will be left alone and NOT deleted. Default: \fB\-\-no\-purge\fP. +Use \fB\-\-purge\fP to delete local files and directories that do not exist on the Chef server\&. By default, if a role, cookbook, etc. does not exist on the Chef server, the local file for said role will be left alone and NOT deleted. Default: \fB\-\-no\-purge\fP\&. .TP .B \fB\-\-[no\-]recurse\fP -Use \fB\-\-no\-recurse\fP to disable downloading a directory recursively. Default: \fB\-\-recurse\fP. +Use \fB\-\-no\-recurse\fP to disable downloading a directory recursively. Default: \fB\-\-recurse\fP\&. .TP .B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP. +The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. .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. @@ -124,90 +128,130 @@ 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 download the entire chef\-repo from the server, browse to the top level of the chef\-repo and enter: +To download the entire chef\-repo from the Chef server, browse to the top level of the chef\-repo and enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife download / .ft P .fi +.UNINDENT +.UNINDENT .sp -To download the \fBcookbooks/\fP directory from the server, browse to the top level of the chef\-repo and enter: +To download the \fBcookbooks/\fP directory from the Chef server, browse to the top level of the chef\-repo and enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife download cookbooks .ft P .fi +.UNINDENT +.UNINDENT .sp or from anywhere in the chef\-repo, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife download /cookbooks .ft P .fi +.UNINDENT +.UNINDENT .sp -To download the \fBenvironments/\fP directory from the server, browse to the top level of the chef\-repo and enter: +To download the \fBenvironments/\fP directory from the Chef server, browse to the top level of the chef\-repo and enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife download environments .ft P .fi +.UNINDENT +.UNINDENT .sp or from anywhere in the chef\-repo, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife download /environments .ft P .fi +.UNINDENT +.UNINDENT .sp -To download an environment named "production" from the server, browse to the top level of the chef\-repo and enter: +To download an environment named "production" from the Chef server, browse to the top level of the chef\-repo and enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife download environments/production.json .ft P .fi +.UNINDENT +.UNINDENT .sp or from the \fBenvironments/\fP directory, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife download production.json .ft P .fi +.UNINDENT +.UNINDENT .sp -To download the \fBroles/\fP directory from the server, browse to the top level of the chef\-repo and enter: +To download the \fBroles/\fP directory from the Chef server, browse to the top level of the chef\-repo and enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife download roles .ft P .fi +.UNINDENT +.UNINDENT .sp or from anywhere in the chef\-repo, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife download /roles .ft P .fi +.UNINDENT +.UNINDENT .sp To download all cookbooks that start with "apache" and belong to the "webserver" role, browse to the top level of the chef\-repo and enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife download cookbooks/apache\e* roles/webserver.json .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-edit.1 b/distro/common/man/man1/knife-edit.1 index aa9919b1a7..1c78babbd7 100644 --- a/distro/common/man/man1/knife-edit.1 +++ b/distro/common/man/man1/knife-edit.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-EDIT" "1" "Chef 11.10.0" "" "knife edit" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-EDIT" "1" "Chef 11.12.0" "" "knife edit" .SH NAME knife-edit \- The man page for the knife edit 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 edit\fP subcommand is used to edit objects on the server. This subcommand works similar to \fBknife cookbook edit\fP, \fBknife data bag edit\fP, \fBknife environment edit\fP, \fBknife node edit\fP, and \fBknife role edit\fP, but with a single verb (and a single action). +The \fBknife edit\fP subcommand is used to edit objects on the Chef server\&. This subcommand works similar to \fBknife cookbook edit\fP, \fBknife data bag edit\fP, \fBknife environment edit\fP, \fBknife node edit\fP, and \fBknife role edit\fP, but with a single verb (and a single action). .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 edit (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -52,7 +56,7 @@ This subcommand has the following options: The configuration file to use. .TP .B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb. +The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. .TP .B \fB\-\-chef\-zero\-port PORT\fP The port on which chef\-zero will listen. @@ -61,7 +65,7 @@ The port on which chef\-zero will listen. Indicates whether colored output will be used. .TP .B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP. +The number of allowed concurrent connections. Default: \fB10\fP\&. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -76,31 +80,31 @@ 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\-\-local\fP -Use to show files in the local chef\-repo instead of a remote location. Default: \fBfalse\fP. +Use to show files in the local chef\-repo instead of a remote location. Default: \fBfalse\fP\&. .TP .B \fB\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .TP .B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP. +The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. .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. @@ -109,7 +113,7 @@ 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 .SH AUTHOR Chef diff --git a/distro/common/man/man1/knife-environment.1 b/distro/common/man/man1/knife-environment.1 index 7d91ab7f22..e392dffa1d 100644 --- a/distro/common/man/man1/knife-environment.1 +++ b/distro/common/man/man1/knife-environment.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-ENVIRONMENT" "1" "Chef 11.10.0" "" "knife environment" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-ENVIRONMENT" "1" "Chef 11.12.0" "" "knife environment" .SH NAME knife-environment \- The man page for the knife environment 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 -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. +An environment is a way to map an organization\(aqs real\-life workflow to what can be configured and managed when using Chef 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. +The \fBknife environment\fP subcommand is used to manage environments within a single organization on the Chef server\&. .SH COMMON OPTIONS .sp The following options may be used with any of the arguments available to the \fBknife environment\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 COMPARE .sp @@ -97,12 +97,16 @@ The \fBcompare\fP argument is used to compare the cookbook version constraints t \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment compare [ENVIRONMENT_NAME...] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -119,14 +123,20 @@ Use to show only matching versions. \fBExample\fP .sp To compare cookbook versions for a single environment: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment compare development .ft P .fi +.UNINDENT +.UNINDENT .sp to return something similar to: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -135,16 +145,24 @@ apache 2.3.1 windows 4.1.2 .ft P .fi +.UNINDENT +.UNINDENT .sp To compare cookbook versions for multiple environments: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment compare development staging .ft P .fi +.UNINDENT +.UNINDENT .sp to return something similar to: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -154,16 +172,24 @@ windows 4.1.2 1.0.0 postgresql 1.0.0 1.0.0 .ft P .fi +.UNINDENT +.UNINDENT .sp To compare all cookbook versions for all environments: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment compare \-\-all .ft P .fi +.UNINDENT +.UNINDENT .sp to return something similar to: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -197,19 +223,25 @@ chef_handler latest latest windows 1.0.0 4.1.2 .ft P .fi +.UNINDENT +.UNINDENT .SH CREATE .sp -The \fBcreate\fP argument is used to add an environment object to the server. When this argument is run, Knife will open $EDITOR to enable editing of the \fBENVIRONMENT\fP description field (unless a description is specified as part of the command). When finished, Knife will add the environment to the server. +The \fBcreate\fP argument is used to add an environment object to the Chef server\&. When this argument is run, Knife will open $EDITOR to enable editing of the \fBENVIRONMENT\fP description field (unless a description is specified as part of the command). When finished, Knife will add the environment to the Chef server\&. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment create ENVIRONMENT_NAME \-d DESCRIPTION .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -217,31 +249,39 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-d DESCRIPTION\fP, \fB\-\-description DESCRIPTION\fP -The description of the environment. This value will populate the description field for the environment on the server. +The description of the environment. This value will populate the description field for the environment on the Chef server\&. .UNINDENT .sp \fBExamples\fP .sp To create an environment named "dev" with a description of "The development environment.": +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment create dev \-d "The development environment." .ft P .fi +.UNINDENT +.UNINDENT .SH DELETE .sp -The \fBdelete\fP argument is used to delete an environment from a server. +The \fBdelete\fP argument is used to delete an environment from a Chef server\&. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment delete ENVIRONMENT_NAME .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -250,27 +290,35 @@ This command does not have any specific options. \fBExamples\fP .sp To delete an environment named "dev", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment delete dev .ft P .fi +.UNINDENT +.UNINDENT .sp Type \fBY\fP to confirm a deletion. .SH EDIT .sp -The \fBedit\fP argument is used to edit the attributes of an environment. When this argument is run, Knife will open $EDITOR to enable editing of \fBENVIRONMENT\fP attributes. When finished, Knife will update the server with those changes. +The \fBedit\fP argument is used to edit the attributes of an environment. When this argument is run, Knife will open $EDITOR to enable editing of \fBENVIRONMENT\fP attributes. When finished, Knife will update the Chef server with those changes. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment edit ENVIRONMENT_NAME .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -279,12 +327,16 @@ This command does not have any specific options. \fBExamples\fP .sp To edit an environment named "devops", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment edit devops .ft P .fi +.UNINDENT +.UNINDENT .SH FROM FILE .sp The \fBfrom file\fP argument is used to add or update an environment using a JSON or Ruby DSL description. It must be run with the \fBcreate\fP or \fBedit\fP arguments. @@ -292,12 +344,16 @@ The \fBfrom file\fP argument is used to add or update an environment using a JSO \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment [create | edit] from file FILE (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -311,33 +367,45 @@ Indicates that all environments found at the specified path will be uploaded. \fBExamples\fP .sp To add an environment using data contained in a JSON file: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment create devops from file "path to JSON file" .ft P .fi +.UNINDENT +.UNINDENT .sp or: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment edit devops from file "path to JSON file" .ft P .fi +.UNINDENT +.UNINDENT .SH LIST .sp -The \fBlist\fP argument is used to list all of the environments that are currently available on the server. +The \fBlist\fP argument is used to list all of the environments 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 environment list \-w .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -351,12 +419,16 @@ Indicates that the corresponding URIs will be shown. \fBExamples\fP .sp To view a list of environments: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment list \-w .ft P .fi +.UNINDENT +.UNINDENT .SH SHOW .sp The \fBshow\fP argument is used to display information about the specified environment. @@ -364,12 +436,16 @@ The \fBshow\fP argument is used to display information about the specified envir \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment show ENVIRONMENT_NAME .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -378,14 +454,20 @@ This command does not have any specific options. \fBExamples\fP .sp To view information about the "dev" environment enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife environment show dev .ft P .fi +.UNINDENT +.UNINDENT .sp to return: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -404,16 +486,22 @@ override_attributes: \e\e .ft P .fi +.UNINDENT +.UNINDENT .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. diff --git a/distro/common/man/man1/knife-exec.1 b/distro/common/man/man1/knife-exec.1 index f9a2c3b570..06c8638bbe 100644 --- a/distro/common/man/man1/knife-exec.1 +++ b/distro/common/man/man1/knife-exec.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-EXEC" "1" "Chef 11.10.0" "" "knife exec" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-EXEC" "1" "Chef 11.12.0" "" "knife exec" .SH NAME knife-exec \- The man page for the knife exec subcommand. . @@ -28,14 +30,12 @@ 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 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. +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 Chef 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 \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: +The \fBknife exec\fP subcommand can be used to make authenticated API requests to the Chef server using the following methods: .TS center; |l|l|. @@ -49,36 +49,40 @@ _ T{ \fBapi.delete\fP T} T{ -Use to delete an object from the server. +Use to delete an object from the Chef server\&. T} _ T{ \fBapi.get\fP T} T{ -Use to get the details of an object on the server. +Use to get the details of an object on the Chef server\&. T} _ T{ \fBapi.post\fP T} T{ -Use to add an object to the server. +Use to add an object to the Chef server\&. T} _ T{ \fBapi.put\fP T} T{ -Use to update an object on the server. +Use to update an object on the Chef server\&. T} _ .TE .sp -These methods are used with the \fB\-E\fP option, which executes that string locally on the workstation using chef\-shell. These methods have the following syntax: +These methods are used with the \fB\-E\fP option, which executes that string locally on the workstation using chef\-shell\&. These methods have the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife exec \-E \(aqapi.method(/endpoint)\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp where: .INDENT 0.0 @@ -89,24 +93,34 @@ where: .UNINDENT .sp For example, to get the data for a node named "Example_Node": +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife exec \-E \(aqputs api.get("/nodes/Example_Node")\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp and to ensure that the output is visible in the console, add the \fBputs\fP in front of the API authorization request: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife exec \-E \(aqputs api.get("/nodes/Example_Node")\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp -where \fBputs\fP is the shorter version of the \fB$stdout.puts\fP predefined variable in Ruby. +where \fBputs\fP is the shorter version of the \fB$stdout.puts\fP predefined variable in Ruby\&. .sp The following example shows how to add a client named "IBM305RAMAC" and the \fB/clients\fP endpoint, and then return the private key for that user in the console: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -119,16 +133,22 @@ $ client_desc = { puts new_client["private_key"] .ft P .fi +.UNINDENT +.UNINDENT .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 exec SCRIPT (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -160,13 +180,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\-p PATH:PATH\fP, \fB\-\-script\-path PATH:PATH\fP A colon\-separated path at which Ruby scripts are located. @@ -175,13 +195,13 @@ A colon\-separated path at which Ruby scripts are located. 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. @@ -190,28 +210,38 @@ 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 There are three ways to use \fBknife exec\fP to run Ruby script files. For example: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife exec /path/to/script_file .ft P .fi +.UNINDENT +.UNINDENT .sp Or: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife exec \-E \(aqRUBY CODE\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp Or: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -220,8 +250,12 @@ RUBY CODE ^D .ft P .fi +.UNINDENT +.UNINDENT .sp To check the status of Knife using a Ruby script named "status.rb" (which looks like): +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -234,32 +268,48 @@ nodes.all do |n| end .ft P .fi +.UNINDENT +.UNINDENT .sp and is located in a directory named "scripts", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife exec scripts/status.rb .ft P .fi +.UNINDENT +.UNINDENT .sp To show the available free memory for all nodes, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife exec \-E \(aqnodes.all {|n| puts "#{n.name} has #{n.memory.total} free memory"}\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp To list all of the available search indexes, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife exec \-E \(aqputs api.get("search").keys\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp To query a node for multiple attributes using a Ruby script named \fBsearch_attributes.rb\fP (which looks like): +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -278,16 +328,24 @@ puts results exit 0 .ft P .fi +.UNINDENT +.UNINDENT .sp enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C % knife exec scripts/search_attributes.rb "hostname:test_system" ipaddress,fqdn .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -296,6 +354,8 @@ Your attributes: ipaddress fqdn {"test_system.example.com"=>{"ipaddress"=>"10.1.1.200", "fqdn"=>"test_system.example.com"}} .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-index-rebuild.1 b/distro/common/man/man1/knife-index-rebuild.1 index 03c8332a31..862f3ca9af 100644 --- a/distro/common/man/man1/knife-index-rebuild.1 +++ b/distro/common/man/man1/knife-index-rebuild.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-INDEX-REBUILD" "1" "Chef 11.10.0" "" "knife index rebuild" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-INDEX-REBUILD" "1" "Chef 11.12.0" "" "knife index rebuild" .SH NAME knife-index-rebuild \- The man page for the knife index rebuild subcommand. . @@ -28,23 +30,29 @@ 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 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 +The \fBknife index rebuild\fP subcommand is used to rebuild the search indexes for the open source Chef server\&. This operation is destructive and may take some time. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +This subcommand ONLY works when run against the open source Chef server version 10.x. This subcommand will NOT run against open source Chef server 11, Enterprise Chef (including hosted Enterprise Chef), or Private Chef\&. +.UNINDENT +.UNINDENT .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 index rebuild .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp diff --git a/distro/common/man/man1/knife-list.1 b/distro/common/man/man1/knife-list.1 index acc3fe47c7..4a6e9daec3 100644 --- a/distro/common/man/man1/knife-list.1 +++ b/distro/common/man/man1/knife-list.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-LIST" "1" "Chef 11.10.0" "" "knife list" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-LIST" "1" "Chef 11.12.0" "" "knife list" .SH NAME knife-list \- The man page for the knife 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 list\fP subcommand is used to view a list of objects on the server. This subcommand works similar to \fBknife cookbook list\fP, \fBknife data bag list\fP, \fBknife environment list\fP, \fBknife node list\fP, and \fBknife role list\fP, but with a single verb (and a single action). +The \fBknife list\fP subcommand is used to view a list of objects on the Chef server\&. This subcommand works similar to \fBknife cookbook list\fP, \fBknife data bag list\fP, \fBknife environment list\fP, \fBknife node list\fP, and \fBknife role list\fP, but with a single verb (and a single action). .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 list [PATTERN...] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -49,13 +53,13 @@ This subcommand has the following options: .INDENT 0.0 .TP .B \fB\-1\fP -Indicates that only one column of results will be shown. Default: \fBfalse\fP. +Indicates that only one column of results will be shown. Default: \fBfalse\fP\&. .TP .B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. .TP .B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb. +The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. .TP .B \fB\-\-chef\-zero\-port PORT\fP The port on which chef\-zero will listen. @@ -64,10 +68,10 @@ The port on which chef\-zero will listen. Indicates whether colored output will be used. .TP .B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP. +The number of allowed concurrent connections. Default: \fB10\fP\&. .TP .B \fB\-d\fP -Indicates that a directory\(aqs children will not be shown when a directory matches a pattern. Default value: \fBfalse\fP. +Indicates that a directory\(aqs children will not be shown when a directory matches a pattern. Default value: \fBfalse\fP\&. .TP .B \fB\-\-defaults\fP Indicates that Knife will use the default value, instead of asking a user to provide one. @@ -82,40 +86,40 @@ 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\fP, \fB\-\-flat\fP -Indicates that a list of file names will be shown. Set to \fBfalse\fP to view ls\-like output. Default: \fBfalse\fP. +Use to show a list of file names. Set to \fBfalse\fP to view ls\-like output. Default: \fBfalse\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: \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\-\-local\fP -Indicates that only contents of the local directory will be returned. Default: \fBfalse\fP. +Indicates that only contents of the local directory will be returned. Default: \fBfalse\fP\&. .TP .B \fB\-p\fP -Indicates that trailing slashes (/) will be shown for directories. Default: \fBfalse\fP. +Indicates that trailing slashes (/) will be shown for directories. Default: \fBfalse\fP\&. .TP .B \fB\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .TP .B \fB\-R\fP -Indicates that directories will be listed recursively. Default: \fBfalse\fP. +Indicates that directories will be listed recursively. Default: \fBfalse\fP\&. .TP .B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP. +The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. .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. @@ -124,34 +128,46 @@ 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 -For example, to view a list of roles on the server: +For example, to view a list of roles on the Chef server: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife list roles/ .ft P .fi +.UNINDENT +.UNINDENT .sp -To view a list of roles and environments on the server: +To view a list of roles and environments on the Chef server: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife list roles/ environments/ .ft P .fi +.UNINDENT +.UNINDENT .sp -To view a list of absolutely everything on the server: +To view a list of absolutely everything on the Chef server: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife list \-R / .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-node.1 b/distro/common/man/man1/knife-node.1 index 1eae3344f2..1be2e4b9a1 100644 --- a/distro/common/man/man1/knife-node.1 +++ b/distro/common/man/man1/knife-node.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-NODE" "1" "Chef 11.10.0" "" "knife node" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-NODE" "1" "Chef 11.12.0" "" "knife node" .SH NAME knife-node \- The man page for the knife node 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 node is any physical, virtual, or cloud machine that is configured to be maintained by a chef\-client. +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. +The \fBknife node\fP subcommand is used to manage the nodes that exist on a Chef server\&. .SH COMMON OPTIONS .sp The following options may be used with any of the arguments available to the \fBknife node\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 nodes that match a \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node bulk delete REGEX .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -111,27 +115,35 @@ This command does not have any specific options. \fBExamples\fP .sp Use a regular expression to define the pattern used to bulk delete nodes: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node bulk delete "^[0\-9]{3}$" .ft P .fi +.UNINDENT +.UNINDENT .sp Type \fBY\fP to confirm a deletion. .SH CREATE .sp -The \fBcreate\fP argument is used to add a node to the server. Node data is stored as JSON on the server. +The \fBcreate\fP argument is used to add a node to the Chef server\&. Node data is stored 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 node create NODE_NAME .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -140,14 +152,20 @@ This command does not have any specific options. \fBExamples\fP .sp To add a node, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node create node1 .ft P .fi +.UNINDENT +.UNINDENT .sp In the $EDITOR enter the node data in JSON: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -171,49 +189,67 @@ In the $EDITOR enter the node 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 node from the server. -.IP Note +The \fBdelete\fP argument is used to delete a node from the Chef server\&. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 Deleting a node will not delete any corresponding API clients. -.RE +.UNINDENT +.UNINDENT .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node delete NODE_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 node delete node_name .ft P .fi +.UNINDENT +.UNINDENT .SH EDIT .sp -The \fBedit\fP argument is used to edit the details of a node on a server. Node data is stored as JSON on the server. +The \fBedit\fP argument is used to edit the details of a node on a Chef server\&. Node data is stored 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 node edit NODE_NAME (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -221,20 +257,26 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-a\fP, \fB\-\-all\fP -Displays a node in the $EDITOR. By default, attributes that are default, override, or automatic are not shown. +Displays a node in the $EDITOR\&. By default, attributes that are default, override, or automatic are not shown. .UNINDENT .sp \fBExamples\fP .sp To edit the data for a node named "node1", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node edit node1 \-a .ft P .fi +.UNINDENT +.UNINDENT .sp Update the role data in JSON: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -258,6 +300,8 @@ Update the role data in JSON: } .ft P .fi +.UNINDENT +.UNINDENT .sp When finished, save it. .SH FROM FILE @@ -267,12 +311,16 @@ The \fBfrom file\fP argument is used to create a node using existing node data a \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node from file FILE .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -281,25 +329,33 @@ This command does not have any specific options. \fBExamples\fP .sp To add a node using data contained in a JSON file: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node from file "path to JSON file" .ft P .fi +.UNINDENT +.UNINDENT .SH LIST .sp -The \fBlist\fP argument is used to view all of the nodes that exist on a server. +The \fBlist\fP argument is used to view all of the nodes that exist on a Chef server\&. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node list (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -312,15 +368,21 @@ Indicates that the corresponding URIs will be shown. .sp \fBExamples\fP .sp -To verify the list of nodes that are registered with the server, enter: +To verify the list of nodes that are registered with the Chef server, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node list .ft P .fi +.UNINDENT +.UNINDENT .sp to return something similar to: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -328,19 +390,25 @@ i\-12345678 rs\-123456 .ft P .fi +.UNINDENT +.UNINDENT .SH RUN_LIST ADD .sp -The \fBrun_list add\fP argument is used to add run list items (roles or recipes) to a node. +The \fBrun_list add\fP argument is used to add run\-list items (roles or recipes) to a node. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node run_list add NODE_NAME RUN_LIST_ITEM (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -354,57 +422,81 @@ Use this to add the run list item after the specified run list item. \fBExamples\fP .sp To add a role to a run list, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node run_list add node \(aqrole[ROLE_NAME]\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp To add roles and recipes to a run list, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node run_list add node \(aqrecipe[COOKBOOK::RECIPE_NAME],recipe[COOKBOOK::RECIPE_NAME],role[ROLE_NAME]\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp To add a recipe to a run list using the fully qualified format, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node run_list add node \(aqrecipe[COOKBOOK::RECIPE_NAME]\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp To add a recipe to a run list using the cookbook format, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node run_list add node \(aqCOOKBOOK::RECIPE_NAME\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp To add the default recipe of a cookbook to a run list, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node run_list add node \(aqCOOKBOOK\(aq .ft P .fi +.UNINDENT +.UNINDENT .SH RUN_LIST REMOVE .sp -The \fBrun_list remove\fP argument is used to remove run list items (roles or recipes) from a node. A recipe must be in one of the following formats: fully qualified, cookbook, or default. Both roles and recipes must be in quotes, for example: \fB\(aqrole[ROLE_NAME]\(aq\fP or \fB\(aqrecipe[COOKBOOK::RECIPE_NAME]\(aq\fP. Use a comma to separate roles and recipes when removing more than one, like this: \fB\(aqrecipe[COOKBOOK::RECIPE_NAME],COOKBOOK::RECIPE_NAME,role[ROLE_NAME]\(aq\fP. +The \fBrun_list remove\fP argument is used to remove run\-list items (roles or recipes) from a node. A recipe must be in one of the following formats: fully qualified, cookbook, or default. Both roles and recipes must be in quotes, for example: \fB\(aqrole[ROLE_NAME]\(aq\fP or \fB\(aqrecipe[COOKBOOK::RECIPE_NAME]\(aq\fP\&. Use a comma to separate roles and recipes when removing more than one, like this: \fB\(aqrecipe[COOKBOOK::RECIPE_NAME],COOKBOOK::RECIPE_NAME,role[ROLE_NAME]\(aq\fP\&. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node run_list remove NODE_NAME RUN_LIST_ITEM .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -413,20 +505,28 @@ This command does not have any specific options. \fBExamples\fP .sp To remove a role from a run list, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node run_list remove node \(aqrole[ROLE_NAME]\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp To remove a recipe from a run list using the fully qualified format, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node run_list remove node \(aqrecipe[COOKBOOK::RECIPE_NAME]\(aq .ft P .fi +.UNINDENT +.UNINDENT .SH SHOW .sp The \fBshow\fP argument is used to display information about a node. @@ -434,12 +534,16 @@ The \fBshow\fP argument is used to display information about a node. \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node show NODE_NAME (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -462,14 +566,20 @@ Indicates that only the run\-list will be shown. \fBExamples\fP .sp To view all data for a node named "build", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node show build .ft P .fi +.UNINDENT +.UNINDENT .sp to return: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -483,82 +593,120 @@ Recipes: Platform: .ft P .fi +.UNINDENT +.UNINDENT .sp To show basic information about a node, truncated and nicely formatted: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C knife node show <node_name> .ft P .fi +.UNINDENT +.UNINDENT .sp To show all information about a node, nicely formatted: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C knife node show \-l <node_name> .ft P .fi +.UNINDENT +.UNINDENT .sp To list a single node attribute: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C knife node show <node_name> \-a <attribute_name> .ft P .fi +.UNINDENT +.UNINDENT .sp where \fB<attribute_name>\fP is something like kernel or platform. (This doesn\(aqt work for nested attributes like \fBnode[kernel][machine]\fP because \fBknife node show\fP doesn\(aqt understand nested attributes.) .sp To view the FQDN for a node named "i\-12345678", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node show i\-12345678 \-a fqdn .ft P .fi +.UNINDENT +.UNINDENT .sp to return: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C fqdn: ip\-10\-251\-75\-20.ec2.internal .ft P .fi +.UNINDENT +.UNINDENT .sp To view the run list for a node named "dev", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife node show dev \-r .ft P .fi +.UNINDENT +.UNINDENT .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 node information in raw JSON, use the \fB\-l\fP or \fB\-\-long\fP option: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C knife node show \-l \-F json <node_name> .ft P .fi +.UNINDENT +.UNINDENT .sp and/or: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C knife node show \-l \-\-format=json <node_name> .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-raw.1 b/distro/common/man/man1/knife-raw.1 index 4965ea315b..533b0e1bde 100644 --- a/distro/common/man/man1/knife-raw.1 +++ b/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. diff --git a/distro/common/man/man1/knife-recipe-list.1 b/distro/common/man/man1/knife-recipe-list.1 index 06f8936f70..806fb40a86 100644 --- a/distro/common/man/man1/knife-recipe-list.1 +++ b/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. diff --git a/distro/common/man/man1/knife-role.1 b/distro/common/man/man1/knife-role.1 index 347eac4c82..597d57a94e 100644 --- a/distro/common/man/man1/knife-role.1 +++ b/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. diff --git a/distro/common/man/man1/knife-search.1 b/distro/common/man/man1/knife-search.1 index 6cd09b57f4..f2e3449906 100644 --- a/distro/common/man/man1/knife-search.1 +++ b/distro/common/man/man1/knife-search.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-SEARCH" "1" "Chef 11.10.0" "" "knife search" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-SEARCH" "1" "Chef 11.12.0" "" "knife search" .SH NAME knife-search \- The man page for the knife search subcommand. . @@ -28,34 +30,42 @@ 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 -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. +Search indexes allow queries to be made for any type of data that is indexed by the Chef 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, 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 Chef server\&. .sp -The \fBknife search\fP subcommand is used run a search query for information that is indexed on a server. +The \fBknife search\fP subcommand is used run a search query for information that is indexed on a Chef server\&. .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 search INDEX SEARCH_QUERY .ft P .fi +.UNINDENT +.UNINDENT .sp where \fBINDEX\fP is one of \fBclient\fP, \fBenvironment\fP, \fBnode\fP, \fBrole\fP, or the name of a data bag and \fBSEARCH_QUERY\fP is the search query syntax for the query that will be executed. .sp -\fBINDEX\fP is implied if omitted, and will default to \fBnode\fP. For example: +\fBINDEX\fP is implied if omitted, and will default to \fBnode\fP\&. For example: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife search \(aq*:*\(aq \-i .ft P .fi +.UNINDENT +.UNINDENT .sp will return something similar to: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -71,30 +81,44 @@ ohai\-test win2k8\-dev .ft P .fi +.UNINDENT +.UNINDENT .sp and is the same search as: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife search node \(aq*:*" \-i .ft P .fi +.UNINDENT +.UNINDENT .sp If the \fBSEARCH_QUERY\fP does not contain a colon character (\fB:\fP), then the default query pattern is \fBtags:*#{@query}* OR roles:*#{@query}* OR fqdn:*#{@query}* OR addresses:*#{@query}*\fP, which means the following two search queries are effectively the same: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife search ubuntu .ft P .fi +.UNINDENT +.UNINDENT .sp or: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife search node "tags:*ubuntu* OR roles:*ubuntu* OR fqdn:*ubuntu* (etc.)" .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -129,7 +153,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. @@ -138,10 +162,10 @@ Shows help for the command. Indicates that only matching object IDs will be shown. .TP .B \fBINDEX\fP -The name of the index to be queried: \fBclient\fP, \fBenvironment\fP, \fBnode\fP, \fBrole\fP, or \fBDATA_BAG_NAME\fP. Default index: \fBnode\fP. +The name of the index to be queried: \fBclient\fP, \fBenvironment\fP, \fBnode\fP, \fBrole\fP, or \fBDATA_BAG_NAME\fP\&. Default index: \fBnode\fP\&. .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\-l\fP, \fB\-\-long\fP Display long output when searching nodes while using the default summary format. @@ -165,16 +189,16 @@ Indicates that only the run\-list will be shown. The number of rows to be returned. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the server. +The URL for the Chef server\&. .TP .B \fBSEARCH_QUERY\fP -The search query used to identify a a list of items on a server. This option uses the same syntax as the \fBsearch\fP sub\-command. +The search query used to identify a a list of items on a Chef server\&. This option uses the same syntax as the \fBsearch\fP sub\-command. .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. @@ -183,20 +207,26 @@ 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 search for the IDs of all nodes running on the Amazon EC2 platform, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife search node \(aqec2:*\(aq \-i .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -211,16 +241,24 @@ ip\-0A58E134.ec2.internal ip\-0A7CFFD5.ec2.internal .ft P .fi +.UNINDENT +.UNINDENT .sp To search for the instance type (flavor) of all nodes running on the Amazon EC2 platform, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife search node \(aqec2:*\(aq \-a ec2.instance_type .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -239,56 +277,82 @@ ec2.instance_type: m1.large id: ip\-0A7CFFD5.ec2.internal .ft P .fi +.UNINDENT +.UNINDENT .sp To search for all nodes running Ubuntu, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife search node \(aqplatform:ubuntu\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp To search for all nodes running CentOS in the production environment, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife search node \(aqchef_environment:production AND platform:centos\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp To find a nested attribute, use a pattern similar to the following: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife search node <query_to_run> \-a <main_attribute>.<nested_attribute> .ft P .fi +.UNINDENT +.UNINDENT .sp 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: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife search node "languages_ruby_version:1.9.3" .ft P .fi +.UNINDENT +.UNINDENT .sp To build a search query that can find a nested attribute: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife search node name:<node_name> \-a kernel.machine .ft P .fi +.UNINDENT +.UNINDENT .sp To test a search query that will be used in a \fBknife ssh\fP command: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife search node "role:web NOT name:web03" .ft P .fi +.UNINDENT +.UNINDENT .sp -where the query in the previous example will search all servers that have the \fBweb\fP role, but not on the server named \fBweb03\fP. +where the query in the previous example will search all servers that have the \fBweb\fP role, but not on the server named \fBweb03\fP\&. .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-show.1 b/distro/common/man/man1/knife-show.1 index 6ec1d14f0d..5e77cf2f39 100644 --- a/distro/common/man/man1/knife-show.1 +++ b/distro/common/man/man1/knife-show.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-SHOW" "1" "Chef 11.10.0" "" "knife show" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-SHOW" "1" "Chef 11.12.0" "" "knife show" .SH NAME knife-show \- The man page for the knife show 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 show\fP subcommand is used to view the details of one (or more) objects on the server. This subcommand works similar to \fBknife cookbook show\fP, \fBknife data bag show\fP, \fBknife environment show\fP, \fBknife node show\fP, and \fBknife role show\fP, but with a single verb (and a single action). +The \fBknife show\fP subcommand is used to view the details of one (or more) objects on the Chef server\&. This subcommand works similar to \fBknife cookbook show\fP, \fBknife data bag show\fP, \fBknife environment show\fP, \fBknife node show\fP, and \fBknife role show\fP, but with a single verb (and a single action). .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 show [PATTERN...] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -55,7 +59,7 @@ The attribute (or attributes) to show. The configuration file to use. .TP .B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb. +The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. .TP .B \fB\-\-chef\-zero\-port PORT\fP The port on which chef\-zero will listen. @@ -64,7 +68,7 @@ The port on which chef\-zero will listen. Indicates whether colored output will be used. .TP .B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP. +The number of allowed concurrent connections. Default: \fB10\fP\&. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -79,13 +83,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\-\-local\fP Indicates that instead of remote files, local files will be shown. @@ -94,16 +98,16 @@ Indicates that instead of remote files, local files will be shown. Indicates that data will be shown after a destructive operation. .TP .B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP. +The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. .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. @@ -112,32 +116,44 @@ 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 show all cookbooks in the \fBcookbooks/\fP directory: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife show cookbooks/ .ft P .fi +.UNINDENT +.UNINDENT .sp or, (if already in the \fBcookbooks/\fP directory in the local chef\-repo): +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife show .ft P .fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife show roles/ environments/ .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-ssh.1 b/distro/common/man/man1/knife-ssh.1 index e50e7ebdb8..6f42870aef 100644 --- a/distro/common/man/man1/knife-ssh.1 +++ b/distro/common/man/man1/knife-ssh.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-SSH" "1" "Chef 11.10.0" "" "knife ssh" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-SSH" "1" "Chef 11.12.0" "" "knife ssh" .SH NAME knife-ssh \- The man page for the knife ssh 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 ssh\fP subcommand is used to invoke SSH commands (in parallel) on a subset of nodes within an organization, based on the results of a search query. .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 ssh SEARCH_QUERY SSH_COMMAND (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -79,7 +83,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\-G GATEWAY\fP, \fB\-\-ssh\-gateway GATEWAY\fP The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation. @@ -91,16 +95,16 @@ Shows help for the command. The SSH identity file used for authentication. Key\-based authentication is recommended. .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\fP, \fB\-\-manual\-list\fP Indicates that a search query is a space\-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: \fB\-\-manual\-list "server01 server 02 server 03"\fP .TP .B \fB\-\-[no\-]host\-key\-verify\fP -Use \fB\-\-no\-host\-key\-verify\fP to disable host key verification. Default setting: \fB\-\-host\-key\-verify\fP. +Use \fB\-\-no\-host\-key\-verify\fP to disable host key verification. Default setting: \fB\-\-host\-key\-verify\fP\&. .TP .B \fBOTHER\fP -The shell type. Possible values: \fBinteractive\fP, \fBscreen\fP, \fBtmux\fP, \fBmacterm\fP, or \fBcssh\fP. (\fBcsshx\fP is deprecated in favor of \fBcssh\fP.) +The shell type. Possible values: \fBinteractive\fP, \fBscreen\fP, \fBtmux\fP, \fBmacterm\fP, or \fBcssh\fP\&. (\fBcsshx\fP is deprecated in favor of \fBcssh\fP\&.) .TP .B \fB\-p PORT\fP, \fB\-\-ssh\-port PORT\fP The SSH port. @@ -112,19 +116,19 @@ The SSH password. This can be used to pass the password directly on the command 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 \fBSEARCH_QUERY\fP -The search query used to return a list of servers to be accessed using SSH and the specified \fBSSH_COMMAND\fP. This option uses the same syntax as the search sub\-command. +The search query used to return a list of servers to be accessed using SSH and the specified \fBSSH_COMMAND\fP\&. This option uses the same syntax as the search sub\-command. .TP .B \fBSSH_COMMAND\fP The command that will be run against the results of a search query. .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. @@ -136,20 +140,26 @@ The SSH user name. 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 find the uptime of all of web servers running Ubuntu on the Amazon EC2 platform, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife ssh "role:web" "uptime" \-x ubuntu \-a ec2.public_hostname .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -160,22 +170,34 @@ ec2\-75\-101\-240\-230.compute\-1.amazonaws.com 13:50:48 up 1 day, 22:59, 1 u ec2\-184\-73\-60\-141.compute\-1.amazonaws.com 13:50:48 up 1 day, 23:30, 1 user, load average: 0.32, 0.17, 0.15 .ft P .fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife ssh \(aqname:*\(aq \(aqsudo chef\-client\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp To force a chef\-client run on all of the web servers running Ubuntu on the Amazon EC2 platform, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife ssh "role:web" "sudo chef\-client" \-x ubuntu \-a ec2.public_hostname .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -206,30 +228,46 @@ ec2\-184\-73\-60\-141.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +000 ec2\-184\-73\-60\-141.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Report handlers complete .ft P .fi +.UNINDENT +.UNINDENT .sp To query for all nodes that have the "webserver" role and then use SSH to run the command "sudo chef\-client", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife ssh "role:webserver" "sudo chef\-client" .ft P .fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife ssh name:* "sudo aptitude upgrade \-y" .ft P .fi +.UNINDENT +.UNINDENT .sp To specify the shell type used on the nodes returned by a search query: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife ssh roles:opscode\-omnitruck macterm .ft P .fi +.UNINDENT +.UNINDENT .sp -where \fBscreen\fP is one of the following values: \fBcssh\fP, \fBinteractive\fP, \fBmacterm\fP, \fBscreen\fP, or \fBtmux\fP. If the node does not have the shell type installed, Knife will return an error similar to the following: +where \fBscreen\fP is one of the following values: \fBcssh\fP, \fBinteractive\fP, \fBmacterm\fP, \fBscreen\fP, or \fBtmux\fP\&. If the node does not have the shell type installed, Knife will return an error similar to the following: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -238,6 +276,8 @@ you need the rb\-appscript gem to use knife ssh macterm. ERROR: LoadError: cannot load such file \-\- appscript .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-ssl-check.1 b/distro/common/man/man1/knife-ssl-check.1 new file mode 100644 index 0000000000..3fa9b3c437 --- /dev/null +++ b/distro/common/man/man1/knife-ssl-check.1 @@ -0,0 +1,207 @@ +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-SSL-CHECK" "1" "Chef 11.12.0" "" "knife ssl check" +.SH NAME +knife-ssl-check \- The man page for the knife ssl check subcommand. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +The \fBknife ssl check\fP subcommand is used to verify the SSL configuration for the Enterprise Chef and/or Open Source Chef servers, or at another location specified by a URL or URI. +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 +When verification of a remote server\(aqs SSL certificate is disabled, the chef\-client will issue a warning similar to "SSL validation of HTTPS requests is disabled. HTTPS connections are still encrypted, but the chef\-client is not able to detect forged replies or man\-in\-the\-middle attacks." To configure SSL for the chef\-client, set \fBssl_verify_mode\fP to \fB:verify_peer\fP (recommended) \fBor\fP \fBverify_api_cert\fP to \fBtrue\fP in the client.rb file. +.UNINDENT +.UNINDENT +.sp +\fBSyntax\fP +.sp +This subcommand has the following syntax: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ knife ssl check URI +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBOptions\fP +.sp +This subcommand has the following options: +.INDENT 0.0 +.TP +.B \fB\-a SSH_ATTR\fP, \fB\-\-attribute SSH_ATTR\fP +The attribute that is used when opening the SSH connection. The default attribute is the FQDN of the host. Other possible values include a public IP address, a private IP address, or a hostname. +.TP +.B \fB\-A\fP, \fB\-\-forward\-agent\fP +Indicates that SSH agent forwarding is enabled. +.TP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP +The configuration file to use. +.TP +.B \fB\-C NUM\fP, \fB\-\-concurrency NUM\fP +The number of allowed concurrent connections. +.TP +.B \fB\-\-chef\-zero\-port PORT\fP +The port on which chef\-zero will listen. +.TP +.B \fB\-\-[no\-]color\fP +Indicates whether colored output will be used. +.TP +.B \fB\-d\fP, \fB\-\-disable\-editing\fP +Indicates that $EDITOR will not be opened; data will be accepted as\-is. +.TP +.B \fB\-\-defaults\fP +Indicates that Knife will use the default value, instead of asking a user to provide one. +.TP +.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP +The $EDITOR that is used for all interactive commands. +.TP +.B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP +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\&. +.TP +.B \fB\-G GATEWAY\fP, \fB\-\-ssh\-gateway GATEWAY\fP +The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation. +.TP +.B \fB\-h\fP, \fB\-\-help\fP +Shows help for the command. +.TP +.B \fB\-i IDENTITY_FILE\fP, \fB\-\-identity\-file IDENTIFY_FILE\fP +The SSH identity file used for authentication. Key\-based authentication is recommended. +.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 Chef server\&. +.TP +.B \fB\-m\fP, \fB\-\-manual\-list\fP +Indicates that a search query is a space\-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: \fB\-\-manual\-list "server01 server 02 server 03"\fP +.TP +.B \fB\-\-[no\-]host\-key\-verify\fP +Use \fB\-\-no\-host\-key\-verify\fP to disable host key verification. Default setting: \fB\-\-host\-key\-verify\fP\&. +.TP +.B \fBOTHER\fP +The shell type. Possible values: \fBinteractive\fP, \fBscreen\fP, \fBtmux\fP, \fBmacterm\fP, or \fBcssh\fP\&. (\fBcsshx\fP is deprecated in favor of \fBcssh\fP\&.) +.TP +.B \fB\-p PORT\fP, \fB\-\-ssh\-port PORT\fP +The SSH port. +.TP +.B \fB\-P PASSWORD\fP, \fB\-\-ssh\-password PASSWORD\fP +The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) Knife will prompt for the password. +.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 Chef server\&. +.TP +.B \fBSEARCH_QUERY\fP +The search query used to return a list of servers to be accessed using SSH and the specified \fBSSH_COMMAND\fP\&. This option uses the same syntax as the search sub\-command. +.TP +.B \fBSSH_COMMAND\fP +The command that will be run against the results of a search query. +.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 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\&. +.TP +.B \fB\-V\fP, \fB\-\-verbose\fP +Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. +.TP +.B \fB\-x USER_NAME\fP, \fB\-\-ssh\-user USER_NAME\fP +The SSH user name. +.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 Chef server to also work against the local chef\-repo\&. +.UNINDENT +.sp +\fBExamples\fP +.sp +The following examples show how to use this Knife subcommand: +.sp +\fBVerify the SSL configuration for the Chef server\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ knife ssl check +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBVerify the SSL configuration for the chef\-client\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ knife ssl check \-c /etc/chef/client.rb +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBVerify an external server\(aqs SSL certificate\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ knife ssl check URL_or_URI +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +for example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ knife ssl check https://www.getchef.com +.ft P +.fi +.UNINDENT +.UNINDENT +.SH AUTHOR +Chef +.\" Generated by docutils manpage writer. +. diff --git a/distro/common/man/man1/knife-ssl-fetch.1 b/distro/common/man/man1/knife-ssl-fetch.1 new file mode 100644 index 0000000000..59db68881a --- /dev/null +++ b/distro/common/man/man1/knife-ssl-fetch.1 @@ -0,0 +1,207 @@ +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-SSL-FETCH" "1" "Chef 11.12.0" "" "knife ssl fetch" +.SH NAME +knife-ssl-fetch \- The man page for the knife ssl fetch subcommand. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +The \fBknife ssl fetch\fP subcommand is used to copy SSL certificates from an HTTPS server to the \fBtrusted_certs_dir\fP directory that is used by Knife and the chef\-client to store trusted SSL certificates. When these certificates match the hostname of the remote server, running \fBknife ssl fetch\fP is the only step required to verify a remote server that is accessed by either Knife or the chef\-client\&. +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 +It is the user\(aqs responsibility to verify the authenticity of every SSL certificate before downloading it to the \fBtrusted_certs_dir\fP directory. Knife will use any certificate in that directory as if it is a 100% trusted and authentic SSL certificate. Knife will not be able to determine if any certificate in this directory has been tampered with, is forged, malicious, or otherwise harmful. Therefore it is essential that users take the proper steps before downloading certificates into this directory. +.UNINDENT +.UNINDENT +.sp +\fBSyntax\fP +.sp +This subcommand has the following syntax: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ knife ssh SEARCH_QUERY SSH_COMMAND (options) +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBOptions\fP +.sp +This subcommand has the following options: +.INDENT 0.0 +.TP +.B \fB\-a SSH_ATTR\fP, \fB\-\-attribute SSH_ATTR\fP +The attribute that is used when opening the SSH connection. The default attribute is the FQDN of the host. Other possible values include a public IP address, a private IP address, or a hostname. +.TP +.B \fB\-A\fP, \fB\-\-forward\-agent\fP +Indicates that SSH agent forwarding is enabled. +.TP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP +The configuration file to use. +.TP +.B \fB\-C NUM\fP, \fB\-\-concurrency NUM\fP +The number of allowed concurrent connections. +.TP +.B \fB\-\-chef\-zero\-port PORT\fP +The port on which chef\-zero will listen. +.TP +.B \fB\-\-[no\-]color\fP +Indicates whether colored output will be used. +.TP +.B \fB\-d\fP, \fB\-\-disable\-editing\fP +Indicates that $EDITOR will not be opened; data will be accepted as\-is. +.TP +.B \fB\-\-defaults\fP +Indicates that Knife will use the default value, instead of asking a user to provide one. +.TP +.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP +The $EDITOR that is used for all interactive commands. +.TP +.B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP +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\&. +.TP +.B \fB\-G GATEWAY\fP, \fB\-\-ssh\-gateway GATEWAY\fP +The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation. +.TP +.B \fB\-h\fP, \fB\-\-help\fP +Shows help for the command. +.TP +.B \fB\-i IDENTITY_FILE\fP, \fB\-\-identity\-file IDENTIFY_FILE\fP +The SSH identity file used for authentication. Key\-based authentication is recommended. +.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 Chef server\&. +.TP +.B \fB\-m\fP, \fB\-\-manual\-list\fP +Indicates that a search query is a space\-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: \fB\-\-manual\-list "server01 server 02 server 03"\fP +.TP +.B \fB\-\-[no\-]host\-key\-verify\fP +Use \fB\-\-no\-host\-key\-verify\fP to disable host key verification. Default setting: \fB\-\-host\-key\-verify\fP\&. +.TP +.B \fBOTHER\fP +The shell type. Possible values: \fBinteractive\fP, \fBscreen\fP, \fBtmux\fP, \fBmacterm\fP, or \fBcssh\fP\&. (\fBcsshx\fP is deprecated in favor of \fBcssh\fP\&.) +.TP +.B \fB\-p PORT\fP, \fB\-\-ssh\-port PORT\fP +The SSH port. +.TP +.B \fB\-P PASSWORD\fP, \fB\-\-ssh\-password PASSWORD\fP +The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) Knife will prompt for the password. +.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 Chef server\&. +.TP +.B \fBSEARCH_QUERY\fP +The search query used to return a list of servers to be accessed using SSH and the specified \fBSSH_COMMAND\fP\&. This option uses the same syntax as the search sub\-command. +.TP +.B \fBSSH_COMMAND\fP +The command that will be run against the results of a search query. +.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 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\&. +.TP +.B \fB\-V\fP, \fB\-\-verbose\fP +Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. +.TP +.B \fB\-x USER_NAME\fP, \fB\-\-ssh\-user USER_NAME\fP +The SSH user name. +.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 Chef server to also work against the local chef\-repo\&. +.UNINDENT +.sp +\fBExamples\fP +.sp +The following examples show how to use this Knife subcommand: +.sp +\fBFetch the SSL certificates used by Knife from the Chef server\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ knife ssl fetch +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBFetch the SSL certificates used by the chef\-client from the Chef server\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ knife ssl fetch \-c /etc/chef/client.rb +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBFetch SSL certificates from a URL or URI\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ knife ssl fetch URL_or_URI +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +for example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ knife ssl fetch https://www.getchef.com +.ft P +.fi +.UNINDENT +.UNINDENT +.SH AUTHOR +Chef +.\" Generated by docutils manpage writer. +. diff --git a/distro/common/man/man1/knife-status.1 b/distro/common/man/man1/knife-status.1 index 544129e2f8..dd6b1187f7 100644 --- a/distro/common/man/man1/knife-status.1 +++ b/distro/common/man/man1/knife-status.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-STATUS" "1" "Chef 11.10.0" "" "knife status" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-STATUS" "1" "Chef 11.12.0" "" "knife status" .SH NAME knife-status \- The man page for the knife status 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 status\fP subcommand is used to display a brief summary of the nodes on a server, including the time of the most recent successful chef\-client run. +The \fBknife status\fP subcommand is used to display a brief summary of the nodes on a Chef server, including the time of the most recent successful chef\-client run. .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 status (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,13 +83,13 @@ Shows help for the command. Indicates that nodes on which a chef\-client run has occurred within the previous hour will be hidden. .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\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .TP .B \fBSEARCH_QUERY\fP -The search query used to identify a a list of items on a server. This option uses the same syntax as the \fBsearch\fP sub\-command. +The search query used to identify a a list of items on a Chef server\&. This option uses the same syntax as the \fBsearch\fP sub\-command. .TP .B \fB\-r RUN_LIST\fP, \fB\-\-run\-list RUN_LIST\fP A comma\-separated list of roles and/or recipes to be applied. @@ -94,13 +98,13 @@ A comma\-separated list of roles and/or recipes to be applied. Indicates that the list will be sorted by last run time, descending. .TP .B \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. @@ -109,20 +113,26 @@ 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 include run lists in the status, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife status \-\-run\-list .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -134,16 +144,24 @@ to return something like: 3 hours ago, i\-f65c969b, ubuntu 10.04, ec2\-184\-73\-60\-141.compute\-1.amazonaws.com, 184.73.60.141, role[web]. .ft P .fi +.UNINDENT +.UNINDENT .sp To show the status for nodes on which the chef\-client did not run successfully within the past hour, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife status \-\-hide\-healthy .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -151,16 +169,24 @@ to return something like: 1 hour ago, i\-a47823c9, ubuntu 10.04, ec2\-174\-129\-127\-206.compute\-1.amazonaws.com, 184.129.143.111, role[lb]. .ft P .fi +.UNINDENT +.UNINDENT .sp To show the status of a subset of nodes that are returned by a specific query, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife status "role:web" \-\-run\-list .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -171,16 +197,24 @@ to return something like: 3 hours ago, i\-f65c969b, ubuntu 10.04, ec2\-184\-73\-60\-141.compute\-1.amazonaws.com, 184.73.60.141, role[web]. .ft P .fi +.UNINDENT +.UNINDENT .sp To view the status of all nodes in the organization, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife status .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -192,6 +226,8 @@ to return something like: 3 hours ago, i\-f65c969b, ubuntu 10.04, ec2\-184\-73\-60\-141.compute\-1.amazonaws.com, 184.73.60.141 .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-tag.1 b/distro/common/man/man1/knife-tag.1 index b9e9343b73..6502f81a57 100644 --- a/distro/common/man/man1/knife-tag.1 +++ b/distro/common/man/man1/knife-tag.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-TAG" "1" "Chef 11.10.0" "" "knife tag" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-TAG" "1" "Chef 11.12.0" "" "knife tag" .SH NAME knife-tag \- The man page for the knife tag 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 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. +The \fBknife tag\fP subcommand is used to apply tags to nodes on a Chef server\&. .SH COMMON OPTIONS .sp The following options may be used with any of the arguments available to the \fBknife tag\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 CREATE .sp @@ -97,12 +97,16 @@ The \fBcreate\fP argument is used to add one or more tags to a node. \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife tag create NODE_NAME [TAG...] .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -111,12 +115,16 @@ This command does not have any specific options. \fBExamples\fP .sp To create tags named "seattle", "portland", and "vancouver", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife tag create node seattle portland vancouver .ft P .fi +.UNINDENT +.UNINDENT .SH DELETE .sp The \fBdelete\fP argument is used to delete one or more tags from a node. @@ -124,12 +132,16 @@ The \fBdelete\fP argument is used to delete one or more tags from a node. \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife tag delete NODE_NAME [TAG...] .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -138,12 +150,16 @@ This command does not have any specific options. \fBExamples\fP .sp To delete tags named "denver" and "phoenix", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife tag delete node denver phoenix .ft P .fi +.UNINDENT +.UNINDENT .sp Type \fBY\fP to confirm a deletion. .SH LIST @@ -153,12 +169,16 @@ The \fBlist\fP argument is used to list all of the tags that have been applied t \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife tag list [NODE_NAME...] .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp diff --git a/distro/common/man/man1/knife-upload.1 b/distro/common/man/man1/knife-upload.1 index e51c9ebcbe..dcbca4f02e 100644 --- a/distro/common/man/man1/knife-upload.1 +++ b/distro/common/man/man1/knife-upload.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-UPLOAD" "1" "Chef 11.10.0" "" "knife upload" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-UPLOAD" "1" "Chef 11.12.0" "" "knife upload" .SH NAME knife-upload \- The man page for the knife upload 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 upload\fP subcommand is used to upload roles, cookbooks, environments, and data bags to the server from the current working directory in the chef\-repo. This subcommand is often used in conjunction with \fBknife diff\fP, which can be used to see exactly what changes will be uploaded, and then \fBknife download\fP, which does the opposite of \fBknife upload\fP. +The \fBknife upload\fP subcommand is used to upload roles, cookbooks, environments, and data bags to the Chef server from the current working directory in the chef\-repo\&. This subcommand is often used in conjunction with \fBknife diff\fP, which can be used to see exactly what changes will be uploaded, and then \fBknife download\fP, which does the opposite of \fBknife upload\fP\&. .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 upload [PATTERN...] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -52,7 +56,7 @@ This subcommand has the following options: The configuration file to use. .TP .B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb. +The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. .TP .B \fB\-\-chef\-zero\-port PORT\fP The port on which chef\-zero will listen. @@ -61,7 +65,7 @@ The port on which chef\-zero will listen. Indicates whether colored output will be used. .TP .B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP. +The number of allowed concurrent connections. Default: \fB10\fP\&. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -70,7 +74,7 @@ Indicates that $EDITOR will not be opened; data will be accepted as\-is. Indicates that Knife will use the default value, instead of asking a user to provide one. .TP .B \fB\-\-[no\-]diff\fP -Indicates that only new and modified files will be uploaded. Set to \fBfalse\fP to upload all files. Default: \fBtrue\fP. +Indicates that only new and modified files will be uploaded. Set to \fBfalse\fP to upload all files. Default: \fBtrue\fP\&. .TP .B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP The $EDITOR that is used for all interactive commands. @@ -79,43 +83,43 @@ 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\-\-[no\-]force\fP -Use \fB\-\-force\fP to upload roles, cookbooks, etc. even if the file in the directory is identical (by default, no \fBPOST\fP or \fBPUT\fP is performed unless an actual change would be made). Default: \fB\-\-no\-force\fP. +Use \fB\-\-force\fP to upload roles, cookbooks, etc. even if the file in the directory is identical (by default, no \fBPOST\fP or \fBPUT\fP is performed unless an actual change would be made). Default: \fB\-\-no\-force\fP\&. .TP .B \fB\-\-[no\-]freeze\fP -Indicates that a cookbook cannot be modified; any changes to this cookbook must be included as a new version. Only the \fB\-\-force\fP option can override this setting. Default: \fBfalse\fP. +Indicates that a cookbook cannot be modified; any changes to this cookbook must be included as a new version. Only the \fB\-\-force\fP option can override this setting. Default: \fBfalse\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\-n\fP, \fB\-\-dry\-run\fP -Indicates that no action is taken and that results are only printed out. Default: \fBfalse\fP. +Indicates that no action is taken and that results are only printed out. Default: \fBfalse\fP\&. .TP .B \fB\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .TP .B \fB\-\-[no\-]purge\fP -Use \fB\-\-purge\fP to delete roles, cookbooks, etc. from the server if their corresponding files do not exist in the chef\-repo. By default, such objects are left alone and NOT purged. Default: \fB\-\-no\-purge\fP. +Use \fB\-\-purge\fP to delete roles, cookbooks, etc. from the Chef server if their corresponding files do not exist in the chef\-repo\&. By default, such objects are left alone and NOT purged. Default: \fB\-\-no\-purge\fP\&. .TP .B \fB\-\-[no\-]recurse\fP -Use \fB\-\-no\-recurse\fP to disable uploading a directory recursively. Default: \fB\-\-recurse\fP. +Use \fB\-\-no\-recurse\fP to disable uploading a directory recursively. Default: \fB\-\-recurse\fP\&. .TP .B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP. +The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. .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. @@ -124,104 +128,152 @@ 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 Browse to the top level of the chef\-repo and enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife upload .ft P .fi +.UNINDENT +.UNINDENT .sp or from anywhere in the chef\-repo, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife upload / .ft P .fi +.UNINDENT +.UNINDENT .sp Browse to the top level of the chef\-repo and enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife upload cookbooks .ft P .fi +.UNINDENT +.UNINDENT .sp or from anywhere in the chef\-repo, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife upload /cookbooks .ft P .fi +.UNINDENT +.UNINDENT .sp Browse to the top level of the chef\-repo and enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife upload environments .ft P .fi +.UNINDENT +.UNINDENT .sp or from anywhere in the chef\-repo, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife upload /environments .ft P .fi +.UNINDENT +.UNINDENT .sp Browse to the top level of the chef\-repo and enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife upload environments/production.json .ft P .fi +.UNINDENT +.UNINDENT .sp or from the \fBenvironments/\fP directory, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife upload production.json .ft P .fi +.UNINDENT +.UNINDENT .sp Browse to the top level of the chef\-repo and enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife upload roles .ft P .fi +.UNINDENT +.UNINDENT .sp or from anywhere in the chef\-repo, enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife upload /roles .ft P .fi +.UNINDENT +.UNINDENT .sp Browse to the top level of the chef\-repo and enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife upload cookbooks/apache\e* roles/webserver.json .ft P .fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife upload \(gaknife deps nodes/*.json\(ga .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man1/knife-user.1 b/distro/common/man/man1/knife-user.1 index 978a0e7d43..fb2508caa6 100644 --- a/distro/common/man/man1/knife-user.1 +++ b/distro/common/man/man1/knife-user.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-USER" "1" "Chef 11.10.0" "" "knife user" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-USER" "1" "Chef 11.12.0" "" "knife user" .SH NAME knife-user \- The man page for the knife user subcommand. . @@ -28,13 +30,15 @@ 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 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 version 10.x. This subcommand will NOT run against open source server 11, Enterprise Chef (including hosted Enterprise Chef), or Private Chef. -.RE +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +This subcommand ONLY works when run against the open source Chef server version 10.x. This subcommand will NOT run against open source Chef server 11, Enterprise Chef (including hosted Enterprise Chef), or Private Chef\&. +.UNINDENT +.UNINDENT .SH COMMON OPTIONS .sp The following options may be used with any of the arguments available to the \fBknife user\fP subcommand: @@ -59,13 +63,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. @@ -74,29 +78,29 @@ 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 CREATE .sp -The \fBcreate\fP argument is used to create a user. This process will generate an RSA key pair for the named user. The public key will be stored on the server and the private key will be displayed on \fBSTDOUT\fP or written to a named file. +The \fBcreate\fP argument is used to create a user. This process will generate an RSA key pair for the named user. The public key will be stored on the Chef server and the private key will be displayed on \fBSTDOUT\fP or written to a named file. .INDENT 0.0 .IP \(bu 2 -For the user, the private key should be copied to the system as \fB/etc/chef/client.pem\fP. +For the user, the private key should be copied to the system as \fB/etc/chef/client.pem\fP\&. .IP \(bu 2 For Knife, the private key is typically copied to \fB~/.chef/client_name.pem\fP and referenced in the knife.rb configuration file. .UNINDENT @@ -104,12 +108,16 @@ For Knife, the private key is typically copied to \fB~/.chef/client_name.pem\fP \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife user create USER_NAME (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -117,10 +125,10 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-a\fP, \fB\-\-admin\fP -Indicates that a client will be created as an admin client. This is required when users of the open source server need to access the Chef Server API as an administrator. This option only works when used with the open source server and will have no effect when used with Enterprise Chef. +Indicates that a client will be created as an admin client. This is required when users of the open source Chef server need to access the Chef Server API as an administrator. This option only works when used with the open source Chef server and will have no effect when used with Enterprise Chef\&. .TP .B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. +Use to save a private key to the specified file name. .TP .B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP The user password. @@ -130,12 +138,16 @@ All users are assigned a public key. Use to write the public key to a file. .UNINDENT .sp \fBExamples\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife user create "Radio Birdman" \-f /keys/user_name .ft P .fi +.UNINDENT +.UNINDENT .SH DELETE .sp The \fBdelete\fP argument is used to delete a registered user. @@ -143,37 +155,49 @@ The \fBdelete\fP argument is used to delete a registered user. \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife user delete USER_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 user delete "Steve Danno" .ft P .fi +.UNINDENT +.UNINDENT .SH EDIT .sp -The \fBedit\fP argument is used to edit the details of a user. When this argument is run, Knife will open $EDITOR. When finished, Knife will update the server with those changes. +The \fBedit\fP argument is used to edit the details of a user. When this argument is run, Knife will open $EDITOR\&. When finished, Knife will update the Chef server with those changes. .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife user edit USER_NAME .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -189,12 +213,16 @@ The \fBlist\fP argument is used to view a list of registered users. \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife user list (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -210,20 +238,28 @@ Indicates that the corresponding URIs will be shown. None. .SH REREGISTER .sp -The \fBreregister\fP argument is used to regenerate an RSA key pair for a user. The public key will be stored on the server and the private key will be displayed on \fBSTDOUT\fP or written to a named file. -.IP Note -Running this argument will invalidate the previous RSA key pair, making it unusable during authentication to the server. -.RE +The \fBreregister\fP argument is used to regenerate an RSA key pair for a user. The public key will be stored on the Chef server and the private key will be displayed on \fBSTDOUT\fP or written to a named file. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +Running this argument will invalidate the previous RSA key pair, making it unusable during authentication to the Chef server\&. +.UNINDENT +.UNINDENT .sp \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife user reregister USER_NAME (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -231,16 +267,20 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. +Use to save a private key to the specified file name. .UNINDENT .sp \fBExamples\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife user reregister "Robert Younger" .ft P .fi +.UNINDENT +.UNINDENT .SH SHOW .sp The \fBshow\fP argument is used to show the details of a user. @@ -248,12 +288,16 @@ The \fBshow\fP argument is used to show the details of a user. \fBSyntax\fP .sp This argument has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife user show USER_NAME (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -267,14 +311,20 @@ The attribute (or attributes) to show. \fBExamples\fP .sp To view a user named "Dennis Teck", enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife user show "Dennis Teck" .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -284,16 +334,22 @@ name: Dennis Teck public_key: .ft P .fi +.UNINDENT +.UNINDENT .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 user show "Dennis Teck" \-F json .ft P .fi +.UNINDENT +.UNINDENT .sp -(Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP, e.g. \fB\-F yaml\fP for YAML.) +(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 b0e8f0b22d..82e3981471 100644 --- a/distro/common/man/man1/knife-xargs.1 +++ b/distro/common/man/man1/knife-xargs.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-XARGS" "1" "Chef 11.10.0" "" "knife xargs" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-XARGS" "1" "Chef 11.12.0" "" "knife xargs" .SH NAME knife-xargs \- The man page for the knife xargs 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 xargs\fP subcommand is used to build and execute command lines against objects on a server using standard input. +The \fBknife xargs\fP subcommand is used to build and execute command lines against objects on a Chef server using standard input. .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 xargs [PATTERN...] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -49,35 +53,59 @@ This subcommand has the following options: .INDENT 0.0 .TP .B \fB\-0\fP -Indicates that a \fBNULL\fP character (\fB\e0\fP) will be used as a separator, instead of white space. Default: \fBfalse\fP. +Indicates that a \fBNULL\fP character (\fB\e0\fP) will be used as a separator, instead of white space. Default: \fBfalse\fP\&. +.TP +.B \fB\-\-chef\-repo\-path PATH\fP +The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. +.TP +.B \fB\-\-concurrency\fP +The number of allowed concurrent connections. Default: \fB10\fP\&. +.TP +.B \fB\-\-[no\-]diff\fP +Use to show a diff when a file changes. Default: \fB\-\-diff\fP\&. +.TP +.B \fB\-\-dry\-run\fP +Use to prevent changes from being uploaded to the Chef server\&. Default: \fBfalse\fP\&. +.TP +.B \fB\-\-[no\-]force\fP +Use to force the upload of files even if they haven\(aqt been changed. Default: \fB\-\-no\-force\fP\&. +.TP +.B \fB\-I REPLACE_STRING\fP, \fB\-\-replace REPLACE_STRING\fP +Use to define a string that will be used to replace all occurrences of a file name. Default: \fBnil\fP\&. +.TP +.B \fB\-J REPLACE_STRING\fP, \fB\-\-replace\-first REPLACE_STRING\fP +Use to define a string that will be used to replace the first occurrence of a file name. Default: \fBnil\fP\&. +.TP +.B \fB\-\-local\fP +Indicates that a command line will be built or executed against a local file. Set to \fBfalse\fP to build or execute against a remote file. Default: \fBfalse\fP\&. +.TP +.B \fB\-n MAX_ARGS\fP, \fB\-\-max\-args MAX_ARGS\fP +The maximum number of arguments per command line. Default: \fBnil\fP\&. +.TP +.B \fB\-p [PATTERN...]\fP, \fB\-\-pattern [PATTERN...]\fP +One (or more) patterns for a command line. If this option is not specified, a list of patterns may be expected on standard input. Default: \fBnil\fP\&. +.TP +.B \fB\-\-repo\-mode MODE\fP +The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default value: \fBdefault\fP\&. +.TP +.B \fB\-s LENGTH\fP, \fB\-\-max\-chars LENGTH\fP +The maximum size (in characters) for a command line. Default: \fBnil\fP\&. +.TP +.B \fB\-t\fP +Indicates that the print command will be run on the command line. Default: \fBnil\fP\&. .TP .B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. .TP -.B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb. -.TP .B \fB\-\-chef\-zero\-port PORT\fP The port on which chef\-zero will listen. .TP -.B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. -.TP -.B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP. -.TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. .TP .B \fB\-\-defaults\fP Indicates that Knife will use the default value, instead of asking a user to provide one. .TP -.B \fB\-\-[no\-]diff\fP -Use to show a diff when a file changes. Default: \fB\-\-diff\fP. -.TP -.B \fB\-\-dry\-run\fP -Use to prevent changes from being uploaded to the server. Default: \fBfalse\fP. -.TP .B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP The $EDITOR that is used for all interactive commands. .TP @@ -85,52 +113,28 @@ 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. -.TP -.B \fB\-\-[no\-]force\fP -Use to force the upload of files even if they haven\(aqt been changed. Default: \fB\-\-no\-force\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\-I REPLACE_STRING\fP, \fB\-\-replace REPLACE_STRING\fP -Use to define a string that will be used to replace all occurrences of a file name. Default: \fBnil\fP. -.TP -.B \fB\-J REPLACE_STRING\fP, \fB\-\-replace\-first REPLACE_STRING\fP -Use to define a string that will be used to replace the first occurrence of a file name. Default: \fBnil\fP. -.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\-\-local\fP -Indicates that a command line will be built or executed against a local file. Set to \fBfalse\fP to build or execute against a remote file. Default: \fBfalse\fP. -.TP -.B \fB\-n MAX_ARGS\fP, \fB\-\-max\-args MAX_ARGS\fP -The maximum number of arguments per command line. Default: \fBnil\fP. -.TP -.B \fB\-p [PATTERN...]\fP, \fB\-\-pattern [PATTERN...]\fP -One (or more) patterns for a command line. If this option is not specified, a list of patterns may be expected on standard input. Default: \fBnil\fP. +.B \fB\-\-[no\-]color\fP +Indicates whether colored output will be used. .TP .B \fB\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .TP -.B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default value: \fBdefault\fP. -.TP -.B \fB\-s LENGTH\fP, \fB\-\-max\-chars LENGTH\fP -The maximum size (in characters) for a command line. Default: \fBnil\fP. -.TP .B \fB\-\-server\-url URL\fP -The URL for the server. -.TP -.B \fB\-t\fP -Indicates that the print command will be run on the command line. Default: \fBnil\fP. +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. @@ -139,16 +143,20 @@ 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 +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife deps nodes/*.json | xargs knife upload .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. diff --git a/distro/common/man/man8/chef-client.8 b/distro/common/man/man8/chef-client.8 index ff10522772..4cb8fc2710 100644 --- a/distro/common/man/man8/chef-client.8 +++ b/distro/common/man/man8/chef-client.8 @@ -1,4 +1,6 @@ -.TH "CHEF-CLIENT" "8" "Chef 11.10.0" "" "chef-client" +.\" Man page generated from reStructuredText. +. +.TH "CHEF-CLIENT" "8" "Chef 11.12.0" "" "chef-client" .SH NAME chef-client \- The man page for the chef-client command line tool. . @@ -28,13 +30,11 @@ 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 chef\-client is an agent that runs locally on every node that is registered with the server. When a chef\-client is run, it will perform all of the steps that are required to bring the node into the expected state, including: +A chef\-client is an agent that runs locally on every node that is registered with the Chef server\&. When a chef\-client is run, it will perform all of the steps that are required to bring the node into the expected state, including: .INDENT 0.0 .IP \(bu 2 -Registering and authenticating the node with the server +Registering and authenticating the node with the Chef server .IP \(bu 2 Building the node object .IP \(bu 2 @@ -47,35 +47,63 @@ Taking the appropriate and required actions to configure the node Looking for exceptions and notifications, handling each as required .UNINDENT .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: \fB/etc/chef/client.rb\fP. On Microsoft Windows machines, the configuration file is located at \fBC:\echef\eclient.rb\fP. -.RE +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +The chef\-client executable can be run as a daemon. +.UNINDENT +.UNINDENT +.sp +The chef\-client executable is run as a command\-line tool. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +A client.rb file is used to specify the configuration details for the chef\-client\&. +.INDENT 0.0 +.IP \(bu 2 +This file is loaded every time this executable is run +.IP \(bu 2 +On UNIX\- and Linux\-based machines, the default location for this file is \fB/etc/chef/client.rb\fP; on Microsoft Windows machines, the default location for this file is \fBC:\echef\eclient.rb\fP; use the \fB\-\-config\fP option from the command line to change this location +.IP \(bu 2 +This file is not created by default +.IP \(bu 2 +When a client.rb file is present in this directory, the settings contained within that file will override the default configuration settings +.UNINDENT +.UNINDENT +.UNINDENT .SH OPTIONS .sp This command has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C chef\-client OPTION VALUE OPTION VALUE ... .ft P .fi +.UNINDENT +.UNINDENT .sp This command has the following options: .INDENT 0.0 .TP .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. +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 .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP -The output format: \fBdoc\fP (default) or \fBmin\fP. +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. +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 @@ -92,25 +120,25 @@ 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. 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. .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. +The location of the file which contains the client key. Default value: \fB/etc/chef/client.pem\fP\&. .TP .B \fB\-K KEY_FILE\fP, \fB\-\-validation_key KEY_FILE\fP -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. +The location of the file which contains the key used when a chef\-client is registered with a Chef 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. .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. +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. +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. @@ -122,31 +150,31 @@ Replace the current run list with the specified items. Indicates that the chef\-client is run once and that interval and splay options are cancelled. .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. +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\fP, \fB\-\-enable\-reporting\fP -Indicates that data collection reporting is enabled during a chef\-client run. +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. +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 .B \fB\-S CHEF_SERVER_URL\fP, \fB\-\-server CHEF_SERVER_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 that owns a process. This is required when starting any executable as a daemon. .TP .B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client. +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.. +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 RUN WITH ELEVATED PRIVILEGES .sp @@ -154,6 +182,8 @@ The chef\-client may need to be run with elevated privileges in order to get a r .SS Linux .sp On Linux, the following error sometimes occurs when the permissions used to run the chef\-client are incorrect: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -162,15 +192,19 @@ $ chef\-client [Tue, 29 Nov 2011 19:46:18 \-0800] WARN: Failed to read the private key /etc/chef/client.pem: #<Errno::EACCES: Permission denied \- /etc/chef/client.pem> .ft P .fi +.UNINDENT +.UNINDENT .sp This can be resolved by running the command as root. There are a few ways this can be done: .INDENT 0.0 .IP \(bu 2 Log in as root and then run the chef\-client .IP \(bu 2 -Use \fBsu\fP to become the root user, and then run the chef\-client. For example: +Use \fBsu\fP to become the root user, and then run the chef\-client\&. For example: .INDENT 2.0 .INDENT 3.5 +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -179,7 +213,6 @@ $ su .fi .UNINDENT .UNINDENT -.UNINDENT .sp and then: .INDENT 0.0 @@ -192,11 +225,14 @@ $ chef\-client .fi .UNINDENT .UNINDENT -.INDENT 0.0 +.UNINDENT +.UNINDENT .IP \(bu 2 Use the sudo utility .INDENT 2.0 .INDENT 3.5 +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -205,8 +241,10 @@ $ sudo chef\-client .fi .UNINDENT .UNINDENT +.UNINDENT +.UNINDENT .IP \(bu 2 -Give a user access to read \fB/etc/chef\fP and also the files accessed by the chef\-client. This requires super user privileges and, as such, is not a recommended approach +Give a user access to read \fB/etc/chef\fP and also the files accessed by the chef\-client\&. This requires super user privileges and, as such, is not a recommended approach .UNINDENT .SS Windows .sp @@ -218,40 +256,54 @@ Log in to the administrator account. (This is not the same as an account in the Run the chef\-client process from the administrator account while being logged into another account. Run the following command: .INDENT 2.0 .INDENT 3.5 +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ runas /user:Administrator "cmd /C chef\-client" .ft P .fi +.UNINDENT +.UNINDENT .sp This will prompt for the administrator account password. .UNINDENT .UNINDENT .IP \(bu 2 -Open a command prompt by right\-clicking on the command prompt application, and then selecting \fBRun as administrator\fP. After the command window opens, the chef\-client can be run as the administrator +Open a command prompt by right\-clicking on the command prompt application, and then selecting \fBRun as administrator\fP\&. After the command window opens, the chef\-client can be run as the administrator .UNINDENT .SH EXAMPLES .sp \fBStart a Chef run when the chef\-client is running as a daemon\fP .sp -A chef\-client that is running as a daemon can be woken up and started by sending the process a \fBSIGUSR1\fP. For example, to trigger a chef\-client run on a machine running Linux: +A chef\-client that is running as a daemon can be woken up and started by sending the process a \fBSIGUSR1\fP\&. For example, to trigger a chef\-client run on a machine running Linux: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ sudo killall \-USR1 chef\-client .ft P .fi +.UNINDENT +.UNINDENT .sp \fBStart a Chef run manually\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ ps auxw|grep chef\-client .ft P .fi +.UNINDENT +.UNINDENT .sp to return something like: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -259,14 +311,20 @@ root 66066 0.9 0.0 2488880 264 s001 S+ 10:26AM 0:03.05 /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby /usr/bin/chef\-client \-i 3600 \-s 20 .ft P .fi +.UNINDENT +.UNINDENT .sp and then enter: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ sudo kill \-USR1 66066 .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR 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 5c56608fba..56ed5527da 100644 --- a/distro/common/man/man8/chef-solo.8 +++ b/distro/common/man/man8/chef-solo.8 @@ -1,4 +1,6 @@ -.TH "CHEF-SOLO" "8" "Chef 11.10.0" "" "chef-solo" +.\" Man page generated from reStructuredText. +. +.TH "CHEF-SOLO" "8" "Chef 11.12.0" "" "chef-solo" .SH NAME chef-solo \- The man page for the chef-solo command line tool. . @@ -28,10 +30,8 @@ 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 -chef\-solo is an open source version of the chef\-client that allows using cookbooks with nodes without requiring access to a server. chef\-solo runs locally and requires that a cookbook (and any of its dependencies) be on the same physical disk as the node. chef\-solo is a limited\-functionality version of the chef\-client and \fBdoes not support\fP the following: +chef\-solo is an open source version of the chef\-client that allows using cookbooks with nodes without requiring access to a Chef server\&. chef\-solo runs locally and requires that a cookbook (and any of its dependencies) be on the same physical disk as the node. chef\-solo is a limited\-functionality version of the chef\-client and \fBdoes not support\fP the following: .INDENT 0.0 .IP \(bu 2 Node data storage @@ -47,16 +47,27 @@ Authentication or authorization Persistent attributes .UNINDENT .sp -The chef\-solo executable can be run as a command\-line tool. +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +chef\-solo can be run as a daemon. +.UNINDENT +.UNINDENT +.sp +The chef\-solo executable is run as a command\-line tool. .SH OPTIONS .sp This command has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C chef\-solo OPTION VALUE OPTION VALUE ... .ft P .fi +.UNINDENT +.UNINDENT .sp This command has the following options: .INDENT 0.0 @@ -65,20 +76,20 @@ This command has the following options: 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. +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. +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. +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. +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 @@ -107,7 +118,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. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. 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. @@ -125,7 +136,7 @@ A number (in seconds) to add to the \fBinterval\fP that is used to determine the The user that owns a process. This is required when starting any executable as a daemon. .TP .B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client. +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. @@ -133,34 +144,44 @@ Indicates that the executable will be run in why\-run mode, which is a type of c .SH EXAMPLES .sp \fBUse a URL\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ chef\-solo \-c ~/solo.rb \-j ~/node.json \-r http://www.example.com/chef\-solo.tar.gz .ft P .fi +.UNINDENT +.UNINDENT .sp -where \fB\-r\fP uses the \fBremote_file\fP resource to retrieve the tar.gz archive into the \fBfile_cache_path\fP, and then extract it to \fBcookbooks_path\fP. +The tar.gz archived into the \fBfile_cache_path\fP, and then extracted to \fBcookbooks_path\fP\&. .sp \fBUse a directory\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ chef\-solo \-c ~/solo.rb \-j ~/node.json .ft P .fi +.UNINDENT +.UNINDENT .sp -where the \fB\-r URL\fP option is not used. chef\-solo will look in the solo.rb file to determine the directory in which cookbooks are located. +chef\-solo will look in the solo.rb file to determine the directory in which cookbooks are located. .sp \fBUse a URL for cookbook and JSON data\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ chef\-solo \-c ~/solo.rb \-j http://www.example.com/node.json \-r http://www.example.com/chef\-solo.tar.gz .ft P .fi -.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. +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. |