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: head/lib/libc/locale/newlocale.3 281925 2015-04-24 10:17:55Z theraven $ 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 locale.h 39.Ft locale_t 40.Fn newlocale "int mask" "const char * locale" "locale_t base" 41.Sh DESCRIPTION 42Creates a new locale, inheriting some properties from an existing locale. 43The 44.Fa mask 45defines the components that the new locale will have set to the locale with the 46name specified in the 47.Fa locale 48parameter. 49Any other components will be inherited from 50.Fa base . 51The 52.Fa mask 53is either 54.Fa LC_ALL_MASK , 55indicating all possible locale components, 56or the logical OR of some combination of the following: 57.Bl -tag -width "LC_MESSAGES_MASK" -offset indent 58.It LC_COLLATE_MASK 59The locale for string collation routines. 60This controls alphabetic ordering in 61.Xr strcoll 3 62and 63.Xr strxfrm 3 . 64.It LC_CTYPE_MASK 65The locale for the 66.Xr ctype 3 67and 68.Xr multibyte 3 69functions. 70This controls recognition of upper and lower case, alphabetic or 71non-alphabetic characters, and so on. 72.It LC_MESSAGES_MASK 73Set a locale for message catalogs, see 74.Xr catopen 3 75function. 76.It LC_MONETARY_MASK 77Set a locale for formatting monetary values; this affects 78the 79.Xr localeconv 3 80function. 81.It LC_NUMERIC_MASK 82Set a locale for formatting numbers. 83This controls the formatting of decimal points in input and output of floating 84point numbers in functions such as 85.Xr printf 3 86and 87.Xr scanf 3 , 88as well as values returned by 89.Xr localeconv 3 . 90.It LC_TIME_MASK 91Set a locale for formatting dates and times using the 92.Xr strftime 3 93function. 94.El 95This function uses the same rules for loading locale components as 96.Xr setlocale 3 . 97.Sh RETURN VALUES 98Returns a new, valid, 99.Fa locale_t 100or NULL if an error occurs. 101You must free the returned locale with 102.Xr freelocale 3 . 103.Sh SEE ALSO 104.Xr duplocale 3 , 105.Xr freelocale 3 , 106.Xr localeconv 3 , 107.Xr querylocale 3 , 108.Xr uselocale 3 , 109.Xr xlocale 3 110.Sh STANDARDS 111This function conforms to 112.St -p1003.1-2008 . 113