[src/trunk]: src manual page for rumphijack

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

details:   https://anonhg.NetBSD.org/src/rev/483ccd924046
branches:  trunk
changeset: 761363:483ccd924046
user:      pooka <pooka%NetBSD.org@localhost>
date:      Tue Jan 25 12:56:25 2011 +0000

description:
manual page for rumphijack

diffstat:

 distrib/sets/lists/comp/mi     |   5 ++-
 lib/librumphijack/Makefile     |   3 +-
 lib/librumphijack/rumphijack.3 |  62 ++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 68 insertions(+), 2 deletions(-)

diffs (115 lines):

diff -r 80e4acb39fca -r 483ccd924046 distrib/sets/lists/comp/mi
--- a/distrib/sets/lists/comp/mi        Tue Jan 25 12:53:45 2011 +0000
+++ b/distrib/sets/lists/comp/mi        Tue Jan 25 12:56:25 2011 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: mi,v 1.1575 2011/01/20 18:47:21 pooka Exp $
+#      $NetBSD: mi,v 1.1576 2011/01/25 12:56:25 pooka Exp $
 #
 # Note: don't delete entries from here - mark them as "obsolete" instead.
 #
@@ -8056,6 +8056,7 @@
 ./usr/share/man/cat3/rresvport_af.0            comp-c-catman           .cat
 ./usr/share/man/cat3/rsa.0                     comp-obsolete           obsolete
 ./usr/share/man/cat3/rump.0                    comp-c-catman           .cat
+./usr/share/man/cat3/rumphijack.0                      comp-c-catman           .cat
 ./usr/share/man/cat3/rump_etfs.0                       comp-c-catman           .cat
 ./usr/share/man/cat3/rump_lwproc.0                     comp-c-catman           .cat
 ./usr/share/man/cat3/rumpuser.0                        comp-c-catman           .cat
@@ -14057,6 +14058,7 @@
 ./usr/share/man/html3/rresvport.html           comp-c-htmlman          html
 ./usr/share/man/html3/rresvport_af.html                comp-c-htmlman          html
 ./usr/share/man/html3/rump.html                        comp-c-htmlman          html
+./usr/share/man/html3/rumphijack.html                  comp-c-htmlman          html
 ./usr/share/man/html3/rump_etfs.html                   comp-c-htmlman          html
 ./usr/share/man/html3/rump_lwproc.html                 comp-c-htmlman          html
 ./usr/share/man/html3/rumpuser.html            comp-c-htmlman          html
@@ -20064,6 +20066,7 @@
 ./usr/share/man/man3/rresvport_af.3            comp-c-man              .man
 ./usr/share/man/man3/rsa.3                     comp-obsolete           obsolete
 ./usr/share/man/man3/rump.3                    comp-c-man              .man
+./usr/share/man/man3/rumphijack.3                      comp-c-man              .man
 ./usr/share/man/man3/rump_etfs.3                       comp-c-man              .man
 ./usr/share/man/man3/rump_lwproc.3                     comp-c-man              .man
 ./usr/share/man/man3/rumpuser.3                        comp-c-man              .man
diff -r 80e4acb39fca -r 483ccd924046 lib/librumphijack/Makefile
--- a/lib/librumphijack/Makefile        Tue Jan 25 12:53:45 2011 +0000
+++ b/lib/librumphijack/Makefile        Tue Jan 25 12:56:25 2011 +0000
@@ -1,10 +1,11 @@
-#      $NetBSD: Makefile,v 1.3 2011/01/18 19:53:23 pooka Exp $
+#      $NetBSD: Makefile,v 1.4 2011/01/25 12:56:25 pooka Exp $
 #
 
 LIB=           rumphijack
 NOSTATICLIB=   dlfun
 NOPROFILE=     dlfun
 LIBDPLIBS+=    pthread ${.CURDIR}/../libpthread
+MAN=           rumphijack.3
 
 SRCS=          hijack.c
 
diff -r 80e4acb39fca -r 483ccd924046 lib/librumphijack/rumphijack.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/librumphijack/rumphijack.3    Tue Jan 25 12:56:25 2011 +0000
@@ -0,0 +1,62 @@
+.\"     $NetBSD: rumphijack.3,v 1.1 2011/01/25 12:56:25 pooka Exp $
+.\"
+.\" Copyright (c) 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
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd January 25, 2011
+.Dt RUMPHIJACK 3
+.Os
+.Sh NAME
+.Nm rumphijack
+.Nd System call hijack library
+.Sh LIBRARY
+used by
+.Xr ld.so 1
+.Sh DESCRIPTION
+The
+.Xr ld.so 1
+runtime linker can be instructed to load
+.Nm
+between the main object and other libraries.
+This enables
+.Nm
+to capture and redirect system call requests to a rump kernel instead
+of the host kernel.
+.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:
+.Bd -literal -offset indent
+$ setenv RUMP_SERVER unix:///tmp/tcpip
+$ setenv LD_PRELOAD /usr/lib/librumphijack.so
+$ firefox
+.Ed
+.Sh SEE ALSO
+.Xr ld.so 1 ,
+.Xr rump_server 1 ,
+.Xr rump 3 ,
+.Xr rump_sp 3