view release on metacpan or  search on metacpan

script/largest-download  view on Meta::CPAN

=head1 DESCRIPTION

This is a thin wrapper for the L<largest> utility; the wrapper sets the
default for the directories to the downloads directories, as well as by default
excluding partial downloads (C<*.part> files).

=head1 OPTIONS

C<*> marks required options.

=head2 Main options

=over

=item B<--num-ranks>=I<s>, B<-N>

Number of ranks to return.

Difference between C<num_results> and C<num_ranks>: C<num_results> (C<-n> option)
specifies number of results regardless of ranks while C<num_ranks> (C<-N> option)
returns number of ranks. For example, if sorting is by reverse size and if
C<num_results> is set to 1 and there are 2 files with the same largest size then
only 1 of those files will be returned. With C<num_ranks> set to 1, both files
will be returned because are they both rank #1.


=item B<--num-results>=I<s>, B<-n>

Number of results to return.

=back

=head2 Configuration options

=over

=item B<--config-path>=I<s>, B<-c>

Set path to configuration file.

Can actually be specified multiple times to instruct application to read from
multiple configuration files (and merge them).


=item B<--config-profile>=I<s>, B<-P>

Set configuration profile to use.

A single configuration file can contain profiles, i.e. alternative sets of
values that can be selected. For example:

 [profile=dev]
 username=foo
 pass=beaver
 
 [profile=production]
 username=bar
 pass=honey

When you specify C<--config-profile=dev>, C<username> will be set to C<foo> and
C<password> to C<beaver>. When you specify C<--config-profile=production>,
C<username> will be set to C<bar> and C<password> to C<honey>.


=item B<--no-config>, B<-C>

Do not use any configuration file.

If you specify C<--no-config>, the application will not read any configuration
file.


=back

=head2 Environment options

=over

=item B<--no-env>

Do not read environment for default options.

If you specify C<--no-env>, the application wil not read any environment
variable.


=back

=head2 Filtering options

=over

=item B<--all>, B<-a>

Do not ignore entries starting with ..

=item B<--exclude-filename-pattern>=I<s>, B<-X>

Exclude filenames that match a regex pattern.

Default value:

 "/\\.part\\z/"

=item B<--include-filename-pattern>=I<s>, B<-I>

Only include filenames that match a regex pattern.

=item B<--type>=I<s>, B<-t>

Only include files of certain type.

Valid values:

 ["file","dir"]

=item B<-d>

Shortcut for `--type=dir`.

See C<--type>.