d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
b14fa90f01
freebsd-skq/share/man/man9/vref.9

68 lines
2.2 KiB
Groff
Raw Normal View History

This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.\" -*- nroff -*-
.\"
.\" Copyright (c) 1996 Doug Rabson
.\"
.\" All rights reserved.
.\"
.\" This program is free software.
.\"
.\" 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 DEVELOPERS ``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 DEVELOPERS 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.
.\"
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.\"
.Dd July 24, 1996
.Os
Minor mdoc fixes.
1997-03-22 22:47:34 +00:00
.Dt VREF 9
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Sh NAME
.Nm vref
.Nd increment the use count for a vnode
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In sys/param.h
.In sys/vnode.h
Fixed #include and/or prototype bugs in synopsis.
1997-04-13 14:49:13 +00:00
.Ft void
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Fn vref "struct vnode *vp"
.Sh DESCRIPTION
Increment the
Some mdoc(7) fixes: Nuke incorrect usage of .Ar; replace it with .Vt, .Va or .Fa appropriately. The .Ar mdoc(7) specifier should only be used when displaying command line arguments. Approved by: des (mentor)
2003-05-31 14:07:25 +00:00
.Va v_usecount
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
field of a vnode.
mdoc(7) police: eliminate warnings.
2000-11-17 15:40:57 +00:00
.Bl -tag -width 2n
Some mdoc(7) fixes: Nuke incorrect usage of .Ar; replace it with .Vt, .Va or .Fa appropriately. The .Ar mdoc(7) specifier should only be used when displaying command line arguments. Approved by: des (mentor)
2003-05-31 14:07:25 +00:00
.It Fa vp
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
the vnode to increment
.El
.Pp
Each vnode maintains a reference count of how many parts of the system
Mdoc Janitor: * Fix hard sentence breaks.
2003-10-23 02:22:07 +00:00
are using the vnode.
This allows the system to detect when a vnode is
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
no longer being used and can be safely recycled for a different file.
.Pp
Any code in the system which is using a vnode (e.g. during the
operation of some algorithm or to store in a data structure) should
call
mdoc(7) police: Deal with self-xrefs.
2002-12-24 13:41:48 +00:00
.Fn vref .
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Sh SEE ALSO
.Xr vget 9 ,
Sort cross refereces in section SEE ALSO.
1997-09-29 10:11:02 +00:00
.Xr vnode 9 ,
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Xr vput 9 ,
.Xr vrele 9
.Sh AUTHORS
.Sh AUTHOR -> .Sh AUTHORS according to mdoc specs. Use .An/.Aq.
1998-03-12 07:31:21 +00:00
This man page was written by
.An Doug Rabson .
Reference in New Issue Copy Permalink