Document complex math library.

1 files changed, 59 insertions, 0 deletions

diff --git a/lib/libm/man/carg.3 b/lib/libm/man/carg.3
new file mode 100644
index 00000000000..2a95238b9b4
--- /dev/null
+++ b/lib/libm/man/carg.3
@@ -0,0 +1,59 @@
+.\"	$OpenBSD: carg.3,v 1.1 2011/07/20 17:50:43 martynas Exp $
+.\"
+.\" Copyright (c) 2011 Martynas Venckus <martynas@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: July 20 2011 $
+.Dt CARG 3
+.Os
+.Sh NAME
+.Nm carg ,
+.Nm cargf ,
+.Nm cargl
+.Nd complex argument functions
+.Sh SYNOPSIS
+.Fd #include <complex.h>
+.Ft double
+.Fn carg "double complex z"
+.Ft float
+.Fn cargf "float complex z"
+.Ft long double
+.Fn cargl "long double complex z"
+.Sh DESCRIPTION
+The
+.Fn carg ,
+.Fn cargf
+and
+.Fn cargl
+functions compute the argument (also called phase angle) of
+.Fa z ,
+with a branch cut on the negative real axis.
+.Sh RETURN VALUES
+The
+.Fn carg ,
+.Fn cargf
+and
+.Fn cargl
+functions return the argument in the interval
+.Bq -Pi, Pi .
+.Sh SEE ALSO
+.Xr cimag 3
+.Sh STANDARDS
+The
+.Fn carg ,
+.Fn cargf
+and
+.Fn cargl
+functions conform to
+.St -isoC-99 .