Permalink
Browse files

added USAGE section to docs

  • Loading branch information...
1 parent 824d1f1 commit 2ed4c255602c261f461a5916e37322d279796638 @xdg xdg committed Jan 13, 2012
Showing with 62 additions and 5 deletions.
  1. +1 −1 META.json
  2. +30 −2 README.pod
  3. +1 −0 dist.ini
  4. +1 −1 lib/Pantry.pm
  5. +29 −1 pod/bin/pantry
View
@@ -1,5 +1,5 @@
{
- "abstract" : "Manage resources for chef-solo",
+ "abstract" : "Configuration management tool for chef-solo",
"author" : [
"David Golden <dagolden@cpan.org>"
],
View
@@ -1,6 +1,6 @@
=head1 NAME
-Pantry - Manage resources for chef-solo
+Pantry - Configuration management tool for chef-solo
=head1 VERSION
@@ -26,7 +26,35 @@ L<chef-solo|http://wiki.opscode.com/display/chef/Chef+Solo>
=head1 USAGE
-(To be written...)
+Arguments to the C<pantry> command line tool follow a regular structure:
+
+ $ pantry VERB [[NOUN] [ARGUMENTS...]]
+
+See the following sections for details and examples by topic.
+
+=head2 Pantry setup
+
+ $ pantry init
+
+This initializes a pantry in the current directory. Currently, it just
+creates some directories for use storing cookbooks, node data, etc.
+
+=head2 Managing nodes
+
+ $ pantry create node NAME
+
+Creates a node configuration file for the given C<NAME>. The C<NAME>
+must be a valid DNS name or IP address.
+
+ $ pantry edit node NAME
+
+Invokes the editor given by the environment variable C<EDITOR> on
+the configuration file for the C<name> node.
+
+ $ pantry sync node NAME
+
+Copies cookbooks and configuration data to the C<NAME> node and invokes
+C<chef-solo> via C<ssh> to start a configuration run.
=head1 AUTHENTICATION
View
@@ -20,6 +20,7 @@ stopwords = OpenSSH
stopwords = littlechef
stopwords = subshell
stopwords = wildcard
+stopwords = DNS
[@Filter]
-bundle = @DAGOLDEN
View
@@ -2,7 +2,7 @@ use v5.14;
use warnings;
package Pantry;
-# ABSTRACT: Manage resources for chef-solo
+# ABSTRACT: Configuration management tool for chef-solo
# VERSION
# This file is a namespace placeholder and gives a default place to find
View
@@ -18,7 +18,35 @@ L<chef-solo|http://wiki.opscode.com/display/chef/Chef+Solo>
=head1 USAGE
-(To be written...)
+Arguments to the C<pantry> command line tool follow a regular structure:
+
+ $ pantry VERB [[NOUN] [ARGUMENTS...]]
+
+See the following sections for details and examples by topic.
+
+=head2 Pantry setup
+
+ $ pantry init
+
+This initializes a pantry in the current directory. Currently, it just
+creates some directories for use storing cookbooks, node data, etc.
+
+=head2 Managing nodes
+
+ $ pantry create node NAME
+
+Creates a node configuration file for the given C<NAME>. The C<NAME>
+must be a valid DNS name or IP address.
+
+ $ pantry edit node NAME
+
+Invokes the editor given by the environment variable C<EDITOR> on
+the configuration file for the C<name> node.
+
+ $ pantry sync node NAME
+
+Copies cookbooks and configuration data to the C<NAME> node and invokes
+C<chef-solo> via C<ssh> to start a configuration run.
=head1 AUTHENTICATION

0 comments on commit 2ed4c25

Please sign in to comment.