Libc-1044.40.1.tar.gz

[apple/libc.git] / stdlib / FreeBSD / atoi.3

diff --git a/stdlib/FreeBSD/atoi.3 b/stdlib/FreeBSD/atoi.3
index 6f71dc1a0700093742c198535a0c4937b7ed4eb8..3dc33e8cd354d2ff635ccf918e801a8cf9d2058a 100644 (file)
--- a/stdlib/FreeBSD/atoi.3
+++ b/stdlib/FreeBSD/atoi.3
@@ -13,10 +13,6 @@
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
-.\" 3. All advertising materials mentioning features or use of this software
-.\"    must display the following acknowledgement:
-.\"    This product includes software developed by the University of
-.\"    California, Berkeley and its contributors.
 .\" 4. Neither the name of the University nor the names of its contributors
 .\"    may be used to endorse or promote products derived from this software
 .\"    without specific prior written permission.
@@ -34,13 +30,14 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)atoi.3     8.1 (Berkeley) 6/4/93
-.\" $FreeBSD: src/lib/libc/stdlib/atoi.3,v 1.12 2002/12/18 13:33:03 ru Exp $
+.\" $FreeBSD: src/lib/libc/stdlib/atoi.3,v 1.14 2007/10/19 06:23:39 davidxu Exp $
 .\"
 .Dd June 4, 1993
 .Dt ATOI 3
 .Os
 .Sh NAME
-.Nm atoi
+.Nm atoi ,
+.Nm atoi_l
 .Nd convert
 .Tn ASCII
 string to integer
@@ -49,29 +46,46 @@ string to integer
 .Sh SYNOPSIS
 .In stdlib.h
 .Ft int
-.Fn atoi "const char *nptr"
+.Fn atoi "const char *str"
+.In xlocale.h
+.Ft int
+.Fn atoi_l "const char *str" "locale_t loc"
 .Sh DESCRIPTION
 The
 .Fn atoi
 function converts the initial portion of the string pointed to by
-.Fa nptr
+.Fa str
 to
 .Vt int
 representation.
 .Pp
 It is equivalent to:
 .Bd -literal -offset indent
-(int)strtol(nptr, (char **)NULL, 10);
+(int)strtol(str, (char **)NULL, 10);
 .Ed
+.Pp
+While the
+.Fn atoi
+function uses the current locale, the
+.Fn atoi_l
+function may be passed a locale directly. See
+.Xr xlocale 3
+for more information.
 .Sh IMPLEMENTATION NOTES
 The
 .Fn atoi
-function is not thread-safe and also not async-cancel safe.
+and
+.Fn atoi_l
+functions are thread-safe and async-cancel-safe.
 .Pp
 The
 .Fn atoi
-function has been deprecated by
+and
+.Fn atoi_l
+functions have been deprecated by
 .Fn strtol
+and
+.Fn strtol_l
 and should not be used in new code.
 .Sh ERRORS
 The function
@@ -84,7 +98,8 @@ on an error.
 .Xr atol 3 ,
 .Xr strtod 3 ,
 .Xr strtol 3 ,
-.Xr strtoul 3
+.Xr strtoul 3 ,
+.Xr xlocale 3
 .Sh STANDARDS
 The
 .Fn atoi