summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjamescott <jamescott@opscode.com>2013-10-28 15:51:02 -0700
committerjamescott <jamescott@opscode.com>2013-10-28 15:51:06 -0700
commita9d2854313b2524bddcb49227cb5a2d28728e57b (patch)
treecb3f8bf12b3625e593bbd0489f91511e7e8d8668
parent14cdc44097461eb9bd67d26bad6c83e778b84357 (diff)
downloadchef-a9d2854313b2524bddcb49227cb5a2d28728e57b.tar.gz
update man pages per CHEF-4592
-rw-r--r--distro/common/man/man1/knife-diff.13
-rw-r--r--distro/common/man/man1/knife-list.13
-rw-r--r--distro/common/man/man1/knife-upload.112
-rw-r--r--distro/common/man/man1/knife-xargs.16
4 files changed, 15 insertions, 9 deletions
diff --git a/distro/common/man/man1/knife-diff.1 b/distro/common/man/man1/knife-diff.1
index f773820286..12fcf4bbca 100644
--- a/distro/common/man/man1/knife-diff.1
+++ b/distro/common/man/man1/knife-diff.1
@@ -111,6 +111,9 @@ This subcommand has the following options:
.B \fB\-\-chef\-repo\-path PATH\fP
The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb.
.TP
+.B \fB\-\-cookbook\-version VERSION\fP
+The version of a cookbook to be downloaded.
+.TP
.B \fB\-\-concurrency\fP
The number of allowed concurrent connections. Default: \fB10\fP.
.TP
diff --git a/distro/common/man/man1/knife-list.1 b/distro/common/man/man1/knife-list.1
index 0314abef33..2788e5b903 100644
--- a/distro/common/man/man1/knife-list.1
+++ b/distro/common/man/man1/knife-list.1
@@ -108,6 +108,9 @@ $ knife list [PATTERN...] (options)
This subcommand has the following options:
.INDENT 0.0
.TP
+.B \fB\-1\fP
+Indicates that only one results column will be shown.
+.TP
.B \fB\-\-chef\-repo\-path PATH\fP
The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb.
.TP
diff --git a/distro/common/man/man1/knife-upload.1 b/distro/common/man/man1/knife-upload.1
index f7498f861c..e59f2f1c48 100644
--- a/distro/common/man/man1/knife-upload.1
+++ b/distro/common/man/man1/knife-upload.1
@@ -114,18 +114,18 @@ The path to the chef\-repo. This setting will override the default path to the c
.B \fB\-\-concurrency\fP
The number of allowed concurrent connections. Default: \fB10\fP.
.TP
-.B \fB\-\-[no\-]force\fP
-Use \fB\-\-force\fP to upload roles, cookbooks, etc. even if the file in the directory is identical (by default, no \fBPOST\fP or \fBPUT\fP is performed unless an actual change would be made). Default: \fB\-\-no\-force\fP.
-.TP
-.B \fB\-n\fP, \fB\-\-dry\-run\fP
-Indicates that no action is taken and that results are only printed out. Default: \fBfalse\fP.
-.TP
.B \fB\-\-[no\-]diff\fP
Indicates that only new and modified files will be uploaded. Set to \fBfalse\fP to upload all files. Default: \fBtrue\fP.
.TP
+.B \fB\-\-[no\-]force\fP
+Use \fB\-\-force\fP to upload roles, cookbooks, etc. even if the file in the directory is identical (by default, no \fBPOST\fP or \fBPUT\fP is performed unless an actual change would be made). Default: \fB\-\-no\-force\fP.
+.TP
.B \fB\-\-[no\-]freeze\fP
Indicates that a cookbook cannot be modified; any changes to this cookbook must be included as a new version. Only the \fB\-\-force\fP option can override this setting. Default: \fBfalse\fP.
.TP
+.B \fB\-n\fP, \fB\-\-dry\-run\fP
+Indicates that no action is taken and that results are only printed out. Default: \fBfalse\fP.
+.TP
.B \fB\-\-[no\-]purge\fP
Use \fB\-\-purge\fP to delete roles, cookbooks, etc. from the server if their corresponding files do not exist in the chef\-repo. By default, such objects are left alone and NOT purged. Default: \fB\-\-no\-purge\fP.
.TP
diff --git a/distro/common/man/man1/knife-xargs.1 b/distro/common/man/man1/knife-xargs.1
index 74f7bcaaab..23e74ead94 100644
--- a/distro/common/man/man1/knife-xargs.1
+++ b/distro/common/man/man1/knife-xargs.1
@@ -108,6 +108,9 @@ $ knife xargs [PATTERN...] (options)
This subcommand has the following options:
.INDENT 0.0
.TP
+.B \fB\-0\fP
+Indicates that a \fBNULL\fP character (\fB\e0\fP) will be used as a separator, instead of white space. Default: \fBfalse\fP.
+.TP
.B \fB\-\-chef\-repo\-path PATH\fP
The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb.
.TP
@@ -132,9 +135,6 @@ The maximum number of arguments per command line. Default: \fBnil\fP.
.B \fB\-s LENGTH\fP, \fB\-\-max\-chars LENGTH\fP
The maximum size (in characters) for a command line. Default: \fBnil\fP.
.TP
-.B \fB\-0\fP
-Indicates that a \fBNULL\fP character (\fB\e0\fP) will be used as a separator, instead of white space. Default: \fBfalse\fP.
-.TP
.B \fB\-p [PATTERN...]\fP, \fB\-\-pattern [PATTERN...]\fP
One (or more) patterns for a command line. If this option is not specified, a list of patterns may be expected on standard input. Default: \fBnil\fP.
.TP