summaryrefslogtreecommitdiff
path: root/doc/zmq_z85_decode.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zmq_z85_decode.3')
-rw-r--r--doc/zmq_z85_decode.364
1 files changed, 0 insertions, 64 deletions
diff --git a/doc/zmq_z85_decode.3 b/doc/zmq_z85_decode.3
deleted file mode 100644
index 1324736..0000000
--- a/doc/zmq_z85_decode.3
+++ /dev/null
@@ -1,64 +0,0 @@
-'\" t
-.\" Title: zmq_z85_decode
-.\" Author: [see the "AUTHORS" section]
-.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 03/10/2014
-.\" Manual: 0MQ Manual
-.\" Source: 0MQ 4.0.1
-.\" Language: English
-.\"
-.TH "ZMQ_Z85_DECODE" "3" "03/10/2014" "0MQ 4\&.0\&.1" "0MQ Manual"
-.\" -----------------------------------------------------------------
-.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.ie \n(.g .ds Aq \(aq
-.el .ds Aq '
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-zmq_z85_decode \- decode a binary key from Z85 printable text
-.SH "SYNOPSIS"
-.sp
-\fBuint8_t *zmq_z85_decode (uint8_t *dest, char *string);\fR
-.SH "DESCRIPTION"
-.sp
-The \fIzmq_z85_decode()\fR function shall decode \fIstring\fR into \fIdest\fR\&. The length of \fIstring\fR shall be divisible by 5\&. \fIdest\fR must be large enough for the decoded value (0\&.8 x strlen (string))\&.
-.sp
-The encoding shall follow the ZMQ RFC 32 specification\&.
-.SH "RETURN VALUE"
-.sp
-The \fIzmq_z85_decode()\fR function shall return \fIdest\fR if successful, else it shall return NULL\&.
-.SH "EXAMPLE"
-.PP
-\fBDecoding a CURVE key\fR.
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-char decoded [] = "rq:rM>}U?@Lns47E1%kR\&.o@n%FcmmsL/@{H8]yf7";
-uint8_t public_key [32];
-zmq_z85_decode (public_key, decoded);
-.fi
-.if n \{\
-.RE
-.\}
-.sp
-.SH "SEE ALSO"
-.sp
-\fBzmq_z85_decode\fR(3) \fBzmq_curve_keypair\fR(3) \fBzmq_curve\fR(7)
-.SH "AUTHORS"
-.sp
-This page was written by the 0MQ community\&. To make a change please read the 0MQ Contribution Policy at \m[blue]\fBhttp://www\&.zeromq\&.org/docs:contributing\fR\m[]\&.