Skip to content

Commit 55a1109

Browse files
author
jtimberman
committed
PL-455, update the man page to reflect option changes.
1 parent 9f94b3f commit 55a1109

File tree

1 file changed

+35
-19
lines changed

1 file changed

+35
-19
lines changed

‎chef/distro/common/man/man8/knife.8‎

Lines changed: 35 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ Set the log level (debug, info, warn, error, fatal)
2929
\fB\-L\fR, \fB\-\-logfile\fR LOGLOCATION
3030
Set the log file location, defaults to STDOUT
3131
.TP
32+
\fB\-n\fR, \fB\-\-no\-editor\fR
33+
Do not open EDITOR, just accept the data as is
34+
.TP
3235
\fB\-u\fR, \fB\-\-user\fR USER
3336
API Client Username
3437
.TP
@@ -49,13 +52,12 @@ Knife sub-commands are structured as "NOUN verb NOUN (options)". The sub-command
4952
.TP
5053
Sub-commands related to working with clients, which are registered entities that access the Chef server.
5154
.TP
52-
.Bclientbulkdelete\fI(options)\fR
53-
.TP
54-
\fB\-r\fR, \fB\-\-regex\fR [REGEX]
55-
Narrow the operation via regular expression
55+
.BclientbulkdeleteREGEX\fI(options)\fR
5656
.PP
57-
Delete all the clients on the Chef server, or only certain clients based on a regular expression.
57+
Delete clients on the Chef server based on a regular expression.
5858
.PP
59+
The regular expression (REGEX) here should be in quotes, not //'s.
60+
.TP
5961
.BclientcreateCLIENT(options)
6062
.TP
6163
\fB\-f\fR, \fB\-\-file\fR FILE
@@ -95,12 +97,11 @@ Show a client.
9597
.TP
9698
Cookbooks are the fundamental unit of distribution in Chef. They encapsulate all the recipes of resources and the assets used to configure a particular aspect of the infrastructure.
9799
.PP
98-
.BcookbookbulkdeleteCOOKBOOK(options)
99-
.TP
100-
\fB\-r\fR, \fB\-\-regex\fR [REGEX]
101-
Narrow the operation via regular expression
100+
.BcookbookbulkdeleteCOOKBOOKREGEX(options)
101+
.PP
102+
Delete cookbooks based on a regular expression.
102103
.PP
103-
Delete all the cookbooks on the Chef server, or use a regular expression to only delete certain cookbooks.
104+
The regular expression (REGEX) here should be in quotes, not //'s.
104105
.PP
105106
.BcookbookdeleteCOOKBOOK(options)
106107
.PP
@@ -143,7 +144,7 @@ The platform version to see the file for
143144
.PP
144145
Show the particular part of a COOKBOOK. PART can be one of:
145146
.TP
146-
\fIattributedefinitionfileproviderreciperesourcetemplate\fR
147+
\fIattributesdefinitionsfileslibrariesprovidersrecipesresourcestemplates\fR
147148
.PP
148149
.BcookbookuploadCOOKBOOK(options)
149150
.TP
@@ -184,12 +185,11 @@ Show a specific data bag or an item in a data bag.
184185
.PP
185186
Nodes are the entities which are configured with Chef, typically servers or workstations. Nodes are registered as a client, typcially of the same name, but a single client might represent one or more nodes.
186187
.PP
187-
.Bnodebulkdelete(options)
188+
.BnodebulkdeleteREGEX(options)
188189
.TP
189-
\fB\-r\fR, \fB\-\-regex\fR [REGEX]
190-
Narrow the operation via regular expression
190+
Delete nodes based on a regular expression.
191191
.PP
192-
Delete all nodes, or only certain nodes based on a regular expression.
192+
The regular expression (REGEX) here should be in quotes, not //'s.
193193
.PP
194194
.BnodecreateNODE(options)
195195
.PP
@@ -238,12 +238,11 @@ Show a node.
238238
.PP
239239
Roles provide a mechanism to apply a set of recipes and attributes to nodes. For example, the 'webserver' role might instruct Chef to add a recipe for Apache, and specify a default domain to use.
240240
.PP
241-
.Brolebulkdelete(options)
241+
.BrolebulkdeleteREGEX(options)
242242
.TP
243-
\fB\-r\fR, \fB\-\-regex\fR [REGEX]
244-
Narrow the operation via regular expression
243+
Delete roles based on a regular expression.
245244
.PP
246-
Delete all roles, or only certain roles based on a regular expression.
245+
The regular expression (REGEX) here should be in quotes, not //'s.
247246
.PP
248247
.BrolecreateROLE(options)
249248
.TP
@@ -315,6 +314,17 @@ The order to sort the results in
315314
The row to start returning results at
316315
.PP
317316
Search indexes are a powerful feature of the Chef server and the search subcommand allows searching any of the available indexes using the SOLR query syntax.
317+
.PP
318+
.BsshQUERYCOMMAND(options)
319+
.TP
320+
\fB\-a\fR, \fB\-\-attribute\fR ATTR
321+
The attribute to use for opening the connection \- default is fqdn
322+
.TP
323+
\fB\-C\fR, \fB\-\-concurrency\fR NUM
324+
The number of concurrent connections
325+
.PP
326+
The ssh sub-command requires the net-ssh-multi Ruby library.
327+
.PP
318328
.SH CONFIGURATION
319329
The knife configuration file is a Ruby DSL. If it exists, knife uses the settings for \fBGENERALOPTIONS\fR defaults.
320330
.TP
@@ -338,6 +348,12 @@ The type of cache to use. Default is \fIBasicFile\fR. This can be any type of Ca
338348
.TP
339349
.Bcache_options
340350
Specifies various options to use for caching. Default reads the Chef client configuration (/etc/chef/checksums).
351+
.TP
352+
.Bvalidation_client_name
353+
Specifies the name of the client used to validate new clients. This is requested from the user when running the configuration sub-command.
354+
.TP
355+
.Bvalidation_key
356+
Specifies the private key file to use for generating ec2 instance data for validating new clients. This is implied from the validation_client_name.
341357
.SH FILES
342358
.PP
343359
\fI~/.chef/knife.rb\fR

0 commit comments

Comments
(0)