Libc-583.tar.gz

[apple/libc.git] / stdlib / atof.3

diff --git a/stdlib/atof.3 b/stdlib/atof.3
index 1f5042d117aed15c11fc85f3b2db88981063983c..1d32d064a262e32d7da064ade517885423c8e362 100644 (file)
--- a/stdlib/atof.3
+++ b/stdlib/atof.3
@@ -34,13 +34,14 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)atof.3     8.1 (Berkeley) 6/4/93
-.\" $FreeBSD: src/lib/libc/stdlib/atof.3,v 1.12 2001/09/26 20:10:10 asmodai Exp $
+.\" $FreeBSD: src/lib/libc/stdlib/atof.3,v 1.16 2002/12/18 13:33:03 ru Exp $
 .\"
 .Dd June 4, 1993
 .Dt ATOF 3
 .Os
 .Sh NAME
-.Nm atof
+.Nm atof ,
+.Nm atof_l
 .Nd convert
 .Tn ASCII
 string to double
@@ -49,24 +50,35 @@ string to double
 .Sh SYNOPSIS
 .In stdlib.h
 .Ft double
-.Fn atof "const char *nptr"
+.Fn atof "const char *str"
+.In xlocale.h
+.Ft double
+.Fn atof_l "const char *str" "locale_t loc"
 .Sh DESCRIPTION
 The
 .Fn atof
 function converts the initial portion of the string pointed to by
-.Ar nptr
+.Fa str
 to
-.Ar double
+.Vt double
 representation.
 .Pp
 It is equivalent to:
 .Bd -literal -offset indent
-strtod(nptr, (char **)NULL);
+strtod(str, (char **)NULL);
 .Ed
 .Pp
 The decimal point
 character is defined in the program's locale (category
 .Dv LC_NUMERIC ) .
+.Pp
+While the
+.Fn atof
+function uses the current locale, the
+.Fn atof_l
+function may be passed a locale directly. See
+.Xr xlocale 3
+for more information.
 .Sh IMPLEMENTATION NOTES
 The
 .Fn atof
@@ -78,15 +90,18 @@ function has been deprecated by
 .Fn strtod
 and should not be used in new code.
 .Sh ERRORS
-The
+The function
 .Fn atof
-function does not detect errors.
+need not affect the value of
+.Va errno
+on an error.
 .Sh SEE ALSO
 .Xr atoi 3 ,
 .Xr atol 3 ,
 .Xr strtod 3 ,
 .Xr strtol 3 ,
-.Xr strtoul 3
+.Xr strtoul 3 ,
+.Xr xlocale 3
 .Sh STANDARDS
 The
 .Fn atof