diff options
author | dfr <dfr@FreeBSD.org> | 1997-03-03 18:01:01 +0000 |
---|---|---|
committer | dfr <dfr@FreeBSD.org> | 1997-03-03 18:01:01 +0000 |
commit | 7e67e1e73230219ea55118f095cc1800faf2c534 (patch) | |
tree | e33dd16a7d9cf5ad26d4f75d4b2d3db1b3d2fdd9 /share/man/man9/VOP_PATHCONF.9 | |
parent | 6c38eceeb9c3076678e4763e02440823894d2323 (diff) | |
download | FreeBSD-src-7e67e1e73230219ea55118f095cc1800faf2c534.zip FreeBSD-src-7e67e1e73230219ea55118f095cc1800faf2c534.tar.gz |
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.
Diffstat (limited to 'share/man/man9/VOP_PATHCONF.9')
-rw-r--r-- | share/man/man9/VOP_PATHCONF.9 | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/share/man/man9/VOP_PATHCONF.9 b/share/man/man9/VOP_PATHCONF.9 new file mode 100644 index 0000000..1f7641d --- /dev/null +++ b/share/man/man9/VOP_PATHCONF.9 @@ -0,0 +1,88 @@ +.\" -*- 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$ +.\" +.Dd July 24, 1996 +.Os +.Dt VOP_PATHCONF 9 +.Sh NAME +.Nm VOP_PATHCONF +.Nd return POSIX pathconf information +.Sh SYNOPSIS +.Fd #include <sys/vnode.h> +.Fd #include <sys/unistd.h> +.Ft int +.Fn VOP_PATHCONF "struct vnode *vp" "int name" "int *retval" +.Sh DESCRIPTION +.Pp +The arguments are: +.Bl -tag -width retval +.It Ar vp +the vnode to get information about +.It Ar name +the type of information to return +.It Ar retval +the place to return the information +.El +.Pp +The value of +.Fa name +specifies what should be returned: +.Bl -tag -width _PC_CHOWN_RESTRICTED +.It Dv _PC_LINK_MAX +The maximum number of links to a file. +.It Dv _PC_NAME_MAX +The maximum number of bytes in a file name. +.It Dv _PC_PATH_MAX +The maximum number of bytes in a pathname. +.It Dv _PC_PIPE_BUF +The maximum number of bytes which will be written atomically to a pipe. +.It Dv _PC_CHOWN_RESTRICTED +Return 1 if appropriate privileges are required for the +.Xr chown 2 +system call, otherwise 0. +.It Dv _PC_NO_TRUNC +Return 1 if file names longer than +.Dv KERN_NAME_MAX +are truncated. +.El +.Sh RETURN VALUES +If +.Fa name +is recognised, +.Fa *retval +is set to the specified value and zero is returned, otherwise +.Dv EINVAL +is returned. +.Sh SEE ALSO +.Xr vnode 9 , +.Xr pathconf 2 +.Sh AUTHORS +This man page was written by Doug Rabson. + |