.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Dist::Zilla::Plugin::Bugtracker 3pm" .TH Dist::Zilla::Plugin::Bugtracker 3pm "2021-01-07" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Dist::Zilla::Plugin::Bugtracker \- Automatically sets the bugtracker URL and mailto .SH "VERSION" .IX Header "VERSION" version 1.111080 .SH "SYNOPSIS" .IX Header "SYNOPSIS" In \f(CW\*(C`dist.ini\*(C'\fR: .PP .Vb 1 \& [Bugtracker] .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This plugin sets the distribution's bugtracker \s-1URL\s0 and possibly the email address as metadata. You can set the \f(CW\*(C`web\*(C'\fR and the \f(CW\*(C`mailto\*(C'\fR values independently in the plugin configuration. .SH "METHODS" .IX Header "METHODS" .SS "web" .IX Subsection "web" This is the bugtracker \s-1URL.\s0 It defaults to the \s-1CPAN RT URL,\s0 so it equivalent to: .PP .Vb 2 \& [Bugtracker] \& web = http://rt.cpan.org/Public/Dist/Display.html?Name=%s .Ve .PP See \f(CW\*(C`interpolate()\*(C'\fR for more information. .SS "mailto" .IX Subsection "mailto" This is the optional email address to which bug reports can be sent. If the \&\s-1CPAN RT\s0 bugtracker is used, the email address defaults to \f(CW\*(C`bug\-%l at rt.cpan.org\*(C'\fR \- see \f(CW\*(C`interpolate()\*(C'\fR for what this means. .PP If a different bugtracker \s-1URL\s0 is used, the email address is only included in the metadata if it is explicitly given. .PP In the following examples, assume that the distribution is called \f(CW\*(C`Foo\-Bar\*(C'\fR. .PP Example 1: .PP .Vb 1 \& [Bugtracker] .Ve .PP will produce the defaults: .PP .Vb 2 \& web: http://rt.cpan.org/Public/Dist/Display.html?Name=Foo\-Bar \& mailto: bug\-foo\-bar at rt.cpan.org .Ve .PP Example 2: .PP To suppress the \f(CW\*(C`mailto\*(C'\fR from example 1, use: .PP .Vb 2 \& [Bugtracker] \& mailto = .Ve .PP Example 3: .PP .Vb 2 \& [Bugtracker] \& web = http://github.com/me/%s/issues .Ve .PP will only produce a \f(CW\*(C`web\*(C'\fR entry, but not a \f(CW\*(C`mailto\*(C'\fR entry: .PP .Vb 1 \& web: http://github.com/me/Foo\-Bar/issues .Ve .PP Example 4: .PP .Vb 2 \& [Bugtracker] \& mailto = me@example.org .Ve .PP will produce: .PP .Vb 2 \& web: http://rt.cpan.org/Public/Dist/Display.html?Name=Foo\-Bar \& mailto: me@example.org .Ve .PP Example 5: .PP .Vb 3 \& [Bugtracker] \& web = http://github.com/me/%s/issues \& mailto = bug\-%U@example.org .Ve .PP will only produce a \f(CW\*(C`web\*(C'\fR entry, but not a \f(CW\*(C`mailto\*(C'\fR entry: .PP .Vb 2 \& web: http://github.com/me/Foo\-Bar/issues \& mailto: bug\-FOO\-BAR@example.org .Ve .PP See CPAN::Meta::Spec for more information. .SS "interpolate" .IX Subsection "interpolate" Both the \f(CW\*(C`web\*(C'\fR and \f(CW\*(C`mailto\*(C'\fR strings are interpolated as follows: .PP .Vb 4 \& %s The distribution name as is (e.g., \*(AqFoo\-Bar\*(Aq) \& %l The distribution name in lowercase (e.g., \*(Aqfoo\-bar\*(Aq) \& %U The distribution name in uppercase (e.g., \*(AqFOO\-BAR\*(Aq) \& %% A literal \*(Aq%\*(Aq sign .Ve .SS "metadata" .IX Subsection "metadata" Sets the bugtracker \s-1URL\s0 and possibly email address in the distribution's metadata. .SH "INSTALLATION" .IX Header "INSTALLATION" See perlmodinstall for information and options on installing Perl modules. .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" No bugs have been reported. .PP Please report any bugs or feature requests through the web interface at . .SH "AVAILABILITY" .IX Header "AVAILABILITY" The latest version of this module is available from the Comprehensive Perl Archive Network (\s-1CPAN\s0). Visit to find a \s-1CPAN\s0 site near you, or see . .PP The development version lives at and may be cloned from . Instead of sending patches, please fork this project using the standard git and github infrastructure. .SH "AUTHOR" .IX Header "AUTHOR" Marcel Gruenauer .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2010 by Marcel Gruenauer. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.