jimzah/freebsd-src
1
0
Fork 0
mirror of https://github.com/freebsd/freebsd-src.git synced 2024-12-04 16:49:40 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Mark lists as in the rest of section 9 manpages.

Browse Source 
Submitted by:	Joel Dahl (mostly)
This commit is contained in:
Ruslan Ermilov 2005-01-28 10:43:05 +00:00
parent 7146d6cb3e
commit 0a57ea7df2
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=140931
28 changed files with 180 additions and 148 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
share/man/man9/VOP_ACCESS.9
View File

@ -47,13 +47,13 @@ given credentials.
Its arguments are:
.Bl -tag -width mode
.It Fa vp
the vnode of the file to check
The vnode of the file to check.
.It Fa mode
the type of access required
The type of access required.
.It Fa cred
the user credentials to check
The user credentials to check.
.It Fa td
the thread which is checking
The thread which is checking.
.El
.Pp
The

10
share/man/man9/VOP_ACLCHECK.9
View File

@ -44,15 +44,15 @@ control list (ACL) for a particular file or directory.
Its arguments are:
.Bl -tag -width type
.It Fa vp
the vnode of the file or directory
The vnode of the file or directory.
.It Fa type
the type of ACL to check
The type of ACL to check.
.It Fa aclp
a pointer to an ACL structure from which to retrieve the ACL data
A pointer to an ACL structure from which to retrieve the ACL data.
.It Fa cred
the user credentials to use in authorizing the request
The user credentials to use in authorizing the request.
.It Fa td
the thread checking the ACL
The thread checking the ACL.
.El
.Pp
The

33
share/man/man9/VOP_ADVLOCK.9
View File

@ -45,25 +45,32 @@
The arguments are:
.Bl -tag -width flags
.It Fa vp
the vnode being manipulated
The vnode being manipulated.
.It Fa id
the id token which is changing the lock
The id token which is changing the lock.
.It Fa op
the operation to perform (see
.Xr fcntl 2 )
The operation to perform (see
.Xr fcntl 2 ) .
.It Fa fl
description of the lock
Description of the lock.
.It Fa flags
One of more of the following:
.Bl -column F_UNLCK -offset indent
.It Dv F_RDLCK Ta "shared or read lock"
.It Dv F_UNLCK Ta "unlock"
.It Dv F_WRLCK Ta "exclusive or write lock"
.It Dv F_WAIT Ta "Wait until lock is granted"
.It Dv F_FLOCK Ta Use
.Pp
.Bl -tag -width ".Dv F_UNLCK" -offset indent -compact
.It Dv F_RDLCK
Shared or read lock.
.It Dv F_UNLCK
Unlock.
.It Dv F_WRLCK
Exclusive or write lock.
.It Dv F_WAIT
Wait until lock is granted.
.It Dv F_FLOCK
Use
.Xr flock 2
semantics for lock
.It Dv F_POSIX Ta "Use POSIX semantics for lock"
semantics for lock.
.It Dv F_POSIX
Use POSIX semantics for lock.
.El
.El
.Pp

8
share/man/man9/VOP_ATTRIB.9
View File

@ -50,13 +50,13 @@ access time and modification time.
The arguments are:
.Bl -tag -width cred
.It Fa vp
the vnode of the file
The vnode of the file.
.It Fa vap
the attributes of the file
The attributes of the file.
.It Fa cred
the user credentials of the calling process
The user credentials of the calling process.
.It Fa td
the thread
The thread.
.El
.Pp
Attributes which are not being modified by

4
share/man/man9/VOP_BWRITE.9
View File

@ -43,9 +43,9 @@
The arguments are:
.Bl -tag -width 2n
.It Fa vp
the vnode of the file being written to
The vnode of the file being written to.
.It Fa bp
the buffer to be written
The buffer to be written.
.El
.Sh RETURN VALUES
Zero is returned on success, otherwise an error is returned.

10
share/man/man9/VOP_CREATE.9
View File

