d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
24cd0f8516
freebsd-dev/share/man/man9/VOP_ATTRIB.9

103 lines
3.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
.\"
Decontextualize the couplet VOP_GETATTR / VOP_SETATTR as the passed thread was always curthread and totally unuseful. Tested by: Giovanni Trematerra <giovanni dot trematerra at gmail dot com>
2008-08-28 15:23:18 +00:00
.Dd August 29, 2008
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
.Dt VOP_ATTRIB 9
mdoc: order prologue macros consistently by Dd/Dt/Os Although groff_mdoc(7) gives another impression, this is the ordering most widely used and also required by mdocml/mandoc. Reviewed by: ru Approved by: philip, ed (mentors)
2010-04-14 19:08:06 +00:00
.Os
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 VOP_GETATTR ,
.Nm VOP_SETATTR
.Nd get and set attributes on a file or directory
.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
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
.Ft int
Decontextualize the couplet VOP_GETATTR / VOP_SETATTR as the passed thread was always curthread and totally unuseful. Tested by: Giovanni Trematerra <giovanni dot trematerra at gmail dot com>
2008-08-28 15:23:18 +00:00
.Fn VOP_GETATTR "struct vnode *vp" "struct vattr *vap" "struct ucred *cred"
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
.Ft int
Decontextualize the couplet VOP_GETATTR / VOP_SETATTR as the passed thread was always curthread and totally unuseful. Tested by: Giovanni Trematerra <giovanni dot trematerra at gmail dot com>
2008-08-28 15:23:18 +00:00
.Fn VOP_SETATTR "struct vnode *vp" "struct vattr *vap" "struct ucred *cred"
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 DESCRIPTION
These entry points manipulate various attributes of a file or directory,
including file permissions, owner, group, size,
access time and modification time.
.Pp
The arguments are:
.Bl -tag -width cred
mdoc(7) police: markup nits.
2002-05-29 17:37:32 +00:00
.It Fa vp
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
The vnode of the file.
mdoc(7) police: markup nits.
2002-05-29 17:37:32 +00:00
.It Fa vap
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
The attributes of the file.
mdoc(7) police: markup nits.
2002-05-29 17:37:32 +00:00
.It Fa cred
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
The user credentials of the calling process.
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
.El
.Pp
Attributes which are not being modified by
mdoc(7) police: Deal with self-xrefs.
2002-12-24 13:41:48 +00:00
.Fn VOP_SETATTR
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
should be set to the value
Various updates to VOP_ATTRIB(9): mention locks being shared/exclusive for VOP_GETATTR() and VOP_SETATTR(), reference VOP_NULL() to suggest clearing all of *vap with it before setting specific values. Cross reference VFS(9). Indicate that failure modes are possible from VOP_GETATTR() and that an errno value is returned. Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org>
2002-05-03 20:28:38 +00:00
.Dv VNOVAL ;
s/VOP_NULL/VATTR_NULL/
2002-09-14 03:32:57 +00:00
.Fn VATTR_NULL
Various updates to VOP_ATTRIB(9): mention locks being shared/exclusive for VOP_GETATTR() and VOP_SETATTR(), reference VOP_NULL() to suggest clearing all of *vap with it before setting specific values. Cross reference VFS(9). Indicate that failure modes are possible from VOP_GETATTR() and that an errno value is returned. Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org>
2002-05-03 20:28:38 +00:00
may be used to clear all the values, and should generally be used to reset
the contents of
mdoc(7) police: markup nits.
2002-05-29 17:37:32 +00:00
.Fa *vap
Various updates to VOP_ATTRIB(9): mention locks being shared/exclusive for VOP_GETATTR() and VOP_SETATTR(), reference VOP_NULL() to suggest clearing all of *vap with it before setting specific values. Cross reference VFS(9). Indicate that failure modes are possible from VOP_GETATTR() and that an errno value is returned. Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org>
2002-05-03 20:28:38 +00:00
prior to setting specific values.
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 LOCKS
mdoc(7) police: Deal with self-xrefs.
2002-12-24 13:41:48 +00:00
.Fn VOP_GETATTR
Revert 1.14: VOP_GETATTR() really does require a vnode lock. Confirmed by: mckusick
2002-02-10 19:28:34 +00:00
expects the vnode to be locked on entry and will leave the vnode locked on
return.
Various updates to VOP_ATTRIB(9): mention locks being shared/exclusive for VOP_GETATTR() and VOP_SETATTR(), reference VOP_NULL() to suggest clearing all of *vap with it before setting specific values. Cross reference VFS(9). Indicate that failure modes are possible from VOP_GETATTR() and that an errno value is returned. Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org>
2002-05-03 20:28:38 +00:00
The lock type can be either shared or exclusive.
More clarification of locking requirements.
1999-09-24 10:42:45 +00:00
.Pp
mdoc(7) police: Deal with self-xrefs.
2002-12-24 13:41:48 +00:00
.Fn VOP_SETATTR
More clarification of locking requirements.
1999-09-24 10:42:45 +00:00
expects the vnode to be locked on entry and will leave the vnode locked on
return.
Various updates to VOP_ATTRIB(9): mention locks being shared/exclusive for VOP_GETATTR() and VOP_SETATTR(), reference VOP_NULL() to suggest clearing all of *vap with it before setting specific values. Cross reference VFS(9). Indicate that failure modes are possible from VOP_GETATTR() and that an errno value is returned. Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org>
2002-05-03 20:28:38 +00:00
The lock type must be exclusive.
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 RETURN VALUES
mdoc(7) police: Deal with self-xrefs.
2002-12-24 13:41:48 +00:00
.Fn VOP_GETATTR
Various updates to VOP_ATTRIB(9): mention locks being shared/exclusive for VOP_GETATTR() and VOP_SETATTR(), reference VOP_NULL() to suggest clearing all of *vap with it before setting specific values. Cross reference VFS(9). Indicate that failure modes are possible from VOP_GETATTR() and that an errno value is returned. Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org>
2002-05-03 20:28:38 +00:00
returns 0 if it was able to retrieve the attribute data via
.Fa *vap ,
otherwise an appropriate error is returned.
mdoc(7) police: Deal with self-xrefs.
2002-12-24 13:41:48 +00:00
.Fn VOP_SETATTR
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
returns zero if the attributes were changed successfully, otherwise an
appropriate error is returned.
.Sh ERRORS
Some minor mdoc cleanup.
1997-03-07 03:32:31 +00:00
.Bl -tag -width Er
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
.It Bq Er EPERM
Style and markup changes only. Capitalize the first letter of the descriptions for the entries in the ERRORS section if they are complete sentences and end the sentences with periods.
2002-09-18 09:34:01 +00:00
The file is immutable.
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
.It Bq Er EACCES
Convert descriptions in the ERRORS section to full sentences if they were not full sentences, elaborating as necessary.
2002-09-18 22:12:43 +00:00
The caller does not have permission to modify the file or directory attributes.
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
.It Bq Er EROFS
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
The file system is read-only.
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
.El
.Sh SEE ALSO
mdoc(7) police: markup nits.
2002-05-29 17:37:32 +00:00
.Xr VFS 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 vnode 9 ,
mdoc(7) police: markup nits.
2002-05-29 17:37:32 +00:00
.Xr VOP_ACCESS 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 AUTHORS
Use 'manual page' instead of 'man page' for consistency. Approved by: re (hrs)
2005-06-28 20:15:19 +00:00
This manual page was written by
.Sh AUTHOR -> .Sh AUTHORS according to mdoc specs. Use .An/.Aq.
1998-03-12 07:31:21 +00:00
.An Doug Rabson .
Reference in New Issue Copy Permalink