.\" -*- 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 "PO4A-NORMALIZE.1P 1"
.TH PO4A-NORMALIZE.1P 1 2024-06-26 "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
po4a\-normalize \- normalize a documentation file by parsing it in po4a, and writing it back
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBpo4a\-normalize\fR \fB\-f\fR \fIfmt\fR \fImaster.doc\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The po4a (PO for anything) project goal is to ease translations (and more
interestingly, the maintenance of translations) using gettext tools on
areas where they were not expected like documentation.
.PP
The \fBpo4a\-normalize\fR script is a debugging tool used to make sure that
po4a don'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.
.PP
The generated document will be written to \fIpo4a\-normalize.output\fR while the
generated POT file will be written to \fIpo4a\-normalize.po\fR by default, but 
you can use the \fB\-\-localized\fR and \fB\-\-pot\fR options to change that.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-o\fR, \fB\-\-option\fR" 4
.IX Item "-o, --option"
Extra option(s) to pass to the format plugin. See the documentation of each
plugin for more information about the valid options and their meanings. For 
example, you could pass '\-o tablecells' to the AsciiDoc parser, while the 
text parser would accept '\-o tabs=split'.
.IP "\fB\-w\fR, \fB\-\-width\fR" 4
.IX Item "-w, --width"
Column at which we should wrap the resulting file if the format supports it
(default: 76).
.IP "\fB\-b\fR, \fB\-\-blank\fR" 4
.IX Item "-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.
.Sp
This is useful to check what parts of the document cannot be translated.
.Sp
Both \fB\-\-blank\fR and \fB\-\-capitalize\fR can't be specified at the same time.
.IP "\fB\-C\fR, \fB\-\-capitalize\fR" 4
.IX Item "-C, --capitalize"
Create a translated document and corresponding po-file with original strings
translated as their capitalized versions.
.Sp
This is useful to check what parts of the document cannot be translated and
generate test data for po4a.
.Sp
Both \fB\-\-blank\fR and \fB\-\-capitalize\fR can't be specified at the same time.
.IP "\fB\-h\fR, \fB\-\-help\fR" 4
.IX Item "-h, --help"
Show a short help message.
.IP \fB\-\-help\-format\fR 4
.IX Item "--help-format"
List the documentation formats understood by po4a.
.IP "\fB\-f\fR, \fB\-\-format\fR" 4
.IX Item "-f, --format"
Format of the documentation you want to handle. Use the \fB\-\-help\-format\fR
option to see the list of available formats.
.IP "\fB\-M\fR, \fB\-\-master\-charset\fR" 4
.IX Item "-M, --master-charset"
Charset of the file containing the document to translate.
.IP "\fB\-l\fR, \fB\-\-localized\fR" 4
.IX Item "-l, --localized"
Name of the normalized file to produce (\fIpo4a\-normalize.output\fR by default).
.IP "\fB\-p\fR, \fB\-\-pot\fR" 4
.IX Item "-p, --pot"
Pot file to produce (\fIpo4a\-normalize.po\fR by default).
.IP "\fB\-V\fR, \fB\-\-version\fR" 4
.IX Item "-V, --version"
Display the version of the script and exit.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBpo4a\-gettextize\fR\|(1),
\&\fBpo4a\-translate\fR\|(1),
\&\fBpo4a\-updatepo\fR\|(1),
\&\fBpo4a\fR\|(7)
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 3
\& Denis Barbier <barbier@linuxfr.org>
\& Nicolas François <nicolas.francois@centraliens.net>
\& Martin Quinson (mquinson#debian.org)
.Ve
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2002\-2023 by SPI, inc.
.PP
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).