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

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