From 54b64d14f81cd7283016a588c2ff42ff52a65177 Mon Sep 17 00:00:00 2001
From: Flavio Poletti <flavio@polettix.it>
Date: Fri, 4 Jan 2008 10:07:45 +0000
Subject: [PATCH] Updated documentation with more examples and new options.

git-svn-id: file:///home/poletti/.svk/local/perl/deployable/trunk@1472 c4a4780d-4107-0410-9bb9-83707a6d5e2d
---
 deployable | 52 ++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 46 insertions(+), 6 deletions(-)

diff --git a/deployable b/deployable
index f2fd04b..42ab428 100755
--- a/deployable
+++ b/deployable
@@ -210,15 +210,15 @@ See version at beginning of script, variable $VERSION, or call
 
    shell$ deployable --version
 
-
 =head1 USAGE
 
    deployable [--usage] [--help] [--man] [--version]
 
-   deployable [--cleanup|-c] [--deploy|--exec-d <program>]
-              [--heredir|-H <dirname>] [--output|-o <filename>]
-              [--tarfile|-T <filename>] [--workdir|-w <path>]
-              [ files or directories... ]
+   deployable [--bundle|--all-exec|-X] [--cleanup|-c] 
+              [--deploy|--exec|d <program>] [--heredir|-H <dirname>]
+              [--output|-o <filename>] [--root|-r <dirname>]
+              [--rootdir|-R <dirname>] [--tarfile|-T <filename>]
+              [--workdir|-w <path>] [ files or directories... ]
 
   
 =head1 EXAMPLES
@@ -229,6 +229,19 @@ See version at beginning of script, variable $VERSION, or call
    # tar file will be extracted, and script.sh will be executed.
    shell$ deployable -o script.pl --exec script.sh -T distro.tar.gz
 
+   # Use a directory's contents as elements for the target root
+   shell$ ls -1 /path/to/target/root
+   etc
+   opt
+   usr
+   var
+   # The above will be deployed as /etc, /opt, /usr and /var
+   shell$ deployable -o dep.pl --root /path/to/target/root
+
+   # Include directory /path/to/etc for inclusion and extraction 
+   # directly as /etc
+   shell$ deployable -o dep.pl --rootdir /path/to/etc
+
 =head1 DESCRIPTION
 
 This is a meta-script to create deploy scripts. The latter ones are
@@ -409,6 +422,14 @@ Real-world options:
 
 =over
 
+=item B<< --bundle | --all-exec | -X >>
+
+Set bundle flag in the produced script. If the bundle flag is set, the
+I<deploy script> will treat all executables in the main deployment
+directory as scripts to be executed.
+
+By default the flag is not set.
+
 =item B<< --cleanup | -c >>
 
 Set cleanup flag in the produced script. If the cleanup flag is set, the
@@ -433,6 +454,25 @@ out on the standard output; if you provide a filename (different from
 C<->, of course!) the script will be saved there and the permissions will
 be set to 0755.
 
+=item B<< --root | -r <dirname> >>
+
+Include C<dirname> contents for deployment under root directory. The
+actual production procedure is: hop into C<dirname> and grab a tarball
+of C<.>. During deployment, hop into C</> and extract the tarball.
+
+This is useful if you're already building up the absolute deployment
+layout under a given directory: just treat that directory as if it were
+the root of the target system.
+
+=item B<< --rootdir | -R <dirname >>
+
+Include C<dirname> as a directory that will be extracted under root
+directory. The actual production procedure is: grab a tarball of
+C<dirname>. During deployment, hop into C</> and extract the tarball.
+
+This is useful if you have a directory (or a group of directories) that
+you want to deploy directly under the root.
+
 =item B<< --tarfile | -T <filename >>
 
 Set the name of a B<tar> file, see L<DESCRIPTION>. You can use this option
@@ -586,7 +626,7 @@ Flavio Poletti C<flavio [AT] polettix.it>
 
 =head1 LICENSE AND COPYRIGHT
 
-Copyright (c) 2006, Flavio Poletti C<flavio [AT] polettix.it>. All rights reserved.
+Copyright (c) 2008, Flavio Poletti C<flavio [AT] polettix.it>. All rights reserved.
 
 This script is free software; you can redistribute it and/or
 modify it under the same terms as Perl itself. See L<perlartistic>
-- 
2.11.4.GIT