File:  [DragonFly] / src / share / man / man9 / VFS_MOUNT.9
Revision 1.3: download - view: text, annotated - select for diffs
Tue Jun 1 11:36:53 2004 UTC (10 years, 3 months ago) by hmp
Branches: MAIN
CVS tags: HEAD, DragonFly_Stable, DragonFly_Snap29Sep2004, DragonFly_Snap13Sep2004, DragonFly_RELEASE_2_0_Slip, DragonFly_RELEASE_2_0, DragonFly_RELEASE_1_8_Slip, DragonFly_RELEASE_1_8, DragonFly_RELEASE_1_6_Slip, DragonFly_RELEASE_1_6, DragonFly_RELEASE_1_4_Slip, DragonFly_RELEASE_1_4, DragonFly_RELEASE_1_2_Slip, DragonFly_RELEASE_1_2, DragonFly_RELEASE_1_12_Slip, DragonFly_RELEASE_1_12, DragonFly_RELEASE_1_10_Slip, DragonFly_RELEASE_1_10, DragonFly_Preview, DragonFly_1_0_REL, DragonFly_1_0_RC1, DragonFly_1_0A_REL
Remove '-*- nroff -*-'.

Lets make a habit not to put editor-related magic into our base
files.  They are redundant and useless.

    1: .\" Copyright (c) 1996 Doug Rabson
    2: .\"
    3: .\" All rights reserved.
    4: .\"
    5: .\" This program is free software.
    6: .\"
    7: .\" Redistribution and use in source and binary forms, with or without
    8: .\" modification, are permitted provided that the following conditions
    9: .\" are met:
   10: .\" 1. Redistributions of source code must retain the above copyright
   11: .\"    notice, this list of conditions and the following disclaimer.
   12: .\" 2. Redistributions in binary form must reproduce the above copyright
   13: .\"    notice, this list of conditions and the following disclaimer in the
   14: .\"    documentation and/or other materials provided with the distribution.
   15: .\"
   16: .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
   17: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   18: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
   19: .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
   20: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
   21: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   22: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   23: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   24: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
   25: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   26: .\"
   27: .\" $FreeBSD: src/share/man/man9/VFS_MOUNT.9,v 1.7.2.1 2001/12/17 11:30:18 ru Exp $
   28: .\" $DragonFly: src/share/man/man9/VFS_MOUNT.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
   29: .\"
   30: .Dd July 24, 1996
   31: .Os
   32: .Dt VFS_MOUNT 9
   33: .Sh NAME
   34: .Nm VFS_MOUNT
   35: .Nd mount a filesystem
   36: .Sh SYNOPSIS
   37: .In sys/param.h
   38: .In sys/mount.h
   39: .In sys/vnode.h
   40: .Ft int
   41: .Fn VFS_MOUNT "struct mount *mp" "char *path" "caddr_t data" "struct nameidata *ndp" "struct proc *p"
   42: .Sh DESCRIPTION
   43: Mount a filesystem into the system's namespace.
   44: .Pp
   45: Its arguments are:
   46: .Bl -tag -width data
   47: .It Ar mp
   48: Structure representing the filesystem.
   49: .It Ar path
   50: Pathname where the filesystem is being mounted.
   51: .It Ar data
   52: Filesystem specific data.  This should be read into the kernel using
   53: .Xr copyin 9 .
   54: .It Ar ndp
   55: Contains the result of a
   56: .Xr namei 9
   57: call on the pathname of the mountpoint.
   58: .It Ar p
   59: Process which is mounting the filesystem.
   60: .El
   61: .Pp
   62: This is called both to mount new filesystems and to change the
   63: attributes of an existing filesystem.  If the
   64: .Dv MNT_UPDATE
   65: flag is set in
   66: .Fa mp->mnt_flag
   67: then the filesystem should update its internal state from the value of
   68: .Fa mp->mnt_flag .
   69: This can be used, for instance, to convert a read-only filesystem to
   70: read-write.
   71: It is also used by
   72: .Xr mountd 8
   73: to update the NFS export information for the filesystem.
   74: .Pp
   75: If the
   76: .Dv MNT_UPDATE
   77: flag is not specified, then this is a newly mounted filesystem.  The
   78: filesystem code should allocate and initialize
   79: any private data needed to represent
   80: the filesystem (it can use the
   81: .Fa mp->mnt_data
   82: field to store this information).
   83: .Sh SEE ALSO
   84: .Xr VFS 9 ,
   85: .Xr vnode 9
   86: .Sh AUTHORS
   87: This man page was written by
   88: .An Doug Rabson .