Skip to content

Commit

Permalink
Fix a number of broken links.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
gdamore committed Mar 8, 2018
1 parent eab4c99 commit e892f2e
Show file tree
Hide file tree
Showing 15 changed files with 56 additions and 58 deletions.
4 changes: 2 additions & 2 deletions docs/man/libnng.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ mode may need to access the header of messages.
=== Asynchronous Operations

Most applications will interact with _nng_ synchronously; that is that
functions such as <<nng_send#,nng_send()>> will block the calling
functions such as <<nng_send#,nng_send(3)>> will block the calling
thread until the operation has completed.

NOTE: Synchronous operations which send messages may return before the
Expand Down Expand Up @@ -297,7 +297,7 @@ NOTE: These functions will only be present if the library has been built
with TLS support.

|===
|<<nng_tls_config_auth_alloc#,nng_tls_config_alloc(3)>>|allocate TLS configuration
|<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>|allocate TLS configuration
|<<nng_tls_config_auth_mode#,nng_tls_config_auth_mode(3)>>|set authentication mode
|<<nng_tls_config_ca_chain#,nng_tls_config_ca_chain(3)>>|set certificate authority chain
|<<nng_tls_config_ca_file#,nng_tls_config_ca_file(3)>>|load certificate authority from file
Expand Down
2 changes: 1 addition & 1 deletion docs/man/nng_aio_cancel.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ If no operation is currently in progress (either because it has already
finished, or no operation has been started yet), then this function
has no effect.

NOTE: This function is the same as calling <<nng_aio_abort#,nng_aio_abort()>>
NOTE: This function is the same as calling <<nng_aio_abort#,nng_aio_abort(3)>>
with the error `NNG_ECANCELED`.

== RETURN VALUES
Expand Down
2 changes: 1 addition & 1 deletion docs/man/nng_http_conn_close.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ None.
== SEE ALSO

<<nng_http_client_connect#,nng_http_client_connect(3)>>,
<<nng_http_alloc_handler#,nng_http_alloc_handler(3)>>,
<<nng_http_handler_alloc#,nng_http_handler_alloc(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
<<nng#,nng(7)>>
4 changes: 2 additions & 2 deletions docs/man/nng_http_conn_read.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ called first, to set the scatter/gather vector for _aio_.

This function returns immediately, with no return value. Completion of
the operation is signaled via the _aio_, and the final result may be
obtained via <<nng_aio_result#,nng_aio_result>>. That result will
obtained via <<nng_aio_result#,nng_aio_result(3)>>. That result will
either be zero or an error code.

The I/O operation completes as soon as at least one byte has been
Expand Down Expand Up @@ -66,7 +66,7 @@ None.
<<nng_aio_count#,nng_aio_count(3)>>,
<<nng_aio_result#,nng_aio_result(3)>>,
<<nng_aio_set_iov#,nng_aio_set_iov(3)>>,
<<nng_http_alloc_handler#,nng_http_alloc_handler(3)>>,
<<nng_http_handler_alloc#,nng_http_handler_alloc(3)>>,
<<nng_http_client_connect#,nng_http_client_connect(3)>>,
<<nng_http_conn_read_all#,nng_http_conn_read_all(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
Expand Down
3 changes: 1 addition & 2 deletions docs/man/nng_http_conn_read_all.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ called first, to set the scatter/gather vector for _aio_.

This function returns immediately, with no return value. Completion of
the operation is signaled via the _aio_, and the final result may be
obtained via <<nng_aio_result#,nng_aio_result>>. That result will
obtained via <<nng_aio_result#,nng_aio_result(3)>>. That result will
either be zero or an error code.

The I/O operation completes only when the entire amount of data
Expand Down Expand Up @@ -69,7 +69,6 @@ None.
<<nng_aio_count#,nng_aio_count(3)>>,
<<nng_aio_result#,nng_aio_result(3)>>,
<<nng_aio_set_iov#,nng_aio_set_iov(3)>>,
<<nng_http_alloc_handler#,nng_http_alloc_handler(3)>>,
<<nng_http_client_connect#,nng_http_client_connect(3)>>,
<<nng_http_conn_read#,nng_http_conn_read(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
Expand Down
3 changes: 1 addition & 2 deletions docs/man/nng_http_conn_read_req.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ data, based on the details of the request itself.

This function returns immediately, with no return value. Completion of
the operation is signaled via the _aio_, and the final result may be
obtained via <<nng_aio_result#,nng_aio_result>>. That result will
obtained via <<nng_aio_result#,nng_aio_result(3)>>. That result will
either be zero or an error code.

