[src/trunk]: src/lib/librumphijack document RUMPHIJACK_RETRYCONNECT

[pooka <pooka%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/e5924e0dc97a
branches:  trunk
changeset: 762159:e5924e0dc97a
user:      pooka <pooka%NetBSD.org@localhost>
date:      Wed Feb 16 19:46:42 2011 +0000

description:
document RUMPHIJACK_RETRYCONNECT

diffstat:

 lib/librumphijack/rumphijack.3 |  37 ++++++++++++++++++++++++++++++++++---
 1 files changed, 34 insertions(+), 3 deletions(-)

diffs (71 lines):

diff -r cfa0de4895ec -r e5924e0dc97a lib/librumphijack/rumphijack.3
--- a/lib/librumphijack/rumphijack.3    Wed Feb 16 19:43:50 2011 +0000
+++ b/lib/librumphijack/rumphijack.3    Wed Feb 16 19:46:42 2011 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: rumphijack.3,v 1.2 2011/01/25 14:05:42 pooka Exp $
+.\"     $NetBSD: rumphijack.3,v 1.3 2011/02/16 19:46:42 pooka Exp $
 .\"
 .\" Copyright (c) 2011 Antti Kantee.  All rights reserved.
 .\"
@@ -23,7 +23,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd January 25, 2011
+.Dd February 16, 2011
 .Dt RUMPHIJACK 3
 .Os
 .Sh NAME
@@ -43,20 +43,51 @@
 to capture and redirect system call requests to a rump kernel instead
 of the host kernel.
 .Pp
+The behaviour of hijacked applications is affected by the following
+environment variables:
+.Bl -tag -width 12345
+.It Dv RUMPHIJACK_RETRYCONNECT
+Change how
+.Xr rumpclient 3
+attempts to reconnect to the server in case the connection is lost.
+Acceptable values are:
+.Bl -tag -width xxinftimexx
+.It Dq inftime
+retry indefinitely
+.It Dq once
+retry once, when that connection fails, give up
+.It Dq die
+call
+.Xr exit 3
+if connection failure is detected
+.It n
+Attempt reconnect for n seconds.
+The value 0 means reconnection is not attempted.
+The value n must be a positive integer.
+.El
+.Pp
+See
+.Xr rumpclient 3
+for more discussion.
+.El
+.Pp
 Currently
 .Nm
 supports only TCP/IP related system calls.
 The set of supported subsystems may change later along with the usage
 of the library.
 .Sh EXAMPLES
-Use an alternate TCP/IP stack for firefox:
+Use an alternate TCP/IP stack for firefox with a persistent server
+connection:
 .Bd -literal -offset indent
 $ setenv RUMP_SERVER unix:///tmp/tcpip
 $ setenv LD_PRELOAD /usr/lib/librumphijack.so
+$ setenv RUMPHIJACK_RETRYCONNECT inftime
 $ firefox
 .Ed
 .Sh SEE ALSO
 .Xr ld.so 1 ,
 .Xr rump_server 1 ,
 .Xr rump 3 ,
+.Xr rumpclient 3 ,
 .Xr rump_sp 7