diff options
Diffstat (limited to 'distro/common/man')
27 files changed, 849 insertions, 1129 deletions
diff --git a/distro/common/man/man1/knife-bootstrap.1 b/distro/common/man/man1/knife-bootstrap.1 index b62031e6d8..c6c86a26b0 100644 --- a/distro/common/man/man1/knife-bootstrap.1 +++ b/distro/common/man/man1/knife-bootstrap.1 @@ -38,66 +38,6 @@ The \fBknife bootstrap\fP subcommand is used run a bootstrap operation that inst To bootstrap the chef\-client on Microsoft Windows machines, the \fI\%knife-windows\fP plugins is required, which includes the necessary bootstrap scripts that are used to do the actual installation. .RE .sp -\fBCommon Options\fP -.sp -The following options can be run with all Knife sub\-commands and plug\-ins: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. -.TP -.B \fB\-\-color\fP -Indicates that 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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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\-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. -.TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user 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 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. -.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\-y\fP, \fB\-\-yes\fP -Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). -.UNINDENT -.sp \fBSyntax\fP .sp This argument has the following syntax: @@ -116,33 +56,66 @@ This subcommand has the following options: .B \fB\-A\fP, \fB\-\-forward\-agent\fP Indicates that SSH agent forwarding is enabled. .TP +.B \fB\-\-bootstrap\-no\-proxy NO_PROXY_URL_or_IP\fP +A URL or IP address that specifies a location that should not be proxied. Note: This option is used internally by Chef to help verify bootstrap operations during testing and should never be used during an actual bootstrap operation. +.TP .B \fB\-\-bootstrap\-proxy PROXY_URL\fP The proxy server for the node that is the target of a bootstrap operation. .TP .B \fB\-\-bootstrap\-version VERSION\fP The version of the chef\-client to install. .TP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\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\-\-[no\-]color\fP +Indicates whether colored output will be used. +.TP .B \fB\-d DISTRO\fP, \fB\-\-distro DISTRO\fP The template file to be used during a bootstrap operation. The following distributions are supported: \fBchef\-full\fP (the default bootstrap), \fBcentos5\-gems\fP, \fBfedora13\-gems\fP, \fBubuntu10.04\-gems\fP, \fBubuntu10.04\-apt\fP, \fBubuntu12.04\-gems\fP, and the name of a custom bootstrap template file. When this option is used, Knife will search for the template file in the following order: the \fBbootstrap/\fP folder in the current working directory, the \fBbootstrap/\fP folder in the chef\-repo, the \fBbootstrap/\fP folder in the \fB~/.chef/\fP directory, or a default bootstrap file. Do not use the \fB\-\-template\-file\fP option when \fB\-\-distro\fP is specified. .TP +.B \fB\-\-defaults\fP +Indicates that Knife will use the default value, instead of asking a user to provide one. +.TP +.B \fB\-\-disable\-editing\fP +Indicates that $EDITOR will not be opened; data will be accepted as\-is. +.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\-\-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. .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 \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. .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. +.TP .B \fB\-N NAME\fP, \fB\-\-node\-name NAME\fP The name of the node. .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 \fB\-p PORT\fP, \fB\-\-ssh\-port PORT\fP The SSH port. .TP @@ -152,9 +125,15 @@ The SSH password. This can be used to pass the password directly on the command .B \fB\-\-prerelease\fP Indicates that pre\-release gems should be installed. .TP +.B \fB\-\-print\-after\fP +Indicates that data will be shown after a destructive operation. +.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. .TP +.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP +The URL for the server. +.TP .B \fB\-\-secret SECRET\fP The encryption key that is used for values contained within a data bag. .TP @@ -167,11 +146,26 @@ Indicates that a bootstrap operation should be executed using sudo. .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. +.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. +.TP +.B \fB\-V\fP, \fB\-\-verbose\fP +Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. +.TP .B \fB\-x USERNAME\fP, \fB\-\-ssh\-user USERNAME\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 server to also work against the local chef\-repo. .UNINDENT .sp \fBExamples\fP @@ -192,6 +186,6 @@ $ knife bootstrap 192.168.1.1 \-x username \-i ~/.ssh/id_rsa \-\-sudo .ft P .fi .SH AUTHOR -Opscode +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 79d433dce9..3431e35067 100644 --- a/distro/common/man/man1/knife-client.1 +++ b/distro/common/man/man1/knife-client.1 @@ -31,7 +31,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" 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 /etc/chef/validation.pem. +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. .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). .sp @@ -46,14 +46,14 @@ $ knife client [ARGUMENT] (options) .fi .SH COMMON OPTIONS .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +The following options may be used with any of the arguments available to the \fBknife client\fP subcommand: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. +.B \fB\-\-chef\-zero\-port PORT\fP +The port on which chef\-zero will listen. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP +The configuration file to use. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -67,9 +67,6 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 @@ -79,11 +76,8 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.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. @@ -94,14 +88,17 @@ The URL for the server. .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. .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\-v\fP, \fB\-\-version\fP +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. .UNINDENT .SH BULK DELETE .sp @@ -125,9 +122,9 @@ This command does not have any specific options. 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. .INDENT 0.0 .IP \(bu 2 -For the chef\-client, the private key should be copied to the system as /etc/chef/client.pem. +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 ~/.chef/client_name.pem and referenced in the knife.rb configuration file. +For Knife, the private key is typically copied to \fB~/.chef/client_name.pem\fP and referenced in the knife.rb configuration file. .UNINDENT .sp \fBSyntax\fP @@ -146,7 +143,7 @@ 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 Hosted Chef or Private Chef. +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. .UNINDENT .sp \fBExamples\fP @@ -159,7 +156,7 @@ $ knife client create exampleorg \-a \-f "/etc/chef/client.pem" .ft P .fi .sp -When running the \fBcreate\fP argument on Hosted Chef or Private Chef, be sure to omit the \fB\-a\fP option: +When running the \fBcreate\fP argument on Enterprise Chef, be sure to omit the \fB\-a\fP option: .sp .nf .ft C @@ -363,6 +360,6 @@ $ knife role show devops \-F json .sp Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP. .SH AUTHOR -Opscode +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 e06793e219..33feb16c0c 100644 --- a/distro/common/man/man1/knife-configure.1 +++ b/distro/common/man/man1/knife-configure.1 @@ -33,16 +33,35 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .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 -\fBCommon Options\fP +\fBSyntax\fP +.sp +This argument has the following syntax: +.sp +.nf +.ft C +$ knife configure (options) +.ft P +.fi +.sp +\fBOptions\fP .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +This subcommand has the following options: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP +.B \fB\-\-admin\-client\-key PATH\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. +.TP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.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. @@ -56,27 +75,24 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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\-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. +.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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. -.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. +.TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the server. .TP @@ -89,42 +105,17 @@ The version of the chef\-client. .B \fB\-V\fP, \fB\-\-verbose\fP Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. .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). -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife configure (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-\-admin\-client\-name NAME\fP -The name of the client, typically the name of the admin client. -.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. -.TP -.B \fB\-i\fP, \fB\-\-initial\fP -Use to create a API client, typically an administrator client on a freshly\-installed server. -.TP -.B \fB\-r REPO\fP, \fB\-\-repository REPO\fP -The path to the chef\-repo. -.TP .B \fB\-\-validation\-client\-name NAME\fP 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. +.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. .UNINDENT .sp \fBExamples\fP @@ -145,6 +136,6 @@ $ knife configure client \(aq/directory\(aq .ft P .fi .SH AUTHOR -Opscode +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 8a2b535333..ae76688144 100644 --- a/distro/common/man/man1/knife-cookbook-site.1 +++ b/distro/common/man/man1/knife-cookbook-site.1 @@ -44,14 +44,14 @@ $ knife cookbook site [ARGUMENT] (options) .fi .SH COMMON OPTIONS .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +The following options may be used with any of the arguments available to the \fBknife cookbook site\fP subcommand: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. +.B \fB\-\-chef\-zero\-port PORT\fP +The port on which chef\-zero will listen. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP +The configuration file to use. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -65,9 +65,6 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 @@ -77,11 +74,8 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.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. @@ -92,14 +86,17 @@ The URL for the server. .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. .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\-v\fP, \fB\-\-version\fP +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. .UNINDENT .SH DOWNLOAD .sp @@ -472,6 +469,6 @@ $ knife cookbook site unshare getting\-started .ft P .fi .SH AUTHOR -Opscode +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 c9b4e807dc..7e4c643f78 100644 --- a/distro/common/man/man1/knife-cookbook.1 +++ b/distro/common/man/man1/knife-cookbook.1 @@ -64,14 +64,14 @@ $ knife cookbook [ARGUMENT] (options) .fi .SH COMMON OPTIONS .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +The following options may be used with any of the arguments available to the \fBknife cookbook\fP subcommand: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. +.B \fB\-\-chef\-zero\-port PORT\fP +The port on which chef\-zero will listen. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP +The configuration file to use. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -85,9 +85,6 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 @@ -97,11 +94,8 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.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. @@ -112,14 +106,17 @@ The URL for the server. .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. .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\-v\fP, \fB\-\-version\fP +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. .UNINDENT .SH BULK DELETE .sp @@ -206,7 +203,7 @@ This argument has the following options: The name of the copyright holder. This option will place a copyright notice that contains the name of the copyright holder in each of the pre\-created files. If this option is not specified, a copyright name of "your_company_name" will be used instead; it can be easily modified later. .TP .B \fB\-I LICENSE\fP, \fB\-\-license LICENSE\fP -The type of license under which a cookbook is distributed: \fBapachev2\fP, \fBgplv2\fP, \fBgplv3\fP, \fBmit\fP, or \fBnone\fP (default). This option will place the appropriate license notice in the pre\-created files. Be aware of the licenses for files inside of a cookbook and be sure to follow any restrictions they describe. +The type of license under which a cookbook is distributed: \fBapachev2\fP, \fBgplv2\fP, \fBgplv3\fP, \fBmit\fP, or \fBnone\fP (default). This option will place the appropriate license notice in the pre\-created files: \fBApache v2.0\fP (for \fBapachev2\fP), \fBGPL v2\fP (for \fBgplv2\fP), \fBGPL v3\fP (for \fBgplv3\fP), \fBMIT\fP (for \fBmit\fP), or \fBlicense \(aqProprietary \- All Rights Reserved\fP (for \fBnone\fP). Be aware of the licenses for files inside of a cookbook and be sure to follow any restrictions they describe. .TP .B \fB\-m EMAIL\fP, \fB\-\-email EMAIL\fP The email address for the individual who maintains the cookbook. This option will place an email address in each of the pre\-created files. If this option is not specified, an email name of "your_email" will be used instead; it can be easily modified later. @@ -637,6 +634,6 @@ ERROR: Version 0.1.6 of cookbook redis is frozen. Use \-\-force to override. .ft P .fi .SH AUTHOR -Opscode +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 b5fae1742a..88864af721 100644 --- a/distro/common/man/man1/knife-data-bag.1 +++ b/distro/common/man/man1/knife-data-bag.1 @@ -46,14 +46,14 @@ $ knife data bag [ARGUMENT] (options) .fi .SH COMMON OPTIONS .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +The following options may be used with any of the arguments available to the \fBknife data bag\fP subcommand: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. +.B \fB\-\-chef\-zero\-port PORT\fP +The port on which chef\-zero will listen. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP +The configuration file to use. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -67,9 +67,6 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 @@ -79,11 +76,8 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.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. @@ -94,14 +88,17 @@ The URL for the server. .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. .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\-v\fP, \fB\-\-version\fP +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. .UNINDENT .SH CREATE .sp @@ -481,6 +478,6 @@ $ knife data bag show admins \-F json .sp Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP. .SH AUTHOR -Opscode +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 7f1028fbb9..078f8224d3 100644 --- a/distro/common/man/man1/knife-delete.1 +++ b/distro/common/man/man1/knife-delete.1 @@ -33,16 +33,38 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .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). .sp -\fBCommon Options\fP +\fBSyntax\fP +.sp +This argument has the following syntax: +.sp +.nf +.ft C +$ knife delete [PATTERN...] (options) +.ft P +.fi .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +\fBOptions\fP +.sp +This subcommand has the following options: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP +.B \fB\-\-both\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\-\-color\fP -Indicates that colored output will be used. +.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. @@ -56,9 +78,6 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 @@ -68,15 +87,18 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.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. .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. +.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. +.TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the server. .TP @@ -91,42 +113,11 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. .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). -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife delete [PATTERN...] (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -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. -.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\-\-local\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\-r\fP, \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. +.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. .UNINDENT .SH AUTHOR -Opscode +Chef .\" Generated by docutils manpage writer. . diff --git a/distro/common/man/man1/knife-deps.1 b/distro/common/man/man1/knife-deps.1 index 2f8056ed26..1de4aa4b33 100644 --- a/distro/common/man/man1/knife-deps.1 +++ b/distro/common/man/man1/knife-deps.1 @@ -33,16 +33,35 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .sp The \fBknife deps\fP subcommand is used to identify dependencies for a node, role, or cookbook. .sp -\fBCommon Options\fP +\fBSyntax\fP +.sp +This argument has the following syntax: +.sp +.nf +.ft C +$ knife deps (options) +.ft P +.fi .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +\fBOptions\fP +.sp +This subcommand has the following options: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.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. @@ -56,9 +75,6 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 @@ -68,18 +84,24 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. -.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. +.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. +.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. +.TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the server. .TP +.B \fB\-\-tree\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. .TP @@ -91,40 +113,9 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. .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). -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife deps (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 .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\-]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. -.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. -.TP -.B \fB\-\-tree\fP -Indicates that dependencies are shown in a visual tree structure (including duplicates, if they exist). Default: \fBfalse\fP. +.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. .UNINDENT .sp \fBExamples\fP @@ -214,6 +205,6 @@ $ knife deps nodes/*.json | xargs knife upload .ft P .fi .SH AUTHOR -Opscode +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 12fcf4bbca..c3ee7ae771 100644 --- a/distro/common/man/man1/knife-diff.1 +++ b/distro/common/man/man1/knife-diff.1 @@ -33,16 +33,38 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .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. .sp -\fBCommon Options\fP +\fBSyntax\fP +.sp +This argument has the following syntax: +.sp +.nf +.ft C +$ knife diff [PATTERN...] (options) +.ft P +.fi .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +\fBOptions\fP +.sp +This subcommand has the following options: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.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\-\-cookbook\-version VERSION\fP +The version of a cookbook to be downloaded. +.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. @@ -50,15 +72,15 @@ Indicates that $EDITOR will not be opened; data will be accepted as\-is. .B \fB\-\-defaults\fP 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. +.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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 @@ -68,15 +90,21 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. +.B \fB\-\-name\-only\fP +Indicates that only the names of modified files will be shown. .TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.B \fB\-\-name\-status\fP +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. .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. +.TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the server. .TP @@ -91,46 +119,9 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. .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). -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife diff [PATTERN...] (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 .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\-\-cookbook\-version VERSION\fP -The version of a cookbook to be downloaded. -.TP -.B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP. -.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. -.TP -.B \fB\-\-name\-only\fP -Indicates that only the names of modified files will be shown. -.TP -.B \fB\-\-name\-status\fP -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. -.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. +.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. .UNINDENT .sp \fBknife.rb File Settings\fP @@ -210,6 +201,6 @@ node\-lb/Rakefile .ft P .fi .SH AUTHOR -Opscode +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 5ab5e788fe..29daeec0ed 100644 --- a/distro/common/man/man1/knife-download.1 +++ b/distro/common/man/man1/knife-download.1 @@ -33,16 +33,38 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .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. .sp -\fBCommon Options\fP +\fBSyntax\fP +.sp +This argument has the following syntax: +.sp +.nf +.ft C +$ knife download [PATTERN...] (options) +.ft P +.fi .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +\fBOptions\fP +.sp +This subcommand has the following options: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.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\-\-cookbook\-version VERSION\fP +The version of a cookbook to be downloaded. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -50,33 +72,42 @@ Indicates that $EDITOR will not be opened; data will be accepted as\-is. .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 +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. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 \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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.B \fB\-n\fP, \fB\-\-dry\-run\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. +.TP +.B \fB\-\-[no\-]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. +.TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the server. .TP @@ -91,46 +122,9 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. .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). -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife download [PATTERN...] (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.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\-\-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\-n\fP, \fB\-\-dry\-run\fP -Indicates that no action is taken and that results are only printed out. Default: \fBfalse\fP. -.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. -.TP -.B \fB\-\-[no\-]recurse\fP -Use \fB\-\-no\-recurse\fP to disable downloading a directory recursively. Default: \fB\-\-recurse\fP. -.TP -.B \fB\-\-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. -.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. +.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. .UNINDENT .sp \fBExamples\fP @@ -215,6 +209,6 @@ $ knife download cookbooks/apache\e* roles/webserver.json .ft P .fi .SH AUTHOR -Opscode +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 fd443726c3..84f808a286 100644 --- a/distro/common/man/man1/knife-edit.1 +++ b/distro/common/man/man1/knife-edit.1 @@ -33,16 +33,35 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .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). .sp -\fBCommon Options\fP +\fBSyntax\fP +.sp +This argument has the following syntax: +.sp +.nf +.ft C +$ knife edit (options) +.ft P +.fi +.sp +\fBOptions\fP .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +This subcommand has the following options: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.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. @@ -56,9 +75,6 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 @@ -68,15 +84,15 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.B \fB\-\-local\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. +.TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the server. .TP @@ -91,36 +107,11 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. .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). -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife edit (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 .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\-\-local\fP -Use to show files in the local chef\-repo instead of a remote location. 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. +.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. .UNINDENT .SH AUTHOR -Opscode +Chef .\" Generated by docutils manpage writer. . diff --git a/distro/common/man/man1/knife-environment.1 b/distro/common/man/man1/knife-environment.1 index c70556a190..32ff9fb7a4 100644 --- a/distro/common/man/man1/knife-environment.1 +++ b/distro/common/man/man1/knife-environment.1 @@ -44,14 +44,14 @@ $ knife environment [ARGUMENT] (options) .fi .SH COMMON OPTIONS .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +The following options may be used with any of the arguments available to the \fBknife environment\fP subcommand: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. +.B \fB\-\-chef\-zero\-port PORT\fP +The port on which chef\-zero will listen. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP +The configuration file to use. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -65,9 +65,6 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 @@ -77,11 +74,8 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.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. @@ -92,14 +86,17 @@ The URL for the server. .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. .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\-v\fP, \fB\-\-version\fP +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. .UNINDENT .SH CREATE .sp @@ -319,6 +316,6 @@ $ knife role show devops \-F json .sp Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP. .SH AUTHOR -Opscode +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 962ec4079e..d931615119 100644 --- a/distro/common/man/man1/knife-exec.1 +++ b/distro/common/man/man1/knife-exec.1 @@ -47,66 +47,6 @@ When the chef\-shell DSL is available, the chef\-client DSL will not be (unless .UNINDENT .UNINDENT .sp -\fBCommon Options\fP -.sp -The following options can be run with all Knife sub\-commands and plug\-ins: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. -.TP -.B \fB\-\-color\fP -Indicates that 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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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\-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. -.TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user 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 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. -.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\-y\fP, \fB\-\-yes\fP -Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). -.UNINDENT -.sp \fBAuthenticated API Requests\fP .sp The \fBknife exec\fP subcommand can be used to make authenticated API requests to the server using the following methods: @@ -209,11 +149,62 @@ $ knife exec SCRIPT (options) This subcommand has the following options: .INDENT 0.0 .TP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\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\-\-[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 CODE\fP, \fB\-\-exec CODE\fP A string of code that will be executed. .TP +.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP +The $EDITOR that is used for all interactive commands. +.TP +.B \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\-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. +.TP .B \fB\-p PATH:PATH\fP, \fB\-\-script\-path PATH:PATH\fP A colon\-separated path at which Ruby scripts are located. +.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. +.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. +.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\-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. .UNINDENT .sp \fBExamples\fP @@ -320,6 +311,6 @@ Your attributes: ipaddress fqdn .ft P .fi .SH AUTHOR -Opscode +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 1dc7dc1703..c3d3411ae0 100644 --- a/distro/common/man/man1/knife-index-rebuild.1 +++ b/distro/common/man/man1/knife-index-rebuild.1 @@ -36,66 +36,6 @@ The \fBknife index rebuild\fP subcommand is used to rebuild the search indexes f 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 -\fBCommon Options\fP -.sp -The following options can be run with all Knife sub\-commands and plug\-ins: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. -.TP -.B \fB\-\-color\fP -Indicates that 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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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\-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. -.TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user 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 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. -.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\-y\fP, \fB\-\-yes\fP -Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). -.UNINDENT -.sp \fBSyntax\fP .sp This argument has the following syntax: @@ -110,6 +50,6 @@ $ knife index rebuild .sp This command does not have any specific options. .SH AUTHOR -Opscode +Chef .\" Generated by docutils manpage writer. . diff --git a/distro/common/man/man1/knife-list.1 b/distro/common/man/man1/knife-list.1 index 2788e5b903..233c9dcc3d 100644 --- a/distro/common/man/man1/knife-list.1 +++ b/distro/common/man/man1/knife-list.1 @@ -33,31 +33,56 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .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). .sp -\fBCommon Options\fP +\fBSyntax\fP +.sp +This argument has the following syntax: +.sp +.nf +.ft C +$ knife list [PATTERN...] (options) +.ft P +.fi +.sp +\fBOptions\fP .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +This subcommand has the following options: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP +.B \fB\-1\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\-\-color\fP -Indicates that colored output will be used. +.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\-d\fP, \fB\-\-disable\-editing\fP -Indicates that $EDITOR will not be opened; data will be accepted as\-is. +.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 +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. .TP +.B \fB\-\-disable\-editing\fP +Indicates that $EDITOR will not be opened; data will be accepted as\-is. +.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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. +.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. .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. @@ -68,15 +93,21 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. +.B \fB\-\-local\fP +Indicates that only contents of the local directory will be returned. Default: \fBfalse\fP. .TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.B \fB\-p\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. +.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. +.TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the server. .TP @@ -91,52 +122,9 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. .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). -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife list [PATTERN...] (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-1\fP -Indicates that only one results column will be shown. -.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\-d\fP -Indicates that a directory\(aqs children will not be shown when a directory matches a pattern. Default value: \fBfalse\fP. -.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. -.TP -.B \fB\-\-local\fP -Indicates that only contents of the local directory will be returned. Default: \fBfalse\fP. -.TP -.B \fB\-1\fP -Indicates that only one column of results will be shown. Default: \fBfalse\fP. -.TP -.B \fB\-p\fP -Indicates that trailing slashes (/) will be shown for directories. Default: \fBfalse\fP. -.TP -.B \fB\-R\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. +.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. .UNINDENT .sp \fBExamples\fP @@ -165,6 +153,6 @@ $ knife list \-R / .ft P .fi .SH AUTHOR -Opscode +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 394cf54c87..0e1b46b655 100644 --- a/distro/common/man/man1/knife-node.1 +++ b/distro/common/man/man1/knife-node.1 @@ -44,14 +44,14 @@ $ knife node [ARGUMENT] (options) .fi .SH COMMON OPTIONS .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +The following options may be used with any of the arguments available to the \fBknife node\fP subcommand: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. +.B \fB\-\-chef\-zero\-port PORT\fP +The port on which chef\-zero will listen. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP +The configuration file to use. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -65,9 +65,6 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 @@ -77,11 +74,8 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.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. @@ -92,14 +86,17 @@ The URL for the server. .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. .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\-v\fP, \fB\-\-version\fP +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. .UNINDENT .SH BULK DELETE .sp @@ -343,7 +340,7 @@ rs\-123456 .fi .SH RUN_LIST ADD .sp -The \fBrun_list add\fP argument is used to add run list items (roles or recipes) to 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 adding more than one, like this: \fB\(aqrecipe[COOKBOOK::RECIPE_NAME],COOKBOOK::RECIPE_NAME,role[ROLE_NAME]\(aq\fP. +The \fBrun_list add\fP argument is used to add run list items (roles or recipes) to a node. .sp \fBSyntax\fP .sp @@ -573,6 +570,6 @@ knife node show \-l \-\-format=json <node_name> .ft P .fi .SH AUTHOR -Opscode +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 c35b010031..cb7c557077 100644 --- a/distro/common/man/man1/knife-raw.1 +++ b/distro/common/man/man1/knife-raw.1 @@ -33,16 +33,29 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .sp The \fBknife raw\fP subcommand is used to send a REST request to a specified path using the Chef Server API. .sp -\fBCommon Options\fP +\fBSyntax\fP +.sp +This argument has the following syntax: +.sp +.nf +.ft C +$ knife raw REQUEST_PATH (options) +.ft P +.fi .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +\fBOptions\fP +.sp +This subcommand has the following options: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.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. @@ -56,23 +69,23 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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\-h\fP, \fB\-\-help\fP Shows help for the command. .TP +.B \fB\-i FILE\fP, \fB\-\-input FILE\fP +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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. +.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. .TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.B \fB\-\-[no\-]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. @@ -91,40 +104,9 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. .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). -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife raw REQUEST_PATH (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.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\-i FILE\fP, \fB\-\-input FILE\fP -The name of a file to be used with the \fBPUT\fP or a \fBPOST\fP request. -.TP -.B \fB\-\-[no\-]pretty\fP -Use \fB\-\-no\-pretty\fP to disable pretty\-print output for JSON. Default: \fB\-\-pretty\fP. -.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. .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. +.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. .UNINDENT .sp \fBExamples\fP @@ -165,6 +147,6 @@ to return something similar to: .ft P .fi .SH AUTHOR -Opscode +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 ab7bf6ec8c..846b3c6b47 100644 --- a/distro/common/man/man1/knife-recipe-list.1 +++ b/distro/common/man/man1/knife-recipe-list.1 @@ -33,66 +33,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .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 (/). .sp -\fBCommon Options\fP -.sp -The following options can be run with all Knife sub\-commands and plug\-ins: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. -.TP -.B \fB\-\-color\fP -Indicates that 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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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\-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. -.TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user 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 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. -.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\-y\fP, \fB\-\-yes\fP -Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). -.UNINDENT -.sp \fBSyntax\fP .sp This argument has the following syntax: @@ -128,6 +68,6 @@ couchdb::org_cleanu .ft P .fi .SH AUTHOR -Opscode +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 33c7b6bf8f..c26d953b2d 100644 --- a/distro/common/man/man1/knife-role.1 +++ b/distro/common/man/man1/knife-role.1 @@ -42,19 +42,16 @@ This subcommand has the following syntax: $ knife role [ARGUMENT] (options) .ft P .fi -.IP Note -Use the \fBknife node\fP subcommand (and the \fBrun_list add node\fP argument) to add a role to a node on the server. -.RE .SH COMMON OPTIONS .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +The following options may be used with any of the arguments available to the \fBknife role\fP subcommand: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. +.B \fB\-\-chef\-zero\-port PORT\fP +The port on which chef\-zero will listen. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP +The configuration file to use. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -68,9 +65,6 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 @@ -80,11 +74,8 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.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. @@ -95,14 +86,17 @@ The URL for the server. .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. .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\-v\fP, \fB\-\-version\fP +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. .UNINDENT .SH BULK DELETE .sp @@ -133,7 +127,7 @@ $ knife role bulk delete "^[0\-9]{3}$" .fi .SH CREATE .sp -The \fBcreate\fP argument is used to add a role to the server. To add a role to a node, you must use the \fBnode\fP sub\-command and the \fBrun\-list add\fP argument. Role data is saved as JSON on the server. +The \fBcreate\fP argument is used to add a role to the server. Role data is saved as JSON on the server. .sp \fBSyntax\fP .sp @@ -174,8 +168,8 @@ In the $EDITOR enter the role data in JSON: "default_attributes": { }, "json_class": "Chef::Role", - "run_list": [ - + "run_list": [\(aqrecipe[cookbook_name::recipe_name], + role[role_name]\(aq ], "description": "", "chef_type": "role", @@ -253,8 +247,8 @@ Update the role data in JSON: "default_attributes": { }, "json_class": "Chef::Role", - "run_list": [ - + "run_list": [\(aqrecipe[cookbook_name::recipe_name], + role[role_name]\(aq ], "description": "This is the description for the role1 role.", "chef_type": "role", @@ -369,6 +363,6 @@ $ knife role show devops \-F json .sp Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP. .SH AUTHOR -Opscode +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 e59be88bd9..689e2f14b4 100644 --- a/distro/common/man/man1/knife-search.1 +++ b/distro/common/man/man1/knife-search.1 @@ -31,70 +31,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" Man page generated from reStructuredText. . .sp -Search indexes allow queries to be made for any type of data that is indexed by the server, including data bags (and data bag items), environments, nodes, and roles. A defined query syntax is used to support search patterns like exact, wildcard, range, and fuzzy. A search is a full\-text query that can be done from several locations, including from within a recipe, by using the \fBsearch\fP subcommand in Knife, by using the search functionality in the Management Console, or by using the \fB/search\fP or \fB/search/INDEX\fP endpoints in the Chef Server API. The search engine is based on Apache Solr and is run from the server. +Search indexes allow queries to be made for any type of data that is indexed by the server, including data bags (and data bag items), environments, nodes, and roles. A defined query syntax is used to support search patterns like exact, wildcard, range, and fuzzy. A search is a full\-text query that can be done from several locations, including from within a recipe, by using the \fBsearch\fP subcommand in Knife, by using the search functionality in the Chef Manager, or by using the \fB/search\fP or \fB/search/INDEX\fP endpoints in the Chef Server API. The search engine is based on Apache Solr and is run from the server. .sp The \fBknife search\fP subcommand is used run a search query for information that is indexed on a server. .sp -\fBCommon Options\fP -.sp -The following options can be run with all Knife sub\-commands and plug\-ins: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. -.TP -.B \fB\-\-color\fP -Indicates that 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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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\-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. -.TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user 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 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. -.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\-y\fP, \fB\-\-yes\fP -Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). -.UNINDENT -.sp \fBSyntax\fP .sp This argument has the following syntax: @@ -167,12 +107,42 @@ The attribute (or attributes) to show. .B \fB\-b ROW\fP, \fB\-\-start ROW\fP The row at which return results will begin. .TP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\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\-\-[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\-h\fP, \fB\-\-help\fP +Shows help for the command. +.TP .B \fB\-i\fP, \fB\-\-id\-only\fP 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. .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. +.TP .B \fB\-l\fP, \fB\-\-long\fP Display long output when searching nodes while using the default summary format. .TP @@ -182,6 +152,9 @@ Display more, but not all, of a node\(aqs data when searching using the default .B \fB\-o SORT\fP, \fB\-\-sort SORT\fP The order in which search results will be sorted. .TP +.B \fB\-\-print\-after\fP +Indicates that data will be shown after a destructive operation. +.TP .B \fB\-q SEARCH_QUERY\fP, \fB\-\-query SEARCH_QUERY\fP Use to protect search queries that start with a hyphen (\-). A \fB\-q\fP query may be specified as an argument or an option, but not both. .TP @@ -191,8 +164,26 @@ Indicates that only the run\-list will be shown. .B \fB\-R INT\fP, \fB\-\-rows INT\fP The number of rows to be returned. .TP +.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP +The URL for the 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. +.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. +.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\-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. .UNINDENT .sp \fBExamples\fP @@ -299,6 +290,6 @@ $ knife search node "role:web AND NOT name:web03" .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. .SH AUTHOR -Opscode +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 0612440672..2723ae431b 100644 --- a/distro/common/man/man1/knife-show.1 +++ b/distro/common/man/man1/knife-show.1 @@ -33,16 +33,38 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .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). .sp -\fBCommon Options\fP +\fBSyntax\fP +.sp +This argument has the following syntax: +.sp +.nf +.ft C +$ knife show [PATTERN...] (options) +.ft P +.fi +.sp +\fBOptions\fP .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +This subcommand has the following options: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP +.B \fB\-a ATTR\fP, \fB\-\-attribute ATTR\fP +The attribute (or attributes) to show. +.TP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.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. @@ -56,9 +78,6 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 @@ -68,15 +87,15 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.B \fB\-\-local\fP +Indicates that instead of remote files, local files will be shown. .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. +.TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the server. .TP @@ -91,22 +110,11 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. .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. .UNINDENT .sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife show [PATTERN...] (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp \fBExamples\fP .sp To show all cookbooks in the \fBcookbooks/\fP directory: @@ -133,6 +141,6 @@ $ knife show roles/ environments/ .ft P .fi .SH AUTHOR -Opscode +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 41f47eecbd..1c4b2adf54 100644 --- a/distro/common/man/man1/knife-ssh.1 +++ b/distro/common/man/man1/knife-ssh.1 @@ -33,66 +33,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .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 -\fBCommon Options\fP -.sp -The following options can be run with all Knife sub\-commands and plug\-ins: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. -.TP -.B \fB\-\-color\fP -Indicates that 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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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\-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. -.TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user 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 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. -.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\-y\fP, \fB\-\-yes\fP -Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). -.UNINDENT -.sp \fBSyntax\fP .sp This argument has the following syntax: @@ -111,15 +51,48 @@ This subcommand has the following options: .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 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 @@ -135,14 +108,35 @@ The SSH port. .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 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 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 server to also work against the local chef\-repo. .UNINDENT .sp \fBExamples\fP @@ -249,6 +243,6 @@ ERROR: LoadError: cannot load such file \-\- appscript .ft P .fi .SH AUTHOR -Opscode +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 0682fdca70..8036e5588e 100644 --- a/distro/common/man/man1/knife-status.1 +++ b/distro/common/man/man1/knife-status.1 @@ -33,16 +33,29 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .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. .sp -\fBCommon Options\fP +\fBSyntax\fP +.sp +This argument has the following syntax: +.sp +.nf +.ft C +$ knife status (options) +.ft P +.fi +.sp +\fBOptions\fP .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +This subcommand has the following options: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.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. @@ -56,28 +69,31 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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\-h\fP, \fB\-\-help\fP Shows help for the command. .TP +.B \fB\-H\fP, \fB\-\-hide\-healthy\fP +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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user 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 +.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. +.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. +.TP +.B \fB\-s\fP, \fB\-\-sort\-reverse\fP +Indicates that the list will be sorted by last run time, descending. +.TP +.B \fB\-\-server\-url URL\fP The URL for the server. .TP .B \fB\-u USER\fP, \fB\-\-user USER\fP @@ -91,34 +107,9 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. .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). -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife status (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 .TP -.B \fBQUERY\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. -.TP -.B \fB\-H\fP, \fB\-\-hide\-healthy\fP -Indicates that nodes on which a chef\-client run has occurred within the previous hour will be hidden. -.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. -.TP -.B \fB\-s\fP, \fB\-\-sort\-reverse\fP -Indicates that the list will be sorted by last run time, descending. +.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. .UNINDENT .sp \fBExamples\fP @@ -202,6 +193,6 @@ to return something like: .ft P .fi .SH AUTHOR -Opscode +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 945912f35e..f2cb86dcfc 100644 --- a/distro/common/man/man1/knife-tag.1 +++ b/distro/common/man/man1/knife-tag.1 @@ -44,14 +44,14 @@ $ knife tag [ARGUMENT] .fi .SH COMMON OPTIONS .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +The following options may be used with any of the arguments available to the \fBknife tag\fP subcommand: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. +.B \fB\-\-chef\-zero\-port PORT\fP +The port on which chef\-zero will listen. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP +The configuration file to use. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -65,9 +65,6 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 @@ -77,11 +74,8 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.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. @@ -92,14 +86,17 @@ The URL for the server. .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. .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\-v\fP, \fB\-\-version\fP +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. .UNINDENT .SH CREATE .sp @@ -175,6 +172,6 @@ $ knife tag list [NODE_NAME...] .sp This command does not have any specific options. .SH AUTHOR -Opscode +Chef .\" Generated by docutils manpage writer. . diff --git a/distro/common/man/man1/knife-upload.1 b/distro/common/man/man1/knife-upload.1 index e59f2f1c48..7cd0fb5fdf 100644 --- a/distro/common/man/man1/knife-upload.1 +++ b/distro/common/man/man1/knife-upload.1 @@ -33,16 +33,35 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .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. .sp -\fBCommon Options\fP +\fBSyntax\fP +.sp +This argument has the following syntax: +.sp +.nf +.ft C +$ knife upload [PATTERN...] (options) +.ft P +.fi +.sp +\fBOptions\fP .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +This subcommand has the following options: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.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. @@ -50,33 +69,45 @@ Indicates that $EDITOR will not be opened; data will be accepted as\-is. .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 +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. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 \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. +.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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.B \fB\-n\fP, \fB\-\-dry\-run\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. +.TP +.B \fB\-\-[no\-]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. +.TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the server. .TP @@ -91,49 +122,9 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. .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). -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife upload [PATTERN...] (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.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 -Indicates that only new and modified files will be uploaded. Set to \fBfalse\fP to upload all files. Default: \fBtrue\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. -.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. -.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. -.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. -.TP -.B \fB\-\-[no\-]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. +.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. .UNINDENT .sp \fBExamples\fP @@ -234,6 +225,6 @@ $ knife upload \(gaknife deps nodes/*.json\(ga .ft P .fi .SH AUTHOR -Opscode +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 b8fe4583f0..344fa55029 100644 --- a/distro/common/man/man1/knife-user.1 +++ b/distro/common/man/man1/knife-user.1 @@ -45,14 +45,14 @@ $ knife user [ARGUMENT] (options) .fi .SH COMMON OPTIONS .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +The following options may be used with any of the arguments available to the \fBknife user\fP subcommand: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. +.B \fB\-\-chef\-zero\-port PORT\fP +The port on which chef\-zero will listen. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP +The configuration file to use. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -66,9 +66,6 @@ The $EDITOR that is used for all interactive commands. .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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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 @@ -78,11 +75,8 @@ Shows help for the command. .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. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.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. @@ -93,23 +87,26 @@ The URL for the server. .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. .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\-v\fP, \fB\-\-version\fP +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. .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. .INDENT 0.0 .IP \(bu 2 -For the user, the private key should be copied to the system as /etc/chef/client.pem. +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 ~/.chef/client_name.pem and referenced in the knife.rb configuration file. +For Knife, the private key is typically copied to \fB~/.chef/client_name.pem\fP and referenced in the knife.rb configuration file. .UNINDENT .sp \fBSyntax\fP @@ -128,7 +125,7 @@ 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 Hosted Chef or Private Chef. +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. .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. @@ -312,6 +309,6 @@ $ knife user show "Dennis Teck" \-F json .sp Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP. .SH AUTHOR -Opscode +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 23e74ead94..ead1c680d9 100644 --- a/distro/common/man/man1/knife-xargs.1 +++ b/distro/common/man/man1/knife-xargs.1 @@ -33,66 +33,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .sp The \fBknife xargs\fP subcommand is used to build and execute command lines against objects on a server using standard input. .sp -\fBCommon Options\fP -.sp -The following options can be run with all Knife sub\-commands and plug\-ins: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. -.TP -.B \fB\-\-color\fP -Indicates that 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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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\-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. -.TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user 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 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. -.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\-y\fP, \fB\-\-yes\fP -Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). -.UNINDENT -.sp \fBSyntax\fP .sp This argument has the following syntax: @@ -111,44 +51,95 @@ This subcommand has the following options: .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. .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 +.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\-\-[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\-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. +.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\-s LENGTH\fP, \fB\-\-max\-chars LENGTH\fP -The maximum size (in characters) for a 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\-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. +.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. +.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. +.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\-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. .UNINDENT .sp \fBExamples\fP @@ -161,6 +152,6 @@ $ knife deps nodes/*.json | xargs knife upload .ft P .fi .SH AUTHOR -Opscode +Chef .\" Generated by docutils manpage writer. . |