mirror of
https://github.com/zeromq/libzmq
synced 2025-03-28 21:13:24 +00:00
b6ca9b2983
* migrate from the old, unmaintained "asciidoc-py" tool to the new "asciidoctor" generator * migrate from asciidoc-py syntax to the modern Asciidoc syntax (especially page titles and section titles) * remove the need of "xmlto" utility to create the manpage output; use asciidoctor for that * add HTML output support to the doc/Makefile by using asciidoctor * change API documentation files extension from .txt to .adoc to make it more explicit that they are Asciidoc-encoded (as a bonus several IDE plugins will autodetect the .adoc format as Asciidoc) * remove asciidoc.conf: asciidoctor does not support that; this also required replacing the macro linkzmq into all documentation pages * add a new Github action CI do deploy to Github Pages the static HTMLs produced by Asciidoctors * removed references to the "xmlto" and "a2x" tools from the build and packaging systems: Asciidoctor can convert the documentation directly to e.g. pdf (via extended converters) and anyway there was no code/target for using "xmlto" and "a2x" tools anyway
44 lines
1.0 KiB
Plaintext
44 lines
1.0 KiB
Plaintext
= 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, const 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
|
|
----
|
|
const 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
|
|
xref:zmq_z85_encode.adoc[zmq_z85_encode]
|
|
xref:zmq_curve_keypair.adoc[zmq_curve_keypair]
|
|
xref:zmq_curve_public.adoc[zmq_curve_public]
|
|
xref:zmq_curve.adoc[zmq_curve]
|
|
|
|
|
|
== AUTHORS
|
|
This page was written by the 0MQ community. To make a change please
|
|
read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.
|