Commits

Anonymous committed ee286d2

Added the help.

Comments (0)

Files changed (2)

File-Dir-Dumper/lib/File/Dir/Dumper/App.pm

 use Carp;
 
 use Getopt::Long qw(GetOptionsFromArray);
+use Pod::Usage;
 
 use File::Dir::Dumper::Scanner;
 use File::Dir::Dumper::Stream::JSON::Writer;
 
     my $output_dest;
 
+    my ($help, $man);
+
     GetOptionsFromArray($argv,
         "output|o=s" => \$output_dest,
+        'help|h' => \$help,
+        'man' => \$man,
     );
 
+    pod2usage(1) if $help;
+    pod2usage(-exitstatus => 0, -verbose => 2) if $man;    
+
     my $dir_to_dump = shift(@$argv);
 
     if (defined($output_dest))

File-Dir-Dumper/scripts/dir-dump

 my $app = File::Dir::Dumper::App->new({argv => \@ARGV});
 exit($app->run());
 
+
+=head1 NAME
+
+dir-dump - the File::Dir::Dumper command line application.
+
+=head1 SYNOPSIS
+
+B<quadp> [-o output-file.txt] /path/to/directory/to/dump
+
+(B<quadp> B<--man> displays the man page)
+
+=head1 DESCRIPTION
+
+Run this program with the path to the directory to dump to produce a dump
+on the standard output.
+
+Run it with B<-o output-file.txt> to write to output-file.txt.
+
+=head1 SEE ALSO
+
+L<http://search.cpan.org/dist/File-Dir-Dumper/> - File-Dir-Dumper on the CPAN.
+
+=head1 AUTHOR
+
+Shlomi Fish, L<http://www.shlomifish.org/>
+
+=cut
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.