lib/libc/locale/newlocale.3

   1 .\" Copyright (c) 2011 The FreeBSD Foundation
   2 .\" All rights reserved.
   3 .\"
   4 .\" This documentation was written by David Chisnall under sponsorship from
   5 .\" the FreeBSD Foundation.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .Dd September 17 2011
  30 .Dt newlocale 3
  31 .Os
  32 .Sh NAME
  33 .Nm newlocale
  34 .Nd Creates a new locale
  35 .Sh LIBRARY
  36 .Lb libc
  37 .Sh SYNOPSIS
  38 .In xlocale
  39 .Ft
  40 .Fn newlocale "int mask" "const char * locale" "locale_t base"
  41 .Sh DESCRIPTION
  42 Creates a new locale, inheriting some properties from an existing locale.
  43 The
  44 .Fa mask
  45 defines the components that the new locale will have set to the locale with the
  46 name specified in the
  47 .Fa locale
  48 parameter.
  49 Any other components will be inherited from
  50 .Fa base .
  51 .Pt
  52 The
  53 .Fa mask
  54 is either
  55 .Fa LC_ALL_MASK,
  56 indicating all possible locale components,
  57 or the logical OR of some combination of the following:
  58 .Bl -tag -width "LC_MESSAGES_MASK" -offset indent
  59 .It LC_COLLATE_MASK
  60 The locale for string collation routines.
  61 This controls alphabetic ordering in
  62 .Xr strcoll 3
  63  and
  64 .Xr strxfrm 3 .
  65 .It LC_CTYPE_MASK
  66 The locale for the
  67 .Xr ctype 3
  68 and
  69 .Xr multibyte 3
  70 functions.
  71 This controls recognition of upper and lower case, alphabetic or
  72 non-alphabetic characters, and so on.
  73 .It LC_MESSAGES_MASK
  74 Set a locale for message catalogs, see
  75 .Xr catopen 3
  76 function.
  77 .It LC_MONETARY_MASK
  78 Set a locale for formatting monetary values; this affects
  79 the
  80 .Xr localeconv 3
  81 function.
  82 .It LC_NUMERIC_MASK
  83 Set a locale for formatting numbers.
  84 This controls the formatting of decimal points in input and output of floating
  85 point numbers in functions such as
  86 .Xr printf 3
  87 and
  88 .Xr scanf 3 ,
  89 as well as values returned by
  90 .Xr localeconv 3 .
  91 .It LC_TIME_MASK
  92 Set a locale for formatting dates and times using the
  93 .Xr strftime 3
  94 function.
  95 .El
  96
  97 This function uses the same rules for loading locale components as
  98 .Xr setlocale 3 .
  99 .Sh RETURN VALUES
 100 Returns a new, valid,
 101 .Fa locale_t
 102 or NULL if an error occurs.
 103 You must free the returned locale with
 104 .Xr freelocale 3 .
 105 .Sh SEE ALSO
 106 .Xr duplocale 3 ,
 107 .Xr freelocale 3 ,
 108 .Xr localeconv 3 ,
 109 .Xr querylocale 3 ,
 110 .Xr uselocale 3 ,
 111 .Xr xlocale 3
 112 .Sh STANDARDS
 113 This function, conforms to
 114 .St -p1003.1-2008