.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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::Role::Git::StringFormatter 3pm"
.TH Dist::Zilla::Role::Git::StringFormatter 3pm 2024-01-20 "perl v5.38.2" "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::Role::Git::StringFormatter \- Provide a String::Formatter for commit messages
.SH VERSION
.IX Header "VERSION"
version 2.049
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This role is used within the Git plugins to format strings that may
include the changes from the current release.
.PP
These formatting codes are available:
.ie n .IP %c 4
.el .IP \f(CW%c\fR 4
.IX Item "%c"
The list of changes in the just-released version (read from \f(CW\*(C`changelog\*(C'\fR).
It will include lines between the current version and timestamp and
the next non-indented line, except that blank lines at the beginning
or end are removed.  It always ends in a newline unless it is the empty string.
.ie n .IP """%{dd\-MMM\-yyyy}d""" 4
.el .IP \f(CW%{dd\-MMM\-yyyy}d\fR 4
.IX Item "%{dd-MMM-yyyy}d"
The current date.  You can use any CLDR format supported by
DateTime.  A bare \f(CW%d\fR means \f(CW\*(C`%{dd\-MMM\-yyyy}d\*(C'\fR.
.ie n .IP %n 4
.el .IP \f(CW%n\fR 4
.IX Item "%n"
a newline
.ie n .IP %N 4
.el .IP \f(CW%N\fR 4
.IX Item "%N"
the distribution name
.ie n .IP """%{\-TRIAL}t""" 4
.el .IP \f(CW%{\-TRIAL}t\fR 4
.IX Item "%{-TRIAL}t"
Expands to \-TRIAL (or any other supplied string) if this is a trial
release, or the empty string if not.  A bare \f(CW%t\fR means \f(CW\*(C`%{\-TRIAL}t\*(C'\fR.
.ie n .IP %v 4
.el .IP \f(CW%v\fR 4
.IX Item "%v"
the distribution version
.ie n .IP %V 4
.el .IP \f(CW%V\fR 4
.IX Item "%V"
The distribution version, but with a leading \f(CW\*(C`v\*(C'\fR removed if it exists.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
.SS changelog
.IX Subsection "changelog"
The filename of your \fIChanges\fR file.  (Must be provided by the class
that consumes this role.)
.SS time_zone
.IX Subsection "time_zone"
The time zone used with the \f(CW%d\fR code.  The default is \f(CW\*(C`local\*(C'\fR.
.SH SUPPORT
.IX Header "SUPPORT"
Bugs may be submitted through the RT bug tracker <https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-Git>
(or bug\-Dist\-Zilla\-Plugin\-Git@rt.cpan.org <mailto:bug-Dist-Zilla-Plugin-Git@rt.cpan.org>).
.PP
There is also a mailing list available for users of this distribution, at
<http://dzil.org/#mailing\-list>.
.PP
There is also an irc channel available for users of this distribution, at
\&\f(CW\*(C`#distzilla\*(C'\fR on \f(CW\*(C`irc.perl.org\*(C'\fR <irc://irc.perl.org/#distzilla>.
.SH AUTHOR
.IX Header "AUTHOR"
Jerome Quelin
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2009 by Jerome Quelin.
.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.