From 597cc5edd624525563e6549dc0057eca2a51c81d Mon Sep 17 00:00:00 2001 From: Micah Anderson Date: Tue, 11 Nov 2014 13:30:46 -0500 Subject: upgrade to new version --- doc/zmq_z85_decode.txt | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 doc/zmq_z85_decode.txt (limited to 'doc/zmq_z85_decode.txt') diff --git a/doc/zmq_z85_decode.txt b/doc/zmq_z85_decode.txt new file mode 100644 index 0000000..72e9703 --- /dev/null +++ b/doc/zmq_z85_decode.txt @@ -0,0 +1,50 @@ +zmq_z85_decode(3) +================= + + +NAME +---- +zmq_z85_decode - decode a binary key from Z85 printable text + + +SYNOPSIS +-------- +*uint8_t *zmq_z85_decode (uint8_t *dest, char *string);* + + +DESCRIPTION +----------- +The _zmq_z85_decode()_ function shall decode 'string' into 'dest'. +The length of 'string' shall be divisible by 5. 'dest' must be large +enough for the decoded value (0.8 x strlen (string)). + +The encoding shall follow the ZMQ RFC 32 specification. + + +RETURN VALUE +------------ +The _zmq_z85_decode()_ function shall return 'dest' if successful, else it +shall return NULL. + + +EXAMPLE +------- +.Decoding a CURVE key +---- +char decoded [] = "rq:rM>}U?@Lns47E1%kR.o@n%FcmmsL/@{H8]yf7"; +uint8_t public_key [32]; +zmq_z85_decode (public_key, decoded); +---- + + +SEE ALSO +-------- +linkzmq:zmq_z85_decode[3] +linkzmq:zmq_curve_keypair[3] +linkzmq:zmq_curve[7] + + +AUTHORS +------- +This page was written by the 0MQ community. To make a change please +read the 0MQ Contribution Policy at . -- cgit v1.2.3