share/man/man9/pseudofs.9

   1 .\"-
   2 .\" Copyright (c) 2001 Dag-Erling Coïdan Smørgrav
   3 .\" 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 .\" $FreeBSD$
  27 .\"
  28 .Dd April 20, 2007
  29 .Dt PSEUDOFS 9
  30 .Os
  31 .Sh NAME
  32 .Nm pseudofs
  33 .Nd pseudo file system construction kit
  34 .Sh SYNOPSIS
  35 .In fs/pseudofs/pseudofs.h
  36 .\" Insert usage example here
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 module offers an abstract API for pseudo-file systems such as
  41 .Xr procfs 5
  42 and
  43 .Xr linprocfs 5 .
  44 It takes care of all the hairy bits like interfacing with the VFS
  45 system, enforcing access control, keeping track of file numbers, and
  46 cloning files and directories that are process-specific.
  47 The consumer module, i.e., the module that implements the actual guts
  48 of the file system, needs only provide the directory structure
  49 (represented by a collection of structures declared and initialized by
  50 macros provided by
  51 .Nm )
  52 and callbacks that report file attributes or write the actual file
  53 contents into sbufs.
  54 .\" Insert more info here
  55 .Sh SEE ALSO
  56 .Xr linprocfs 5 ,
  57 .Xr linsysfs 5 ,
  58 .Xr procfs 5 ,
  59 .Xr sbuf 9 ,
  60 .Xr vnode 9
  61 .Sh HISTORY
  62 The
  63 .Nm
  64 module appeared in
  65 .Fx 5.0 .
  66 .Sh AUTHORS
  67 The
  68 .Nm
  69 module and this manual page were written by
  70 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org .