diff options
Diffstat (limited to 'distro/common/man/man1/knife-user.1')
| -rw-r--r-- | distro/common/man/man1/knife-user.1 | 37 |
1 files changed, 17 insertions, 20 deletions
diff --git a/distro/common/man/man1/knife-user.1 b/distro/common/man/man1/knife-user.1 index b8fe4583f0..344fa55029 100644 --- a/distro/common/man/man1/knife-user.1 +++ b/distro/common/man/man1/knife-user.1 @@ -45,14 +45,14 @@ $ knife user [ARGUMENT] (options) .fi .SH COMMON OPTIONS .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +The following options may be used with any of the arguments available to the \fBknife user\fP subcommand: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. +.B \fB\-\-chef\-zero\-port PORT\fP +The port on which chef\-zero will listen. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP +The configuration file to use. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -66,9 +66,6 @@ The $EDITOR that is used for all interactive commands. .B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP The name of the environment. When this option is added to a command, the command will run only against the named environment. .TP -.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.TP .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP. .TP @@ -78,11 +75,8 @@ Shows help for the command. .B \fB\-k KEY\fP, \fB\-\-key KEY\fP The private key that Knife will use to sign requests made by the API client to the server. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.B \fB\-\-[no\-]color\fP +Indicates whether colored output will be used. .TP .B \fB\-\-print\-after\fP Indicates that data will be shown after a destructive operation. @@ -93,23 +87,26 @@ The URL for the server. .B \fB\-u USER\fP, \fB\-\-user USER\fP The user name used by Knife to sign requests made by the API client to the server. Authentication will fail if the user name does not match the private key. .TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client. -.TP .B \fB\-V\fP, \fB\-\-verbose\fP Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. .TP +.B \fB\-v\fP, \fB\-\-version\fP +The version of the chef\-client. +.TP .B \fB\-y\fP, \fB\-\-yes\fP Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). +.TP +.B \fB\-z\fP, \fB\-\-local\-mode\fP +Indicates that the chef\-client will be run in local mode, which allows all commands that work against the server to also work against the local chef\-repo. .UNINDENT .SH CREATE .sp The \fBcreate\fP argument is used to create a user. This process will generate an RSA key pair for the named user. The public key will be stored on the server and the private key will be displayed on \fBSTDOUT\fP or written to a named file. .INDENT 0.0 .IP \(bu 2 -For the user, the private key should be copied to the system as /etc/chef/client.pem. +For the user, the private key should be copied to the system as \fB/etc/chef/client.pem\fP. .IP \(bu 2 -For Knife, the private key is typically copied to ~/.chef/client_name.pem and referenced in the knife.rb configuration file. +For Knife, the private key is typically copied to \fB~/.chef/client_name.pem\fP and referenced in the knife.rb configuration file. .UNINDENT .sp \fBSyntax\fP @@ -128,7 +125,7 @@ This argument has the following options: .INDENT 0.0 .TP .B \fB\-a\fP, \fB\-\-admin\fP -Indicates that a client will be created as an admin client. This is required when users of the open source server need to access the Chef Server API as an administrator. This option only works when used with the open source server and will have no effect when used with Hosted Chef or Private Chef. +Indicates that a client will be created as an admin client. This is required when users of the open source server need to access the Chef Server API as an administrator. This option only works when used with the open source server and will have no effect when used with Enterprise Chef. .TP .B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP Indicates that the private key will be saved to a specified file name. @@ -312,6 +309,6 @@ $ knife user show "Dennis Teck" \-F json .sp Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP. .SH AUTHOR -Opscode +Chef .\" Generated by docutils manpage writer. . |