diff options
Diffstat (limited to 'doc/zmq_curve_keypair.3')
| -rw-r--r-- | doc/zmq_curve_keypair.3 | 69 |
1 files changed, 0 insertions, 69 deletions
diff --git a/doc/zmq_curve_keypair.3 b/doc/zmq_curve_keypair.3 deleted file mode 100644 index b99e0ed..0000000 --- a/doc/zmq_curve_keypair.3 +++ /dev/null @@ -1,69 +0,0 @@ -'\" t -.\" Title: zmq_curve_keypair -.\" 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_CURVE_KEYPAIR" "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_curve_keypair \- generate a new CURVE keypair -.SH "SYNOPSIS" -.sp -\fBint zmq_curve_keypair (char *z85_public_key, char *z85_secret_key);\fR -.SH "DESCRIPTION" -.sp -The \fIzmq_curve_keypair()\fR function shall return a newly generated random keypair consisting of a public key and a secret key\&. The caller provides two buffers, each at least 41 octets large, in which this method will store the keys\&. The keys are encoded using \fBzmq_z85_encode\fR(3)\&. -.SH "RETURN VALUE" -.sp -The \fIzmq_curve_keypair()\fR function shall return 0 if successful, else it shall return \-1 and set \fIerrno\fR to one of the values defined below\&. -.SH "ERRORS" -.PP -\fBENOTSUP\fR -.RS 4 -The libzmq library was not built with cryptographic support (libsodium)\&. -.RE -.SH "EXAMPLE" -.PP -\fBGenerating a new CURVE keypair\fR. -.sp -.if n \{\ -.RS 4 -.\} -.nf -char public_key [41]; -char secret_key [41]; -int rc = crypto_box_keypair (public_key, secret_key); -assert (rc == 0); -.fi -.if n \{\ -.RE -.\} -.sp -.SH "SEE ALSO" -.sp -\fBzmq_z85_decode\fR(3) \fBzmq_z85_encode\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[]\&. |