Add more man pages

Signed-off-by: Mattias Andrée <maandree@kth.se>

1 files changed, 50 insertions, 0 deletions

diff --git a/man/zdivmod.3 b/man/zdivmod.3
new file mode 100644
index 0000000..683d17f
--- /dev/null
+++ b/man/zdivmod.3
@@ -0,0 +1,50 @@
+.TH ZDIVMOD 3 libzahl
+.SH NAME
+zdivmod - Calculate the quotient and the remainder of two big integer
+.SH SYNOPSIS
+.nf
+#include <zahl.h>
+
+void zdivmod(z_t \fIquotient\fP, z_t \fIremainder\fP, z_t \fIdividend\fP, z_t \fIdivisor\fP);
+.fi
+.SH DESCRIPTION
+.B zdivmod
+calculates the quotient and the remainder of a
+.I dividend
+and a
+.IR divisor ,
+and stores the quotient in
+.I quotient
+and the remainder in
+.IR remainder .
+That is,
+.I quotient
+gets
+.I dividend
+/
+.I divisor
+and
+.I remainder
+gets
+.I dividend
+Mod
+.IR divisor .
+.P
+It is safe to call
+.B zdivmod
+with non-unique parameters,
+except it is
+.I not
+safe to call
+.B zdivmod with
+.IR "(quotient==remainder)" .
+.SH SEE ALSO
+.BR zstr (3),
+.BR zadd (3),
+.BR zsub (3),
+.BR zmul (3),
+.BR zdiv (3),
+.BR zmod (3),
+.BR zneg (3),
+.BR zabs (3),
+.BR zpow (3)