From 1f4fb92a5f52e25170f28a61e6979cf63ca7f36b Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Tue, 1 Mar 2016 11:49:17 +0100
Subject: Add more man pages
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@kth.se>
---
 man/zmod.3 | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 man/zmod.3

(limited to 'man/zmod.3')

diff --git a/man/zmod.3 b/man/zmod.3
new file mode 100644
index 0000000..9c6e72b
--- /dev/null
+++ b/man/zmod.3
@@ -0,0 +1,41 @@
+.TH ZMOD 3 libzahl
+.SH NAME
+zmod - Calculate the modulus of two big integer
+.SH SYNOPSIS
+.nf
+#include <zahl.h>
+
+void zmod(z_t \fIremainder\fP, z_t \fIdividend\fP, z_t \fIdivisor\fP);
+.fi
+.SH DESCRIPTION
+.B zmod
+calculates the remainder of a
+.I dividend
+and a
+.IR divisor ,
+and stores the result in
+.IR remainder .
+That is,
+.I remainder
+gets
+.I dividend
+Mod
+.IR divisor .
+.P
+The result
+.RI ( remainder )
+is always non-negative.
+.P
+It is safe to call
+.B zmod
+with non-unique parameters.
+.SH SEE ALSO
+.BR zdivmod (3),
+.BR zstr (3),
+.BR zadd (3),
+.BR zsub (3),
+.BR zmul (3),
+.BR zdiv (3),
+.BR zneg (3),
+.BR zabs (3),
+.BR zpow (3)
-- 
cgit v1.2.3-70-g09d2