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

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

details:   https://anonhg.NetBSD.org/src/rev/d55df4485566
branches:  trunk
changeset: 763235:d55df4485566
user:      pooka <pooka%NetBSD.org@localhost>
date:      Mon Mar 14 15:21:22 2011 +0000

description:
document fdoff

diffstat:

 lib/librumphijack/rumphijack.3 |  14 ++++++++++++--
 1 files changed, 12 insertions(+), 2 deletions(-)

diffs (35 lines):

diff -r 1b73047f1729 -r d55df4485566 lib/librumphijack/rumphijack.3
--- a/lib/librumphijack/rumphijack.3    Mon Mar 14 15:15:47 2011 +0000
+++ b/lib/librumphijack/rumphijack.3    Mon Mar 14 15:21:22 2011 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: rumphijack.3,v 1.11 2011/03/10 08:53:04 wiz Exp $
+.\"     $NetBSD: rumphijack.3,v 1.12 2011/03/14 15:21:22 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 March 9, 2011
+.Dd March 14, 2011
 .Dt RUMPHIJACK 3
 .Os
 .Sh NAME
@@ -173,6 +173,16 @@
 and
 .Dq no ,
 meaning to call the rump or the host kernel, respectively.
+.It Dq fdoff
+Adjust the library's fd offset to the specified value.
+All rump kernel descriptors have the offset added to them
+before they are returned to the application.
+This should be changed only if the application defines a low non-default
+.Dv FD_SETSIZE
+for
+.Fn select
+or if it opens a very large number of file descriptors.
+The default value is 128.
 .El
 .Pp
 If the environment variable is unset, the default value