@ -56,15 +56,15 @@ in a given directory.
The arguments are:
.Bl -tag -width target
.It Fa dvp
the locked vnode of the directory
The locked vnode of the directory.
.It Fa vpp
the address of a variable where the resulting locked vnode should be stored
The address of a variable where the resulting locked vnode should be stored.
.It Fa cnp
the pathname component created
The pathname component created.
.It Fa vap
the attributes that the new object should be created with
The attributes that the new object should be created with.
.It Fa target
the pathname of the target of the symlink
The pathname of the target of the symlink.
.El
.Pp
These entry points are called after

14
share/man/man9/VOP_FSYNC.9
View File

@ -50,22 +50,22 @@ system calls.
Its arguments are:
.Bl -tag -width waitfor
.It Fa vp
the vnode of the file
The vnode of the file.
.It Fa cred
the caller's credentials
The caller's credentials.
.It Fa waitfor
whether the function should wait for I/O to complete.
Whether the function should wait for I/O to complete.
Possible values are:
.Bl -tag -width MNT_NOWAIT
.It Dv MNT_WAIT
synchronously wait for I/O to complete
Synchronously wait for I/O to complete.
.It Dv MNT_NOWAIT
start all I/O, but do not wait for it
Start all I/O, but do not wait for it.
.It Dv MNT_LAZY
push data not written by file system syncer
Push data not written by file system syncer.
.El
.It Fa td
the calling thread
The calling thread.
.El
.Pp
The argument

10
share/man/man9/VOP_GETACL.9
View File

@ -44,15 +44,15 @@ file or directory.
Its arguments are:
.Bl -tag -width type
.It Fa vp
the vnode of the file or directory
The vnode of the file or directory.
.It Fa type
the type of ACL to retrieve
The type of ACL to retrieve.
.It Fa aclp
a pointer to an ACL structure to receive the ACL data
A pointer to an ACL structure to receive the ACL data.
.It Fa cred
the user credentials to use in authorizing the request
The user credentials to use in authorizing the request.
.It Fa td
the thread requesting the ACL
The thread requesting the ACL.
.El
.Pp
The

16
share/man/man9/VOP_GETEXTATTR.9
View File

@ -52,16 +52,16 @@ from a file or directory.
Its arguments are:
.Bl -tag -width ".Fa attrnamespace"
.It Fa vp
the vnode of the file or directory
The vnode of the file or directory.
.It Fa attrnamespace
integer constant indicating which extended attribute namespace the attribute
name is present in
Integer constant indicating which extended attribute namespace the attribute
name is present in.
.It Fa name
pointer to a null-terminated character string containing the attribute name
Pointer to a null-terminated character string containing the attribute name.
.It Fa uio
the location of the data to be read
The location of the data to be read.
.It Fa size
if not
If not
.Dv NULL ,
on return it will contain the number of bytes required to read all of the
attribute data.
@ -73,9 +73,9 @@ when
.Fa size
is not, and vise versa.
.It Fa cred
the user credentials to use in authorizing the request
The user credentials to use in authorizing the request.
.It Fa td
the thread requesting the extended attribute
The thread requesting the extended attribute.
.El
.Pp
The

4
share/man/man9/VOP_GETVOBJECT.9
View File

@ -48,9 +48,9 @@ with a particular vnode.
The arguments specific to these functions are:
.Bl -tag -width objpp
.It Fa vp
the vnode of the file
The vnode of the file.
.It Fa objpp
the VM object being returned, or
The VM object being returned, or
.Dv NULL
if the caller wants to test for the existence
of the VM object).

2
share/man/man9/VOP_INACTIVE.9
View File

@ -46,7 +46,7 @@
The arguments are:
.Bl -tag -width 2n
.It Fa vp
the vnode being reclaimed
The vnode being reclaimed.
.El
.Pp
.Fn VOP_INACTIVE

12
share/man/man9/VOP_IOCTL.9
View File

@ -45,17 +45,17 @@ Manipulate a file in device dependent ways.
Its arguments are:
.Bl -tag -width command
.It Fa vp
the vnode of the file (normally representing a device)
The vnode of the file (normally representing a device).
.It Fa command
the device specific operation to perform
The device specific operation to perform.
.It Fa cnp
extra data for the specified operation
Extra data for the specified operation.
.It Fa fflag
some flags ???
Some flags ???
.It Fa cred
the caller's credentials
The caller's credentials.
.It Fa td
the calling thread
The calling thread.
.El
.Pp
Most file systems do not implement this entry point.

