.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Dpkg::Gettext 3" .TH Dpkg::Gettext 3 "2018-06-26" "1.18.25" "libdpkg-perl" .\" 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" Dpkg::Gettext \- convenience wrapper around Locale::gettext .SH "DESCRIPTION" .IX Header "DESCRIPTION" The Dpkg::Gettext module is a convenience wrapper over the Locale::gettext module, to guarantee we always have working gettext functions, and to add some commonly used aliases. .SH "VARIABLES" .IX Header "VARIABLES" .ie n .IP "$Dpkg::Gettext::DEFAULT_TEXT_DOMAIN" 4 .el .IP "\f(CW$Dpkg::Gettext::DEFAULT_TEXT_DOMAIN\fR" 4 .IX Item "$Dpkg::Gettext::DEFAULT_TEXT_DOMAIN" Specifies the default text domain name to be used with the short function aliases. This is intended to be used by the Dpkg modules, so that they can produce localized messages even when the calling program has set the current domain with \fItextdomain()\fR. If you would like to use the aliases for your own modules, you might want to set this variable to undef, or to another domain, but then the Dpkg modules will not produce localized messages. .SH "FUNCTIONS" .IX Header "FUNCTIONS" .ie n .IP "$trans = g_($msgid)" 4 .el .IP "\f(CW$trans\fR = g_($msgid)" 4 .IX Item "$trans = g_($msgid)" Calls \fIdgettext()\fR on the \f(CW$msgid\fR and returns its translation for the current locale. If \fIdgettext()\fR is not available, simply returns \f(CW$msgid\fR. .ie n .IP "$trans = C_($msgctxt, $msgid)" 4 .el .IP "\f(CW$trans\fR = C_($msgctxt, \f(CW$msgid\fR)" 4 .IX Item "$trans = C_($msgctxt, $msgid)" Calls \fIdgettext()\fR on the \f(CW$msgid\fR and returns its translation for the specific \&\f(CW$msgctxt\fR supplied. If \fIdgettext()\fR is not available, simply returns \f(CW$msgid\fR. .ie n .IP "$trans = P_($msgid, $msgid_plural, $n)" 4 .el .IP "\f(CW$trans\fR = P_($msgid, \f(CW$msgid_plural\fR, \f(CW$n\fR)" 4 .IX Item "$trans = P_($msgid, $msgid_plural, $n)" Calls \fIdngettext()\fR, returning the correct translation for the plural form dependent on \f(CW$n\fR. If \fIdngettext()\fR is not available, returns \f(CW$msgid\fR if \f(CW$n\fR is 1 or \f(CW$msgid_plural\fR otherwise. .ie n .IP "$msgid = N_($msgid)" 4 .el .IP "\f(CW$msgid\fR = N_($msgid)" 4 .IX Item "$msgid = N_($msgid)" A pseudo function that servers as a marked for automated extraction of messages, but does not call \fIgettext()\fR. The run-time translation is done at a different place in the code. .SH "CHANGES" .IX Header "CHANGES" .SS "Version 1.02 (dpkg 1.18.3)" .IX Subsection "Version 1.02 (dpkg 1.18.3)" New function: \fIN_()\fR. .SS "Version 1.01 (dpkg 1.18.0)" .IX Subsection "Version 1.01 (dpkg 1.18.0)" Now the short aliases (g_ and P_) will call domain aware functions with \&\f(CW$DEFAULT_TEXT_DOMAIN\fR. .PP New functions: \fIg_()\fR, \fIC_()\fR. .PP Deprecated function: \fI_g()\fR. .SS "Version 1.00 (dpkg 1.15.6)" .IX Subsection "Version 1.00 (dpkg 1.15.6)" Mark the module as public.