diff options
Diffstat (limited to 'distro/common/man/man1/knife-configure.1')
| -rw-r--r-- | distro/common/man/man1/knife-configure.1 | 83 |
1 files changed, 37 insertions, 46 deletions
diff --git a/distro/common/man/man1/knife-configure.1 b/distro/common/man/man1/knife-configure.1 index e06793e219..33feb16c0c 100644 --- a/distro/common/man/man1/knife-configure.1 +++ b/distro/common/man/man1/knife-configure.1 @@ -33,16 +33,35 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .sp The \fBknife configure\fP subcommand is used to create the knife.rb and client.rb files so that they can be distributed to workstations and nodes. .sp -\fBCommon Options\fP +\fBSyntax\fP +.sp +This argument has the following syntax: +.sp +.nf +.ft C +$ knife configure (options) +.ft P +.fi +.sp +\fBOptions\fP .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +This subcommand has the following options: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP +.B \fB\-\-admin\-client\-key PATH\fP +The path to the private key used by the client, typically a file named \fBadmin.pem\fP. +.TP +.B \fB\-\-admin\-client\-name NAME\fP +The name of the client, typically the name of the admin client. +.TP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.B \fB\-\-chef\-zero\-port PORT\fP +The port on which chef\-zero will listen. +.TP +.B \fB\-\-[no\-]color\fP +Indicates whether colored output will be used. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -56,27 +75,24 @@ The $EDITOR that is used for all interactive commands. .B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP The name of the environment. When this option is added to a command, the command will run only against the named environment. .TP -.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.TP .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP. .TP .B \fB\-h\fP, \fB\-\-help\fP Shows help for the command. .TP +.B \fB\-i\fP, \fB\-\-initial\fP +Use to create a API client, typically an administrator client on a freshly\-installed server. +.TP .B \fB\-k KEY\fP, \fB\-\-key KEY\fP The private key that Knife will use to sign requests made by the API client to the server. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. -.TP .B \fB\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .TP +.B \fB\-r REPO\fP, \fB\-\-repository REPO\fP +The path to the chef\-repo. +.TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the server. .TP @@ -89,42 +105,17 @@ The version of the chef\-client. .B \fB\-V\fP, \fB\-\-verbose\fP Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. .TP -.B \fB\-y\fP, \fB\-\-yes\fP -Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife configure (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-\-admin\-client\-name NAME\fP -The name of the client, typically the name of the admin client. -.TP -.B \fB\-\-admin\-client\-key PATH\fP -The path to the private key used by the client, typically a file named \fBadmin.pem\fP. -.TP -.B \fB\-i\fP, \fB\-\-initial\fP -Use to create a API client, typically an administrator client on a freshly\-installed server. -.TP -.B \fB\-r REPO\fP, \fB\-\-repository REPO\fP -The path to the chef\-repo. -.TP .B \fB\-\-validation\-client\-name NAME\fP The name of the validation client. .TP .B \fB\-\-validation\-key PATH\fP The path to the validation key used by the client, typically a file named \fBvalidation.pem\fP. +.TP +.B \fB\-y\fP, \fB\-\-yes\fP +Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). +.TP +.B \fB\-z\fP, \fB\-\-local\-mode\fP +Indicates that the chef\-client will be run in local mode, which allows all commands that work against the server to also work against the local chef\-repo. .UNINDENT .sp \fBExamples\fP @@ -145,6 +136,6 @@ $ knife configure client \(aq/directory\(aq .ft P .fi .SH AUTHOR -Opscode +Chef .\" Generated by docutils manpage writer. . |