aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nngcat.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-03-07 23:53:10 -0800
committerGarrett D'Amore <garrett@damore.org>2018-03-07 23:53:10 -0800
commite892f2e13786af2ffec74934ac363e3a9890f7b7 (patch)
tree8de9c909404d9496e87d0dbfd3bf943dd53adf46 /docs/man/nngcat.adoc
parenteab4c99046347144afdd8f42898c1d53d9cc14f0 (diff)
downloadnng-e892f2e13786af2ffec74934ac363e3a9890f7b7.tar.gz
nng-e892f2e13786af2ffec74934ac363e3a9890f7b7.tar.bz2
nng-e892f2e13786af2ffec74934ac363e3a9890f7b7.zip
Fix a number of broken links.
There are still some busted links that have to be fixed, but these are the ones that are just typos or trivially fixed. There is of course some content still missing.
Diffstat (limited to 'docs/man/nngcat.adoc')
-rw-r--r--docs/man/nngcat.adoc64
1 files changed, 34 insertions, 30 deletions
diff --git a/docs/man/nngcat.adoc b/docs/man/nngcat.adoc
index 5e776e95..edb22629 100644
--- a/docs/man/nngcat.adoc
+++ b/docs/man/nngcat.adoc
@@ -52,11 +52,12 @@ equa
*--compat*::
Compatible mode. This cause _nngcat_ to behave more like the legacy
_nanocat_ application. In this mode connections are made asynchronously,
- and the *--pair* option selects version 0 of the <<nng_pair#,PAIR>> protocol
- instead of version 1.
+ and the *--pair* option selects version 0 of the <<nng_pair#,nng_pair(7)>>
+ protocol instead of version 1.
*--subscribe*=_TOPIC_::
Subscribe to _TOPIC_. This option can only be used with the
- <<nng_sub#,SUBv0>> protocol. The _TOPIC_ is checked against the first bytes
+ <<nng_sub#,nng_sub(7)>> protocol. The _TOPIC_ is checked against the
+ first bytes
of messages received, and messages are discarded if they do not match.
This may be specified multiple times to subscribe to multiple topics. If
not specified at all, then a default subscription to everything is assumed.
@@ -65,42 +66,45 @@ equa
NOTE: At least one protocol must be selected.
*--bus, --bus0*::
- Select the <<nng_bus#,BUSv0>> protocol. This protocol can send
- and receive messages to and from other <<nng_bus#,BUSv0>> peers.
+ Select the <<nng_bus#,nng_bus(7)>> version 0 protocol. This protocol can send
+ and receive messages to and from other BUS version 0 peers.
*--req, --req0*::
- Select the <<nng_req#,REQv0>> protocol. This protocol sends
- messages to <<nng_rep#,REPv0>> peers and receives replies from them.
+ Select the <<nng_req#,nng_req(7)>> version 0 protocol. This protocol sends
+ messages to <<nng_rep#,nng_rep(7)>> version 0 peers and receives replies
+ from them.
*--rep, --rep0*::
- Select the <<nng_rep#,REPv0>> protocol. This protocol receives
- messages from <<nng_req#,REQv0>> peers and can send replies to them.
+ Select the <<nng_rep#,nng_rep(7)>> version 0 protocol. This protocol
+ receives messages from <<nng_req#,nng_req(7)>> version 0 peers and can send
+ replies to them.
*--pub, --pub0*::
- Select the <<nng_pub#,PUBv0>> protocol. This protocol sends
- messages to <<nng_sub#,SUBv0>> peers.
+ Select the <<nng_pub#,nng_pub(7)>> version 0 protocol. This protocol sends
+ messages to <<nng_sub#,nng_sub(7)>> version peers.
*--sub, --sub0*::
- Select the <<nng_sub#,SUBv0>> protocol. This protocol receives
- messages from <<nng_pub#,PUBv0>> peers, and filters them based on
- subscriptions set with *--subscribe*.
+ Select the <<nng_sub#,nng_sub(7)>> version 0 protocol.
+ This protocol receives messages from <<nng_pub#,nng_pub(7)>> version 0 peers,
+ and filters them based on subscriptions set with *--subscribe*.
*--push, --push0*::
- Select the <<nng_push#,PUSHv0>> protocol. This protocol sends
- messages to <<nng_pull#,PULLv0>> peers. A given message is normally
- only delivered to a single peer.
+ Select the <<nng_push#,nng_push(7)>> version 0 protocol.
+ This protocol sends messages to <<nng_pull#,nng_pull(7)>> version 0 peers.
+ A given message is normally only delivered to a single peer.
*--pull, --pull0*::
- Select the <<nng_pull#,PULLv0>> protocol. This protocol receives
- messages from <<nng_push#,PUSHv0>> peers.
+ Select the <<nng_pull#,nng_pull(7)>> version 0 protocol.
+ This protocol receives
+ messages from <<nng_push#,nng_push(7)>> version 0 peers.
*--pair0*::
- Select the <<nng_pair#,PAIRv0>> protocol. This protocol can send and
- receive messages with one connected <<nng_pair#,PAIRv0>> peer.
+ Select the <<nng_pair#,nng_pair(7)>> veresion 0 protocol. This protocol
+ can send and receive messages with one connected PAIR version 0 peer.
*--pair1*::
- Select the <<nng_pair#,PAIRv1>> protocol. This protocol can send and
- receive messages with one connected <<nng_pair#,PAIRv1>> peer. It
+ Select the <<nng_pair#,nng_pair(7)>> version 1 protocol. This protocol
+ can send and receive messages with one connected PAIR version 1 peer. It
is not supported in *--compat* mode. (Polyamorous mode is not supported
in _nngcat_, although peers may be using polyamorous mode.)
@@ -109,14 +113,14 @@ NOTE: At least one protocol must be selected.
which case it acts as an alias for *--pair0*.
*--surveyor, --surveyor0*::
- Select the <<nng_surveyor#,SURVEYORv0>> protocol. This protocol sends
- a survey request to <<nng_respondent#,RESPONDENTv0>> peers, and then
- receives replies from them.
+ Select the <<nng_surveyor#,nng_surveyor(7)>> version 0 protocol.
+ This protocol sends a survey request to <<nng_respondent#,nng_respondent(7)>>
+ version 0 peers, and then receives replies from them.
*--respondent, --respondent0*::
- Select the <<nng_respondent#,RESPONDENTv0>> protocol. This protocol receives
- survey requests from <<nng_survey#,SURVEYORv0>> peers, and can send a reply
- to them.
+ Select the <<nng_respondent#,nng_respondent(7)>> version 0 protocol.
+ This protocol receives survey requests from <<nng_surveyor#,nng_surveyor(7)>>
+ version 0 peers, and can send a reply to them.
=== Peer Selection
NOTE: At least one peer address must be selected.
@@ -266,7 +270,7 @@ $ nngcat --sub --dial=${addr} --quoted &
== SEE ALSO
<<libnng#,libnng(3)>>,
-<<nng#,nng(3)>>,
+<<nng#,nng(7)>>,
<<nng_bus#,nng_bus(7)>>,
<<nng_pair#,nng_pair(7)>>,
<<nng_pub#,nng_pub(7)>>,