Libc-763.13.tar.gz

[apple/libc.git] / locale / nl_langinfo.3

diff --git a/locale/nl_langinfo.3 b/locale/nl_langinfo.3
index a4ddf9645960e4d2b2449ddd7f259a1cdc1ce470..3d846deb113cff078bef484523a69e04558d5a47 100644 (file)
--- a/locale/nl_langinfo.3
+++ b/locale/nl_langinfo.3
@@ -1,4 +1,4 @@
-.\" Copyright (c) 2001 Alexey Zelkin
+.\" Copyright (c) 2001 Alexey Zelkin <phantom@FreeBSD.org>
 .\" All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
@@ -22,20 +22,30 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/lib/libc/locale/nl_langinfo.3,v 1.2 2001/09/17 08:18:45 ache Exp $
+.\" $FreeBSD: src/lib/libc/locale/nl_langinfo.3,v 1.7 2009/11/16 14:33:31 brueffer Exp $
 .\"
 .Dd May 3, 2001
 .Dt NL_LANGINFO 3
 .Os
 .Sh NAME
-.Nm nl_langinfo
+.Nm nl_langinfo ,
+.Nm nl_langinfo_l
 .Nd language information
 .Sh LIBRARY
 .Lb libc
 .Sh SYNOPSIS
 .In langinfo.h
 .Ft char *
-.Fn nl_langinfo "nl_item item"
+.Fo nl_langinfo
+.Fa "nl_item item"
+.Fc
+.In langinfo.h
+.In xlocale.h
+.Ft char *
+.Fo nl_langinfo_l
+.Fa "nl_item item"
+.Fa "locale_t loc"
+.Fc
 .Sh DESCRIPTION
 The
 .Fn nl_langinfo
@@ -44,7 +54,7 @@ the particular language or cultural area defined in the program's locale.
 The manifest constant names and values of
 .Fa item
 are defined in
-.Aq Pa langinfo.h .
+.In langinfo.h .
 .Pp
 Calls to
 .Fn setlocale
@@ -53,7 +63,18 @@ with a category corresponding to the category of
 or to the
 category
 .Dv LC_ALL ,
-may overwrite buffer pointed by the return value.
+may overwrite the buffer pointed to by the return value.
+.Sh RETURN VALUES
+In a locale where langinfo data is not defined,
+.Fn nl_langinfo
+returns a pointer to the corresponding string in the
+.Tn POSIX
+locale.
+In all locales,
+.Fn nl_langinfo
+returns a pointer to an empty string if
+.Fa item
+contains an invalid setting.
 .Sh EXAMPLES
 For example:
 .Pp
@@ -65,19 +86,17 @@ if the identified language was
 Portuguese, and
 .Qq Li Sun
 if the identified language was English.
-.Sh RETURN VALUES
-In a locale where langinfo data is not defined,
-.Fn nl_langinfo
-returns a pointer to the corresponding string in the
-.Tn POSIX
-locale.
-In all locales,
+.Pp
+While the
 .Fn nl_langinfo
-returns a pointer to an empty string if
-.Fa item
-contains an invalid setting.
+function uses the current locale, the
+.Fn nl_langinfo_l
+function may be passed a locale directly. See
+.Xr xlocale 3
+for more information.
 .Sh SEE ALSO
-.Xr setlocale 3
+.Xr setlocale 3 ,
+.Xr xlocale 3
 .Sh STANDARDS
 The
 .Fn nl_langinfo
@@ -87,4 +106,4 @@ function conforms to
 The
 .Fn nl_langinfo
 function first appeared in
-.Fx 5.0 .
+.Fx 4.6 .