Libc-1439.100.3.tar.gz

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

diff --git a/stdlib/FreeBSD/atof.3 b/stdlib/FreeBSD/atof.3
index e417e279932104415b729727e19d1f5145125fba..5454422c974b9ae8bb6db6098b8f769797fa8123 100644 (file)
--- a/stdlib/FreeBSD/atof.3
+++ b/stdlib/FreeBSD/atof.3
@@ -36,7 +36,8 @@
 .Dt ATOF 3
 .Os
 .Sh NAME
 .Dt ATOF 3
 .Os
 .Sh NAME

-.Nm atof
+.Nm atof ,
+.Nm atof_l

 .Nd convert
 .Tn ASCII
 string to double
 .Nd convert
 .Tn ASCII
 string to double


@@ -45,34 +46,51 @@ string to double
 .Sh SYNOPSIS
 .In stdlib.h
 .Ft 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
 .Sh DESCRIPTION
 The
 .Fn atof
 function converts the initial portion of the string pointed to by

-.Fa nptr
+.Fa str

 to
 .Vt double
 representation.
 .Pp
 It is equivalent to:
 .Bd -literal -offset indent
 to
 .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 ) .
 .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
 .Sh IMPLEMENTATION NOTES
 The
 .Fn atof

-function is not thread-safe and also not async-cancel-safe.
+and
+.Fn atof_l
+functions are thread-safe and async-cancel-safe.

 .Pp
 The
 .Pp
 The

+.Fn strtod 
+and 
+.Fn strtod_l
+functions are recommended instead of 

 .Fn atof
 .Fn atof

-function has been deprecated by
-.Fn strtod
-and should not be used in new code.
+and
+.Fn atof_l
+functions, especially in new code.

 .Sh ERRORS
 The function
 .Fn atof
 .Sh ERRORS
 The function
 .Fn atof


@@ -84,7 +102,8 @@ on an error.
 .Xr atol 3 ,
 .Xr strtod 3 ,
 .Xr strtol 3 ,
 .Xr atol 3 ,
 .Xr strtod 3 ,
 .Xr strtol 3 ,

-.Xr strtoul 3
+.Xr strtoul 3 ,
+.Xr xlocale 3

 .Sh STANDARDS
 The
 .Fn atof
 .Sh STANDARDS
 The
 .Fn atof