aboutsummaryrefslogtreecommitdiffstats
path: root/man/zinit.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2016-02-29 15:34:38 +0100
committerMattias Andrée <maandree@kth.se>2016-02-29 15:34:38 +0100
commita1a1d9ed137c8e404e7f0bd41804099ef18b9267 (patch)
tree171def711738fa9989a9b040bb264e2cecbda867 /man/zinit.3
parentreadme: libzahl is not thread-safe at the moment (diff)
downloadlibzahl-a1a1d9ed137c8e404e7f0bd41804099ef18b9267.tar.gz
libzahl-a1a1d9ed137c8e404e7f0bd41804099ef18b9267.tar.bz2
libzahl-a1a1d9ed137c8e404e7f0bd41804099ef18b9267.tar.xz
Add a number of man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man/zinit.3')
-rw-r--r--man/zinit.333
1 files changed, 33 insertions, 0 deletions
diff --git a/man/zinit.3 b/man/zinit.3
new file mode 100644
index 0000000..060224d
--- /dev/null
+++ b/man/zinit.3
@@ -0,0 +1,33 @@
+.TH ZINIT 3 libzahl
+.SH NAME
+zinit - Prepare a bit integer for use.
+.SH SYNOPSIS
+.nf
+#include <zahl.h>
+
+void zinit(z_t \fIa\fP);
+.fi
+.SH DESCRIPTION
+.B zinit
+initializes the big integer
+.I a
+so that it can be used in other function calls.
+.P
+.B z_t
+is defined as
+.P
+.nf
+typedef struct {
+ /* You should not care about what is
+ * inside this struct. It could change
+ * in the future. */
+} z_t[1];
+.fi
+.SH SEE ALSO
+.BR zfree (3),
+.BR zswap (3),
+.BR zsave (3),
+.BR zsignum (3),
+.BR zeven (3),
+.BR zset (3),
+.BR zcmp (3)