freebsd-dev/lib/libc/stdlib/atof.3

.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the American National Standards Committee X3, on Information
.\" Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 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.
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)atof.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd June 4, 1993
.Dt ATOF 3
.Os
.Sh NAME
.Nm atof
.Nd convert
.Tn ASCII
string to double
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdlib.h
.Ft double
.Fn atof "const char *nptr"
.Sh DESCRIPTION
The
.Fn atof
function converts the initial portion of the string pointed to by
.Fa nptr
to
.Vt double
representation.
.Pp
It is equivalent to:
.Bd -literal -offset indent
strtod(nptr, (char **)NULL);
.Ed
.Pp
The decimal point
character is defined in the program's locale (category
.Dv LC_NUMERIC ) .
.Sh IMPLEMENTATION NOTES
The
.Fn atof
function is not thread-safe and also not async-cancel-safe.
.Pp
The
.Fn atof
function has been deprecated by
.Fn strtod
and should not be used in new code.
.Sh ERRORS
The function
.Fn atof
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
.Sh STANDARDS
The
.Fn atof
function conforms to
.St -p1003.1-90 ,
.St -isoC ,
and
.St -isoC-99 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" This code is derived from software contributed to Berkeley by`
			`.\" the American National Standards Committee X3, on Information`
			`.\" Processing Systems.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 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.`
			`.\" 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.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)atof.3 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
			`.Dd June 4, 1993`
			`.Dt ATOF 3`
			`.Os`
			`.Sh NAME`
			`.Nm atof`
			`.Nd convert`
			`.Tn ASCII`
			`string to double`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
Move to using .In instead of .Fd #include <> for include mark-up. Inspired by comment from: dd 2001-09-07 14:46:36 +00:00			`.In stdlib.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft double`
			`.Fn atof "const char *nptr"`
			`.Sh DESCRIPTION`
			`The`
			`.Fn atof`
			`function converts the initial portion of the string pointed to by`
mdoc(7) police: Fixed abuses of the .Ar and .Em macros. 2002-12-18 13:33:04 +00:00			`.Fa nptr`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`to`
mdoc(7) police: Fixed abuses of the .Ar and .Em macros. 2002-12-18 13:33:04 +00:00			`.Vt double`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`representation.`
			`.Pp`
			`It is equivalent to:`
			`.Bd -literal -offset indent`
			`strtod(nptr, (char **)NULL);`
mdoc(7) police: mark LC_NUMERIC with .Dv. 2001-02-10 10:26:52 +00:00			`.Ed`
Note that decimal point taken from locale 2001-02-10 06:42:32 +00:00			`.Pp`
			`The decimal point`
mdoc(7) police: mark LC_NUMERIC with .Dv. 2001-02-10 10:26:52 +00:00			`character is defined in the program's locale (category`
			`.Dv LC_NUMERIC ) .`
Add more standards which we conform to. Note our implementation is not thread nor async-cancel safe. Explicitely note atof() does not check nor report errors. Note that strtod() should be used instead. 2001-09-09 21:09:53 +00:00			`.Sh IMPLEMENTATION NOTES`
			`The`
			`.Fn atof`
			`function is not thread-safe and also not async-cancel-safe.`
			`.Pp`
			`The`
			`.Fn atof`
			`function has been deprecated by`
			`.Fn strtod`
			`and should not be used in new code.`
Be explicit about the POSIX version it conforms to [in this case 1990]. Put the error comment under the more appropriate ERRORS section. 2001-09-26 20:10:10 +00:00			`.Sh ERRORS`
Back out errno preserving 2001-12-30 03:34:46 +00:00			`The function`
Be explicit about the POSIX version it conforms to [in this case 1990]. Put the error comment under the more appropriate ERRORS section. 2001-09-26 20:10:10 +00:00			`.Fn atof`
mdoc(7) police: add missing markup bits for ``errno''. 2002-01-09 14:03:54 +00:00			`need not affect the value of`
			`.Va errno`
			`on an error.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SEE ALSO`
			`.Xr atoi 3 ,`
			`.Xr atol 3 ,`
			`.Xr strtod 3 ,`
			`.Xr strtol 3 ,`
			`.Xr strtoul 3`
			`.Sh STANDARDS`
			`The`
			`.Fn atof`
			`function conforms to`
Be explicit about the POSIX version it conforms to [in this case 1990]. Put the error comment under the more appropriate ERRORS section. 2001-09-26 20:10:10 +00:00			`.St -p1003.1-90 ,`
Change standards compliancy order so that C and POSIX are grouped. 2001-09-26 19:42:39 +00:00			`.St -isoC ,`
Add more standards which we conform to. Note our implementation is not thread nor async-cancel safe. Explicitely note atof() does not check nor report errors. Note that strtod() should be used instead. 2001-09-09 21:09:53 +00:00			`and`
			`.St -isoC-99 .`