usr/src/man/man3head/locale.h.3head

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
  45 .\" Copyright (c) 2014, Joyent, Inc.  All rights reserved.
  46 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
  47 .\"
  48 .TH LOCALE.H 3HEAD "Jun 23, 2004"
  49 .SH NAME
  50 locale.h, locale \- category macros
  51 .SH SYNOPSIS
  52 .LP
  53 .nf
  54 #include <\fBlocale.h\fR>
  55 .fi
  56 .SH DESCRIPTION
  57 .LP
  58 The <\fBlocale.h\fR> header provides a definition for the \fBlconv\fR
  59 structure, which includes the following members. (See the definition of
  60 \fBLC_MONETARY\fR in \fBlocale\fR(5).)
  61 .sp
  62 .in +2
  63 .nf
  64 char         *currency_symbol
  65 char         *decimal_point
  66 char         frac_digits
  67 char         *grouping
  68 char         *int_curr_symbol
  69 char         int_frac_digits
  70 char         int_n_cs_precedes
  71 char         int_n_sep_by_space
  72 char         int_n_sign_posn
  73 char         int_p_cs_precedes
  74 char         int_p_sep_by_space
  75 char         int_p_sign_posn
  76 char         *mon_decimal_point
  77 char         *mon_grouping
  78 char         *mon_thousands_sep
  79 char         *negative_sign
  80 char         n_cs_precedes
  81 char         n_sep_by_space
  82 char         n_sign_posn
  83 char         *positive_sign
  84 char         p_cs_precedes
  85 char         p_sep_by_space
  86 char         p_sign_posn
  87 char         *thousands_sep
  88 .fi
  89 .in -2
  90 .LP
  91 The <\fBlocale.h\fR> header defines \fINULL\fR (as defined in <\fBstddef.h\fR>)
  92 and the following as macros:
  93 .sp
  94 .in +2
  95 .nf
  96 LC_ALL
  97 LC_COLLATE
  98 LC_CTYPE
  99 LC_MESSAGES
 100 LC_MONETARY
 101 LC_NUMERIC
 102 LC_TIME
 103 .fi
 104 .in -2
 105 .LP
 106 The preceding expand to distinct integer constant expressions, for use as the
 107 first argument to the \fBsetlocale()\fR function. See \fBsetlocale\fR(3C).
 108 .LP
 109 The <\fBlocale.h\fR> header also defines the following macros, for use with
 110 \fBnewlocale\fR(3C):
 111 .sp
 112 .in +2
 113 .nf
 114 LC_ALL_MASK
 115 LC_COLLATE_MASK
 116 LC_CTYPE_MASK
 117 LC_MESSAGES_MASK
 118 LC_MONETARY_MASK
 119 LC_NUMERIC_MASK
 120 LC_TIME_MASK
 121 .fi
 122 .in -2
 123 .LP
 124 In addition, to facilitate the use of per-thread locales with the
 125 .BR uselocale (3C)
 126 function, the
 127 .RB < locale.h >
 128 header defines the following type and macro:
 129 .sp
 130 .in +2
 131 .nf
 132 locale_t
 133 .fi
 134 .in -2
 135 .sp
 136 .RS 6n
 137 An opaque type that refers to a locale constructed through the use of
 138 the
 139 .BR newlocale (3C)
 140 function.
 141 .RE
 142
 143 .sp
 144 .in +2
 145 .nf
 146 LC_GLOBAL_LOCALE
 147 .fi
 148 .in -2
 149 .sp
 150 .RS 6n
 151 A macro which expands to a
 152 .B locale_t
 153 that represents the current global locale as set by
 154 .BR setlocale (3C).
 155 .RE
 156
 157 .LP
 158 Additional macro definitions, beginning with the characters \fBLC_\fR and an
 159 uppercase letter, can also be specified here.
 160 .SH ATTRIBUTES
 161 .LP
 162 See \fBattributes\fR(5) for descriptions of the following attributes:
 163 .TS
 164 box;
 165 c | c
 166 l | l .
 167 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 168 _
 169 Interface Stability     Standard
 170 .TE
 171
 172 .SH SEE ALSO
 173 .sp
 174 .LP
 175 .BR newlocale (3C),
 176 .BR setlocale (3C),
 177 .BR uselocale (3C),
 178 .BR localeconv (3C),
 179 .BR stddef.h (3HEAD),
 180 .BR attributes (5),
 181 .BR locale (5),
 182 .BR standards (5)