From 2ac45d7d78aec9a7387201a90fe4a9d11cd86df8 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 26 Oct 2017 13:14:07 -0700 Subject: Documentation updates. This adds a few man pages, fixes the content and formatting on a few others. It also adds two utility scripts for me to use, publish.sh, which I use to publish updates to the gh-pages branch, and preview.sh, which I use to look at markup without cluttering my work directory. --- docs/nng.adoc | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) (limited to 'docs/nng.adoc') diff --git a/docs/nng.adoc b/docs/nng.adoc index 2ffc6e5b..e09cd014 100644 --- a/docs/nng.adoc +++ b/docs/nng.adoc @@ -3,7 +3,6 @@ nng(7) :doctype: manpage :manmanual: nng :mansource: nng -:manvolnum: 7 :icons:font :copyright: Copyright 2017 Garrett D'Amore \ Copyright 2017 Capitar IT Group BV \ @@ -39,9 +38,10 @@ The _nng_ library is designed to permit easy creation of new _transports_ and, to a lesser extent, new _protocols_. The _nng_ library is wire compatible with the SP protocols described in -the nanomsg project; projects using _libnanomsg_ can inter-operate with +the nanomsg project; projects using +https://github.com/nanomsg/nanomsg[_libnanomsg_] can inter-operate with nng as well as other conforming implementations. (One such implementation -is the https://github.com/go-mangos/mangos[mangos]. Applications using _nng_ +is https://github.com/go-mangos/mangos[_mangos_].) Applications using _nng_ which wish to communicate with older libraries must ensure that they only use protocols or transports offered by the earlier library. @@ -56,11 +56,17 @@ other languages please check the http://nanomsg.org/[website]. Protocols ~~~~~~~~~ -* <> - Bus protocol -* <> - Pair protocol -* <> - Publish/Subscribe protocol -* <> - Request/Reply protocol -* <> - Survey/Respond protocol +* <> - Bus protocol +* <> - Pair protocol +* <> - Publisher side of publish/subscribe protocol +* <> - Subscriber side of publish/subscribe protocol +* <> - Reply side of request/reply protocol +* <> - Request side of request/reply protocol +* <> - Respondent side of survey protocol +* <> - Surveyor side of survey protocol + + +* <> - Survey/Respond protocol Transports ~~~~~~~~~~ -- cgit v1.2.3-70-g09d2