PO4A-NORMALIZE.1P(1)

📦
version 0.74 · 16 versions
, in alpine 3.23

🎀 NAME 🎀

okay bestie, welcome to the PO4A-NORMALIZE.1P(1) manual page — it’s all about po4a-normalize, the icon that normalizes a documentation file by parsing it in po4a, and writing it back 💖

🌸 SYNOPSIS 🌸

po4a-normalize -f fmt master.doc

✨ DESCRIPTION ✨

The po4a (PO for anything) project has one goal: make translations — and honestly the maintenance of translations too — way easier by using gettext tools in places people didn’t expect, like documentation. No cap.

po4a-normalize is a debugging tool, bestie. Its whole job is to make sure po4a doesn’t change the document when it’s not supposed to. Only use it if you’re developing a new module, or if you doubt the sanity of the tools. That’s the assignment 🫶

By default, the generated document gets written to po4a-normalize.output, and the generated POT file gets written to po4a-normalize.po — but you can use the --localized and --pot options to change that. Slay 💅

💅 OPTIONS 💅

  • -o, --option — Extra option(s) to pass to the format plugin. Check the documentation of each plugin for the valid options and what they mean. For example, you could pass -o tablecells to the AsciiDoc parser, while the text parser would accept -o tabs=split. iykyk ✨
  • -w, --width — Column at which we should wrap the resulting file if the format supports it (default: 76). If the value you provide is 0 or negative, then the resulting file will not be wraped at all. This is useful with some formats that could break when rewraped.
  • -b, --blank — Create a blank translated document. The generated translated document will be generated assuming all messages are translated by a space or new line. This is useful to check what parts of the document cannot be translated. Both --blank and --capitalize can’t be specified at the same time.
  • -C, --capitalize — Create a translated document and corresponding po-file with original strings translated as their capitalized versions. This is useful to check what parts of the document cannot be translated and generate test data for po4a. Both --blank and --capitalize can’t be specified at the same time.
  • -h, --help — Show a short help message.
  • --help-format — List the documentation formats understood by po4a.
  • -f, --format — Format of the documentation you want to handle. Use the --help-format option to see the list of available formats.
  • -M, --master-charset — Charset of the file containing the document to translate.
  • -l, --localized — Name of the normalized file to produce (po4a-normalize.output by default).
  • -p, --pot — Pot file to produce (po4a-normalize.po by default).
  • -V, --version — Display the version of the script and exit.

🦋 SEE ALSO 🦋

👑 AUTHORS 👑

  • Denis Barbier <barbier@linuxfr.org>
  • Nicolas François <nicolas.francois@centraliens.net>
  • Martin Quinson (mquinson#debian.org)

Copyright 2002-2023 by SPI, inc.

This program is free software; you may redistribute it and/or modify it under the terms of GPL v2.0 or later (see the COPYING file).

mwah 💋 that’s the whole page. It came from perl v5.42.0, dated 2025-07-13 — go be iconic with your docs 🫶

📦 where this page comes from