1 .\" Copyright (C) 2001 Richard Braakman
2 .\" Copyright (C) 2004 Alastair McKinstry
3 .\" Copyright (C) 2005 Lars Wirzenius
4 .\" Copyright (C) 2014 Marko Myllynen
6 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
7 .\" This is free documentation; you can redistribute it and/or
8 .\" modify it under the terms of the GNU General Public License as
9 .\" published by the Free Software Foundation; either version 2 of
10 .\" the License, or (at your option) any later version.
12 .\" The GNU General Public License's references to "object code"
13 .\" and "executables" are to be interpreted as the output of any
14 .\" document formatting or typesetting system, including
15 .\" intermediate and printed output.
17 .\" This manual is distributed in the hope that it will be useful,
18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 .\" GNU General Public License for more details.
22 .\" You should have received a copy of the GNU General Public
23 .\" License along with this manual; if not, see
24 .\" <http://www.gnu.org/licenses/>.
27 .\" This manual page was initially written by Richard Braakman
28 .\" on behalf of the Debian GNU/Linux Project and anyone else
29 .\" who wants it. It was amended by Alastair McKinstry to
30 .\" explain new ISO 14652 elements, and amended further by
31 .\" Lars Wirzenius to document new functionality (as of GNU
34 .TH LOCALEDEF 1 2016-07-17 "Linux" "Linux User Manual"
36 localedef \- compile locale definition files
44 .B "localedef \-\-list\-archive"
47 .B "localedef \-\-delete\-from\-archive"
51 .B "localedef \-\-add\-to\-archive"
55 .B "localedef \-\-version"
57 .B "localedef \-\-help"
59 .B "localedef \-\-usage"
65 program reads the indicated
69 files, compiles them to a binary form quickly usable by the
70 locale functions in the C library
73 etc.), and places the output in
78 argument is interpreted as follows:
82 contains a slash character ('/'), it is interpreted as the name of the
83 directory where the output definitions are to be stored.
84 In this case, there is a separate output file for each locale category
93 is the name of a subdirectory in
95 where per-category compiled files are placed.
99 is the name of a locale and the compiled locale data is added to the
101 .IR /usr/lib/locale/locale-archive .
102 A locale archive is a memory-mapped file which contains all the
103 system-provided locales;
104 it is used by all localized programs when the environment variable
110 aborts if the directory in which it tries to write locale files has
111 not already been created.
117 (for ASCII) is used by default.
120 is given, or if it is given as a dash
123 reads from standard input.
125 .SS Operation-selection options
128 to do something other than compile locale definitions.
129 Only one of these options should be used at a time.
131 .B \-\-delete\-from\-archive
132 Delete the named locales from the locale archive file.
135 List the locales contained in the locale archive file.
137 .B \-\-add\-to\-archive
140 directories to the locale archive file.
141 The directories should have been created by previous runs of
144 .BR \-\-no\-archive .
146 Some of the following options are sensible only for certain operations;
147 generally, it should be self-evident which ones.
149 .BI \-f " charmapfile" "\fR, \fP\-\-charmap=" charmapfile
150 Specify the file that defines the character set
151 that is used by the input file.
154 contains a slash character ('/'),
155 it is interpreted as the name of the character map.
156 Otherwise, the file is sought in the current directory
157 and the default directory for character maps.
158 If the environment variable
161 .I $I18NPATH/charmaps/
164 are also searched after the current directory.
165 The default directory for character maps is printed by
166 .BR "localedef \-\-help" .
168 .BI \-i " inputfile" "\fR, \fP\-\-inputfile=" inputfile
169 Specify the locale definition file to compile.
170 The file is sought in the current directory
171 and the default directory for locale definition files.
172 If the environment variable
175 .I $I18NPATH/locales/
178 are also searched after the current directory.
179 The default directory for locale definition files is printed by
180 .BR "localedef \-\-help" .
182 .BI \-u " repertoirefile" "\fR, \fP\-\-repertoire-map=" repertoirefile
183 Read mappings from symbolic names to Unicode code points from
187 contains a slash character ('/'),
188 it is interpreted as the pathname of the repertoire map.
189 Otherwise, the file is sought in the current directory
190 and the default directory for repertoire maps.
191 If the environment variable
194 .I $I18NPATH/repertoiremaps/
197 are also searched after the current directory.
198 The default directory for repertoire maps is printed by
199 .BR "localedef \-\-help" .
201 .BI \-A " aliasfile" "\fR, \fP\-\-alias\-file=" aliasfile
204 to look up aliases for locale names.
205 There is no default aliases file.
207 .BI \-\-prefix= pathname
208 Set the prefix to be prepended to the full archive pathname.
209 By default, the prefix is empty.
210 Setting the prefix to
212 the archive would be placed in
213 .IR foo/usr/lib/locale/locale-archive .
215 .BR \-c ", " \-\-force
216 Write the output files even if warnings were generated about the input
219 .BR \-v ", " \-\-verbose
220 Generate extra warnings about errors that are normally ignored.
223 Suppress all notifications and warnings, and report only fatal errors.
226 Conform strictly to POSIX. Implies
228 This option currently has no other effect.
229 POSIX conformance is assumed if the environment variable
234 Replace a locale in the locale archive file.
235 Without this option, if the locale is in the archive file already,
239 Do not use the locale archive file, instead create
241 as a subdirectory in the same directory as the locale archive file,
242 and create separate output files for locale categories in it.
243 This is helpful to prevent system locale archive updates from overwriting
244 custom locales created with
247 .BR \-? ", " \-\-help
248 Print a usage summary and exit.
249 Also prints the default paths used by
253 Print a short usage summary and exit.
255 .BR \-V ", " \-\-version
256 Print the version number, license, and disclaimer of warranty for
259 One of the following exit values can be returned by
264 Command completed successfully.
267 Warnings or errors occurred, output files were written.
270 Errors encountered, no output created.
277 flag is assumed if this environment variable is set.
280 A colon-separated list of search directories for files.
283 .I /usr/share/i18n/charmaps
284 Usual default character map path.
286 .I /usr/share/i18n/locales
287 Usual default path for locale definition files.
289 .I /usr/share/i18n/repertoiremaps
290 Usual default repertoire map path.
292 .I /usr/lib/locale/locale-archive
293 Usual default locale archive location.
296 Usual default path for compiled individual locale data files.
298 .I outputpath/LC_ADDRESS
299 An output file that contains information about formatting of
300 addresses and geography-related items.
302 .I outputpath/LC_COLLATE
303 An output file that contains information about the rules for comparing
306 .I outputpath/LC_CTYPE
307 An output file that contains information about character classes.
309 .I outputpath/LC_IDENTIFICATION
310 An output file that contains metadata about the locale.
312 .I outputpath/LC_MEASUREMENT
313 An output file that contains information about locale measurements
314 (metric versus US customary).
316 .I outputpath/LC_MESSAGES/SYS_LC_MESSAGES
317 An output file that contains information about the language messages
318 should be printed in, and what an affirmative or negative answer looks
321 .I outputpath/LC_MONETARY
322 An output file that contains information about formatting of monetary
325 .I outputpath/LC_NAME
326 An output file that contains information about salutations for persons.
328 .I outputpath/LC_NUMERIC
329 An output file that contains information about formatting of nonmonetary
332 .I outputpath/LC_PAPER
333 An output file that contains information about settings related to
336 .I outputpath/LC_TELEPHONE
337 An output file that contains information about formats to be used with
340 .I outputpath/LC_TIME
341 An output file that contains information about formatting of data and
346 Compile the locale files for Finnish in the UTF\-8 character set
347 and add it to the default locale archive with the name
351 localedef \-f UTF\-8 \-i fi_FI fi_FI.UTF\-8
354 The next example does the same thing, but generates files into the
356 directory which can then be used by programs when the environment
359 is set to the current directory (note that the last argument must
363 localedef \-f UTF\-8 \-i fi_FI ./fi_FI.UTF\-8
369 .BR repertoiremap (5),