diff options
Diffstat (limited to 'distro/common/man/man1/knife-bootstrap.1')
-rw-r--r-- | distro/common/man/man1/knife-bootstrap.1 | 25 |
1 files changed, 14 insertions, 11 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 |