---
name: "Dist::Zilla::Role::PotWriter"
section: "3pm"
platform: "linux"
package: "libdist-zilla-localetextdomain-perl"
version: "0.91-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Dist::Zilla::Role::PotWriter"
---

# Dist::Zilla::Role::PotWriter(3pm)

Something that writes gettext language translation template file

## Name

Dist::Zilla::Plugin::PotWriter - Something that writes gettext language translation template file

## Synopsis

```
  with 'Dist::Zilla::Role::PotWriter';
  # ...
  sub execute {
      my $self = shift;
      $self->write_pot(%params);
  }
```

## Description

This role provides a utility method for generating a GNU gettext \<http://www.gnu.org/software/gettext/\>-style language translation template.

### Instance Methods

*"write\_pot"*

```
  $self->write_pot(%params);
```

Creates or updates a GNU gettext \<http://www.gnu.org/software/gettext/\>-style language translation file. The supported parameters are:

- "to"

  Path::Tiny object representing the file to write to. Required.

- "scan\_files"

  Array reference listing the files to scan. Defaults to all *\*.pm* files gathered by Dist::Zilla.

- "xgettext"

  Path to the `"xgettext"` application. Defaults to just `"xgettext"` (`"xgettext.exe"` on Windows), which should work if it's in your path.

- "encoding"

  Encoding to assume when scanning for localizable strings. Defaults to `"UTF-8"`.

- "package"

  The name of the localization package. Defaults to the distribution name as configured for Dist::Zilla.

- "version"

  The version of the package. Defaults to the version as configured for Dist::Zilla.

- "copyright\_holder"

  The name of the translation copyright holder. Defaults to the copyright holder configured for Dist::Zilla.

- "bugs\_email"

  Email address for reporting translation bugs. Defaults to the email address of the first author known to Dist::Zilla, if available and parseable by Email::Address::XS.

## Author

David E. Wheeler \<david@justatheory.com\>

## Contributor

Charles McGarvey \<ccm@cpan.org\>

## Copyright and License

This software is copyright (c) 2012-2017 by David E. Wheeler.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.