diff options
Diffstat (limited to 'distro/common/man/man1/knife-configure.1')
| -rw-r--r-- | distro/common/man/man1/knife-configure.1 | 44 |
1 files changed, 30 insertions, 14 deletions
diff --git a/distro/common/man/man1/knife-configure.1 b/distro/common/man/man1/knife-configure.1 index 49b7f9dac5..71db9aafb6 100644 --- a/distro/common/man/man1/knife-configure.1 +++ b/distro/common/man/man1/knife-configure.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-CONFIGURE" "1" "Chef 11.10.0" "" "knife configure" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-CONFIGURE" "1" "Chef 11.12.0" "" "knife configure" .SH NAME knife-configure \- The man page for the knife configure subcommand. . @@ -28,28 +30,34 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.\" Man page generated from reStructuredText. -. .sp The \fBknife configure\fP subcommand is used to create the knife.rb and client.rb files so that they can be distributed to workstations and nodes. .sp \fBSyntax\fP .sp -This argument has the following syntax when creating a knife.rb file: +This subcommand has the following syntax when creating a knife.rb file: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife configure (options) .ft P .fi +.UNINDENT +.UNINDENT .sp and the following syntax when creating a client.rb file: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife configure client DIRECTORY .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -57,7 +65,7 @@ This subcommand has the following options: .INDENT 0.0 .TP .B \fB\-\-admin\-client\-key PATH\fP -The path to the private key used by the client, typically a file named \fBadmin.pem\fP. +The path to the private key used by the client, typically a file named \fBadmin.pem\fP\&. .TP .B \fB\-\-admin\-client\-name NAME\fP The name of the client, typically the name of the admin client. @@ -84,31 +92,31 @@ The $EDITOR that is used for all interactive commands. The name of the environment. When this option is added to a command, the command will run only against the named environment. .TP .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP -The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP. +The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&. .TP .B \fB\-h\fP, \fB\-\-help\fP Shows help for the command. .TP .B \fB\-i\fP, \fB\-\-initial\fP -Use to create a API client, typically an administrator client on a freshly\-installed server. +Use to create a API client, typically an administrator client on a freshly\-installed Chef server\&. .TP .B \fB\-k KEY\fP, \fB\-\-key KEY\fP -The private key that Knife will use to sign requests made by the API client to the server. +The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .TP .B \fB\-r REPO\fP, \fB\-\-repository REPO\fP -The path to the chef\-repo. +The path to the chef\-repo\&. .TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the server. +The URL for the Chef server\&. .TP .B \fB\-u USER\fP, \fB\-\-user USER\fP -The user name used by Knife to sign requests made by the API client to the server. Authentication will fail if the user name does not match the private key. +The user name used by Knife to sign requests made by the API client to the Chef server\&. Authentication will fail if the user name does not match the private key. .TP .B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client. +The version of the chef\-client\&. .TP .B \fB\-V\fP, \fB\-\-verbose\fP Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. @@ -117,28 +125,36 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. The name of the validation client. .TP .B \fB\-\-validation\-key PATH\fP -The path to the validation key used by the client, typically a file named \fBvalidation.pem\fP. +The path to the validation key used by the client, typically a file named \fBvalidation.pem\fP\&. .TP .B \fB\-y\fP, \fB\-\-yes\fP Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). .TP .B \fB\-z\fP, \fB\-\-local\-mode\fP -Indicates that the chef\-client will be run in local mode, which allows all commands that work against the server to also work against the local chef\-repo. +Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife configure .ft P .fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife configure client \(aq/directory\(aq .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. |