summaryrefslogtreecommitdiff
path: root/distro/common/man/man1/knife-configure.1
diff options
context:
space:
mode:
authorsersut <serdar@opscode.com>2013-10-18 12:19:31 -0700
committersersut <serdar@opscode.com>2013-10-18 12:19:31 -0700
commit53502fa0e95fea9bf9040498b414bc585c3160f5 (patch)
tree3fa3a9bac5fc8fd29da171eea0f090a37a5473eb /distro/common/man/man1/knife-configure.1
parent28300f908ccc980e3ed395ea0e41f0959bdc0cc3 (diff)
downloadchef-53502fa0e95fea9bf9040498b414bc585c3160f5.tar.gz
Revert the man docs back to restore changes from James.
Diffstat (limited to 'distro/common/man/man1/knife-configure.1')
-rw-r--r--distro/common/man/man1/knife-configure.1204
1 files changed, 149 insertions, 55 deletions
diff --git a/distro/common/man/man1/knife-configure.1 b/distro/common/man/man1/knife-configure.1
index aef0507f88..8ca138f3d4 100644
--- a/distro/common/man/man1/knife-configure.1
+++ b/distro/common/man/man1/knife-configure.1
@@ -1,58 +1,152 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "KNIFE\-CONFIGURE" "1" "October 2013" "Chef 11.8.0.rc.0" "Chef Manual"
-.
-.SH "NAME"
-\fBknife\-configure\fR \- Generate configuration files for knife or Chef Client
-.
-.SH "SYNOPSIS"
-\fBknife\fR \fBconfigure\fR [client] \fI(options)\fR
-.
-.SH "DESCRIPTION"
-Generates a knife\.rb configuration file interactively\. When given the \-\-initial option, also creates a new administrative user\.
-.
-.SH "CONFIGURE SUBCOMMANDS"
-\fBknife configure\fR \fI(options)\fR
-.
+.TH "KNIFE-CONFIGURE" "1" "Chef 11.8" "" "knife configure"
+.SH NAME
+knife-configure \- The man page for the knife configure subcommand.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" 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
+\fBCommon Options\fP
+.sp
+The following options can be run with all Knife sub\-commands and plug\-ins:
+.INDENT 0.0
.TP
-\fB\-i\fR, \fB\-\-initial\fR
-Create an initial API Client
-.
+.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP
+The configuration file to use.
.TP
-\fB\-r\fR, \fB\-\-repository REPO\fR
-The path to your chef\-repo
-.
-.P
-Create a configuration file for knife\. This will prompt for values to enter into the file\. Default values are listed in square brackets if no other entry is typed\. See \fBknife\fR(1) for a description of configuration options\.
-.
-.P
-\fBknife configure client\fR \fIdirectory\fR
-.
-.P
-Read the \fIknife\.rb\fR config file and generate a config file suitable for use in \fI/etc/chef/client\.rb\fR and copy the validation certificate into the specified \fIdirectory\fR\.
-.
-.SH "EXAMPLES"
-.
-.IP "\(bu" 4
-On a freshly installed Chef Server, use \fIknife configure \-i\fR to create an administrator and knife configuration file\. Leave the field blank to accept the default value\. On most systems, the default values are acceptable\.
-.
-.IP
-user@host$ knife configure \-i Please enter the chef server URL: [http://localhost:4000] Please enter a clientname for the new client: [username] Please enter the existing admin clientname: [chef\-webui] Please enter the location of the existing admin client\'s private key: [/etc/chef/webui\.pem] Please enter the validation clientname: [chef\-validator] Please enter the location of the validation key: [/etc/chef/validation\.pem] Please enter the path to a chef repository (or leave blank): Creating initial API user\.\.\. Created (or updated) client[username] Configuration file written to /home/username/\.chef/knife\.rb
-.
-.IP
-This creates a new administrator client named \fIusername\fR, writes a configuration file to \fI/home/username/\.chef/knife\.rb\fR, and the private key to \fI/home/username/\.chef/username\.pem\fR\. The configuration file and private key may be copied to another system to facilitate administration of the Chef Server from a remote system\. Depending on the value given for the Chef Server URL, you may need to modify that setting after copying to a remote host\.
-.
-.IP "" 0
-.
-.SH "SEE ALSO"
-\fBknife\fR(1) \fBknife\-client\fR(1)
-.
-.SH "AUTHOR"
-Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\.
-.
-.SH "DOCUMENTATION"
-This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
+.B \fB\-\-color\fP
+Indicates that 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.
+.TP
+.B \fB\-\-defaults\fP
+Indicates that Knife will use the default value, instead of asking a user to provide one.
+.TP
+.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP
+The $EDITOR that is used for all interactive commands.
+.TP
+.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\-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\-s URL\fP, \fB\-\-server\-url URL\fP
+The URL for the 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.
+.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\-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.
+.UNINDENT
+.sp
+\fBExamples\fP
+.sp
+To create a knife.rb file, enter:
+.sp
+.nf
+.ft C
+$ knife configure
+.ft P
+.fi
+.sp
+To configure a client.rb, enter:
+.sp
+.nf
+.ft C
+$ knife configure client \(aq/directory\(aq
+.ft P
+.fi
+.SH AUTHOR
+Opscode
+.SH COPYRIGHT
+This work is licensed under a Creative Commons Attribution 3.0 Unported License
+.\" Generated by docutils manpage writer.
.
-.SH "CHEF"
-Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR