diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-03-05 20:55:08 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-03-05 20:55:08 -0800 |
| commit | 43c137b7a9ca046f272bb8e6971d8ce385563358 (patch) | |
| tree | 849532fba2e366fe9e8c609d8b8fb96b30edecfb /docs/man/nng_version.adoc | |
| parent | 2e9efe0f6d904f8e3c0bdd60f51ba7434f34e944 (diff) | |
| download | nng-43c137b7a9ca046f272bb8e6971d8ce385563358.tar.gz nng-43c137b7a9ca046f272bb8e6971d8ce385563358.tar.bz2 nng-43c137b7a9ca046f272bb8e6971d8ce385563358.zip | |
Add some man pages (alloc, free, version).
Diffstat (limited to 'docs/man/nng_version.adoc')
| -rw-r--r-- | docs/man/nng_version.adoc | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/man/nng_version.adoc b/docs/man/nng_version.adoc new file mode 100644 index 00000000..3f69b0ca --- /dev/null +++ b/docs/man/nng_version.adoc @@ -0,0 +1,56 @@ += nng_version(3) +// +// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// This document is supplied under the terms of the MIT License, a +// copy of which should be located in the distribution where this +// file was obtained (LICENSE.txt). A copy of the license may also be +// found online at https://opensource.org/licenses/MIT. +// + +== NAME + +nng_version - report library version + +== SYNOPSIS + +[source, c] +----------- +#include <nng/nng.h> + +const char * nng_version(void); +----------- + +== DESCRIPTION + +The `nng_version()` function returns a human readable version +number for the _nng_ library. This is intended for output in +programs, and so forth. + +Additionally, compile time version information is available +via some predefined macros: + +`NNG_MAJOR_VERSION`:: Major version number. +`NNG_MINOR_VERSION`:: Minor version number. +`NNG_PATCH_VERSION`:: Patch version number. + +The _nng_ library is developed and released using +http:///www.semver.org[Semantic Versioning 2.0], and +the version numbers reported refer to both the API and the +library itself. (The ABI -- binary interface -- between the +library and the application is controlled in a similar, but different +manner depending upon the link options and how the library is built.) + +== RETURN VALUES + +C string (NUL-terminated) containing the library version number. + +== ERRORS + +None. + +== SEE ALSO + +<<libnng#,libnng(3)>>, +<<nng#,nng(7)>> |
