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