From 320adc96d05e08a6f2f54c9281cb64bd851b1ffe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dag-Erling=20Sm=C3=B8rgrav?= Date: Sun, 30 Sep 2001 18:07:55 +0000 Subject: [PATCH] Token man page for pseudofs(9). --- share/man/man9/Makefile | 2 +- share/man/man9/pseudofs.9 | 69 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 share/man/man9/pseudofs.9 diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index 840596f57e4a..32938607f57c 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -51,7 +51,7 @@ MAN= BUF_LOCK.9 BUF_LOCKFREE.9 BUF_LOCKINIT.9 BUF_REFCNT.9 \ module.9 mutex.9 \ namei.9 \ panic.9 pbuf.9 pfil.9 pfind.9 pgfind.9 \ - physio.9 posix4.9 printf.9 psignal.9 \ + physio.9 posix4.9 printf.9 pseudofs.9 psignal.9 \ random.9 resettodr.9 resource_int_value.9 resource_query_string.9 \ rtalloc.9 rtentry.9 runqueue.9 \ sbuf.9 scheduler.9 sema.9 sleep.9 sleepqueue.9 spl.9 store.9 \ diff --git a/share/man/man9/pseudofs.9 b/share/man/man9/pseudofs.9 new file mode 100644 index 000000000000..408457ff2605 --- /dev/null +++ b/share/man/man9/pseudofs.9 @@ -0,0 +1,69 @@ +.\"- +.\" Copyright (c) 2001 Dag-Erling Coïdan Smørgrav +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd September 30, 2001 +.Dt PSEUDOFS 9 +.Os +.Sh NAME +.Nm pseudofs +.Nd pseudo-filesystem construction kit +.Sh SYNOPSIS +.Fd #include +.\" Insert usage example here +.Sh DESCRIPTION +The +.Nm +module offers an abstract API for pseudo-filesystems such as +.Xr procfs 5 +and +.Xr linprocfs 5 . +It takes care of all the hairy bits like interfacing with the VFS +system, keeping track of file numbers, and cloning files and +directories that are process-specific. +The consumer module, i.e. the module that implements the actual guts +of the filesystem, need only provide the directory structure +(represented by a collection of structures declared and initialized by +macros provided by +.Nm ) +and callbacks that report file attributes or write the actual file +contents into sbufs. +.\" Insert more info here +.Sh SEE ALSO +.Xr linprocfs 5 , +.Xr procfs 5 , +.Xr sbuf 9 , +.Xr vnode 9 , +.Sh HISTORY +The +.Nm +module appeared in +.Fx 5.0 . +.Sh AUTHORS +The +.Nm +module and this manual page were written by +.An Dag-Erling Sm\(/orgrav .