[src/trunk]: src/lib/librump add paragraph about kernel clients

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

details:   https://anonhg.NetBSD.org/src/rev/cd8156d7ea98
branches:  trunk
changeset: 763568:cd8156d7ea98
user:      pooka <pooka%NetBSD.org@localhost>
date:      Fri Mar 25 16:07:43 2011 +0000

description:
add paragraph about kernel clients

diffstat:

 lib/librump/rump.3 |  26 ++++++++++++++++++--------
 1 files changed, 18 insertions(+), 8 deletions(-)

diffs (63 lines):

diff -r 1ab3e2a8cfe1 -r cd8156d7ea98 lib/librump/rump.3
--- a/lib/librump/rump.3        Fri Mar 25 14:47:31 2011 +0000
+++ b/lib/librump/rump.3        Fri Mar 25 16:07:43 2011 +0000
@@ -1,6 +1,6 @@
-.\"     $NetBSD: rump.3,v 1.8 2011/02/21 08:50:45 pooka Exp $
+.\"     $NetBSD: rump.3,v 1.9 2011/03/25 16:07:43 pooka Exp $
 .\"
-.\" Copyright (c) 2008-2010 Antti Kantee.  All rights reserved.
+.\" Copyright (c) 2008-2011 Antti Kantee.  All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
@@ -23,7 +23,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd November 19, 2010
+.Dd March 25, 2011
 .Dt RUMP 3
 .Os
 .Sh NAME
@@ -66,6 +66,18 @@
 host, and might not include include for example file system support
 at all.
 .Pp
+Clients using services provided by rump kernels can exist either
+in the same process as the rump kernel or in other processes.
+Local clients access the rump kernel through direct function calls.
+They also naturally have access to the kernel memory space.
+This document is geared towards local clients.
+For more information on remote clients,
+see
+.Xr rump_sp 7 .
+It is also possible to use unmodified application binaries as
+remote clients with
+.Xr rumphijack 3 .
+.Pp
 A rump kernel is bootstrapped by calling
 .Fn rump_init .
 Before bootstrapping the kernel, it is possible to control its
@@ -153,6 +165,7 @@
 .Xr rump_etfs 3 ,
 .Xr rump_lwproc 3 ,
 .Xr rumpclient 3 ,
+.Xr rumphijack 3 ,
 .Xr rumpuser 3 ,
 .Xr ukfs 3 ,
 .Xr rump_sp 7
@@ -192,12 +205,9 @@
 .Re
 .Sh HISTORY
 .Nm
-first appeared in
+appeared as an experimental concept in
 .Nx 5.0 .
-It underwent a huge number of changes for
+The first stable version was released in
 .Nx 6.0 .
 .Sh AUTHORS
 .An Antti Kantee Aq pooka%iki.fi@localhost
-.Sh NOTE
-.Nm
-is still somewhat experimental.