Add route table guide and formatting tweaks
[ric-plt/lib/rmr.git] / doc / src / man / rmr_wh_open.3.xfm
index af343dc..7611b21 100644 (file)
@@ -1,7 +1,7 @@
 .if false
 ==================================================================================
-   Copyright (c) 2019 Nokia
-   Copyright (c) 2018-2019 AT&T Intellectual Property.
+   Copyright (c) 2019-2020 Nokia
+   Copyright (c) 2018-2020 AT&T Intellectual Property.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -52,11 +52,11 @@ be passed to the &cw(rmr_wh_send_msg) function.
 
 &space
 &ital(Target) is the &ital(name:port,) or &ital(IP-address:port,) combination of the
-processess that the wormhole should be connected to.
+processes that the wormhole should be connected to.
 &ital(Vctx) is the RMR void context pointer that was returned by the &cw(rmr_init) function.
 
 &space
-When invoked, this function immediatly attempts to connect to the target process.
+When invoked, this function immediately attempts to connect to the target process.
 If the connection cannot be established, an error is returned to the caller, and no
 direct messages can be sent to the target.
 Once a wormhole is connected, the underlying transport mechanism (e.g. NNG) will provide
@@ -70,17 +70,17 @@ The &cw(rmr_wh_open) function returns a type &cw(rmr_whid_t) which must be passe
 the &cw(rmr_wh_send_msg) function when sending a message.
 The id may also be tested to determine success or failure of the connection by
 using the RMR_WH_CONNECTED macro and passing the ID as the parameter; a result of
-1 indicates that the connection was esablished and that the ID is valid.
+1 indicates that the connection was established and that the ID is valid.
 
 &h2(ERRORS)
 The following error values are specifically set by this RMR function. In some cases the
 error message of a system call is propagated up, and thus this list might be incomplete.
 
 &beg_dlist(.75i : ^&bold_font )
-&di(EINVAL) A parameter passed was not valid.
-&di(EACCESS) The user application does not have the ability to establish a wormhole to the
+&ditem(EINVAL) A parameter passed was not valid.
+&ditem(EACCESS) The user application does not have the ability to establish a wormhole to the
         indicated target (or maybe any target).
-&di(ECONNREFUSED) The connection was refused.
+&ditem(ECONNREFUSED) The connection was refused.
 &end_dlist
 
 &h2(EXAMPLE)