Added documentation about pack command
Tatsuhiko Miyagawa [Wed, 3 Apr 2013 22:24:18 +0000 (15:24 -0700)]
bin/fatpack
lib/App/FatPacker.pm

index 1ad9cb2..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]
index 71fd66d..935584b 100644 (file)
@@ -270,6 +270,10 @@ App::FatPacker - pack your dependencies onto your script file
 
 =head1 SYNOPSIS
 
+  $ fatpack pack myscript.pl >myscript.packed.pl
+
+Or, with more step-by-step control:
+
   $ fatpack trace myscript.pl
   $ fatpack packlists-for `cat fatpacker.trace` >packlists
   $ fatpack tree `cat packlists`