xref: /freebsd/share/man/man9/pseudofs.9 (revision 1a720cbec513210fa2e85c3882741ef2f6dc5f35)
1320adc96SDag-Erling Smørgrav.\"-
2e738085bSDag-Erling Smørgrav.\" Copyright (c) 2001 Dag-Erling Smørgrav
3320adc96SDag-Erling Smørgrav.\" All rights reserved.
4320adc96SDag-Erling Smørgrav.\"
5320adc96SDag-Erling Smørgrav.\" Redistribution and use in source and binary forms, with or without
6320adc96SDag-Erling Smørgrav.\" modification, are permitted provided that the following conditions
7320adc96SDag-Erling Smørgrav.\" are met:
8320adc96SDag-Erling Smørgrav.\" 1. Redistributions of source code must retain the above copyright
9320adc96SDag-Erling Smørgrav.\"    notice, this list of conditions and the following disclaimer.
10320adc96SDag-Erling Smørgrav.\" 2. Redistributions in binary form must reproduce the above copyright
11320adc96SDag-Erling Smørgrav.\"    notice, this list of conditions and the following disclaimer in the
12320adc96SDag-Erling Smørgrav.\"    documentation and/or other materials provided with the distribution.
13320adc96SDag-Erling Smørgrav.\"
14320adc96SDag-Erling Smørgrav.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15320adc96SDag-Erling Smørgrav.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16320adc96SDag-Erling Smørgrav.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17320adc96SDag-Erling Smørgrav.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18320adc96SDag-Erling Smørgrav.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19320adc96SDag-Erling Smørgrav.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20320adc96SDag-Erling Smørgrav.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21320adc96SDag-Erling Smørgrav.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22320adc96SDag-Erling Smørgrav.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23320adc96SDag-Erling Smørgrav.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24320adc96SDag-Erling Smørgrav.\" SUCH DAMAGE.
25320adc96SDag-Erling Smørgrav.\"
26880a3b45SChristian Brueffer.Dd April 20, 2007
27320adc96SDag-Erling Smørgrav.Dt PSEUDOFS 9
28320adc96SDag-Erling Smørgrav.Os
29320adc96SDag-Erling Smørgrav.Sh NAME
30320adc96SDag-Erling Smørgrav.Nm pseudofs
318d5d039fSRuslan Ermilov.Nd pseudo file system construction kit
32320adc96SDag-Erling Smørgrav.Sh SYNOPSIS
332754f630SRuslan Ermilov.In fs/pseudofs/pseudofs.h
34320adc96SDag-Erling Smørgrav.\" Insert usage example here
35320adc96SDag-Erling Smørgrav.Sh DESCRIPTION
36320adc96SDag-Erling SmørgravThe
37320adc96SDag-Erling Smørgrav.Nm
38320adc96SDag-Erling Smørgravmodule offers an abstract API for pseudo-file systems such as
39*1a720cbeSAlexander Ziaee.Xr procfs 4
40320adc96SDag-Erling Smørgravand
41*1a720cbeSAlexander Ziaee.Xr linprocfs 4 .
42320adc96SDag-Erling SmørgravIt takes care of all the hairy bits like interfacing with the VFS
4311cee4a6SDag-Erling Smørgravsystem, enforcing access control, keeping track of file numbers, and
4411cee4a6SDag-Erling Smørgravcloning files and directories that are process-specific.
455203edcdSRuslan ErmilovThe consumer module, i.e., the module that implements the actual guts
462754f630SRuslan Ermilovof the file system, needs only provide the directory structure
47320adc96SDag-Erling Smørgrav(represented by a collection of structures declared and initialized by
48320adc96SDag-Erling Smørgravmacros provided by
49320adc96SDag-Erling Smørgrav.Nm )
50320adc96SDag-Erling Smørgravand callbacks that report file attributes or write the actual file
51320adc96SDag-Erling Smørgravcontents into sbufs.
52320adc96SDag-Erling Smørgrav.\" Insert more info here
53320adc96SDag-Erling Smørgrav.Sh SEE ALSO
54*1a720cbeSAlexander Ziaee.Xr linprocfs 4 ,
55*1a720cbeSAlexander Ziaee.Xr linsysfs 4 ,
56*1a720cbeSAlexander Ziaee.Xr procfs 4 ,
57320adc96SDag-Erling Smørgrav.Xr sbuf 9 ,
582754f630SRuslan Ermilov.Xr vnode 9
59320adc96SDag-Erling Smørgrav.Sh HISTORY
60320adc96SDag-Erling SmørgravThe
61320adc96SDag-Erling Smørgrav.Nm
62320adc96SDag-Erling Smørgravmodule appeared in
63320adc96SDag-Erling Smørgrav.Fx 5.0 .
64320adc96SDag-Erling Smørgrav.Sh AUTHORS
65320adc96SDag-Erling SmørgravThe
66320adc96SDag-Erling Smørgrav.Nm
67320adc96SDag-Erling Smørgravmodule and this manual page were written by
688a7314fcSBaptiste Daroussin.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
69