6
share/man/man9/VOP_LINK.9
View File

@ -45,11 +45,11 @@ This links a new name in the specified directory to an existing file.
Its arguments are:
.Bl -tag -width 8n
.It Fa dvp
the vnode of the directory
The vnode of the directory.
.It Fa vp
the vnode of the file to be linked
The vnode of the file to be linked.
.It Fa cnp
pathname information about the file
Pathname information about the file.
.El
.Pp
The pathname info should

14
share/man/man9/VOP_LISTEXTATTR.9
View File

@ -56,14 +56,14 @@ from a specified namespace on a file or directory.
Its arguments are:
.Bl -tag -width ".Fa attrnamespace"
.It Fa vp
the vnode of the file or directory
The vnode of the file or directory.
.It Fa attrnamespace
integer constant indicating which extended attribute namespace the attribute
name is present in
Integer constant indicating which extended attribute namespace the attribute
name is present in.
.It Fa uio
the location of the data to be read
The location of the data to be read.
.It Fa size
if not
If not
.Dv NULL ,
on return it will contain the number of bytes required to read the list.
The resulting data will be an
@ -78,9 +78,9 @@ when
.Fa size
is not, and vise versa.
.It Fa cred
the user credentials to use in authorizing the request
The user credentials to use in authorizing the request.
.It Fa td
the thread requesting the extended attribute
The thread requesting the extended attribute.
.El
.Pp
The

61
share/man/man9/VOP_LOCK.9
View File

@ -57,41 +57,60 @@ same time.
The arguments are:
.Bl -tag -width flags
.It Fa vp
the vnode being locked or unlocked
The vnode being locked or unlocked.
.It Fa flags
One of the lock request types:
.Bl -column LK_EXCLUPGRADE -offset indent
.It Dv LK_SHARED Ta "Shared lock"
.It Dv LK_EXCLUSIVE Ta "Exclusive lock"
.It Dv LK_UPGRADE Ta "Shared-to-exclusive upgrade"
.It Dv LK_EXCLUPGRADE Ta "First shared-to-exclusive upgrade"
.It Dv LK_DOWNGRADE Ta "Exclusive-to-shared downgrade"
.It Dv LK_RELEASE Ta "Release any type of lock"
.It Dv LK_DRAIN Ta "Wait for all lock activity to end"
.Pp
.Bl -tag -width ".Dv LK_EXCLUPGRADE" -offset indent -compact
.It Dv LK_SHARED
Shared lock.
.It Dv LK_EXCLUSIVE
Exclusive lock.
.It Dv LK_UPGRADE
Shared-to-exclusive upgrade.
.It Dv LK_EXCLUPGRADE
First shared-to-exclusive upgrade.
.It Dv LK_DOWNGRADE
Exclusive-to-shared downgrade.
.It Dv LK_RELEASE
Release any type of lock.
.It Dv LK_DRAIN
Wait for all lock activity to end.
.El
.Pp
The lock type may be
.Em or Ns 'ed
with these lock flags:
.Bl -column LK_CANRECURSE -offset indent
.It Dv LK_NOWAIT Ta "Do not sleep to wait for lock"
.It Dv LK_SLEEPFAIL Ta "Sleep, then return failure"
.It Dv LK_CANRECURSE Ta "Allow recursive exclusive lock"
.It Dv LK_REENABLE Ta "Lock is to be reenabled after drain"
.It Dv LK_NOPAUSE Ta "No spinloop"
.Pp
.Bl -tag -width ".Dv LK_EXCLUPGRADE" -offset indent -compact
.It Dv LK_NOWAIT
Do not sleep to wait for lock.
.It Dv LK_SLEEPFAIL
Sleep, then return failure.
.It Dv LK_CANRECURSE
Allow recursive exclusive lock.
.It Dv LK_REENABLE
Lock is to be reenabled after drain.
.It Dv LK_NOPAUSE
No spinloop.
.El
.Pp
The lock type may be
.Em or Ns 'ed
with these control flags:
.Bl -column LK_INTERLOCK -offset indent
.It Dv LK_INTERLOCK Ta "Specify when the caller already has a simple lock \
(VOP_LOCK will unlock the simple lock after getting the lock)"
.It Dv LK_RETRY Ta "Retry until locked"
.It Dv LK_NOOBJ Ta "Don't create object"
.Pp
.Bl -tag -width ".Dv LK_EXCLUPGRADE" -offset indent -compact
.It Dv LK_INTERLOCK
Specify when the caller already has a simple lock
.Fn ( VOP_LOCK
will unlock the simple lock after getting the lock).
.It Dv LK_RETRY
Retry until locked.
.It Dv LK_NOOBJ
Don't create object.
.El
.It Fa td
thread context to use for the locks
Thread context to use for the locks.
.El
.Pp
Kernel code should use

