X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_wh_open.3.xfm;h=738090a30fbf1c6539a3ddcd55a2e24dd0d9daab;hb=2d9d6784b306047e94ca9816813e5007b00fd17e;hp=c271651f87a475c4a9dd29a52df88424661a10e1;hpb=d975485d41908af33714d88cfef5ad397dac392d;p=ric-plt%2Flib%2Frmr.git

diff --git a/doc/src/man/rmr_wh_open.3.xfm b/doc/src/man/rmr_wh_open.3.xfm
index c271651..738090a 100644
--- a/doc/src/man/rmr_wh_open.3.xfm
+++ b/doc/src/man/rmr_wh_open.3.xfm
@@ -1,7 +1,7 @@
 .if false
 ==================================================================================
-	Copyright (c) 2019 Nokia 
-	Copyright (c) 2018-2019 AT&T Intellectual Property.
+   Copyright (c) 2019 Nokia
+   Copyright (c) 2018-2019 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.
@@ -18,31 +18,20 @@
 .fi
 
 .if false
-	Mnemonic	rmr_wh_open.xfm
-	Abstract	The manual page for the rmr_wh_open function.
-	Author		E. Scott Daniels
-	Date		20 February 2019
+    Mnemonic    rmr_wh_open.xfm
+    Abstract    The manual page for the rmr_wh_open function.
+    Author      E. Scott Daniels
+    Date        20 February 2019
 .fi
 
-.** if formatting with tfm, the roff.im will cause roff output to be generated
-.** if formatting with pfm, then pretty postscript will be generated
 .gv e LIB lib
-.if pfm
-	.im &{lib}/generic_ps.im
-.ei
-	.gv e OUTPUT_RST use_rst
-	.if .ev &use_rst 1 = 
-		.im &{lib}/rst.im
-	.ei
-		.im &{lib}/roff.im
-	.fi
-.fi
+.im &{lib}/man/setup.im
 
 &line_len(6i)
 
 &h1(RMR Library Functions)
 &h2(NAME)
-	rmr_wh_open
+    rmr_wh_open
 
 &h2(SYNOPSIS)
 &indent
@@ -62,14 +51,14 @@ by the user application (via this function), and that the ID returned by &cw(rmr
 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.  
+&ital(Target) is the &ital(name:port,) or &ital(IP-address:port,) combination of the
+processess 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. 
-If the connection cannot be established, an error is returned to the caller, and no 
-direct messages can be sent to the target. 
+When invoked, this function immediatly 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
 reconnects should the connection be lost, however the handling of messages sent when
 a connection is broken is undetermined as each underlying transport mechanism may handle
@@ -77,10 +66,10 @@ buffering and retries differently.
 
 
 &h2(RETURN VALUE)
-The &cw(rmr_wh_open) function returns a type &cw(rmr_whid_t) which must be passed to 
-the &cw(rmr_wh_send_msg) function when sending a message. 
+The &cw(rmr_wh_open) function returns a type &cw(rmr_whid_t) which must be passed to
+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 
+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.
 
 &h2(ERRORS)
@@ -89,8 +78,8 @@ error message of a system call is propagated up, and thus this list might be inc
 
 &beg_dlist(.75i : ^&bold_font )
 &di(EINVAL) A parameter passed was not valid.
-&di(EACCESS) The user applicarion does not have the ability to establish a wormhole to the
-		indicated target (or maybe any target).
+&di(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.
 &end_dlist
 
@@ -101,13 +90,14 @@ error message of a system call is propagated up, and thus this list might be inc
 
    rmc = rmr_init( "43086", 4096, 0 ); // init context
    wh = rmr_wh_open( rmc, "localhost:6123" );
-   if( !RMR_WH_CONNECTED( wh ) ) { 
-	 fprintf( stderr, "unable to connect wormhole: %s\n",
+   if( !RMR_WH_CONNECTED( wh ) ) {
+     fprintf( stderr, "unable to connect wormhole: %s\n",
              strerror( errno ) );
    }
 &ex_end
 
 &h2(SEE ALSO )
+.ju off
 rmr_alloc_msg(3),
 rmr_call(3),
 rmr_free_msg(3),
@@ -123,9 +113,7 @@ rmr_has_str(3),
 rmr_tokenise(3),
 rmr_mk_ring(3),
 rmr_ring_free(3),
+rmr_wh_close(3),
 rmr_wh_send_msg(3),
-rmr_wh_close(3)
-
-
-.qu
-
+rmr_wh_state(3)
+.ju on