1 '\" te
   2 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
   3 .\"  Copyright 1989 AT&T  Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   4 .\" 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
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" 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.
   9 .\" 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.
  10 .\" 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]
  11 .TH NL_LANGINFO 3C "Jun 24, 2014"
  12 .SH NAME
  13 nl_langinfo, nl_langinfo_l \- language information
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <langinfo.h>
  18 
  19 \fBchar *\fR\fBnl_langinfo\fR(\fBnl_item\fR \fIitem\fR);
  20 .fi
  21 .LP
  22 .nf
  23 \fBchar *\fR\fBnl_langinfo_l\fR(\fBnl_item\fR \fIitem\fR, \fBlocale_t\fR \fIloc\fR);
  24 .fi
  25 .SH DESCRIPTION
  26 .LP
  27 The \fBnl_langinfo()\fR function returns a pointer to a null-terminated string
  28 containing information relevant to a particular language or cultural area
  29 defined in the programs locale. The manifest constant names and values of
  30 \fIitem\fR are defined by <\fBlanginfo.h\fR>. For example:
  31 .IP
  32 \fBnl_langinfo\fR(\fBABDAY_1\fR);
  33 .LP
  34 would return a pointer to the string "\fBDim\fR" if the identified language was
  35 French and a French locale was correctly installed; or "\fBSun\fR" if the
  36 identified language was English.
  37 .LP
  38 The function \fBnl_langinfo_l()\fR behaves identically to \fBnl_langinfo()\fR,
  39 except instead of acting in the current locale, it instead acts in the locale
  40 specified by \fIloc\fR.
  41 .SH RETURN VALUES
  42 .LP
  43 If the locale has not been set or is invalid, or if  data for a
  44 supported language is either not available, or if \fIitem\fR is not defined
  45 therein, then these functions return a pointer to the corresponding string
  46 in the C locale. In all locales, they return a pointer to an
  47 empty string if \fIitem\fR contains an invalid setting.
  48 .SH ATTRIBUTES
  49 .LP
  50 See \fBattributes\fR(5) for descriptions of the following attributes:
  51 .TS
  52 box;
  53 c | c
  54 l | l .
  55 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  56 _
  57 CSI     Enabled
  58 _
  59 Interface Stability     Standard
  60 _
  61 MT-Level        MT-Safe
  62 .TE
  63 
  64 .SH SEE ALSO
  65 .LP
  66 \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),
  67 \fBlanginfo.h\fR(3HEAD), \fBnl_types.h\fR(3HEAD),
  68 \fBattributes\fR(5), \fBstandards\fR(5)
  69 .SH WARNINGS
  70 .LP
  71 The array pointed to by the return value should not be modified by the program.
  72 Subsequent calls to these functions may overwrite the array.