6
share/man/man9/VOP_LOOKUP.9
View File

@ -46,11 +46,11 @@ This entry point looks up a single pathname component in a given directory.
Its arguments are:
.Bl -tag -width vpp
.It Fa dvp
the locked vnode of the directory to search
The locked vnode of the directory to search.
.It Fa vpp
the address of a variable where the resulting locked vnode should be stored
The address of a variable where the resulting locked vnode should be stored.
.It Fa cnp
the pathname component to be searched for
The pathname component to be searched for.
.El
.Pp
.Fa Cnp

6
share/man/man9/VOP_OPENCLOSE.9
View File

@ -52,11 +52,11 @@ entry point is called after a file is finished with by the process.
The arguments are:
.Bl -tag -width mode
.It Fa vp
the vnode of the file
The vnode of the file.
.It Fa mode
the access mode required by the calling process
The access mode required by the calling process.
.It Fa td
the thread which is accessing the file
The thread which is accessing the file.
.El
.Pp
Additionally,

6
share/man/man9/VOP_PATHCONF.9
View File

@ -44,11 +44,11 @@
The arguments are:
.Bl -tag -width retval
.It Fa vp
the vnode to get information about
The vnode to get information about.
.It Fa name
the type of information to return
The type of information to return.
.It Fa retval
the place to return the information
The place to return the information.
.El
.Pp
The value of

2
share/man/man9/VOP_PRINT.9
View File

@ -43,7 +43,7 @@
The arguments are:
.Bl -tag -width 2n
.It Fa vp
the vnode to print
The vnode to print.
.El
.Sh RETURN VALUES
Zero is returned on success, otherwise an error is returned.

22
share/man/man9/VOP_RDWR.9
View File

@ -49,13 +49,13 @@ These entry points read or write the contents of a file
The arguments are:
.Bl -tag -width ioflag
.It Fa vp
the vnode of the file
The vnode of the file.
.It Fa uio
the location of the data to be read or written
The location of the data to be read or written.
.It Fa ioflag
various flags
Various flags.
.It Fa cnp
the credentials of the caller
The credentials of the caller.
.El
.Pp
The
@ -66,20 +66,20 @@ read-ahead hint (in units of file system blocks) that the file system
should attempt.
The low 16 bits are a bit mask which can contain
the following flags:
.Bl -tag -width IO_NODELOCKED
.Bl -tag -width ".Dv IO_NODELOCKED"
.It Dv IO_UNIT
do I/O as atomic unit
Do I/O as atomic unit.
.It Dv IO_APPEND
append write to end
Append write to end.
.It Dv IO_SYNC
do I/O synchronously
Do I/O synchronously.
.It Dv IO_NODELOCKED
underlying node already locked
Underlying node already locked.
.It Dv IO_NDELAY
.Dv FNDELAY
flag set in file table
flag set in file table.
.It Dv IO_VMIO
data already in VMIO space
Data already in VMIO space.
.El
.Sh LOCKS
The file should be locked on entry and will still be locked on exit.

18
share/man/man9/VOP_READDIR.9
View File

@ -44,17 +44,23 @@
Read directory entries.
.Bl -tag -width ncookies
.It Fa vp
the vnode of the directory
The vnode of the directory.
.It Fa uio
where to read the directory contents
Where to read the directory contents.
.It Fa cred
the caller's credentials
The caller's credentials.
.It Fa eofflag
return end of file status (NULL if not wanted)
Return end of file status
.Dv ( NULL
if not wanted).
.It Fa ncookies
number of directory cookies generated for NFS (NULL if not wanted)
Number of directory cookies generated for NFS
.Dv ( NULL
if not wanted).
.It Fa cookies
directory seek cookies generated for NFS (NULL if not wanted)
Directory seek cookies generated for NFS
.Dv ( NULL
if not wanted).
.El
The directory contents are read into
.Vt struct dirent

