1 package # hide from PAUSE
2 DBIx::Class::Admin::Usage;
5 use base 'Getopt::Long::Descriptive::Usage';
7 use base 'Class::Accessor::Grouped';
9 __PACKAGE__->mk_group_accessors('simple', 'synopsis', 'short_description');
12 Getopt::Long::Descriptive::prog_name();
16 my ($self,$field, $value) = @_;
17 my $prog_name = prog_name();
18 $value =~ s/%c/$prog_name/g;
19 $self->next::method($field, $value);
24 # This returns the usage formated as a pod document
27 return join qq{\n}, $self->pod_leader_text, $self->pod_option_text, $self->pod_authorlic_text;
33 return qq{=head1 NAME\n\n}.prog_name()." - ".$self->short_description().qq{\n\n}.
34 qq{=head1 SYNOPSIS\n\n}.$self->leader_text().qq{\n}.$self->synopsis().qq{\n\n};
38 sub pod_authorlic_text {
42 'See L<DBIx::Class/CONTRIBUTORS>',
44 'You may distribute this code under the same terms as Perl itself',
52 my @options = @{ $self->{options} || [] };
54 return $string unless @options;
56 $string .= "=head1 OPTIONS\n\n=over\n\n";
58 foreach my $opt (@options) {
59 my $spec = $opt->{spec};
60 my $desc = $opt->{desc};
61 next if ($desc eq 'hidden');
62 if ($desc eq 'spacer') {
63 $string .= "=back\n\n=head2 $spec\n\n=cut\n\n=over\n\n";
67 $spec = Getopt::Long::Descriptive->_strip_assignment($spec);
68 $string .= "=item " . join " or ", map { length > 1 ? "B<--$_>" : "B<-$_>" }
70 $string .= "\n\n$desc\n\n=cut\n\n";
73 $string .= "=back\n\n";