From 1aee86408d575d6572b071d7564da7f006d1757e Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Tue, 9 Mar 2010 18:47:31 +0100 Subject: Documentation rewrite --- doc/zmq_version.txt | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) (limited to 'doc/zmq_version.txt') diff --git a/doc/zmq_version.txt b/doc/zmq_version.txt index 8c038ae..0ad3a55 100644 --- a/doc/zmq_version.txt +++ b/doc/zmq_version.txt @@ -4,19 +4,24 @@ zmq_version(3) NAME ---- -zmq_version - reports 0MQ version +zmq_version - report 0MQ library version SYNOPSIS -------- -'void zmq_version (int *major, int *minor, int *patch);' +*void zmq_version (int '*major', int '*minor', int '*patch');* DESCRIPTION ----------- -Returns current version of 0MQ. The functionality is useful for applications -linking with 0MQ dynamically to make sure the right version of 0MQ is installed -on the system. +The _zmq_version()_ function shall fill in the integer variables pointed to by +the 'major', 'minor' and 'patch' arguments with the major, minor and patchlevel +components of the 0MQ library version. + +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. + RETURN VALUE ------------ @@ -30,6 +35,7 @@ No errors are defined. EXAMPLE ------- +.Printing out the version of the 0MQ library ---- int major, minor, patch; zmq_version (&major, &minor, &patch); @@ -41,6 +47,7 @@ SEE ALSO -------- linkzmq:zmq[7] -AUTHOR ------- -Martin Sustrik +AUTHORS +------- +The 0MQ documentation was written by Martin Sustrik and +Martin Lucina . -- cgit v1.2.3