6
share/man/man9/VOP_READLINK.9
View File

@ -44,11 +44,11 @@
This reads the target pathname of a symbolic link
.Bl -tag -width uio
.It Fa vp
the vnode of the symlink
The vnode of the symlink.
.It Fa uio
the location of the data to be read or written
The location of the data to be read or written.
.It Fa cred
the credentials of the caller
The credentials of the caller.
.El
.Sh LOCKS
The vnode should be locked on entry and will still be locked on exit.

4
share/man/man9/VOP_REALLOCBLKS.9
View File

@ -43,9 +43,9 @@
The arguments are:
.Bl -tag -width buflist
.It Fa vp
the file to manipulate
The file to manipulate.
.It Fa buflist
a list of buffers to rearrange
A list of buffers to rearrange.
.El
.Pp
This seems to be part of a work in progress.

6
share/man/man9/VOP_REMOVE.9
View File

@ -48,11 +48,11 @@ These entry points remove files and directories respectively.
The arguments are:
.Bl -tag -width dvp
.It Fa dvp
the vnode of the directory
The vnode of the directory.
.It Fa vp
the vnode of the file to be removed
The vnode of the file to be removed.
.It Fa cnp
pathname information about the file
Pathname information about the file.
.El
.Sh LOCKS
Both

12
share/man/man9/VOP_RENAME.9
View File

@ -46,17 +46,17 @@ If the destination object exists, it will be removed first.
Its arguments are:
.Bl -tag -width fdvp
.It Fa fdvp
the vnode of the old parent directory
The vnode of the old parent directory.
.It Fa fvp
the vnode of the file to be renamed
The vnode of the file to be renamed.
.It Fa fcnp
pathname information about the file's current name
Pathname information about the file's current name.
.It Fa tdvp
the vnode of the new parent directory
The vnode of the new parent directory.
.It Fa tvp
the vnode of the target file (if it exists)
The vnode of the target file (if it exists).
.It Fa tcnp
pathname information about the file's new name
Pathname information about the file's new name.
.El
.Sh LOCKS
The source directory and file are unlocked but are expected to have their

10
share/man/man9/VOP_SETACL.9
View File

@ -44,15 +44,15 @@ or directory.
Its arguments are:
.Bl -tag -width type
.It Fa vp
the vnode of the file or directory
The vnode of the file or directory.
.It Fa type
the type of ACL to set
The type of ACL to set.
.It Fa aclp
a pointer to an ACL structure from which to retrieve the ACL data
A pointer to an ACL structure from which to retrieve the ACL data.
.It Fa cred
the user credentials to use in authorizing the request
The user credentials to use in authorizing the request.
.It Fa td
the thread setting the ACL
The thread setting the ACL.
.El
.Pp
The

14
share/man/man9/VOP_SETEXTATTR.9
View File

@ -44,18 +44,18 @@ file or directory.
Its arguments are:
.Bl -tag -width type
.It Fa vp
the vnode of the file or directory
The vnode of the file or directory.
.It Fa attrnamespace
integer constant indicating which extended attribute namespace the attribute
name is present in
Integer constant indicating which extended attribute namespace the attribute
name is present in.
.It Fa name
pointer to a null-terminated character string containing the attribute name
Pointer to a null-terminated character string containing the attribute name.
.It Fa uio
the location of the data to be read or written
The location of the data to be read or written.
.It Fa cred
the user credentials to use in authorizing the request
The user credentials to use in authorizing the request.
.It Fa td
the thread setting the extended attribute
The thread setting the extended attribute.
.El
.Pp
The uio structure is used in a manner similar to the argument of the same

4
share/man/man9/VOP_STRATEGY.9
View File

@ -43,9 +43,9 @@
The arguments are:
.Bl -tag -width 2n
.It Fa vp
the vnode that the buffer is for
The vnode that the buffer is for.
.It Fa bp
the buffer to be read or written
The buffer to be read or written.
.El
.Pp
This call either reads or writes data from a file, depending on the value of