== RETURN VALUES
Expand All @@ -57,7 +57,6 @@ None.

<<nng_aio_alloc#,nng_aio_alloc(3)>>,
<<nng_aio_result#,nng_aio_result(3)>>,
<<nng_http_alloc_handler#,nng_http_alloc_handler(3)>>,
<<nng_http_client_connect#,nng_http_client_connect(3)>>,
<<nng_http_conn_read_all#,nng_http_conn_read_all(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
Expand Down
3 changes: 1 addition & 2 deletions docs/man/nng_http_conn_read_res.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ data, based on the details of the response itself.

This function returns immediately, with no return value. Completion of
the operation is signaled via the _aio_, and the final result may be
obtained via <<nng_aio_result#,nng_aio_result>>. That result will
obtained via <<nng_aio_result#,nng_aio_result(3)>>. That result will
either be zero or an error code.

== RETURN VALUES
Expand All @@ -57,7 +57,6 @@ None.

<<nng_aio_alloc#,nng_aio_alloc(3)>>,
<<nng_aio_result#,nng_aio_result(3)>>,
<<nng_http_alloc_handler#,nng_http_alloc_handler(3)>>,
<<nng_http_client_connect#,nng_http_client_connect(3)>>,
<<nng_http_conn_read_all#,nng_http_conn_read_all(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
Expand Down
4 changes: 2 additions & 2 deletions docs/man/nng_http_conn_write.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ called first, to set the scatter/gather vector for _aio_.

This function returns immediately, with no return value. Completion of
the operation is signaled via the _aio_, and the final result may be
obtained via <<nng_aio_result#,nng_aio_result>>. That result will
obtained via <<nng_aio_result#,nng_aio_result(3)>>. That result will
either be zero or an error code.

The I/O operation completes as soon as at least one byte has been
Expand Down Expand Up @@ -67,8 +67,8 @@ None.
<<nng_aio_count#,nng_aio_count(3)>>,
<<nng_aio_result#,nng_aio_result(3)>>,
<<nng_aio_set_iov#,nng_aio_set_iov(3)>>,
<<nng_http_alloc_handler#,nng_http_alloc_handler(3)>>,
<<nng_http_client_connect#,nng_http_client_connect(3)>>,
<<nng_http_conn_write_all#,nng_http_conn_write_all(3)>>,
<<nng_http_handler_alloc#,nng_http_handler_alloc(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
<<nng#,nng(7)>>
3 changes: 1 addition & 2 deletions docs/man/nng_http_conn_write_all.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ called first, to set the scatter/gather vector for _aio_.

This function returns immediately, with no return value. Completion of
the operation is signaled via the _aio_, and the final result may be
obtained via <<nng_aio_result#,nng_aio_result>>. That result will
obtained via <<nng_aio_result#,nng_aio_result(3)>>. That result will
either be zero or an error code.

