share/man/man4/puffs.4

   1 .\"     $NetBSD: puffs.4,v 1.10 2009/11/22 18:36:16 pooka Exp $
   2 .\"
   3 .\" Copyright (c) 2009 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 February 5, 2012
  27 .Dt PUFFS 4
  28 .Os
  29 .Sh NAME
  30 .Nm puffs
  31 .Nd Pass-to-Userspace Framework File System
  32 .Sh SYNOPSIS
  33 .Cd "options PUFFS"
  34 .Cd "pseudo-device putter"
  35 .Sh DESCRIPTION
  36 .Nm
  37 provides a framework for creating file systems as userspace servers.
  38 The in-kernel VFS attachment is controlled through a special device
  39 node,
  40 .Pa /dev/puffs .
  41 People looking to implement file systems should use the
  42 system through the convenience library described in
  43 .Xr puffs 3 .
  44 .Ss Termination
  45 A
  46 .Nm
  47 file system can be unmounted regularly using
  48 .Xr umount 8 .
  49 The file system will automatically be unmounted in case the userspace
  50 server is killed or the control file descriptor closed.
  51 .Sh SEE ALSO
  52 .Xr puffs 3
  53 .Sh HISTORY
  54 An unsupported experimental version of
  55 .Nm
  56 first appeared in
  57 .Nx 4.0 .
  58 A stable version appeared in
  59 .Nx 5.0 .
  60 .Sh AUTHORS
  61 .An Antti Kantee Aq pooka@iki.fi