[src/trunk]: src add man page for rumpfs

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

details:   https://anonhg.NetBSD.org/src/rev/cecc2349f3b3
branches:  trunk
changeset: 327279:cecc2349f3b3
user:      pooka <pooka%NetBSD.org@localhost>
date:      Mon Mar 03 18:27:20 2014 +0000

description:
add man page for rumpfs

diffstat:

 distrib/sets/lists/man/mi |   5 ++-
 lib/librumpvfs/Makefile   |   4 +-
 lib/librumpvfs/rumpfs.4   |  67 +++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 73 insertions(+), 3 deletions(-)

diffs (120 lines):

diff -r 4d2dc5219581 -r cecc2349f3b3 distrib/sets/lists/man/mi
--- a/distrib/sets/lists/man/mi Mon Mar 03 18:25:14 2014 +0000
+++ b/distrib/sets/lists/man/mi Mon Mar 03 18:27:20 2014 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: mi,v 1.1462 2014/03/03 13:54:43 skrll Exp $
+# $NetBSD: mi,v 1.1463 2014/03/03 18:27:20 pooka Exp $
 #
 # Note: don't delete entries from here - mark them as "obsolete" instead.
 #
@@ -1566,6 +1566,7 @@
 ./usr/share/man/cat4/rtpphy.0                  man-obsolete            obsolete
 ./usr/share/man/cat4/rtw.0                     man-sys-catman          .cat
 ./usr/share/man/cat4/rum.0                     man-sys-catman          .cat
+./usr/share/man/cat4/rumpfs.0                  man-sys-catman          .cat,rump
 ./usr/share/man/cat4/run.0                     man-sys-catman          .cat
 ./usr/share/man/cat4/s390rtc.0                 man-sys-catman          .cat
 ./usr/share/man/cat4/sandpoint/nhpow.0         man-sys-catman          .cat
@@ -4530,6 +4531,7 @@
 ./usr/share/man/html4/rtk.html                 man-sys-htmlman         html
 ./usr/share/man/html4/rtw.html                 man-sys-htmlman         html
 ./usr/share/man/html4/rum.html                 man-sys-htmlman         html
+./usr/share/man/html4/rumpfs.html                      man-sys-htmlman         html,rump
 ./usr/share/man/html4/run.html                 man-sys-htmlman         html
 ./usr/share/man/html4/s390rtc.html             man-sys-htmlman         html
 ./usr/share/man/html4/sandpoint/nhpow.html     man-sys-htmlman         html
@@ -7398,6 +7400,7 @@
 ./usr/share/man/man4/rtpphy.4                  man-obsolete            obsolete
 ./usr/share/man/man4/rtw.4                     man-sys-man             .man
 ./usr/share/man/man4/rum.4                     man-sys-man             .man
+./usr/share/man/man4/rumpfs.4                  man-sys-man             .man,rump
 ./usr/share/man/man4/run.4                     man-sys-man             .man
 ./usr/share/man/man4/s390rtc.4                 man-sys-man             .man
 ./usr/share/man/man4/sandpoint/nhpow.4         man-sys-man             .man
diff -r 4d2dc5219581 -r cecc2349f3b3 lib/librumpvfs/Makefile
--- a/lib/librumpvfs/Makefile   Mon Mar 03 18:25:14 2014 +0000
+++ b/lib/librumpvfs/Makefile   Mon Mar 03 18:27:20 2014 +0000
@@ -1,10 +1,10 @@
-#      $NetBSD: Makefile,v 1.3 2010/11/30 17:32:29 pooka Exp $
+#      $NetBSD: Makefile,v 1.4 2014/03/03 18:27:20 pooka Exp $
 #
 
 RUMPTOP=       ${.CURDIR}/../../sys/rump
 
 LIBDPLIBS+=     rump   ${.CURDIR}/../librump
-MAN=           rump_etfs.3
+MAN=           rump_etfs.3 rumpfs.4
 
 WARNS=         3       # XXX: kernel isn't ready for -Wsign-compare
 
diff -r 4d2dc5219581 -r cecc2349f3b3 lib/librumpvfs/rumpfs.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/librumpvfs/rumpfs.4   Mon Mar 03 18:27:20 2014 +0000
@@ -0,0 +1,67 @@
+.\"     $NetBSD: rumpfs.4,v 1.1 2014/03/03 18:27:20 pooka Exp $
+.\"
+.\" Copyright (c) 2014 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 March 3, 2014
+.Dt RUMPFS 4
+.Os
+.Sh NAME
+.Nm rumpfs
+.Nd rump kernel root file system
+.Sh LIBRARY
+rump kernel (librumpvfs, \-lrumpvfs)
+.Sh DESCRIPTION
+.Nm
+is a simple in-memory file system for rump kernels.
+It is automatically mounted as the root file system of a rump kernel
+at boot time, provided that the VFS faction is configured into the rump
+kernel instance.
+.Pp
+The three main features of
+.Nm
+are:
+.Bl -enum -offset indent
+.It 
+providing a hook for accessing host files via the
+.Xr rump_etfs 3
+interfaces.
+.It
+supporting enough of file and directory interfaces to facilitate simple
+operations such as hosting config files or creating mount points.
+.It
+being small and lightweight so as to keep a barebones rump kernel
+lightweight.
+.El
+.Pp
+.Nm
+is not intended for hosting large files or big directory
+hierarchies.
+If faced with such a use case, mounting a tmpfs file system
+inside the rump kernel is recommended.
+.Sh SEE ALSO
+.Xr rump 3
+.Sh HISTORY
+.Nm
+first appeared in
+.Nx 6.0 .