diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-03-15 08:40:17 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-03-17 08:49:12 -0700 |
| commit | 98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 (patch) | |
| tree | e3cc06524b26fd0773d1742de82a00862f95c5f6 /docs/man/nng_version.adoc | |
| parent | 91866ed9365ab89069c12da41c873c23d0ba1d19 (diff) | |
| download | nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.gz nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.bz2 nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.zip | |
fixes #286 nng_pair0_open (and all others) need man page
fixes #279 consider restructuring man sections
This represents a rather significant rework, and major editing
effort, for the entire set of manual pages.
All of the pages now have a section number in their filename;
this assists in some other tooling, particularly ebook generation
as every link needs to be programmatically modified when combined
into an ebook.
Section 5 is introduced, and populated with pages for the main
types, and all options are now documented.
Numerous errors have been corrected, including rewriting certain
portions such as the header section of the surveyor protocol.
Much work has been done to facilitate index generation, although
certainly more work remains here.
Every internal link within these pages now resolves; there are no
more dead links. (This is required to generate Kindle format books.)
Diffstat (limited to 'docs/man/nng_version.adoc')
| -rw-r--r-- | docs/man/nng_version.adoc | 57 |
1 files changed, 0 insertions, 57 deletions
diff --git a/docs/man/nng_version.adoc b/docs/man/nng_version.adoc deleted file mode 100644 index bc578682..00000000 --- a/docs/man/nng_version.adoc +++ /dev/null @@ -1,57 +0,0 @@ -= 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)) -- ((application 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)>> |
