debian/local/manpages/localedef.1

   1 .TH LOCALEDEF 1 "May 20, 2005"
   2 .SH NAME
   3 localedef \- compile locale definition files
   4 .SH SYNOPSIS
   5 .ad l
   6 .nh
   7 .B localedef
   8 .RI [ options ]
   9 .I outputpath
  10 .br
  11 .B "localedef \-\-list\-archive"
  12 .RI [ options ]
  13 .br
  14 .B "localedef \-\-delete\-from\-archive"
  15 .RI [ options ]
  16 .IR localename " ..."
  17 .br
  18 .B "localedef \-\-add\-to\-archive"
  19 .RI [ options ]
  20 .IR compiledpath
  21 .br
  22 .B "localedef \-\-version"
  23 .br
  24 .B "localedef \-\-help"
  25 .br
  26 .B "localedef \-\-usage"
  27 .ad b
  28 .hy
  29 .SH DESCRIPTION
  30 The
  31 .B localedef
  32 program reads the indicated
  33 .I charmap
  34 and
  35 .I input
  36 files, compiles them to a binary form quickly usable by the
  37 .BR locale (7)
  38 functions in the C library, and places the output in
  39 .IR outputpath .
  40 .PP
  41 If
  42 .I outputpath
  43 contains a slash character ('/'), it is directly the name of the output
  44 directory.
  45 In this case, there is a separate output file for each locale category
  46 (LC_CTIME, LC_NUMERIC, and so on).
  47 .PP
  48 Otherwise, if the
  49 .B \-\-no\-archive
  50 option is used,
  51 .I outputpath
  52 is the name of a subdirectory in
  53 .B /usr/lib/locale
  54 where per-category compiled files are placed.
  55 .PP
  56 Otherwise,
  57 .I outputpath
  58 is the name of a locale and the compiled locale data is added to the
  59 archive file
  60 .BR /usr/lib/locale/locale-archive .
  61 .PP
  62 In any case,
  63 .B localedef
  64 aborts if the directory in which it tries to write locale files has
  65 not already been created.
  66 .PP
  67 If no
  68 .I charmapfile
  69 is given, the value
  70 .I POSIX
  71 is used by default.
  72 If no
  73 .I inputfile
  74 is given, or if it is given as a dash
  75 .RB ( \- ),
  76 .B localedef
  77 reads from standard input.
  78 .SH OPTIONS
  79 Most options can have either short or long forms.  If multiple short
  80 options are used, they can be combined in one word (for example,
  81 .B \-cv
  82 is identical to
  83 .BR "\-c \-v" ).
  84 .PP
  85 If a short option takes an argument, the argument can be given separately
  86 as the next word
  87 .RB ( "\-f foo" ),
  88 or it can be written together with the option letter
  89 .RB ( \-ffoo ).
  90 If a long option takes an argument, the argument can be given separately
  91 as the next word, or it can be written as option=argument
  92 .RB ( \-\-charmap=foo ).
  93 .SS "Operation selection options"
  94 A few options direct
  95 .B localedef
  96 to do something else than compile locale definitions.
  97 Only one of these should be used at a time.
  98 .TP
  99 .B \-\-delete\-from\-archive
 100 Delete the named locales from the locale archive file.
 101 .TP
 102 .B \-\-list\-archive
 103 List the locales contained in the locale archive file.
 104 .TP
 105 .B \-\-add\-to\-archive
 106 Add the
 107 .I compiledpath
 108 directories to the locale archive file.
 109 The directories should have been created by previous runs of
 110 .BR localedef ,
 111 using
 112 .BR \-\-no\-archive .
 113 .SS "Other options"
 114 Some of the following options are only sensible for some operations; hopefully it is self-evident which ones.
 115 .TP
 116 .BI \-f " charmapfile" ", \-\-charmap=" charmapfile
 117 Specify the file that defines the symbolic character names that are
 118 used by the input file.  If the file is in the default directory for
 119 character maps, it is not necessary to specify the full pathname.
 120 This default directory is printed by
 121 .BR "localedef \-\-help" .
 122 .TP
 123 .BI \-i " inputfile" ", \-\-inputfile=" inputfile
 124 Specify the locale definition file to compile.  If
 125 .I inputfile
 126 is not absolute,
 127 .B localedef
 128 will also look in the directories specified by the environment variable
 129 .B I18NPATH
 130 and in the default directory for locale definition files.  This default
 131 directory is printed by
 132 .BR "localedef \-\-help" .
 133 .TP
 134 .BI \-u " repertoirefile" ", \-\-repertoire-map=" repertoirefile
 135 Read mappings from symbolic names to Unicode UCS4 values from
 136 .IR repertoirefile .
 137 .TP
 138 .BI \-A " aliasfile" ", \-\-alias\-file=" aliasfile
 139 Use
 140 .I aliasfile
 141 to look up aliases for locale names.
 142 There is no default aliases file.
 143 .TP
 144 .BI \-\-prefix= pathname
 145 Set prefix to be prepended to the full archive pathname.
 146 By default, the prefix is empty.
 147 Setting the prefix to
 148 .IR foo ,
 149 the archive would be placed in
 150 .BR foo/usr/lib/locale/locale-archive .
 151 .TP
 152 .B "\-c, \-\-force"
 153 Write the output files even if warnings were generated about the input
 154 file.
 155 .TP
 156 .B \-\-old\-style
 157 Create old-style tables.
 158 .TP
 159 .B "\-v, \-\-verbose"
 160 Generate extra warnings about errors that are normally ignored.
 161 .TP
 162 .B \-\-quiet
 163 Suppress all notifications and warnings, and report only fatal errors.
 164 .TP
 165 .B \-\-posix
 166 Conform strictly to POSIX.  Implies
 167 .BR \-\-verbose .
 168 This option currently has no other effect.  Posix conformance is
 169 assumed if the environment variable
 170 .B POSIXLY_CORRECT
 171 is set.
 172 .TP
 173 .B \-\-replace
 174 Replace a locale in the locale archive file.
 175 Without this option, if the locale is in the archive file already,
 176 an error occurs.
 177 .TP
 178 .B \-\-no\-archive
 179 Do not use the locale archive file, instead create
 180 .I outputpath
 181 as a subdirectory in the same directory as the locale archive file,
 182 and create separate output files for locale categories in it.
 183 .TP
 184 .B "\-\-help"
 185 Print a usage summary and exit.  Also prints the default paths used by
 186 .BR localedef .
 187 .TP
 188 .B "\-\-usage"
 189 Print a short usage summary and exit.
 190 .TP
 191 .B "\-V, \-\-version"
 192 Print the version number, license, and disclaimer of warranty for
 193 .BR localedef .
 194 .SH ENVIRONMENT
 195 .TP
 196 .B POSIXLY_CORRECT
 197 The
 198 .B \-\-posix
 199 flag is assumed if this environment variable is set.
 200 .TP
 201 .B I18NPATH
 202 A colon separated list of default directories for locale definition files.
 203 .SH FILES
 204 .TP
 205 .B /usr/share/i18n/charmaps
 206 Usual default charmap path.
 207 .TP
 208 .B /usr/share/i18n/locales
 209 Usual default path for locale source files.
 210 .TP
 211 .B /usr/share/i18n/repertoiremaps
 212 Usual default repertoire map path.
 213 .TP
 214 .B /usr/lib/locale/locale-archive
 215 Usual default locale archive location.
 216 .TP
 217 .IB outputpath/ LC_COLLATE
 218 One of the output files.  It describes the rules for comparing strings
 219 in the locale's alphabet.
 220 .TP
 221 .IB outputpath/ LC_CTYPE
 222 One of the output files.  It contains information about character
 223 cases and case conversions for the locale.
 224 .TP
 225 .IB outputpath/ LC_MONETARY
 226 One of the output files.  It describes the way monetary values should
 227 be formatted in the locale.
 228 .TP
 229 .IB outputpath/ LC_MESSAGES/SYS_LC_MESSAGES
 230 One of the output files.  It contains information about the language
 231 messages should be printed in, and what an affirmative or negative
 232 answer looks like.
 233 .TP
 234 .IB outputpath/ LC_NUMERIC
 235 One of the output files.  It describes the rules for formatting
 236 numbers in the locale.
 237 .TP
 238 .IB outputpath/ LC_TIME
 239 One of the output files.  It describes the rules for formatting
 240 times and dates in the locale.
 241 .TP
 242 .IB outputpath/ LC_PAPER
 243 One of the output files. It describes the default paper size
 244 in the locale.
 245 .TP
 246 .IB outputpath/ LC_NAME
 247 One of the output files. It describes the rules for formatting
 248 names in the locale.
 249 .TP
 250 .IB outputpath/ LC_ADDRESS
 251 One of the output files. It describes the rules for formatting
 252 addresses, and other location information in the locale.
 253 .TP
 254 .IB outputpath/ LC_TELEPHONE
 255 One of the output files. It describes the rules for formatting
 256 telephone numbers in the locale.
 257 .TP
 258 .IB outputpath/ LC_MEASUREMENT
 259 One of the output files. It describes the rules for measurement in the
 260 locale, e.g. Metric or other units.
 261 .TP
 262 .IB outputpath/ LC_IDENTIFICATION
 263 One of the output files. It identifies the elements within the locale.
 264 .SH EXAMPLES
 265 Compile the locale files for Finnish in the UTF-8 character set
 266 and add it to the default locale archive with the name
 267 .BR fi_FI.UTF-8 :
 268 .PP
 269 .RS
 270 localedef \-f UTF\-8 \-i fi_FI fi_FI.UTF\-8
 271 .RE
 272 .PP
 273 The same, but generate files into the current directory (note that the
 274 last argument must then contain a slash):
 275 .PP
 276 .RS
 277 localedef \-f UTF\-8 \-i fi_FI ./
 278 .RE
 279 .SH "SEE ALSO"
 280 .BR locale "(5), " locale "(7), " locale (1)
 281 .SH AUTHOR
 282 The program was written by Ulrich Drepper.
 283 .PP
 284 This manual page was written by Richard Braakman <dark@xs4all.nl> on
 285 behalf of the Debian GNU/Linux Project and anyone else who wants it.
 286 It was amended by Alastair McKinstry <mckinstry@computer.org> to
 287 explain new ISO 14652 elements,
 288 and amended further by Lars Wirzenius <liw@iki.fi> to document new
 289 functionality (as of GNU C library 2.3.5).
 290 The manpage is not supported by the GNU libc maintainers and may be
 291 out of date.
 292 .SH STANDARDS
 293 This program conforms to the POSIX standard P1003.2