diff options
author | jamescott <jscott@Ettores-MacBook-Pro.local> | 2014-07-02 12:18:07 -0700 |
---|---|---|
committer | jamescott <jscott@Ettores-MacBook-Pro.local> | 2014-07-02 12:18:11 -0700 |
commit | af305126ffa352f21d5c2520d0395474612bd16d (patch) | |
tree | d2f8204a510bbb3803d3a0af0a8010d8457cd7a7 /distro/common/man/man1 | |
parent | eb082febf2332ffea673c150a97c853408e0fa25 (diff) | |
download | chef-af305126ffa352f21d5c2520d0395474612bd16d.tar.gz |
update knife man pages; add knife serve
Diffstat (limited to 'distro/common/man/man1')
31 files changed, 510 insertions, 288 deletions
diff --git a/distro/common/man/man1/knife-bootstrap.1 b/distro/common/man/man1/knife-bootstrap.1 index b3b5c51b7a..89916e2b13 100644 --- a/distro/common/man/man1/knife-bootstrap.1 +++ b/distro/common/man/man1/knife-bootstrap.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-BOOTSTRAP" "1" "Chef 11.12.0" "" "knife bootstrap" +.TH "KNIFE-BOOTSTRAP" "1" "Chef 11.14" "" "knife bootstrap" .SH NAME knife-bootstrap \- The man page for the knife bootstrap subcommand. . @@ -55,7 +55,7 @@ This subcommand has the following options: .INDENT 0.0 .TP .B \fB\-A\fP, \fB\-\-forward\-agent\fP -Indicates that SSH agent forwarding is enabled. +Use to enable SSH agent forwarding. .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. @@ -73,7 +73,7 @@ The configuration file to use. The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-d DISTRO\fP, \fB\-\-distro DISTRO\fP .sp @@ -87,10 +87,10 @@ The default bootstrap operation uses the omnibus installer, which means the defa 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. +Use to have Knife 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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP The $EDITOR that is used for all interactive commands. @@ -132,10 +132,10 @@ The SSH port. 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\-\-prerelease\fP -Indicates that pre\-release gems should be installed. +Use to install pre\-release gems. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data 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. @@ -150,7 +150,7 @@ The encryption key that is used for values contained within a data bag item. The path to the file that contains the encryption key. .TP .B \fB\-\-sudo\fP -Indicates that a bootstrap operation should be executed using sudo\&. +Use to execute a bootstrap operation with sudo\&. .TP .B \fB\-\-template\-file TEMPLATE\fP The path to a template file that will be used during a bootstrap operation. Do not use the \fB\-\-distro\fP option when \fB\-\-template\-file\fP is specified. @@ -159,7 +159,7 @@ The path to a template file that will be used during a bootstrap operation. Do n The user name used by Knife to sign requests made by the API client to the Chef server\&. Authentication will fail if the user name does not match the private key. .TP .B \fB\-\-use\-sudo\-password\fP -Indicates that a bootstrap operation is done using sudo, with the password specified by the \fB\-P\fP (or \fB\-\-ssh\-password\fP) option. +Use to perform a bootstrap operation with sudo; specify the password with the \fB\-P\fP (or \fB\-\-ssh\-password\fP) option. .TP .B \fB\-v\fP, \fB\-\-version\fP The version of the chef\-client\&. @@ -167,14 +167,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\-V \-V\fP +Use to run the initial chef\-client run at the \fBdebug\fP log\-level (e.g. \fBchef\-client \-l debug\fP). +.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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-client.1 b/distro/common/man/man1/knife-client.1 index 738198cd60..84cde555d1 100644 --- a/distro/common/man/man1/knife-client.1 +++ b/distro/common/man/man1/knife-client.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-CLIENT" "1" "Chef 11.12.0" "" "knife client" +.TH "KNIFE-CLIENT" "1" "Chef 11.14" "" "knife client" .SH NAME knife-client \- The man page for the knife client subcommand. . @@ -52,10 +52,10 @@ The port on which chef\-zero will listen. 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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -73,10 +73,10 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data after a destructive operation. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -91,10 +91,10 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .SH BULK DELETE .sp @@ -147,15 +147,18 @@ 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 Chef server need to access the Chef Server API as an administrator. This option only works when used with the open source Chef server and will have no effect when used with Enterprise Chef\&. +Use to create a client as an admin client. This is required for any user to access Open Source Chef as an administrator. This option only works when used with the open source Chef server and will have no effect when used with Enterprise Chef\&. .TP -.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP +.B \fB\-f FILE\fP, \fB\-\-file FILE\fP Use to save a private key to the specified file name. +.TP +.B \fB\-\-validator\fP +Use to create the client as the chef\-validator\&. Default value: \fBtrue\fP\&. .UNINDENT .sp \fBExamples\fP .sp -To create a Chef Admin client with the name "exampleorg" and save its private key to a file, enter: +To create a chef\-client that can access the Chef Server API as an administrator\-\-\-sometimes referred to as an "API chef\-client"\-\-\-with the name "exampleorg" and save its private key to a file, enter: .INDENT 0.0 .INDENT 3.5 .sp @@ -274,7 +277,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-w\fP, \fB\-\-with\-uri\fP -Indicates that the corresponding URIs will be shown. +Use to show the corresponding URIs. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-configure.1 b/distro/common/man/man1/knife-configure.1 index 71db9aafb6..182deb4555 100644 --- a/distro/common/man/man1/knife-configure.1 +++ b/distro/common/man/man1/knife-configure.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-CONFIGURE" "1" "Chef 11.12.0" "" "knife configure" +.TH "KNIFE-CONFIGURE" "1" "Chef 11.14" "" "knife configure" .SH NAME knife-configure \- The man page for the knife configure subcommand. . @@ -77,13 +77,13 @@ The configuration file to use. The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP -Indicates that $EDITOR will not be opened; data will be accepted as\-is. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -104,7 +104,7 @@ Use to create a API client, typically an administrator client on a freshly\-inst The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data after a destructive operation. .TP .B \fB\-r REPO\fP, \fB\-\-repository REPO\fP The path to the chef\-repo\&. @@ -128,10 +128,10 @@ The name of the validation client. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-cookbook-site.1 b/distro/common/man/man1/knife-cookbook-site.1 index d21aae1667..08a0f4d731 100644 --- a/distro/common/man/man1/knife-cookbook-site.1 +++ b/distro/common/man/man1/knife-cookbook-site.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-COOKBOOK-SITE" "1" "Chef 11.12.0" "" "knife cookbook site" +.TH "KNIFE-COOKBOOK-SITE" "1" "Chef 11.14" "" "knife cookbook site" .SH NAME knife-cookbook-site \- The man page for the knife cookbook site subcommand. . @@ -31,9 +31,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .sp -The Cookbooks Site API is used to provide access to the cookbooks community hosted at \fI\%http://community.opscode.com/\fP\&. All of the cookbooks in the community are accessible through a REST API located at \fI\%https://cookbooks.opscode.com/api/v1/cookbooks\fP by using any of the supported endpoints. In most cases, using Knife and the \fBknife cookbook site\fP sub\-command (and any of its arguments) is the recommended method of interacting with these cookbooks, but in some cases, using the REST API directly may make sense. +The Cookbooks Site API is used to provide access to the cookbooks community hosted at \fI\%http://community.opscode.com/cookbooks\fP\&. All of the cookbooks in the community are accessible through a RESTful API located at \fI\%https://cookbooks.opscode.com/api/v1/cookbooks\fP by using any of the supported endpoints. In most cases, using Knife and the \fBknife cookbook site\fP sub\-command (and any of its arguments) is the recommended method of interacting with these cookbooks, but in some cases, using the Cookbooks Site API directly may make sense. .sp -The \fBknife cookbook site\fP subcommand is used to interact with cookbooks that are located at \fI\%http://community.opscode.com/\fP\&. A user account is required for any community actions that write data to this site. The following arguments do not require a user account: \fBdownload\fP, \fBsearch\fP, \fBinstall\fP, and \fBlist\fP\&. +The \fBknife cookbook site\fP subcommand is used to interact with cookbooks that are located at \fI\%http://community.opscode.com/cookbooks\fP\&. A user account is required for any community actions that write data to this site. The following arguments do not require a user account: \fBdownload\fP, \fBsearch\fP, \fBinstall\fP, and \fBlist\fP\&. .SH COMMON OPTIONS .sp The following options may be used with any of the arguments available to the \fBknife cookbook site\fP subcommand: @@ -46,10 +46,10 @@ The port on which chef\-zero will listen. 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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -67,10 +67,10 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data after a destructive operation. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -85,10 +85,10 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .SH DOWNLOAD .sp @@ -114,13 +114,13 @@ This argument has the following options: .INDENT 0.0 .TP .B \fBCOOKBOOK_VERSION\fP -The version of a cookbook to be downloaded. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, Knife will prompt for a version. +The version of a cookbook to be downloaded. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, the most recent version of the cookbook will be downloaded. .TP .B \fB\-f FILE\fP, \fB\-\-file FILE\fP The file to which a cookbook download is written. .TP .B \fB\-\-force\fP -Indicates that an existing directory will be overwritten. +Use to overwrite an existing directory. .UNINDENT .sp \fBExamples\fP @@ -152,7 +152,7 @@ Cookbook saved: /Users/sdanna/opscodesupport/getting\-started\-0.3.0.tar.gz .UNINDENT .SH INSTALL .sp -The \fBinstall\fP argument is used to install a cookbook that has been downloaded from the community site to a local git repository . This action uses the git version control system in conjunction with the \fI\%http://community.opscode.com/\fP site to install community\-contributed cookbooks to the local chef\-repo\&. Using this argument does the following: +The \fBinstall\fP argument is used to install a cookbook that has been downloaded from the community site to a local git repository . This action uses the git version control system in conjunction with the \fI\%http://community.opscode.com/cookbooks\fP site to install community\-contributed cookbooks to the local chef\-repo\&. Using this argument does the following: .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 @@ -161,7 +161,7 @@ A new "pristine copy" branch is created in git for tracking the upstream. .IP 2. 3 All existing versions of a cookbook are removed from the branch. .IP 3. 3 -The cookbook is downloaded from \fI\%http://community.opscode.com/\fP in the tar.gz format. +The cookbook is downloaded from \fI\%http://community.opscode.com/cookbooks\fP in the tar.gz format. .IP 4. 3 The downloaded cookbook is untarred and its contents are committed to git and a tag is created. .IP 5. 3 @@ -192,7 +192,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-b\fP, \fB\-\-use\-current\-branch\fP -Indicates that the current branch will be used. +Use to ensure that the current branch is used. .TP .B \fB\-B BRANCH\fP, \fB\-\-branch BRANCH\fP The name of the default branch. This will default to the master branch. @@ -201,7 +201,7 @@ The name of the default branch. This will default to the master branch. The version of the cookbook to be installed. If a version is not specified, the most recent version of the cookbook will be installed. .TP .B \fB\-D\fP, \fB\-\-skip\-dependencies\fP -Indicates that all cookbooks to which the installed cookbook has a dependency will not be installed. +Use to ensure that all cookbooks to which the installed cookbook has a dependency will not be installed. .TP .B \fB\-o PATH:PATH\fP, \fB\-\-cookbook\-path PATH:PATH\fP The directory in which cookbook are created. This can be a colon\-separated path. @@ -261,7 +261,7 @@ Cookbook getting\-started version 0.3.0 successfully installed .UNINDENT .SH LIST .sp -The \fBlist\fP argument is used to view a list of cookbooks that are currently available at \fI\%http://community.opscode.com/\fP\&. +The \fBlist\fP argument is used to view a list of cookbooks that are currently available at \fI\%http://community.opscode.com/cookbooks\fP\&. .sp \fBSyntax\fP .sp @@ -283,12 +283,12 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-w\fP, \fB\-\-with\-uri\fP -Indicates that the corresponding URIs will be shown. +Use to show the corresponding URIs. .UNINDENT .sp \fBExamples\fP .sp -To view a list of cookbooks at \fI\%http://community.opscode.com/\fP server, enter: +To view a list of cookbooks at \fI\%http://community.opscode.com/cookbooks\fP server, enter: .INDENT 0.0 .INDENT 3.5 .sp @@ -323,7 +323,7 @@ ant iis redmine .UNINDENT .SH SEARCH .sp -The \fBsearch\fP argument is used to search for a cookbook at \fI\%http://community.opscode.com/\fP\&. A search query is used to return a list of cookbooks at \fI\%http://community.opscode.com/\fP and uses the same syntax as the \fBknife search\fP sub\-command. +The \fBsearch\fP argument is used to search for a cookbook at \fI\%http://community.opscode.com/cookbooks\fP\&. A search query is used to return a list of cookbooks at \fI\%http://community.opscode.com/cookbooks\fP and uses the same syntax as the \fBknife search\fP sub\-command. .sp \fBSyntax\fP .sp @@ -385,7 +385,7 @@ kickstart: .UNINDENT .SH SHARE .sp -The \fBshare\fP argument is used to add a cookbook to \fI\%http://community.opscode.com/\fP\&. This action will require a user account and a certificate for \fI\%http://community.opscode.com\fP\&. By default, Knife will use the user name and API key that is identified in the configuration file used during the upload; otherwise these values must be specified on the command line or in an alternate configuration file. If a cookbook already exists on \fI\%http://community.opscode.com/\fP, then only an owner or maintainer of that cookbook can make updates. +The \fBshare\fP argument is used to add a cookbook to \fI\%http://community.opscode.com/cookbooks\fP\&. This action will require a user account and a certificate for \fI\%http://community.opscode.com\fP\&. By default, Knife will use the user name and API key that is identified in the configuration file used during the upload; otherwise these values must be specified on the command line or in an alternate configuration file. If a cookbook already exists on \fI\%http://community.opscode.com/cookbooks\fP, then only an owner or maintainer of that cookbook can make updates. .sp \fBSyntax\fP .sp @@ -407,7 +407,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fBCATEGORY\fP -The cookbook category: \fBDatabases\fP, \fBWeb Servers\fP, \fBProcess Management\fP, \fBMonitoring and Trending\fP, \fBProgramming Languages\fP, \fBPackage Management\fP, \fBApplications\fP, \fBNetworking\fP, \fBOperations Systems and Virtualization\fP, \fBUtilities\fP, or \fBOther\fP\&. +The cookbook category: \fB"Databases"\fP, \fB"Web Servers"\fP, \fB"Process Management"\fP, \fB"Monitoring & Trending"\fP, \fB"Programming Languages"\fP, \fB"Package Management"\fP, \fB"Applications"\fP, \fB"Networking"\fP, \fB"Operations Systems & Virtualization"\fP, \fB"Utilities"\fP, or \fB"Other"\fP\&. .TP .B \fB\-o PATH:PATH\fP, \fB\-\-cookbook\-path PATH:PATH\fP The directory in which cookbook are created. This can be a colon\-separated path. @@ -428,7 +428,7 @@ $ knife cookbook site share "apache2" "Web Servers" .UNINDENT .SH SHOW .sp -The \fBshow\fP argument is used to view information about a cookbook on \fI\%http://community.opscode.com/\fP\&. +The \fBshow\fP argument is used to view information about a cookbook on \fI\%http://community.opscode.com/cookbooks\fP\&. .sp \fBSyntax\fP .sp @@ -510,7 +510,7 @@ $ knife role show devops \-F json Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&. .SH UNSHARE .sp -The \fBunshare\fP argument is used to stop the sharing of a cookbook at \fI\%http://community.opscode.com/\fP\&. Only the maintainer of a cookbook may perform this action. +The \fBunshare\fP argument is used to stop the sharing of a cookbook at \fI\%http://community.opscode.com/cookbooks\fP\&. Only the maintainer of a cookbook may perform this action. .sp \fBSyntax\fP .sp diff --git a/distro/common/man/man1/knife-cookbook.1 b/distro/common/man/man1/knife-cookbook.1 index c64ac92710..4609923c33 100644 --- a/distro/common/man/man1/knife-cookbook.1 +++ b/distro/common/man/man1/knife-cookbook.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-COOKBOOK" "1" "Chef 11.12.0" "" "knife cookbook" +.TH "KNIFE-COOKBOOK" "1" "Chef 11.14" "" "knife cookbook" .SH NAME knife-cookbook \- The man page for the knife cookbook subcommand. . @@ -66,10 +66,10 @@ The port on which chef\-zero will listen. 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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -87,10 +87,10 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data after a destructive operation. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -105,10 +105,10 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .SH BULK DELETE .sp @@ -134,7 +134,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-p\fP, \fB\-\-purge\fP -Indicates that a cookbook (or cookbook version) will be removed entirely from the Chef server\&. This action should be used carefully because only one copy of any single file is stored on the Chef server\&. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged. +Use to entirely remove a cookbook (or cookbook version) from the Chef server\&. This action should be used carefully because only one copy of any single file is stored on the Chef server\&. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged. .UNINDENT .sp \fBExamples\fP @@ -270,13 +270,13 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-a\fP, \fB\-\-all\fP -Indicates that a cookbook and every version of that cookbook will be deleted. +Use to delete all cookbooks (and cookbook versions). .TP .B \fBCOOKBOOK_VERSION\fP The version of a cookbook to be deleted. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, Knife will prompt for a version. .TP .B \fB\-p\fP, \fB\-\-purge\fP -Indicates that a cookbook (or cookbook version) will be removed entirely from the Chef server\&. This action should be used carefully because only one copy of any single file is stored on the Chef server\&. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged. +Use to entirely remove a cookbook (or cookbook version) from the Chef server\&. This action should be used carefully because only one copy of any single file is stored on the Chef server\&. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged. .UNINDENT .sp \fBExamples\fP @@ -331,10 +331,10 @@ This argument has the following options: The directory into which a cookbook will be downloaded. .TP .B \fB\-f\fP, \fB\-\-force\fP -Indicates that an existing directory will be overwritten. +Use to overwrite an existing directory. .TP .B \fB\-N\fP, \fB\-\-latest\fP -Indicates that the most recent version of a cookbook will be downloaded. +Use to download the most recent version of a cookbook. .UNINDENT .sp \fBExamples\fP @@ -374,10 +374,10 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-a\fP, \fB\-\-all\fP -Indicates that all available versions of each cookbook will be returned. +Use to return all available versions for every cookbook. .TP .B \fB\-w\fP, \fB\-\-with\-uri\fP -Indicates that the corresponding URIs will be shown. +Use to show the corresponding URIs. .UNINDENT .sp \fBExamples\fP @@ -417,7 +417,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-a\fP, \fB\-\-all\fP -Indicates that metadata should be generated for all cookbooks, and not just for a specified cookbook. +Use to generate metadata for all cookbooks. .TP .B \fB\-o PATH:PATH\fP, \fB\-\-cookbook\-path PATH:PATH\fP The directory in which cookbook are created. This can be a colon\-separated path. @@ -462,7 +462,7 @@ This command does not have any specific options. .sp .nf .ft C -$ knife cookbook metadta from file /path/to/file +$ knife cookbook metadata from file /path/to/file .ft P .fi .UNINDENT @@ -509,7 +509,7 @@ The part of the cookbook to show: \fBattributes\fP, \fBdefinitions\fP, \fBfiles\ The version of the platform. .TP .B \fB\-w\fP, \fB\-\-with\-uri\fP -Indicates that the corresponding URIs will be shown. +Use to show the corresponding URIs. .UNINDENT .sp \fBExamples\fP @@ -617,7 +617,7 @@ $ knife role show devops \-F json Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&. .SH TEST .sp -The \fBtest\fP argument is used to test a cookbook for syntax errors. This argument uses Ruby syntax checking to verify every file in a cookbook that ends in .rb and Embedded Ruby (ERB)\&. +The \fBtest\fP argument is used to test a cookbook for syntax errors. This argument uses Ruby syntax checking to verify every file in a cookbook that ends in .rb and Embedded Ruby (ERB)\&. This argument will respect \&.chefignore files when determining which cookbooks to test for syntax errors. .sp \fBSyntax\fP .sp @@ -639,7 +639,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-a\fP, \fB\-\-all\fP -Indicates that all cookbooks will be tested. +Use to test all cookbooks. .TP .B \fB\-o PATH:PATH\fP, \fB\-\-cookbook\-path PATH:PATH\fP The directory in which cookbook are created. This can be a colon\-separated path. @@ -694,22 +694,22 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-a\fP, \fB\-\-all\fP -Indicates that all cookbooks will be uploaded. +Use to upload all cookbooks. .TP .B \fB\-\-concurrency\fP The number of allowed concurrent connections. Default: \fB10\fP\&. .TP .B \fB\-d\fP, \fB\-\-include\-dependencies\fP -Indicates that when a cookbook has a dependency on one (or more) cookbooks, those cookbooks will also be uploaded. +Use to ensure that when a cookbook has a dependency on one (or more) cookbooks, those cookbooks will also be uploaded. .TP .B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP Use to set the environment version dependency to the cookbook version being uploaded. .TP .B \fB\-\-force\fP -Indicates that a cookbook should be updated even if the \fB\-\-freeze\fP flag has been set. +Use to update a cookbook even if the \fB\-\-freeze\fP flag has been set. .TP .B \fB\-\-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. +Use to require changes to a cookbook be included as a new version. Only the \fB\-\-force\fP option can override this setting. .TP .B \fB\-o PATH:PATH\fP, \fB\-\-cookbook\-path PATH:PATH\fP The directory in which cookbook are created. This can be a colon\-separated path. diff --git a/distro/common/man/man1/knife-data-bag.1 b/distro/common/man/man1/knife-data-bag.1 index f0ec22f722..a756490846 100644 --- a/distro/common/man/man1/knife-data-bag.1 +++ b/distro/common/man/man1/knife-data-bag.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-DATA-BAG" "1" "Chef 11.12.0" "" "knife data bag" +.TH "KNIFE-DATA-BAG" "1" "Chef 11.14" "" "knife data bag" .SH NAME knife-data-bag \- The man page for the knife data bag subcommand. . @@ -48,10 +48,10 @@ The port on which chef\-zero will listen. 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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -69,10 +69,10 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data after a destructive operation. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -87,10 +87,10 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .SH CREATE .sp @@ -308,15 +308,15 @@ to: .UNINDENT .SH FROM FILE .sp -The \fBfrom file\fP argument is used to create a data bag on the Chef server from a file. The path to the data bag file must specify one of the following: +The \fBfrom file\fP argument is used to: .INDENT 0.0 .IP \(bu 2 -the name of a data bag +Add a data bag item to a data bag .IP \(bu 2 -a relative or absolute path to a file +Update the contents of an existing data bag item .UNINDENT .sp -If the name of a data bag is specified, Knife will search for the data bag in \fB\&./data_bags/bag_name/file\fP\&. Once opened, the JSON file should be a hash that contains at least an ID key which represents the name of the data bag item. +The data bag itself must already exist on the Chef server and must be specified as part of the command. The contents of the data bag item are specified using a JSON file. This JSON file may be located at a relative or absolute path; its location must be specified as part of the command. The JSON file that defines the contents of the data bag item must at least contain the name of the data bag item\-\-\-\fB"id": "name"\fP\&. .sp \fBWARNING:\fP .INDENT 0.0 @@ -345,7 +345,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-a\fP, \fB\-\-all\fP -Indicates that all data bags found at the specified path will be uploaded. +Use to upload all data bags found at the specified path. .TP .B \fB\-\-secret SECRET\fP The encryption key that is used for values contained within a data bag item. @@ -410,7 +410,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-w\fP, \fB\-\-with\-uri\fP -Indicates that the corresponding URIs will be shown. +Use to show the corresponding URIs. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-delete.1 b/distro/common/man/man1/knife-delete.1 index 0f3014bfa2..fa4e56266e 100644 --- a/distro/common/man/man1/knife-delete.1 +++ b/distro/common/man/man1/knife-delete.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-DELETE" "1" "Chef 11.12.0" "" "knife delete" +.TH "KNIFE-DELETE" "1" "Chef 11.14" "" "knife delete" .SH NAME knife-delete \- The man page for the knife delete subcommand. . @@ -53,7 +53,7 @@ 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\&. +Use to delete both local and remote copies of an object. Default: \fBfalse\fP\&. .TP .B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. @@ -65,16 +65,16 @@ The path to the chef\-repo\&. This setting will override the default path to the The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -92,10 +92,10 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-local\fP -Indicates that only the local copy of an object should be deleted. (The remote copy will not be deleted.) Default: \fBfalse\fP\&. +Use to delete only the local copy of an object. (A 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. +Use to show data 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\&. @@ -116,10 +116,10 @@ The version of the chef\-client\&. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .SH AUTHOR Chef diff --git a/distro/common/man/man1/knife-deps.1 b/distro/common/man/man1/knife-deps.1 index 554bdae163..3017dddc55 100644 --- a/distro/common/man/man1/knife-deps.1 +++ b/distro/common/man/man1/knife-deps.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-DEPS" "1" "Chef 11.12.0" "" "knife deps" +.TH "KNIFE-DEPS" "1" "Chef 11.14" "" "knife deps" .SH NAME knife-deps \- The man page for the knife deps subcommand. . @@ -62,16 +62,16 @@ The path to the chef\-repo\&. This setting will override the default path to the The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -89,13 +89,13 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data 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 Chef server instead of the local chef\-repo\&. Default: \fBfalse\fP\&. +Use to determine dependencies from objects located on the Chef server instead of in 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\&. @@ -104,7 +104,7 @@ The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverythi The URL for the Chef server\&. .TP .B \fB\-\-tree\fP -Indicates that dependencies are shown in a visual tree structure (including duplicates, if they exist). Default: \fBfalse\fP\&. +Use to show dependencies 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 Chef server\&. Authentication will fail if the user name does not match the private key. @@ -116,10 +116,10 @@ The version of the chef\-client\&. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-diff.1 b/distro/common/man/man1/knife-diff.1 index 42f836987d..de4f003987 100644 --- a/distro/common/man/man1/knife-diff.1 +++ b/distro/common/man/man1/knife-diff.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-DIFF" "1" "Chef 11.12.0" "" "knife diff" +.TH "KNIFE-DIFF" "1" "Chef 11.14" "" "knife diff" .SH NAME knife-diff \- The man page for the knife diff subcommand. . @@ -62,7 +62,7 @@ The path to the chef\-repo\&. This setting will override the default path to the The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-\-cookbook\-version VERSION\fP The version of a cookbook to be downloaded. @@ -71,13 +71,13 @@ The version of a cookbook to be downloaded. 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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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\&. +Use to select only files 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. @@ -95,16 +95,16 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-name\-only\fP -Indicates that only the names of modified files will be shown. +Use to show only the names of modified files. .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. +Use to show only the names of files with a status of \fBAdded\fP, \fBDeleted\fP, \fBModified\fP, or \fBType Changed\fP\&. .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. +Use to show data 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\&. @@ -122,10 +122,10 @@ The version of the chef\-client\&. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBknife.rb File Settings\fP diff --git a/distro/common/man/man1/knife-download.1 b/distro/common/man/man1/knife-download.1 index 54188b244c..3597d674d2 100644 --- a/distro/common/man/man1/knife-download.1 +++ b/distro/common/man/man1/knife-download.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-DOWNLOAD" "1" "Chef 11.12.0" "" "knife download" +.TH "KNIFE-DOWNLOAD" "1" "Chef 11.14" "" "knife download" .SH NAME knife-download \- The man page for the knife download subcommand. . @@ -62,7 +62,7 @@ The path to the chef\-repo\&. This setting will override the default path to the The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-\-concurrency\fP The number of allowed concurrent connections. Default: \fB10\fP\&. @@ -71,13 +71,13 @@ The number of allowed concurrent connections. Default: \fB10\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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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\&. +Use to download only new and modified files. 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. @@ -98,10 +98,10 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-n\fP, \fB\-\-dry\-run\fP -Indicates that no action is taken and that results are only printed out. Default: \fBfalse\fP\&. +Use to take no action and only print out results. Default: \fBfalse\fP\&. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data 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 Chef server\&. By default, if a role, cookbook, etc. does not exist on the Chef server, the local file for said role will be left alone and NOT deleted. Default: \fB\-\-no\-purge\fP\&. @@ -125,10 +125,10 @@ The version of the chef\-client\&. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-edit.1 b/distro/common/man/man1/knife-edit.1 index 1c78babbd7..438c197681 100644 --- a/distro/common/man/man1/knife-edit.1 +++ b/distro/common/man/man1/knife-edit.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-EDIT" "1" "Chef 11.12.0" "" "knife edit" +.TH "KNIFE-EDIT" "1" "Chef 11.14" "" "knife edit" .SH NAME knife-edit \- The man page for the knife edit subcommand. . @@ -62,16 +62,16 @@ The path to the chef\-repo\&. This setting will override the default path to the The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -92,7 +92,7 @@ The private key that Knife will use to sign requests made by the API client to t 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. +Use to show data 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\&. @@ -110,10 +110,10 @@ The version of the chef\-client\&. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .SH AUTHOR Chef diff --git a/distro/common/man/man1/knife-environment.1 b/distro/common/man/man1/knife-environment.1 index e392dffa1d..1415500eb4 100644 --- a/distro/common/man/man1/knife-environment.1 +++ b/distro/common/man/man1/knife-environment.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-ENVIRONMENT" "1" "Chef 11.12.0" "" "knife environment" +.TH "KNIFE-ENVIRONMENT" "1" "Chef 11.14" "" "knife environment" .SH NAME knife-environment \- The man page for the knife environment subcommand. . @@ -46,10 +46,10 @@ The port on which chef\-zero will listen. 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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -67,10 +67,10 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data after a destructive operation. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -85,10 +85,10 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .SH COMPARE .sp @@ -114,7 +114,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-a\fP, \fB\-\-all\fP -Indicates that all environments found at the specified path will be uploaded. +Use to upload all environments found at the specified path. .TP .B \fB\-m\fP, \fB\-\-mismatch\fP Use to show only matching versions. @@ -361,7 +361,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-a\fP, \fB\-\-all\fP -Indicates that all environments found at the specified path will be uploaded. +Use to upload all environments found at the specified path. .UNINDENT .sp \fBExamples\fP @@ -413,7 +413,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-w\fP, \fB\-\-with\-uri\fP -Indicates that the corresponding URIs will be shown. +Use to show the corresponding URIs. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-exec.1 b/distro/common/man/man1/knife-exec.1 index 06c8638bbe..d649e52a30 100644 --- a/distro/common/man/man1/knife-exec.1 +++ b/distro/common/man/man1/knife-exec.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-EXEC" "1" "Chef 11.12.0" "" "knife exec" +.TH "KNIFE-EXEC" "1" "Chef 11.14" "" "knife exec" .SH NAME knife-exec \- The man page for the knife exec subcommand. . @@ -162,13 +162,13 @@ The configuration file to use. The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP -Indicates that $EDITOR will not be opened; data will be accepted as\-is. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -192,7 +192,7 @@ The private key that Knife will use to sign requests made by the API client to t 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. +Use to show data after a destructive operation. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -207,10 +207,10 @@ The version of the chef\-client\&. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-index-rebuild.1 b/distro/common/man/man1/knife-index-rebuild.1 index 862f3ca9af..9fcecd9411 100644 --- a/distro/common/man/man1/knife-index-rebuild.1 +++ b/distro/common/man/man1/knife-index-rebuild.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-INDEX-REBUILD" "1" "Chef 11.12.0" "" "knife index rebuild" +.TH "KNIFE-INDEX-REBUILD" "1" "Chef 11.14" "" "knife index rebuild" .SH NAME knife-index-rebuild \- The man page for the knife index rebuild subcommand. . diff --git a/distro/common/man/man1/knife-list.1 b/distro/common/man/man1/knife-list.1 index 4a6e9daec3..e0b03e59c7 100644 --- a/distro/common/man/man1/knife-list.1 +++ b/distro/common/man/man1/knife-list.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-LIST" "1" "Chef 11.12.0" "" "knife list" +.TH "KNIFE-LIST" "1" "Chef 11.14" "" "knife list" .SH NAME knife-list \- The man page for the knife list subcommand. . @@ -53,7 +53,7 @@ This subcommand has the following options: .INDENT 0.0 .TP .B \fB\-1\fP -Indicates that only one column of results will be shown. Default: \fBfalse\fP\&. +Use to show only one column of results. Default: \fBfalse\fP\&. .TP .B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. @@ -65,19 +65,19 @@ The path to the chef\-repo\&. This setting will override the default path to the The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .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\&. +Use to prevent a directory\(aqs children from showing 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. +Use to have Knife 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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP The $EDITOR that is used for all interactive commands. @@ -98,16 +98,16 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-local\fP -Indicates that only contents of the local directory will be returned. Default: \fBfalse\fP\&. +Use to return only the contents of the local directory. Default: \fBfalse\fP\&. .TP .B \fB\-p\fP -Indicates that trailing slashes (/) will be shown for directories. Default: \fBfalse\fP\&. +Use to show directories with trailing slashes (/). Default: \fBfalse\fP\&. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data after a destructive operation. .TP .B \fB\-R\fP -Indicates that directories will be listed recursively. Default: \fBfalse\fP\&. +Use to list directories 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\&. @@ -125,10 +125,10 @@ The version of the chef\-client\&. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-node.1 b/distro/common/man/man1/knife-node.1 index 1be2e4b9a1..e78f745c2b 100644 --- a/distro/common/man/man1/knife-node.1 +++ b/distro/common/man/man1/knife-node.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-NODE" "1" "Chef 11.12.0" "" "knife node" +.TH "KNIFE-NODE" "1" "Chef 11.14" "" "knife node" .SH NAME knife-node \- The man page for the knife node subcommand. . @@ -46,10 +46,10 @@ The port on which chef\-zero will listen. 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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -67,10 +67,10 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data after a destructive operation. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -85,10 +85,10 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .SH BULK DELETE .sp @@ -363,7 +363,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-w\fP, \fB\-\-with\-uri\fP -Indicates that the corresponding URIs will be shown. +Use to show the corresponding URIs. .UNINDENT .sp \fBExamples\fP @@ -417,6 +417,9 @@ This argument has the following options: .TP .B \fB\-a ITEM\fP, \fB\-\-after ITEM\fP Use this to add the run list item after the specified run list item. +.TP +.B \fB\-b ITEM\fP, \fB\-\-before ITEM\fP +Use this to add the run list item before the specified run list item. .UNINDENT .sp \fBExamples\fP @@ -560,7 +563,7 @@ Display long output when searching nodes while using the default summary format. Display more, but not all, of a node\(aqs data when searching using the default summary format. .TP .B \fB\-r\fP, \fB\-\-run\-list\fP -Indicates that only the run\-list will be shown. +Use to show only the run\-list. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-raw.1 b/distro/common/man/man1/knife-raw.1 index 533b0e1bde..412faf42da 100644 --- a/distro/common/man/man1/knife-raw.1 +++ b/distro/common/man/man1/knife-raw.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-RAW" "1" "Chef 11.12.0" "" "knife raw" +.TH "KNIFE-RAW" "1" "Chef 11.14" "" "knife raw" .SH NAME knife-raw \- The man page for the knife raw subcommand. . @@ -59,13 +59,13 @@ The configuration file to use. The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP -Indicates that $EDITOR will not be opened; data will be accepted as\-is. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -92,7 +92,7 @@ The request method: \fBDELETE\fP, \fBGET\fP, \fBPOST\fP, or \fBPUT\fP\&. Default 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. +Use to show data after a destructive operation. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -107,10 +107,10 @@ The version of the chef\-client\&. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-recipe-list.1 b/distro/common/man/man1/knife-recipe-list.1 index 806fb40a86..2cad6dcea1 100644 --- a/distro/common/man/man1/knife-recipe-list.1 +++ b/distro/common/man/man1/knife-recipe-list.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-RECIPE-LIST" "1" "Chef 11.12.0" "" "knife recipe list" +.TH "KNIFE-RECIPE-LIST" "1" "Chef 11.14" "" "knife recipe list" .SH NAME knife-recipe-list \- The man page for the knife recipe list subcommand. . diff --git a/distro/common/man/man1/knife-role.1 b/distro/common/man/man1/knife-role.1 index 597d57a94e..0f29eec795 100644 --- a/distro/common/man/man1/knife-role.1 +++ b/distro/common/man/man1/knife-role.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-ROLE" "1" "Chef 11.12.0" "" "knife role" +.TH "KNIFE-ROLE" "1" "Chef 11.14" "" "knife role" .SH NAME knife-role \- The man page for the knife role subcommand. . @@ -46,10 +46,10 @@ The port on which chef\-zero will listen. 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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -67,10 +67,10 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data after a destructive operation. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -85,10 +85,10 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .SH BULK DELETE .sp @@ -348,7 +348,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-w\fP, \fB\-\-with\-uri\fP -Indicates that the corresponding URIs will be shown. +Use to show the corresponding URIs. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-search.1 b/distro/common/man/man1/knife-search.1 index f2e3449906..b30ec5bf8f 100644 --- a/distro/common/man/man1/knife-search.1 +++ b/distro/common/man/man1/knife-search.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-SEARCH" "1" "Chef 11.12.0" "" "knife search" +.TH "KNIFE-SEARCH" "1" "Chef 11.14" "" "knife search" .SH NAME knife-search \- The man page for the knife search subcommand. . @@ -138,13 +138,13 @@ The configuration file to use. The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP -Indicates that $EDITOR will not be opened; data will be accepted as\-is. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -159,7 +159,7 @@ The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, Shows help for the command. .TP .B \fB\-i\fP, \fB\-\-id\-only\fP -Indicates that only matching object IDs will be shown. +Use to show only matching object IDs. .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\&. @@ -177,13 +177,13 @@ Display more, but not all, of a node\(aqs data when searching using the default 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. +Use to show data 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 .B \fB\-r\fP, \fB\-\-run\-list\fP -Indicates that only the run\-list will be shown. +Use to show only the run\-list. .TP .B \fB\-R INT\fP, \fB\-\-rows INT\fP The number of rows to be returned. @@ -204,10 +204,10 @@ The version of the chef\-client\&. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-serve.1 b/distro/common/man/man1/knife-serve.1 new file mode 100644 index 0000000000..26341cbeed --- /dev/null +++ b/distro/common/man/man1/knife-serve.1 @@ -0,0 +1,109 @@ +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-SERVE" "1" "Chef 11.14.0" "" "knife serve" +.SH NAME +knife-serve \- The man page for the knife serve subcommand. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +The \fBknife serve\fP subcommand is used to run a persistent chef\-zero against the local chef\-repo\&. (chef\-zero is a lightweight Chef server that runs in\-memory on the local machine.) This is the same as running the chef\-client executable with the \fB\-\-local\-mode\fP option. The \fBchef_repo_path\fP is located automatically and the Chef server will bind to port \fB8900\fP by default. \fBknife serve\fP will print the URL for the local Chef server, so that it may be added to the knife.rb file. +.sp +\fBSyntax\fP +.sp +This subcommand has the following syntax: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ knife serve (options) +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBOptions\fP +.sp +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\-d\fP, \fB\-\-disable\-editing\fP +Use to prevent the $EDITOR from being opened and to accept data as\-is. +.TP +.B \fB\-\-defaults\fP +Use to have Knife 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\-k KEY\fP, \fB\-\-key KEY\fP +The private key that Knife will use to sign requests made by the API client to the Chef server\&. +.TP +.B \fB\-\-[no\-]color\fP +Use to view colored output. +.TP +.B \fB\-\-print\-after\fP +Use to show data after a destructive operation. +.TP +.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP +The URL for the Chef server\&. +.TP +.B \fB\-u USER\fP, \fB\-\-user USER\fP +The user name used by Knife to sign requests made by the API client to the Chef server\&. Authentication will fail if the user name does not match the private key. +.TP +.B \fB\-v\fP, \fB\-\-version\fP +The version of the chef\-client\&. +.TP +.B \fB\-V\fP, \fB\-\-verbose\fP +Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. +.TP +.B \fB\-y\fP, \fB\-\-yes\fP +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. +.TP +.B \fB\-z\fP, \fB\-\-local\-mode\fP +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. +.UNINDENT +.SH AUTHOR +Chef +.\" Generated by docutils manpage writer. +. diff --git a/distro/common/man/man1/knife-show.1 b/distro/common/man/man1/knife-show.1 index 5e77cf2f39..e3867989a3 100644 --- a/distro/common/man/man1/knife-show.1 +++ b/distro/common/man/man1/knife-show.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-SHOW" "1" "Chef 11.12.0" "" "knife show" +.TH "KNIFE-SHOW" "1" "Chef 11.14" "" "knife show" .SH NAME knife-show \- The man page for the knife show subcommand. . @@ -65,16 +65,16 @@ The path to the chef\-repo\&. This setting will override the default path to the The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -92,10 +92,10 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-local\fP -Indicates that instead of remote files, local files will be shown. +Use to show local files instead of remote files. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data 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\&. @@ -113,10 +113,10 @@ The version of the chef\-client\&. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-ssh.1 b/distro/common/man/man1/knife-ssh.1 index 6f42870aef..427dfaef78 100644 --- a/distro/common/man/man1/knife-ssh.1 +++ b/distro/common/man/man1/knife-ssh.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-SSH" "1" "Chef 11.12.0" "" "knife ssh" +.TH "KNIFE-SSH" "1" "Chef 11.14" "" "knife ssh" .SH NAME knife-ssh \- The man page for the knife ssh subcommand. . @@ -56,7 +56,7 @@ This subcommand has the following options: 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. +Use to enable SSH agent forwarding. .TP .B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. @@ -68,13 +68,13 @@ The number of allowed concurrent connections. The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP -Indicates that $EDITOR will not be opened; data will be accepted as\-is. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -98,7 +98,7 @@ The SSH identity file used for authentication. Key\-based authentication is reco The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-m\fP, \fB\-\-manual\-list\fP -Indicates that a search query is a space\-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: \fB\-\-manual\-list "server01 server 02 server 03"\fP +Use to define a search query as a space\-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: \fB\-\-manual\-list "server01 server 02 server 03"\fP .TP .B \fB\-\-[no\-]host\-key\-verify\fP Use \fB\-\-no\-host\-key\-verify\fP to disable host key verification. Default setting: \fB\-\-host\-key\-verify\fP\&. @@ -113,7 +113,7 @@ The SSH port. 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. +Use to show data after a destructive operation. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -137,10 +137,10 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-ssl-check.1 b/distro/common/man/man1/knife-ssl-check.1 index 3fa9b3c437..4645febaef 100644 --- a/distro/common/man/man1/knife-ssl-check.1 +++ b/distro/common/man/man1/knife-ssl-check.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-SSL-CHECK" "1" "Chef 11.12.0" "" "knife ssl check" +.TH "KNIFE-SSL-CHECK" "1" "Chef 11.14" "" "knife ssl check" .SH NAME knife-ssl-check \- The man page for the knife ssl check subcommand. . @@ -63,7 +63,7 @@ This subcommand has the following options: 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. +Use to enable SSH agent forwarding. .TP .B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. @@ -75,13 +75,13 @@ The number of allowed concurrent connections. The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP -Indicates that $EDITOR will not be opened; data will be accepted as\-is. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -105,7 +105,7 @@ The SSH identity file used for authentication. Key\-based authentication is reco The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-m\fP, \fB\-\-manual\-list\fP -Indicates that a search query is a space\-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: \fB\-\-manual\-list "server01 server 02 server 03"\fP +Use to define a search query as a space\-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: \fB\-\-manual\-list "server01 server 02 server 03"\fP .TP .B \fB\-\-[no\-]host\-key\-verify\fP Use \fB\-\-no\-host\-key\-verify\fP to disable host key verification. Default setting: \fB\-\-host\-key\-verify\fP\&. @@ -120,7 +120,7 @@ The SSH port. 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. +Use to show data after a destructive operation. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -144,10 +144,10 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-ssl-fetch.1 b/distro/common/man/man1/knife-ssl-fetch.1 index 59db68881a..6d5a9f4f46 100644 --- a/distro/common/man/man1/knife-ssl-fetch.1 +++ b/distro/common/man/man1/knife-ssl-fetch.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-SSL-FETCH" "1" "Chef 11.12.0" "" "knife ssl fetch" +.TH "KNIFE-SSL-FETCH" "1" "Chef 11.14" "" "knife ssl fetch" .SH NAME knife-ssl-fetch \- The man page for the knife ssl fetch subcommand. . @@ -48,7 +48,7 @@ This subcommand has the following syntax: .sp .nf .ft C -$ knife ssh SEARCH_QUERY SSH_COMMAND (options) +$ knife ssl fetch URI_FOR_HTTPS_SERVER .ft P .fi .UNINDENT @@ -63,7 +63,7 @@ This subcommand has the following options: 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. +Use to enable SSH agent forwarding. .TP .B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. @@ -75,13 +75,13 @@ The number of allowed concurrent connections. The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP -Indicates that $EDITOR will not be opened; data will be accepted as\-is. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -105,7 +105,7 @@ The SSH identity file used for authentication. Key\-based authentication is reco The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-m\fP, \fB\-\-manual\-list\fP -Indicates that a search query is a space\-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: \fB\-\-manual\-list "server01 server 02 server 03"\fP +Use to define a search query as a space\-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: \fB\-\-manual\-list "server01 server 02 server 03"\fP .TP .B \fB\-\-[no\-]host\-key\-verify\fP Use \fB\-\-no\-host\-key\-verify\fP to disable host key verification. Default setting: \fB\-\-host\-key\-verify\fP\&. @@ -120,7 +120,7 @@ The SSH port. 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. +Use to show data after a destructive operation. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -144,10 +144,10 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-status.1 b/distro/common/man/man1/knife-status.1 index dd6b1187f7..1c3cf8e4e9 100644 --- a/distro/common/man/man1/knife-status.1 +++ b/distro/common/man/man1/knife-status.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-STATUS" "1" "Chef 11.12.0" "" "knife status" +.TH "KNIFE-STATUS" "1" "Chef 11.14" "" "knife status" .SH NAME knife-status \- The man page for the knife status subcommand. . @@ -59,13 +59,13 @@ The configuration file to use. The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP -Indicates that $EDITOR will not be opened; data will be accepted as\-is. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -80,13 +80,13 @@ The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\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. +Use to hide nodes on which a chef\-client run has occurred within the previous hour. .TP .B \fB\-k KEY\fP, \fB\-\-key KEY\fP The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data after a destructive operation. .TP .B \fBSEARCH_QUERY\fP The search query used to identify a a list of items on a Chef server\&. This option uses the same syntax as the \fBsearch\fP sub\-command. @@ -95,7 +95,7 @@ The search query used to identify a a list of items on a Chef server\&. This opt 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. +Use to sort a list by last run time, descending. .TP .B \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -110,10 +110,10 @@ The version of the chef\-client\&. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-tag.1 b/distro/common/man/man1/knife-tag.1 index 6502f81a57..0d2347b812 100644 --- a/distro/common/man/man1/knife-tag.1 +++ b/distro/common/man/man1/knife-tag.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-TAG" "1" "Chef 11.12.0" "" "knife tag" +.TH "KNIFE-TAG" "1" "Chef 11.14" "" "knife tag" .SH NAME knife-tag \- The man page for the knife tag subcommand. . @@ -46,10 +46,10 @@ The port on which chef\-zero will listen. 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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -67,10 +67,10 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data after a destructive operation. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -85,10 +85,10 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .SH CREATE .sp diff --git a/distro/common/man/man1/knife-upload.1 b/distro/common/man/man1/knife-upload.1 index dcbca4f02e..52b392e761 100644 --- a/distro/common/man/man1/knife-upload.1 +++ b/distro/common/man/man1/knife-upload.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-UPLOAD" "1" "Chef 11.12.0" "" "knife upload" +.TH "KNIFE-UPLOAD" "1" "Chef 11.14" "" "knife upload" .SH NAME knife-upload \- The man page for the knife upload subcommand. . @@ -62,19 +62,19 @@ The path to the chef\-repo\&. This setting will override the default path to the The port on which chef\-zero will listen. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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\&. +Use to upload only new and modified files. 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. @@ -89,7 +89,7 @@ The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\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\&. +Use to require changes to a cookbook 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. @@ -98,10 +98,10 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-n\fP, \fB\-\-dry\-run\fP -Indicates that no action is taken and that results are only printed out. Default: \fBfalse\fP\&. +Use to take no action and only print out results. Default: \fBfalse\fP\&. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data after a destructive operation. .TP .B \fB\-\-[no\-]purge\fP Use \fB\-\-purge\fP to delete roles, cookbooks, etc. from the Chef server if their corresponding files do not exist in the chef\-repo\&. By default, such objects are left alone and NOT purged. Default: \fB\-\-no\-purge\fP\&. @@ -125,10 +125,10 @@ The version of the chef\-client\&. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-user.1 b/distro/common/man/man1/knife-user.1 index fb2508caa6..aad73d1d96 100644 --- a/distro/common/man/man1/knife-user.1 +++ b/distro/common/man/man1/knife-user.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-USER" "1" "Chef 11.12.0" "" "knife user" +.TH "KNIFE-USER" "1" "Chef 11.14" "" "knife user" .SH NAME knife-user \- The man page for the knife user subcommand. . @@ -51,10 +51,10 @@ The port on which chef\-zero will listen. 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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -72,10 +72,10 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data after a destructive operation. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -90,10 +90,10 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .SH CREATE .sp @@ -125,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 Chef server need to access the Chef Server API as an administrator. This option only works when used with the open source Chef server and will have no effect when used with Enterprise Chef\&. +Use to create a client as an admin client. This is required for any user to access Open Source Chef as an administrator. This option only works when used with the open source Chef server and will have no effect when used with Enterprise Chef\&. .TP .B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP Use to save a private key to the specified file name. @@ -230,7 +230,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-w\fP, \fB\-\-with\-uri\fP -Indicates that the corresponding URIs will be shown. +Use to show the corresponding URIs. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-xargs.1 b/distro/common/man/man1/knife-xargs.1 index 82e3981471..245aa346ff 100644 --- a/distro/common/man/man1/knife-xargs.1 +++ b/distro/common/man/man1/knife-xargs.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-XARGS" "1" "Chef 11.12.0" "" "knife xargs" +.TH "KNIFE-XARGS" "1" "Chef 11.14" "" "knife xargs" .SH NAME knife-xargs \- The man page for the knife xargs subcommand. . @@ -101,10 +101,10 @@ The configuration file to use. 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. +Use to prevent the $EDITOR from being opened and to accept data as\-is. .TP .B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. +Use to have Knife 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. @@ -122,10 +122,10 @@ Shows help for the command. The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-[no\-]color\fP -Indicates whether colored output will be used. +Use to view colored output. .TP .B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. +Use to show data after a destructive operation. .TP .B \fB\-\-server\-url URL\fP The URL for the Chef server\&. @@ -140,10 +140,10 @@ The version of the chef\-client\&. 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). +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife.1 b/distro/common/man/man1/knife.1 index 7e20d8a4c9..ed29b7a6a3 100644 --- a/distro/common/man/man1/knife.1 +++ b/distro/common/man/man1/knife.1 @@ -1,4 +1,6 @@ -.TH "KNIFE" "1" "Chef 11.8.0" "" "knife" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE" "1" "Chef 11.14" "" "knife" .SH NAME knife \- The man page for the knife command line tool. . @@ -28,10 +30,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.\" Man page generated from reStructuredText. -. .sp -Knife is a command\-line tool that provides an interface between a local chef\-repo and the server. Knife helps users to manage: +Knife is a command\-line tool that provides an interface between a local chef\-repo and the Chef server\&. Knife helps users to manage: .INDENT 0.0 .IP \(bu 2 Nodes @@ -48,7 +48,7 @@ Cloud resources, including provisioning .IP \(bu 2 The installation of the chef\-client on management workstations .IP \(bu 2 -Searching of indexed data on the server +Searching of indexed data on the Chef server .UNINDENT .sp Knife subcommands: @@ -108,21 +108,83 @@ knife xargs .UNINDENT .SH WORKING WITH KNIFE .sp -Knife runs from a management workstation and sits in\-between a server and an organization\(aqs infrastructure. Knife interacts with a server by using the same REST API that is used by a chef\-client. Role\-based authentication controls (RBAC) can be used to authorize changes when Knife is run with Hosted Chef or Private Chef. Knife is configured during workstation setup, but subsequent modifications can be made using the knife.rb configuration file. +Knife runs from a management workstation and sits in\-between a Chef server and an organization\(aqs infrastructure. Knife interacts with a Chef server by using the same REST API that is used by a chef\-client\&. Role\-based authentication controls (RBAC) can be used to authorize changes when Knife is run with Enterprise Chef\&. Knife is configured during workstation setup, but subsequent modifications can be made using the knife.rb configuration file. +.SS Common Options +.sp +The following options can be run with all Knife sub\-commands and plug\-ins: +.INDENT 0.0 +.TP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP +The configuration file to use. For example, when Knife is run from a node that is configured to be managed by the Chef server, this option is used to allow Knife to use the same credentials as the chef\-client when communicating with the Chef server\&. +.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 +Use to prevent the $EDITOR from being opened and to accept data as\-is. +.TP +.B \fB\-\-defaults\fP +Use to have Knife 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. This option is ignored during search queries made using the \fBknife search\fP subcommand. +.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 Chef server\&. +.TP +.B \fB\-\-[no\-]color\fP +Use to view colored output. +.TP +.B \fB\-\-print\-after\fP +Use to show data after a destructive operation. +.TP +.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP +The URL for the Chef server\&. +.TP +.B \fB\-u USER\fP, \fB\-\-user USER\fP +The user name used by Knife to sign requests made by the API client to the Chef server\&. Authentication will fail if the user name does not match the private key. +.TP +.B \fB\-v\fP, \fB\-\-version\fP +The version of the chef\-client\&. +.TP +.B \fB\-V\fP, \fB\-\-verbose\fP +Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. +.TP +.B \fB\-y\fP, \fB\-\-yes\fP +Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation. +.TP +.B \fB\-z\fP, \fB\-\-local\-mode\fP +Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. +.UNINDENT .SS JSON Data Format .sp -Most data is entered using a text editor in JSON format, unless the \fB\-\-disable\-editing\fP option is entered as part of a command. (Encrypted data bags use YAML, which is a superset of JSON.) JSON is a common, language\-independent data format that provides a simple text representation of arbitrary data structures. For more information about JSON, see \fI\%http://www.json.org/\fP or \fI\%http://en.wikipedia.org/wiki/JSON\fP. +Most data is entered using a text editor in JSON format, unless the \fB\-\-disable\-editing\fP option is entered as part of a command. (Encrypted data bags use YAML, which is a superset of JSON\&.) JSON is a common, language\-independent data format that provides a simple text representation of arbitrary data structures. For more information about JSON, see \fI\%http://www.json.org/\fP or \fI\%http://en.wikipedia.org/wiki/JSON\fP\&. .SS Set the Text Editor .sp Some Knife commands, such as \fBknife data bag edit\fP, require that information be edited as JSON data using a text editor. For example, the following command: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife data bag edit admins admin_name .ft P .fi +.UNINDENT +.UNINDENT .sp will open up the text editor with data similar to: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -131,8 +193,12 @@ will open up the text editor with data similar to: } .ft P .fi +.UNINDENT +.UNINDENT .sp Changes to that file can then be made: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -142,62 +208,92 @@ Changes to that file can then be made: } .ft P .fi +.UNINDENT +.UNINDENT .sp The type of text editor that is used by Knife can be configured by adding an entry to the knife.rb file or by setting an \fBEDITOR\fP environment variable. For example, to configure the text editor to always open with vim, add the following to the knife.rb file: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C knife[:editor] = "/usr/bin/vim" .ft P .fi +.UNINDENT +.UNINDENT .sp When a Microsoft Windows file path is enclosed in a double\-quoted string (" "), the same backslash character (\fB\e\fP) that is used to define the file path separator is also used in Ruby to define an escape character. The knife.rb file is a Ruby file; therefore, file path separators must be escaped. In addition, spaces in the file path must be replaced with \fB~1\fP so that the length of each section within the file path is not more than 8 characters. For example, if EditPad Pro is the text editor of choice and is located at the following path: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C C:\e\eProgram Files (x86)\eEditPad Pro\eEditPad.exe .ft P .fi +.UNINDENT +.UNINDENT .sp the setting in the knife.rb file would be similar to: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C knife[:editor] = "C:\e\eProgra~1\e\eEditPa~1\e\eEditPad.exe" .ft P .fi +.UNINDENT +.UNINDENT .sp One approach to working around the double\- vs. single\-quote issue is to put the single\-quotes outside of the double\-quotes. For example, for Notepad++: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C knife[:editor] = \(aq"C:\eProgram Files (x86)\eNotepad++\enotepad++.exe \-nosession \-multiInst"\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp for Sublime Text: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C knife[:editor] = \(aq"C:\eProgram Files\eSublime Text 2\esublime_text.exe \-\-wait"\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp for TextPad: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C knife[:editor] = \(aq"C:\eProgram Files (x86)\eTextPad 7\eTextPad.exe"\(aq .ft P .fi +.UNINDENT +.UNINDENT .sp and for vim: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C knife[:editor] = \(aq"C:\eProgram Files (x86)\evim\evim74\egvim.exe"\(aq .ft P .fi +.UNINDENT +.UNINDENT .SS Using Quotes .sp Values can be entered with double quotes (" ") or single quotes (\(aq \(aq), but this should be done consistently. @@ -205,10 +301,14 @@ Values can be entered with double quotes (" ") or single quotes (\(aq \(aq), but .sp Knife comes with a collection of built in subcommands that work together to provide all of the functionality required to take specific actions against any object in an organization, including cookbooks, nodes, roles, data bags, environments, and users. A Knife plugin extends the functionality beyond built\-in subcommands. .sp -Knife has the following subcommands: \fBbootstrap\fP, \fBclient\fP, \fBconfigure\fP, \fBcookbook\fP, \fBcookbook site\fP, \fBdata bag\fP, \fBdelete\fP, \fBdeps\fP, \fBdiff\fP, \fBdownload\fP, \fBedit\fP, \fBenvironment\fP, \fBexec\fP, \fBindex rebuild\fP, \fBlist\fP, \fBnode\fP, \fBrecipe list\fP, \fBrole\fP, \fBsearch\fP, \fBshow\fP, \fBssh\fP, \fBstatus\fP, \fBtag\fP, \fBupload\fP, \fBuser\fP, and \fBxargs\fP. -.IP Note -The following subcommands run only against the open source server: \fBindex rebuild\fP and \fBuser\fP. -.RE +Knife has the following subcommands: \fBbootstrap\fP, \fBclient\fP, \fBconfigure\fP, \fBcookbook\fP, \fBcookbook site\fP, \fBdata bag\fP, \fBdelete\fP, \fBdeps\fP, \fBdiff\fP, \fBdownload\fP, \fBedit\fP, \fBenvironment\fP, \fBexec\fP, \fBindex rebuild\fP, \fBlist\fP, \fBnode\fP, \fBrecipe list\fP, \fBrole\fP, \fBsearch\fP, \fBshow\fP, \fBssh\fP, \fBstatus\fP, \fBtag\fP, \fBupload\fP, \fBuser\fP, and \fBxargs\fP\&. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +The following subcommands run only against the open source Chef server: \fBindex rebuild\fP and \fBuser\fP\&. +.UNINDENT +.UNINDENT .SS Syntax .sp All Knife subcommands have the following syntax: @@ -219,10 +319,14 @@ knife subcommand [ARGUMENT] (options) .UNINDENT .sp Each subcommand has its own set of arguments and options. -.IP Note +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 All syntax examples in this document show variables in ALL_CAPS. For example \fB\-u PORT_LIST\fP (where PORT_LIST is a comma\-separated list of local and public UDP ports) or \fB\-F FORMAT\fP (where FORMAT determines the output format, either \fBsummary\fP, \fBtext\fP, \fBjson\fP, \fByaml\fP, or \fBpp\fP). These variables often require specific values that are unique to each organization. -.RE +.UNINDENT +.UNINDENT .SH AUTHOR -Opscode +Chef .\" Generated by docutils manpage writer. . |