Bring in a VFS_SET(9) manual page (from FreeBSD).
authorSascha Wildner <saw@online.de>
Sun, 2 Sep 2012 11:31:33 +0000 (13:31 +0200)
committerSascha Wildner <saw@online.de>
Sun, 2 Sep 2012 11:31:33 +0000 (13:31 +0200)
share/man/man9/Makefile
share/man/man9/VFS_SET.9 [new file with mode: 0644]

index 5a2d7a9..90cd28b 100644 (file)
@@ -174,6 +174,7 @@ MAN=        accept_filter.9 \
        VFS_MOUNT.9 \
        VFS_QUOTACTL.9 \
        VFS_ROOT.9 \
+       VFS_SET.9 \
        VFS_START.9 \
        VFS_STATFS.9 \
        VFS_SYNC.9 \
diff --git a/share/man/man9/VFS_SET.9 b/share/man/man9/VFS_SET.9
new file mode 100644 (file)
index 0000000..8116eac
--- /dev/null
@@ -0,0 +1,116 @@
+.\"
+.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. 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(s), this list of conditions and the following disclaimer as
+.\"    the first lines of this file unmodified other than the possible
+.\"    addition of one or more copyright notices.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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: src/share/man/man9/VFS_SET.9,v 1.12 2008/11/17 20:49:29 pjd Exp $
+.\"
+.Dd September 2, 2012
+.Dt VFS_SET 9
+.Os
+.Sh NAME
+.Nm VFS_SET
+.Nd set up loadable file system
+.Vt vfsconf
+.Sh SYNOPSIS
+.In sys/param.h
+.In sys/kernel.h
+.In sys/module.h
+.In sys/mount.h
+.Ft void
+.Fn VFS_SET "struct vfsops *vfsops" "fsname" "int flags"
+.Sh DESCRIPTION
+.Fn VFS_SET
+creates a
+.Vt vfsconf
+structure for the loadable module with the given
+.Fa vfsops , fsname
+and
+.Fa flags ,
+and declares it by calling
+.Xr DECLARE_MODULE 9
+using
+.Fn vfs_modevent
+as the event handler.
+.Pp
+Possible values for the
+.Fa flags
+argument are:
+.Bl -hang -width ".Dv VFCF_DELEGADMIN"
+.It Dv VFCF_STATIC
+File system should be statically available in the kernel.
+.It Dv VFCF_NETWORK
+Network exportable file system.
+.It Dv VFCF_READONLY
+Does not support write operations.
+.It Dv VFCF_SYNTHETIC
+Pseudo file system, data does not represent on-disk files.
+.It Dv VFCF_LOOPBACK
+Loopback file system layer.
+.It Dv VFCF_UNICODE
+File names are stored as Unicode.
+.\".It Dv VFCF_JAIL
+.\"Can be mounted from within a jail if
+.\".Va security.jail.mount_allowed
+.\"sysctl is set to
+.\".Dv 1 .
+.\".It Dv VFCF_DELEGADMIN
+.\"Supports delegated administration if
+.\".Va vfs.usermount
+.\"sysctl is set to
+.\".Dv 1 .
+.El
+.Sh PSEUDOCODE
+.Bd -literal
+/*
+ * fill in the ones we use, and use the vfs_std for the rest.
+ */
+static struct vfsops myfs_vfsops = {
+        myfs_mount,
+        vfs_stdstart,
+        myfs_unmount,
+        myfs_root,
+        vfs_stdquotactl,
+        myfs_statfs,
+        vfs_stdsync,
+        vfs_stdvget,
+        vfs_stdfhtovp,
+        vfs_stdcheckexp,
+        vfs_stdvptofh,
+        vfs_stdinit,
+        vfs_stduninit,
+        vfs_stdextattrctl,
+};
+
+VFS_SET(myfs_vfsops, skelfs, 0);
+.Ed
+.Sh SEE ALSO
+.\".Xr jail 2 ,
+.\".Xr jail 8 ,
+.Xr DECLARE_MODULE 9
+.\".Xr vfsconf 9 ,
+.\".Xr vfs_modevent 9
+.Sh AUTHORS
+This manual page was written by
+.An Chad David Aq davidc@acns.ab.ca .