add knife compare to man page

1 files changed, 107 insertions, 0 deletions

diff --git a/distro/common/man/man1/knife-environment.1 b/distro/common/man/man1/knife-environment.1
index b741002c82..7d91ab7f22 100644
--- a/distro/common/man/man1/knife-environment.1
+++ b/distro/common/man/man1/knife-environment.1
@@ -90,6 +90,113 @@ Indicates that the response to all confirmation prompts will be "Yes" (and that
 .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 COMPARE
+.sp
+The \fBcompare\fP argument is used to compare the cookbook version constraints that are set on one (or more) environments.
+.sp
+\fBSyntax\fP
+.sp
+This argument has the following syntax:
+.sp
+.nf
+.ft C
+$ knife environment compare [ENVIRONMENT_NAME...] (options)
+.ft P
+.fi
+.sp
+\fBOptions\fP
+.sp
+This argument has the following options:
+.INDENT 0.0
+.TP
+.B \fB\-a\fP, \fB\-\-all\fP
+Indicates that all environments found at the specified path will be uploaded.
+.TP
+.B \fB\-m\fP, \fB\-\-mismatch\fP
+Use to show only matching versions.
+.UNINDENT
+.sp
+\fBExample\fP
+.sp
+To compare cookbook versions for a single environment:
+.sp
+.nf
+.ft C
+$ knife environment compare development
+.ft P
+.fi
+.sp
+to return something similar to:
+.sp
+.nf
+.ft C
+           development
+apache     2.3.1
+windows    4.1.2
+.ft P
+.fi
+.sp
+To compare cookbook versions for multiple environments:
+.sp
+.nf
+.ft C
+$ knife environment compare development staging
+.ft P
+.fi
+.sp
+to return something similar to:
+.sp
+.nf
+.ft C
+              development    staging
+apache        2.3.1          1.2.2
+windows       4.1.2          1.0.0
+postgresql    1.0.0          1.0.0
+.ft P
+.fi
+.sp
+To compare all cookbook versions for all environments:
+.sp
+.nf
+.ft C
+$ knife environment compare \-\-all
+.ft P
+.fi
+.sp
+to return something similar to:
+.sp
+.nf
+.ft C
+                   staging  development
+ulimit             latest   latest
+redisio            latest   latest
+journly            latest   latest
+aws                latest   latest
+test               latest   latest
+unicorn            latest   latest
+sensu              latest   latest
+runit              latest   latest
+templater          latest   latest
+powershell         latest   latest
+openssl            latest   latest
+rbenv              latest   latest
+rabbitmq           latest   latest
+postgresql         latest   latest
+mysql              latest   latest
+ohai               latest   latest
+git                latest   latest
+erlang             latest   latest
+ssh_known_hosts    latest   latest
+nginx              latest   latest
+database           latest   latest
+yum                latest   latest
+xfs                latest   latest
+apt                latest   latest
+dmg                latest   latest
+chef_handler       latest   latest
+windows            1.0.0    4.1.2
+.ft P
+.fi
 .SH CREATE
 .sp
 The \fBcreate\fP argument is used to add an environment object to the server. When this argument is run, Knife will open $EDITOR to enable editing of the \fBENVIRONMENT\fP description field (unless a description is specified as part of the command). When finished, Knife will add the environment to the server.