docs

lib/OrePAN/Archive.pm

@@ -143,7 +143,7 @@ sub _parse_version($) {
             };
             local $^W = 0;
             my $version = eval($eval);  ## no critic
-            warn "Could not eval '$eval' in $parsefile: $@" if $@;
+            warnf("Could not eval '$eval' in $parsefile: $@") if $@;
             if ( ! ref($version) ) {
                 $version = eval { version->new($version) };
             }

orepan.pl

@@ -74,23 +74,45 @@
 
 =head1 NAME
 
-orepan.pl - my own Perl Archive Network.
+orepan.pl - DarkPAN manager
 
 =head1 SYNOPSIS
 
-    % orepan.pl --destination=/path/to/repository Foo-0.01.tar.gz
-        --pause=FOO
-    % orepan.pl --destination=/path/to/repository https://example.com/MyModule-0.96.tar.gz
+    % mkdir -p /path/to/repository
 
-    # and so...
+    # add new module to repository directory
+    % orepan.pl --destination=/path/to/repository --pause=FOO \
+        Foo-0.01.tar.gz
+    # retrieve from network
+    % orepan.pl --destination=/path/to/repository --pause=FOO \
+        https://example.com/MyModule-0.96.tar.gz
+
+    # and use it
     % cpanm --mirror-only --mirror=file:///path/to/repository Foo
 
 =head1 DESCRIPTION
 
-OrePAN is yet another DarkPAN repository manager.
+OrePAN is yet another CPAN mirror aka DarkPAN repository manager.
+
+orepan.pl can add a new module to DarkPAN repository. If you want remove modules, add 
+many modules at once, you can use L<orepan_index.pl>
 
 OrePAN is highly simple and B<limited>. OrePAN supports only L<App::cpanminus>. Because I'm using cpanm for daily jobs.
 
+=head1 OPTIONS
+
+=over 4
+
+=item B<--destination>
+
+Set a directory that use as DarkPAN repository
+
+=item B<--pause>
+
+PAUSEID, the module is copied to destination/authors/id/{substr(0,1,id)}/{substr(0,2,id)}/{id}/module
+
+=back
+
 =head1 AUTHOR
 
 Tokuhiro Matsuno E<lt>tokuhirom AAJKLFJEF GMAIL COME<gt>

orepan_index.pl

@@ -68,17 +68,45 @@ sub build_index {
 
 =head1 NAME
 
-orepan_index.pl - index builder
+orepan_index.pl - DarkPAN index builder
 
 =head1 SYNOPSIS
 
+    # make directory
+    % mkdir -p /path/to/repository/{modules,authors}
+    # copy CPAN mouldes to the directory
+    % cp MyModule-0.03.tar.gz /path/to/repository/authors/id/A/AB/ABC/
+
+    # make index file
+    % orepan_index.pl --repository=/path/to/repository
+
+    # remove module and recreate index
+    % rm /path/to/repository/authors/id/A/AB/ABC/MyModule-0.04.tar.gz
     % orepan_index.pl --repository=/path/to/repository
 
-    # and so...
+    # and use it
     % cpanm --mirror-only --mirror=file:///path/to/repository Foo
 
 =head1 DESCRIPTION
 
+OrePAN is yet another CPAN mirror aka DarkPAN repository manager.
+
+orepan_index.pl is CPAN mirror aka DarkPAN index builder. 
+orepan_index.pl parses all tarballs in specified repository directory, and makes 02packages.txt.gz file.
+
+You can use the directory aka DarkPAN with `cpanm --mirror`.
+
+If you want to add other mouldes to repository in one command, you can use L<orepan.pl>
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<--repository>
+
+Set a directory that use as DarkPAN repository
+
+=back
 
 =head1 AUTHOR