aboutsummaryrefslogtreecommitdiffstats
path: root/man/zstr.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2016-03-01 10:55:20 +0100
committerMattias Andrée <maandree@kth.se>2016-03-01 10:55:20 +0100
commit32b87c5979a0e70994e4db65415ec0a2349c5618 (patch)
treea366f6c46762f349ce8b96439a35ac944021055b /man/zstr.3
parentAdd a number of man pages (diff)
downloadlibzahl-32b87c5979a0e70994e4db65415ec0a2349c5618.tar.gz
libzahl-32b87c5979a0e70994e4db65415ec0a2349c5618.tar.bz2
libzahl-32b87c5979a0e70994e4db65415ec0a2349c5618.tar.xz
Add more man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man/zstr.3')
-rw-r--r--man/zstr.336
1 files changed, 36 insertions, 0 deletions
diff --git a/man/zstr.3 b/man/zstr.3
new file mode 100644
index 0000000..9fef75b
--- /dev/null
+++ b/man/zstr.3
@@ -0,0 +1,36 @@
+.TH ZSTR 3 libzahl
+.SH NAME
+zstr - Create a string representation of a big integer
+.SH SYNOPSIS
+.nf
+#include <zahl.h>
+
+char *zstr(z_t \fIa\fP, char *\fIstr\fP);
+.fi
+.SH DESCRIPTION
+.B zstr
+writes the integer
+.I a
+in decimal form into
+.IR str .
+If
+.I str
+is is
+.BR 0 ,
+.B zstr
+create a new allocation.
+.SH RETURN VALUE
+.I str
+is returned unless
+.I str
+is
+.BR 0 .
+If
+.I str
+is
+.BR 0 ,
+the string allocated by the function is returned.
+.SH SEE ALSO
+.BR zstr_length_positive (3),
+.BR zsets (3),
+.BR zload (3)