summaryrefslogtreecommitdiff
path: root/doc/xs_version.txt
diff options
context:
space:
mode:
authorMartin Sustrik <sustrik@250bpm.com>2012-02-16 10:01:47 +0900
committerMartin Sustrik <sustrik@250bpm.com>2012-02-16 10:01:47 +0900
commit4a7aad06d95701cf232198093ce396dcdbb53e5b (patch)
tree8ced8929e603a179d9434099244dfd782e705d5e /doc/xs_version.txt
parent1fc63e4dbcf1438eb571d720f57be68852f820f7 (diff)
ZeroMQ renamed to Crossroads
Signed-off-by: Martin Sustrik <sustrik@250bpm.com>
Diffstat (limited to 'doc/xs_version.txt')
-rw-r--r--doc/xs_version.txt53
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/xs_version.txt b/doc/xs_version.txt
new file mode 100644
index 0000000..c13a080
--- /dev/null
+++ b/doc/xs_version.txt
@@ -0,0 +1,53 @@
+xs_version(3)
+=============
+
+
+NAME
+----
+xs_version - report Crossroads library version
+
+
+SYNOPSIS
+--------
+*void xs_version (int '*major', int '*minor', int '*patch');*
+
+
+DESCRIPTION
+-----------
+The _xs_version()_ function shall fill in the integer variables pointed to by
+the 'major', 'minor' and 'patch' arguments with the major, minor and patch level
+components of the Crossroads library version.
+
+This functionality is intended for applications or language bindings
+dynamically linking to the Crossroads library that wish to determine the actual
+version of the Crossroads library they are using.
+
+
+RETURN VALUE
+------------
+There is no return value.
+
+
+ERRORS
+------
+No errors are defined.
+
+
+EXAMPLE
+-------
+.Printing out the version of the Crossroads library
+----
+int major, minor, patch;
+xs_version (&major, &minor, &patch);
+printf ("Current Crossroads version is %d.%d.%d\n", major, minor, patch);
+----
+
+
+SEE ALSO
+--------
+linkxs:xs[7]
+
+AUTHORS
+-------
+The Crossroads documentation was written by Martin Sustrik <sustrik@250bpm.com>
+and Martin Lucina <martin@lucina.net>.