1.\" $NetBSD: rumpfs.4,v 1.1 2014/11/09 17:39:38 pooka Exp $ 2.\" 3.\" Copyright (c) 2014 Antti Kantee. All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" 26.Dd March 3, 2014 27.Dt RUMPFS 4 28.Os 29.Sh NAME 30.Nm rumpfs 31.Nd rump kernel root file system 32.Sh LIBRARY 33rump kernel (librumpvfs, \-lrumpvfs) 34.Sh DESCRIPTION 35.Nm 36is a simple in-memory file system for rump kernels. 37It is automatically mounted as the root file system of a rump kernel 38at boot time, provided that the VFS faction is configured into the rump 39kernel instance. 40.Pp 41The three main features of 42.Nm 43are: 44.Bl -enum -offset indent 45.It 46providing a hook for accessing host files via the 47.Xr rump_etfs 3 48interfaces. 49.It 50supporting enough of file and directory interfaces to facilitate simple 51operations such as hosting config files or creating mount points. 52.It 53being small and lightweight so as to keep a barebones rump kernel 54lightweight. 55.El 56.Pp 57.Nm 58is not intended for hosting large files or big directory 59hierarchies. 60If faced with such a use case, mounting a tmpfs file system 61inside the rump kernel is recommended. 62.Sh SEE ALSO 63.Xr rump 3 64.Sh HISTORY 65.Nm 66first appeared in 67.Nx 6.0 . 68