| 1 |
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. |
| 2 |
.TH PRINTF_NGETTEXT "1" "July 2025" "GNU gettext-runtime 0.26" "User Commands" |
| 3 |
.SH NAME |
| 4 |
printf_ngettext \- translate format string and apply it |
| 5 |
.SH SYNOPSIS |
| 6 |
.B printf_ngettext |
| 7 |
[\fI\,OPTION\/\fR] \fI\,FORMAT FORMAT-PLURAL COUNT \/\fR[\fI\,ARGUMENT\/\fR]... |
| 8 |
.SH DESCRIPTION |
| 9 |
.\" Add any additional description here |
| 10 |
The \fBprintf_ngettext\fP program translates a format string into the user's |
| 11 |
language, by looking up the translation in a message catalog and then |
| 12 |
choosing the appropriate plural form, which depends on the number \fICOUNT\fP |
| 13 |
and the language of the message catalog where the translation was found, and |
| 14 |
applies the translated format string to the specified arguments. |
| 15 |
.PP |
| 16 |
Produces formatted output, applying the native language translation of FORMAT |
| 17 |
and FORMAT\-PLURAL, depending on COUNT, to the ARGUMENTs. |
| 18 |
.SS "Options and arguments:" |
| 19 |
.TP |
| 20 |
\fB\-c\fR, \fB\-\-context\fR=\fI\,CONTEXT\/\fR |
| 21 |
specify context for FORMAT |
| 22 |
.TP |
| 23 |
FORMAT |
| 24 |
English singular form of format string |
| 25 |
.TP |
| 26 |
FORMAT\-PLURAL |
| 27 |
English plural form of format string |
| 28 |
.TP |
| 29 |
COUNT |
| 30 |
choose singular/plural form based on this value |
| 31 |
.TP |
| 32 |
ARGUMENT |
| 33 |
string or numeric argument |
| 34 |
.SS "Informative output:" |
| 35 |
.TP |
| 36 |
\fB\-h\fR, \fB\-\-help\fR |
| 37 |
display this help and exit |
| 38 |
.TP |
| 39 |
\fB\-V\fR, \fB\-\-version\fR |
| 40 |
display version information and exit |
| 41 |
.PP |
| 42 |
Each format string consists of |
| 43 |
.IP |
| 44 |
\- plain text, |
| 45 |
\- directives, that start with '%', |
| 46 |
\- escape sequences, that start with a backslash. |
| 47 |
.PP |
| 48 |
A directive that consumes an argument |
| 49 |
.IP |
| 50 |
\- starts with '%' or '%m$' where m is a positive integer, |
| 51 |
\- is optionally followed by any of the characters '#', '0', '\-', ' ', '+', |
| 52 |
.IP |
| 53 |
each of which acts as a flag, |
| 54 |
.IP |
| 55 |
\- is optionally followed by a width specification (a nonnegative integer), |
| 56 |
\- is optionally followed by '.' and a precision specification (an optional |
| 57 |
.IP |
| 58 |
nonnegative integer), |
| 59 |
.IP |
| 60 |
\- is finished by a specifier |
| 61 |
.IP |
| 62 |
\- 'c', that prints a character, |
| 63 |
\- 's', that prints a string, |
| 64 |
\- 'i', 'd', that print an integer, |
| 65 |
\- 'u', 'o', 'x', 'X', that print an unsigned (nonnegative) integer, |
| 66 |
\- 'e', 'E', that print a floating\-point number in scientific notation, |
| 67 |
\- 'f', 'F', that print a floating\-point number without an exponent, |
| 68 |
\- 'g', 'G', that print a floating\-point number in general notation, |
| 69 |
\- 'a', 'A', that print a floating\-point number in hexadecimal notation. |
| 70 |
.PP |
| 71 |
Additionally there is the directive '%%', that prints a single '%'. |
| 72 |
.PP |
| 73 |
If a directive specifies the argument by its number ('%m$' notation), |
| 74 |
all directives that consume an argument must do so. |
| 75 |
.PP |
| 76 |
The escape sequences are: |
| 77 |
.TP |
| 78 |
\e\e |
| 79 |
backslash |
| 80 |
.TP |
| 81 |
\ea |
| 82 |
alert (BEL) |
| 83 |
.TP |
| 84 |
\eb |
| 85 |
backspace (BS) |
| 86 |
.TP |
| 87 |
\ef |
| 88 |
form feed (FF) |
| 89 |
.TP |
| 90 |
\en |
| 91 |
new line (LF) |
| 92 |
.TP |
| 93 |
\er |
| 94 |
carriage return (CR) |
| 95 |
.TP |
| 96 |
\et |
| 97 |
horizontal tab (HT) |
| 98 |
.TP |
| 99 |
\ev |
| 100 |
vertical tab (VT) |
| 101 |
.TP |
| 102 |
\ennn |
| 103 |
octal number with 1 to 3 octal digits |
| 104 |
.PP |
| 105 |
Environment variables: |
| 106 |
.PP |
| 107 |
The translation of the format string is looked up in the translation domain |
| 108 |
given by the environment variable TEXTDOMAIN. |
| 109 |
It is looked up in the catalogs directory given by the environment variable |
| 110 |
TEXTDOMAINDIR or, if not present, in the default catalogs directory. |
| 111 |
This binary is configured to use the default catalogs directory: |
| 112 |
/usr/share/locale |
| 113 |
.SH AUTHOR |
| 114 |
Written by Bruno Haible. |
| 115 |
.SH "REPORTING BUGS" |
| 116 |
Report bugs in the bug tracker at <https://savannah.gnu.org/projects/gettext> |
| 117 |
or by email to <bug\[email protected]>. |
| 118 |
.SH COPYRIGHT |
| 119 |
Copyright \(co 2025 Free Software Foundation, Inc. |
| 120 |
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html> |
| 121 |
.br |
| 122 |
This is free software: you are free to change and redistribute it. |
| 123 |
There is NO WARRANTY, to the extent permitted by law. |
| 124 |
.SH "SEE ALSO" |
| 125 |
The full documentation for |
| 126 |
.B printf_ngettext |
| 127 |
is maintained as a Texinfo manual. If the |
| 128 |
.B info |
| 129 |
and |
| 130 |
.B printf_ngettext |
| 131 |
programs are properly installed at your site, the command |
| 132 |
.IP |
| 133 |
.B info printf_ngettext |
| 134 |
.PP |
| 135 |
should give you access to the complete manual. |