xref: /dflybsd-src/share/man/man9/VOP_PATHCONF.9 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino.\" Copyright (c) 1996 Doug Rabson
286d7f5d3SJohn Marino.\"
386d7f5d3SJohn Marino.\" All rights reserved.
486d7f5d3SJohn Marino.\"
586d7f5d3SJohn Marino.\" This program is free software.
686d7f5d3SJohn Marino.\"
786d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without
886d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions
986d7f5d3SJohn Marino.\" are met:
1086d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
1186d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
1286d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
1386d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
1486d7f5d3SJohn Marino.\"    documentation and/or other materials provided with the distribution.
1586d7f5d3SJohn Marino.\"
1686d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
1786d7f5d3SJohn Marino.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1886d7f5d3SJohn Marino.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1986d7f5d3SJohn Marino.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
2086d7f5d3SJohn Marino.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
2186d7f5d3SJohn Marino.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2286d7f5d3SJohn Marino.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2386d7f5d3SJohn Marino.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2486d7f5d3SJohn Marino.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2586d7f5d3SJohn Marino.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2686d7f5d3SJohn Marino.\"
2786d7f5d3SJohn Marino.\" $FreeBSD: src/share/man/man9/VOP_PATHCONF.9,v 1.6.2.3 2001/12/17 11:30:18 ru Exp $
2886d7f5d3SJohn Marino.\"
2986d7f5d3SJohn Marino.Dd July 24, 1996
3086d7f5d3SJohn Marino.Dt VOP_PATHCONF 9
3186d7f5d3SJohn Marino.Os
3286d7f5d3SJohn Marino.Sh NAME
3386d7f5d3SJohn Marino.Nm VOP_PATHCONF
3486d7f5d3SJohn Marino.Nd return POSIX pathconf information
3586d7f5d3SJohn Marino.Sh SYNOPSIS
3686d7f5d3SJohn Marino.In sys/param.h
3786d7f5d3SJohn Marino.In sys/vnode.h
3886d7f5d3SJohn Marino.In sys/unistd.h
3986d7f5d3SJohn Marino.Ft int
4086d7f5d3SJohn Marino.Fn VOP_PATHCONF "struct vnode *vp" "int name" "int *retval"
4186d7f5d3SJohn Marino.Sh DESCRIPTION
4286d7f5d3SJohn MarinoThe arguments are:
4386d7f5d3SJohn Marino.Bl -tag -width retval
4486d7f5d3SJohn Marino.It Fa vp
4586d7f5d3SJohn Marinothe vnode to get information about
4686d7f5d3SJohn Marino.It Fa name
4786d7f5d3SJohn Marinothe type of information to return
4886d7f5d3SJohn Marino.It Fa retval
4986d7f5d3SJohn Marinothe place to return the information
5086d7f5d3SJohn Marino.El
5186d7f5d3SJohn Marino.Pp
5286d7f5d3SJohn MarinoThe value of
5386d7f5d3SJohn Marino.Fa name
5486d7f5d3SJohn Marinospecifies what should be returned:
5586d7f5d3SJohn Marino.Bl -tag -width ".Dv _PC_CHOWN_RESTRICTED"
5686d7f5d3SJohn Marino.It Dv _PC_LINK_MAX
5786d7f5d3SJohn MarinoThe maximum number of links to a file.
5886d7f5d3SJohn Marino.It Dv _PC_NAME_MAX
5986d7f5d3SJohn MarinoThe maximum number of bytes in a file name.
6086d7f5d3SJohn Marino.It Dv _PC_PATH_MAX
6186d7f5d3SJohn MarinoThe maximum number of bytes in a pathname.
6286d7f5d3SJohn Marino.It Dv _PC_PIPE_BUF
6386d7f5d3SJohn MarinoThe maximum number of bytes which will be written atomically to a pipe.
6486d7f5d3SJohn Marino.It Dv _PC_CHOWN_RESTRICTED
6586d7f5d3SJohn MarinoReturn 1 if appropriate privileges are required for the
6686d7f5d3SJohn Marino.Xr chown 2
6786d7f5d3SJohn Marinosystem call, otherwise 0.
6886d7f5d3SJohn Marino.It Dv _PC_NO_TRUNC
6986d7f5d3SJohn MarinoReturn 1 if file names longer than
7086d7f5d3SJohn Marino.Dv KERN_NAME_MAX
7186d7f5d3SJohn Marinoare truncated.
7286d7f5d3SJohn Marino.El
7386d7f5d3SJohn Marino.Sh RETURN VALUES
7486d7f5d3SJohn MarinoIf
7586d7f5d3SJohn Marino.Fa name
7686d7f5d3SJohn Marinois recognized,
7786d7f5d3SJohn Marino.Fa *retval
7886d7f5d3SJohn Marinois set to the specified value and zero is returned, otherwise
7986d7f5d3SJohn Marino.Er EINVAL
8086d7f5d3SJohn Marinois returned.
8186d7f5d3SJohn Marino.Sh SEE ALSO
8286d7f5d3SJohn Marino.Xr pathconf 2 ,
8386d7f5d3SJohn Marino.Xr vnode 9
8486d7f5d3SJohn Marino.Sh AUTHORS
8586d7f5d3SJohn MarinoThis man page was written by
8686d7f5d3SJohn Marino.An Doug Rabson .
87