Added documentation about pack command
[p5sagit/App-FatPacker.git] / bin / fatpack
index 3e6cc93..c6d7235 100755 (executable)
@@ -8,6 +8,15 @@ fatpack - Command line frontend for App::FatPacker
 
 =head1 COMMANDS
 
+=head2 pack
+
+  $ fatpack pack myscript.pl > myscript.packed.pl
+
+A shortcut to do all the work of tracing, collecting packlists,
+extracting modules in fatlib, then concatinating into a packed script
+- in one shot. If you need more detailed controls for additional
+modules, use the following commands separately (see L</RECIPES>).
+
 =head2 trace
 
   $ fatpack trace [--to=trace-file|--to-stderr] [--use=MODULE]
@@ -67,6 +76,9 @@ Current basic recipe for packing:
   $ fatpack tree `cat packlists`
   $ (head -n1 myscript.pl |grep '^#!'; fatpack file; cat myscript.pl) >myscript.packed.pl
 
+The C<head -n1 myscript.pl |grep '^#!'> code pulls out the Unix shebang
+line, if there is one, and injects it at the start of the packed script.
+
 =head1 COPYRIGHT, LICENSE, AUTHOR
 
 See the corresponding sections in L<App::FatPacker>.