usr.bin/mklocale/mklocale.1

   1 .\" $NetBSD: mklocale.1,v 1.16 2013/07/15 18:46:47 joerg Exp $
   2 .\" FreeBSD: src/usr.bin/mklocale/mklocale.1,v 1.6 1999/09/20 09:15:21 phantom Exp
   3 .\"
   4 .\" Copyright (c) 1993, 1994
   5 .\"     The Regents of the University of California.  All rights reserved.
   6 .\"
   7 .\" This code is derived from software contributed to Berkeley by
   8 .\" Paul Borman at Krystal Technologies.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\" 3. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)mklocale.1  8.2 (Berkeley) 4/18/94
  35 .\"
  36 .Dd July 15, 2013
  37 .Dt MKLOCALE 1
  38 .Os
  39 .Sh NAME
  40 .Nm mklocale
  41 .Nd make LC_CTYPE locale files
  42 .Sh SYNOPSIS
  43 .Nm mklocale
  44 .Op Fl d
  45 .Op Fl t Ar type
  46 \*[Lt]
  47 .Ar source
  48 \*[Gt]
  49 .Ar language/LC_CTYPE
  50 .Nm mklocale
  51 .Op Fl d
  52 .Op Fl t Ar type
  53 .Fl o
  54 .Ar language/LC_CTYPE
  55 .Ar source
  56 .Sh DESCRIPTION
  57 The
  58 .Nm mklocale
  59 utility reads an
  60 .Dv LC_CTYPE
  61 source file from standard input and produces an
  62 .Dv LC_CTYPE
  63 binary file on standard output suitable for placement in
  64 .Pa /usr/share/locale/\*[Lt]language\*[Gt]/LC_CTYPE .
  65 .Pp
  66 The format of
  67 .Ar source
  68 is quite simple.
  69 It consists of a series of lines which start with a keyword and have
  70 associated data following.
  71 C style comments are used
  72 to place comments in the file.
  73 .Pp
  74 Following options are available:
  75 .Bl -tag -width XXX
  76 .It Fl d
  77 Turns on debugging messages.
  78 .It Fl o
  79 Specify output file.
  80 .It Fl t
  81 Generate output in new-style LC_{MONETARY,NUMERIC,TIME,MESSAGES}
  82 locale-db format.
  83 .El
  84 .Pp
  85 Besides the keywords which will be listed below,
  86 the following are valid tokens in
  87 .Ar source :
  88 .Bl -tag -width literal
  89 .It Dv RUNE
  90 A
  91 .Dv RUNE
  92 may be any of the following:
  93 .Bl -tag -width 0x[0-9a-f]+
  94 .It Ar 'x'
  95 The ASCII character
  96 .Ar x .
  97 .It Ar '\ex'
  98 The ANSI C character
  99 .Ar \ex
 100 where
 101 .Ar \ex
 102 is one of
 103 .Dv \ea ,
 104 .Dv \eb ,
 105 .Dv \ef ,
 106 .Dv \en ,
 107 .Dv \er ,
 108 .Dv \et ,
 109 or
 110 .Dv \ev .
 111 .It Ar 0x[0-9a-f]+
 112 A hexadecimal number representing a rune code.
 113 .It Ar 0[0-7]*
 114 An octal number representing a rune code.
 115 .It Ar [1-9][0-9]*
 116 A decimal number representing a rune code.
 117 .El
 118 .It Dv STRING
 119 A string enclosed in double quotes (").
 120 .It Dv THRU
 121 Either
 122 .Dv ...
 123 or
 124 .Dv - .
 125 Used to indicate ranges.
 126 .It Ar literal
 127 The follow characters are taken literally:
 128 .Bl -tag -width "\*[Lt]\|\|(\|\|["
 129 .It Dv "\*[Lt]\|(\|["
 130 Used to start a mapping.
 131 All are equivalent.
 132 .It Dv "\*[Gt]\|\^)\|]"
 133 Used to end a mapping.
 134 All are equivalent.
 135 .It Dv \&:
 136 Used as a delimiter in mappings.
 137 .El
 138 .El
 139 .Pp
 140 Key words which should only appear once are:
 141 .Bl -tag -width PHONOGRAM
 142 .It Dv ENCODING
 143 Followed by a
 144 .Dv STRING
 145 which indicates the encoding mechanism to be used for this locale.
 146 The current encodings are:
 147 .Bl -tag -width NONE
 148 .It Dv NONE
 149 No translation and the default.
 150 .It Dv UTF2
 151 .Dv "Universal character set Transformation Format"
 152 adopted from
 153 .Nm "Plan 9 from Bell Labs" .
 154 .It Dv EUC
 155 .Dv EUC
 156 encoding as used by several
 157 vendors of
 158 .Ux
 159 systems.
 160 .El
 161 .It Dv VARIABLE
 162 This keyword must be followed by a single tab or space character,
 163 after which encoding specific data is placed.
 164 Currently only the
 165 .Dv "EUC"
 166 encoding requires variable data.
 167 .\" See
 168 .\" .Xr euc 4
 169 .\" for further details.
 170 .It Dv INVALID
 171 A single
 172 .Dv RUNE
 173 follows and is used as the invalid rune for this locale.
 174 .El
 175 .Pp
 176 The following keywords may appear multiple times and have the following
 177 format for data:
 178 .Bl -tag -width "XXRUNE1 THRU RUNEn : RUNE2XX" -offset indent
 179 .It Aq Dv RUNE1 RUNE2
 180 .Dv RUNE1
 181 is mapped to
 182 .Dv RUNE2 .
 183 .It Aq Dv RUNE1 THRU RUNEn : RUNE2
 184 Runes
 185 .Dv RUNE1
 186 through
 187 .Dv RUNEn
 188 are mapped to
 189 .Dv RUNE2
 190 through
 191 .Dv RUNE2
 192 + n-1.
 193 .El
 194 .Bl -tag -width PHONOGRAM
 195 .It Dv MAPLOWER
 196 Defines the tolower mappings.
 197 .Dv RUNE2
 198 is the lower case representation of
 199 .Dv RUNE1 .
 200 .It Dv MAPUPPER
 201 Defines the toupper mappings.
 202 .Dv RUNE2
 203 is the upper case representation of
 204 .Dv RUNE1 .
 205 .It Dv TODIGIT
 206 Defines a map from runes to their digit value.
 207 .Dv RUNE2
 208 is the integer value represented by
 209 .Dv RUNE1 .
 210 For example, the ASCII character
 211 .Sq 0
 212 would map to the decimal value 0.
 213 Only values up to 255 are allowed.
 214 .El
 215 .Pp
 216 The following keywords may appear multiple times and have the following
 217 format for data:
 218 .Bl -tag -width "RUNE1 THRU RUNEn"
 219 .It Dv RUNE
 220 This rune has the property defined by the keyword.
 221 .It Dv "RUNE1 THRU RUNEn"
 222 All the runes between and including
 223 .Dv RUNE1
 224 and
 225 .Dv RUNEn
 226 have the property defined by the keyword.
 227 .El
 228 .Bl -tag -width PHONOGRAM
 229 .It Dv ALPHA
 230 Defines runes which are alphabetic, printable, and graphic.
 231 .It Dv CONTROL
 232 Defines runes which are control characters.
 233 .It Dv DIGIT
 234 Defines runes which are decimal digits, printable, and graphic.
 235 .It Dv GRAPH
 236 Defines runes which are graphic and printable.
 237 .It Dv LOWER
 238 Defines runes which are lower case, printable, and graphic.
 239 .It Dv PUNCT
 240 Defines runes which are punctuation, printable, and graphic.
 241 .It Dv SPACE
 242 Defines runes which are spaces.
 243 .It Dv UPPER
 244 Defines runes which are upper case, printable, and graphic.
 245 .It Dv XDIGIT
 246 Defines runes which are hexadecimal digits, printable, and graphic.
 247 .It Dv BLANK
 248 Defines runes which are blank.
 249 .It Dv PRINT
 250 Defines runes which are printable.
 251 .It Dv IDEOGRAM
 252 Defines runes which are ideograms, printable, and graphic.
 253 .It Dv SPECIAL
 254 Defines runes which are special characters, printable, and graphic.
 255 .It Dv PHONOGRAM
 256 Defines runes which are phonograms, printable, and graphic.
 257 .It Dv SWIDTHn
 258 Defines runes with specific glyph width.
 259 .Ar n
 260 takes 0 to 3.
 261 .It Dv CHARSET
 262 Controls character set for subsequent runes.
 263 .\" To support
 264 .\" .Xr iso2022 4
 265 .\" locale definitions.
 266 .El
 267 .Sh SEE ALSO
 268 .\"Xr colldef 1 ,
 269 .Xr setlocale 3 ,
 270 .\" .Xr euc 4 ,
 271 .\" .Xr utf8 4
 272 .Xr nls 7
 273 .Sh HISTORY
 274 The
 275 .Nm mklocale
 276 utility first appeared in
 277 .Bx 4.4 .
 278 .Sh BUGS
 279 The
 280 .Nm mklocale
 281 utility is overly simplistic.
 282 .Pp
 283 We should switch to
 284 .Nm localedef
 285 and its file format, which is more standard.