~ubuntu-branches/ubuntu/maverick/zeromq/maverick

« back to all changes in this revision

Viewing changes to doc/zmq_version.3

  • Committer: Bazaar Package Importer
  • Author(s): Adrian von Bidder
  • Date: 2010-03-17 10:43:40 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20100317104340-un1ne0oqe16w8eaq
Tags: 2.0.6beta.dfsg-1
* New upstream version.
  - Source doesn't include non-C/C++ language bindings anymore.
  - New versioning: 2.0.6 is official upstream version which is a beta.
* Repacked orig tar: removed non-free RFC documents (closes: #567513)
* Improved/corrected description and copyright file, added bzip2 build
  dependency.  Thanks to feedback from zeromq mailing list.
* Disable OpenPGM on non-x86 architectures (closes: #567848)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
'\" t
 
2
.\"     Title: zmq_version
 
3
.\"    Author: [see the "AUTHORS" section]
 
4
.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
 
5
.\"      Date: 03/16/2010
 
6
.\"    Manual: 0MQ Manual
 
7
.\"    Source: 0MQ 2.0.6
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "ZMQ_VERSION" "3" "03/16/2010" "0MQ 2\&.0\&.6" "0MQ Manual"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * set default formatting
 
13
.\" -----------------------------------------------------------------
 
14
.\" disable hyphenation
 
15
.nh
 
16
.\" disable justification (adjust text to left margin only)
 
17
.ad l
 
18
.\" -----------------------------------------------------------------
 
19
.\" * MAIN CONTENT STARTS HERE *
 
20
.\" -----------------------------------------------------------------
 
21
.SH "NAME"
 
22
zmq_version \- report 0MQ library version
 
23
.SH "SYNOPSIS"
 
24
.sp
 
25
\fBvoid zmq_version (int \fR\fB\fI*major\fR\fR\fB, int \fR\fB\fI*minor\fR\fR\fB, int \fR\fB\fI*patch\fR\fR\fB);\fR
 
26
.SH "DESCRIPTION"
 
27
.sp
 
28
The \fIzmq_version()\fR function shall fill in the integer variables pointed to by the \fImajor\fR, \fIminor\fR and \fIpatch\fR arguments with the major, minor and patchlevel components of the 0MQ library version\&.
 
29
.sp
 
30
This functionality is intended for applications or language bindings dynamically linking to the 0MQ library that wish to determine the actual version of the 0MQ library they are using\&.
 
31
.SH "RETURN VALUE"
 
32
.sp
 
33
There is no return value\&.
 
34
.SH "ERRORS"
 
35
.sp
 
36
No errors are defined\&.
 
37
.SH "EXAMPLE"
 
38
.PP
 
39
\fBExample\ \&1.\ \&Printing out the version of the 0MQ library\fR
 
40
.sp
 
41
.if n \{\
 
42
.RS 4
 
43
.\}
 
44
.nf
 
45
int major, minor, patch;
 
46
zmq_version (&major, &minor, &patch);
 
47
printf ("Current 0MQ version is %d\&.%d\&.%d\en", major, minor, patch);
 
48
.fi
 
49
.if n \{\
 
50
.RE
 
51
.\}
 
52
.SH "SEE ALSO"
 
53
.sp
 
54
\fBzmq\fR(7)
 
55
.SH "AUTHORS"
 
56
.sp
 
57
The 0MQ documentation was written by Martin Sustrik <\m[blue]\fBsustrik@250bpm\&.com\fR\m[]\&\s-2\u[1]\d\s+2> and Martin Lucina <\m[blue]\fBmato@kotelna\&.sk\fR\m[]\&\s-2\u[2]\d\s+2>\&.
 
58
.SH "NOTES"
 
59
.IP " 1." 4
 
60
sustrik@250bpm.com
 
61
.RS 4
 
62
\%mailto:sustrik@250bpm.com
 
63
.RE
 
64
.IP " 2." 4
 
65
mato@kotelna.sk
 
66
.RS 4
 
67
\%mailto:mato@kotelna.sk
 
68
.RE