/usr/share/perl5/MooX/Options/Manual/Man.pod is in libmoox-options-perl 4.023-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | # PODNAME: MooX::Options::Manual::Man
# ABSTRACT: More documentation for the man option
__END__
=pod
=head1 NAME
MooX::Options::Manual::Man - More documentation for the man option
=head1 VERSION
version 4.023
=head1 DESCRIPTION
You can add more documentation for the man option. This is the long option.
=head1 SYNOPSIS
myTool --man
=head1 PARAMETERS
=head2 description
The description of your tool.
use MooX::Options description => 'Description of your tools'
=head2 authors
The list of authors of your tool.
use MooX::Options authors => 'Celogeek <me@celogeek.com>'
use MooX::Options authors => ['Celogeek <me@celogeek.com', 'Jens Rehsack']
=head2 synopsis
You can define a full example in pod format. This will be placed in the synopsis section
use MooX::Options synopsis => '
A example of my tools
myTool --run
'
This should not be very easy to do it this way, but you can also extract it from your own script :
use Moo;
use Pod::POM;
my $synopsis = "";
BEGIN {
my $parser = Pod::POM->new;
my $pom = $parser->parse(__FILE__) or die $parser->error();
for my $head1 ($pom->head1) {
if ($head1->title eq 'SYNOPSIS') {
$synopsis = $head1->content;
last;
}
}
}
use MooX::Options synopsis => $synopsis;
=head1 OPTIONS
=head2 long_doc
If a 'long_doc' parameter is present, it will replace the 'doc' or 'documentation' to generate a long doc for the man page.
option 'foo' => (
is => 'ro',
doc => 'bar',
long_doc => 'this is a bar example that will appear in my man page',
);
The 'long_doc' will be write in place of the pod documentation. All the rules of pod, is applied.
For instance, to add a new paragraph, you need to let a empty line.
option 'foo' => (
is => 'ro',
doc => 'bar',
long_doc => join("\n\n", "first paragraph", "second paragraph"),
);
See the L<perlpod> for more explanation.
=head1 SEE ALSO
L<MooX::Options>
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website
https://github.com/celogeek/MooX-Options/issues
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=head1 AUTHOR
celogeek <me@celogeek.com>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2013 by celogeek <me@celogeek.com>.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|