The I/O operation completes only when the entire amount of data
Expand Down Expand Up @@ -81,7 +81,6 @@ None.
<<nng_aio_count#,nng_aio_count(3)>>,
<<nng_aio_result#,nng_aio_result(3)>>,
<<nng_aio_set_iov#,nng_aio_set_iov(3)>>,
<<nng_http_alloc_handler#,nng_http_alloc_handler(3)>>,
<<nng_http_client_connect#,nng_http_client_connect(3)>>,
<<nng_http_conn_write#,nng_http_conn_write(3)>>,
<<nng_http_conn_write_req#,http_conn_write_req(3)>>,
Expand Down
7 changes: 3 additions & 4 deletions docs/man/nng_http_conn_write_req.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ The `nng_http_conn_write_req()` function starts an asynchronous write of
the HTTP request _req_ to the connection _conn_. The entire request is sent,
including headers, and if present, the request body data. (The
request body can be set with
<<nng_http_req_set_data#,nng_http_req_set_data>> or
<<nng_http_req_copy_data#,nng_http_req_copy_data>>.)
<<nng_http_req_set_data#,nng_http_req_set_data(3)>> or
<<nng_http_req_copy_data#,nng_http_req_copy_data(3)>>.)

This function returns immediately, with no return value. Completion of
the operation is signaled via the _aio_, and the final result may be
obtained via <<nng_aio_result#,nng_aio_result>>. That result will
obtained via <<nng_aio_result#,nng_aio_result(3)>>. That result will
either be zero or an error code.

== RETURN VALUES
Expand All @@ -55,7 +55,6 @@ None.

<<nng_aio_alloc#,nng_aio_alloc(3)>>,
<<nng_aio_result#,nng_aio_result(3)>>,
<<nng_http_alloc_handler#,nng_http_alloc_handler(3)>>,
<<nng_http_client_connect#,nng_http_client_connect(3)>>,
<<nng_http_conn_read_all#,nng_http_conn_read_all(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
Expand Down
7 changes: 3 additions & 4 deletions docs/man/nng_http_conn_write_res.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ The `nng_http_conn_write_res()` function starts an asynchronous write of
the HTTP response _res_ to the connection _conn_. The entire response is sent,
including headers, and if present, the response body data. (The
response body can be set with
<<nng_http_res_set_data#,nng_http_res_set_data>> or
<<nng_http_res_copy_data#,nng_http_res_copy_data>>.)
<<nng_http_res_set_data#,nng_http_res_set_data(3)>> or
<<nng_http_res_copy_data#,nng_http_res_copy_data(3)>>.)

This function returns immediately, with no return value. Completion of
the operation is signaled via the _aio_, and the final result may be
obtained via <<nng_aio_result#,nng_aio_result>>. That result will
obtained via <<nng_aio_result#,nng_aio_result(3)>>. That result will
either be zero or an error code.

=== Persistent Connections
Expand Down Expand Up @@ -64,7 +64,6 @@ None.

<<nng_aio_alloc#,nng_aio_alloc(3)>>,
<<nng_aio_result#,nng_aio_result(3)>>,
<<nng_http_alloc_handler#,nng_http_alloc_handler(3)>>,
<<nng_http_client_connect#,nng_http_client_connect(3)>>,
<<nng_http_conn_read_all#,nng_http_conn_read_all(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
Expand Down
4 changes: 2 additions & 2 deletions docs/man/nng_http_hijack.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ WebSocket), where the underlying HTTP connection will be taken over for
some other purpose, and should not be used any further by the server.

This function is most useful when called from a handler function.
(See <<nng_http_alloc_handler#,nng_http_alloc_handler(3).)
(See <<nng_http_handler_alloc#,nng_http_handler_alloc(3).)

NOTE: It is the responsibility of the caller to dispose of the underlying
connection when it is no longer needed. Furthermore, the HTTP server will
Expand All @@ -57,7 +57,7 @@ None.

== SEE ALSO

<<nng_http_alloc_handler#,nng_http_alloc_handler(3)>>,
<<nng_http_conn_write_res#,nng_http_conn_write_res(3)>>,
<<nng_http_handler_alloc#,nng_http_handler_alloc(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
<<nng#,nng(7)>>
2 changes: 1 addition & 1 deletion docs/man/nng_http_res_alloc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ This function returns 0 on success, and non-zero otherwise.
<<nng_http_conn_read_res#,nng_http_conn_read_res(3)>>,
<<nng_http_conn_write_res#,nng_http_conn_write_res(3)>>,
<<nng_http_req_alloc#,nng_http_req_alloc(3)>>,
<<nng_http_res_alloc_errror#,nng_http_res_alloc_error(3)>>,
<<nng_http_res_alloc_error#,nng_http_res_alloc_error(3)>>,
<<nng_http_res_add_header#,nng_http_res_add_header(3)>>,
<<nng_http_res_copy_data#,nng_http_res_copy_data(3)>>,
<<nng_http_res_del_header#,nng_http_res_del_header(3)>>,
Expand Down
2 changes: 1 addition & 1 deletion docs/man/nng_msg_header_insert.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ This function returns 0 on success, and non-zero otherwise.
== SEE ALSO

<<nng_msg_alloc#,nng_msg_alloc(3)>>,
<<nng_msg_header#,nng_msg_header(3)>>,
<<nng_msg_header_append#,nng_msg_header_append(3)>>,
<<nng_msg_header_body#,nng_msg_header_body(3)>>,
<<nng_msg_header_chop#,nng_msg_header_chop(3)>>,
<<nng_msg_header_len#,nng_msg_header_len(3)>>,
<<nng_msg_header_trim#,nng_msg_header_trim(3)>>,
Expand Down
64 changes: 34 additions & 30 deletions docs/man/nngcat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.)

Expand All @@ -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.
Expand Down Expand Up @@ -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)>>,
Expand Down

0 comments on commit e892f2e

Please sign in to comment.