Dist::...sg_scan(3pm)

📦
version 0.91 · 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

✨ NAME ✨

Dist::Zilla::App::Command::msg_scan — bestie, this is the dzil command that scans your localization strings and drops them into a translation template 💖

It lives in the Dist::...sg_scan(3pm) manpage (yes the name got a little chopped, we still love her) and she's here to make your app speak every language. Periodt. 🌍

🎀 SYNOPSIS 🎀

First, set her up in your dist.ini:

[LocaleTextDomain]
textdomain = My-App
lang_dir = po

Then on the command line, just:

dzil msg-scan

That's it. That's the whole vibe. ✨

🦋 DESCRIPTION 🦋

Okay so here's the tea: this command scans all the Perl modules in your distribution and creates or updates a GNU gettext-style language translation template. It's giving i18n main character energy, fr fr. 🌈

She pulls all her settings from the LocaleTextDomain plugin (so go configure that first, bestie), and — important — she requires that the GNU gettext utilities be available. No gettext utils, no scan. Not negotiable. 💅

The GNU gettext situation lives over at <http://www.gnu.org/software/gettext/> if you need to go get it. 🫶

💜 OPTIONS 💜

  • --xgettext — where the xgettext program lives. That's the tool distributed with GNU gettext (<http://www.gnu.org/software/gettext/>). Defaults to just xgettext, which totally works if it's chillin' in your PATH. 👑
  • --encoding — the encoding you're assuming your Perl modules are written in. Defaults to UTF-8, because of course it does, she's iconic. 💖
  • --pot-file — the name of the template file she writes to. Defaults to $lang_dir/$textdomain.pot. 🍓
  • --copyright-holder — name of the application copyright holder. Defaults to whatever copyright holder you defined in dist.ini. 🌸
  • --bugs-email — email address where translation bug reports should be sent. Defaults to the email address of the first distribution author, if available. 🙈

💫 AUTHOR 💫

David E. Wheeler <david@justatheory.com>

🌟 CONTRIBUTOR 🌟

Charles McGarvey <ccm@cpan.org>

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.

Okay that's the whole page bestie, no cap 🫶 go scan some strings and slay. perl v5.26.2 · 2018-07-08 · Dist::...sg_scan(3pm) 💅✨
📦 where this page comes from