Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / lib / msun / man / acosh.3
1 .\" Copyright (c) 1991 Regents of the University of California.
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     from: @(#)acosh.3       5.2 (Berkeley) 5/6/91
33 .\" $FreeBSD: src/lib/msun/man/acosh.3,v 1.6.2.3 2001/12/17 10:08:36 ru Exp $
34 .\" $DragonFly: src/lib/msun/man/Attic/acosh.3,v 1.2 2003/06/17 04:26:52 dillon Exp $
35 .\"
36 .Dd May 6, 1991
37 .Dt ACOSH 3
38 .Os
39 .Sh NAME
40 .Nm acosh ,
41 .Nm acoshf
42 .Nd inverse hyperbolic cosine functions
43 .Sh LIBRARY
44 .Lb libm
45 .Sh SYNOPSIS
46 .In math.h
47 .Ft double
48 .Fn acosh "double x"
49 .Ft float
50 .Fn acoshf "float x"
51 .Sh DESCRIPTION
52 The
53 .Fn acosh
54 and the
55 .Fn acoshf
56 functions compute the inverse hyperbolic cosine
57 of the real
58 argument
59 .Ar x .
60 For a discussion of error due to roundoff, see
61 .Xr math 3 .
62 .Sh RETURN VALUES
63 The
64 .Fn acosh
65 and the
66 .Fn acoshf
67 functions
68 return the inverse hyperbolic cosine of
69 .Ar x .
70 On the
71 .Tn VAX
72 and
73 .Tn Tahoe ,
74 if the argument is less than one
75 .Fn acosh
76 sets the global variable
77 .Va errno
78 to
79 .Er EDOM
80 and
81 causes a reserved operand fault.
82 .Sh SEE ALSO
83 .Xr asinh 3 ,
84 .Xr atanh 3 ,
85 .Xr exp 3 ,
86 .Xr math 3
87 .Sh HISTORY
88 The
89 .Fn acosh
90 function appeared in
91 .Bx 4.3 .