summaryrefslogtreecommitdiff
path: root/distro/common/man/man1/knife-user.1
diff options
context:
space:
mode:
authorjamescott <jamescott@opscode.com>2014-04-04 10:05:26 -0700
committerjamescott <jamescott@opscode.com>2014-04-04 10:05:31 -0700
commit204a52df8689fdc6e15d5bcc313fe079f9b775f9 (patch)
tree01212a1bb62b229bd25e8253ad49f5f966acd58e /distro/common/man/man1/knife-user.1
parentc914b9740781da98543e9b7dc345f5763bbee8d6 (diff)
downloadchef-204a52df8689fdc6e15d5bcc313fe079f9b775f9.tar.gz
update man pages for 11-12
Diffstat (limited to 'distro/common/man/man1/knife-user.1')
-rw-r--r--distro/common/man/man1/knife-user.1102
1 files changed, 79 insertions, 23 deletions
diff --git a/distro/common/man/man1/knife-user.1 b/distro/common/man/man1/knife-user.1
index 978a0e7d43..fb2508caa6 100644
--- a/distro/common/man/man1/knife-user.1
+++ b/distro/common/man/man1/knife-user.1
@@ -1,4 +1,6 @@
-.TH "KNIFE-USER" "1" "Chef 11.10.0" "" "knife user"
+.\" Man page generated from reStructuredText.
+.
+.TH "KNIFE-USER" "1" "Chef 11.12.0" "" "knife user"
.SH NAME
knife-user \- The man page for the knife user subcommand.
.
@@ -28,13 +30,15 @@ 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 user\fP subcommand is used to manage the list of users and their associated RSA public key\-pairs.
-.IP Note
-This subcommand ONLY works when run against the open source server version 10.x. This subcommand will NOT run against open source server 11, Enterprise Chef (including hosted Enterprise Chef), or Private Chef.
-.RE
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+This subcommand ONLY works when run against the open source Chef server version 10.x. This subcommand will NOT run against open source Chef server 11, Enterprise Chef (including hosted Enterprise Chef), or Private Chef\&.
+.UNINDENT
+.UNINDENT
.SH COMMON OPTIONS
.sp
The following options may be used with any of the arguments available to the \fBknife user\fP subcommand:
@@ -59,13 +63,13 @@ 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\-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\-\-[no\-]color\fP
Indicates whether colored output will be used.
@@ -74,29 +78,29 @@ Indicates whether colored output will be used.
Indicates that data will be shown after a destructive operation.
.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\-\-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.
+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.
+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
.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.
+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 Chef 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 \fB/etc/chef/client.pem\fP.
+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 \fB~/.chef/client_name.pem\fP and referenced in the knife.rb configuration file.
.UNINDENT
@@ -104,12 +108,16 @@ For Knife, the private key is typically copied to \fB~/.chef/client_name.pem\fP
\fBSyntax\fP
.sp
This argument has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
$ knife user create USER_NAME (options)
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
\fBOptions\fP
.sp
@@ -117,10 +125,10 @@ 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 Enterprise Chef.
+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\&.
.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.
+Use to save a private key to the specified file name.
.TP
.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP
The user password.
@@ -130,12 +138,16 @@ All users are assigned a public key. Use to write the public key to a file.
.UNINDENT
.sp
\fBExamples\fP
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
$ knife user create "Radio Birdman" \-f /keys/user_name
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SH DELETE
.sp
The \fBdelete\fP argument is used to delete a registered user.
@@ -143,37 +155,49 @@ The \fBdelete\fP argument is used to delete a registered user.
\fBSyntax\fP
.sp
This argument has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
$ knife user delete USER_NAME
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
\fBOptions\fP
.sp
This command does not have any specific options.
.sp
\fBExamples\fP
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
$ knife user delete "Steve Danno"
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SH EDIT
.sp
-The \fBedit\fP argument is used to edit the details of a user. When this argument is run, Knife will open $EDITOR. When finished, Knife will update the server with those changes.
+The \fBedit\fP argument is used to edit the details of a user. When this argument is run, Knife will open $EDITOR\&. When finished, Knife will update the Chef server with those changes.
.sp
\fBSyntax\fP
.sp
This argument has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
$ knife user edit USER_NAME
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
\fBOptions\fP
.sp
@@ -189,12 +213,16 @@ The \fBlist\fP argument is used to view a list of registered users.
\fBSyntax\fP
.sp
This argument has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
$ knife user list (options)
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
\fBOptions\fP
.sp
@@ -210,20 +238,28 @@ Indicates that the corresponding URIs will be shown.
None.
.SH REREGISTER
.sp
-The \fBreregister\fP argument is used to regenerate an RSA key pair for a 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.
-.IP Note
-Running this argument will invalidate the previous RSA key pair, making it unusable during authentication to the server.
-.RE
+The \fBreregister\fP argument is used to regenerate an RSA key pair for a user. The public key will be stored on the Chef server and the private key will be displayed on \fBSTDOUT\fP or written to a named file.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+Running this argument will invalidate the previous RSA key pair, making it unusable during authentication to the Chef server\&.
+.UNINDENT
+.UNINDENT
.sp
\fBSyntax\fP
.sp
This argument has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
$ knife user reregister USER_NAME (options)
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
\fBOptions\fP
.sp
@@ -231,16 +267,20 @@ This argument has the following options:
.INDENT 0.0
.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.
+Use to save a private key to the specified file name.
.UNINDENT
.sp
\fBExamples\fP
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
$ knife user reregister "Robert Younger"
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SH SHOW
.sp
The \fBshow\fP argument is used to show the details of a user.
@@ -248,12 +288,16 @@ The \fBshow\fP argument is used to show the details of a user.
\fBSyntax\fP
.sp
This argument has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
$ knife user show USER_NAME (options)
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
\fBOptions\fP
.sp
@@ -267,14 +311,20 @@ The attribute (or attributes) to show.
\fBExamples\fP
.sp
To view a user named "Dennis Teck", enter:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
$ knife user show "Dennis Teck"
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
to return something like:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
@@ -284,16 +334,22 @@ name: Dennis Teck
public_key:
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
To view information in JSON format, use the \fB\-F\fP common option as part of the command like this:
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
$ knife user show "Dennis Teck" \-F json
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
-(Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP, e.g. \fB\-F yaml\fP for YAML.)
+(Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP, e.g. \fB\-F yaml\fP for YAML\&.)
.SH AUTHOR
Chef
.\" Generated by docutils manpage writer.