xref: /dflybsd-src/share/man/man9/VOP_PATHCONF.9 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
1*86d7f5d3SJohn Marino.\" Copyright (c) 1996 Doug Rabson
2*86d7f5d3SJohn Marino.\"
3*86d7f5d3SJohn Marino.\" All rights reserved.
4*86d7f5d3SJohn Marino.\"
5*86d7f5d3SJohn Marino.\" This program is free software.
6*86d7f5d3SJohn Marino.\"
7*86d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without
8*86d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions
9*86d7f5d3SJohn Marino.\" are met:
10*86d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
11*86d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
12*86d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
13*86d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
14*86d7f5d3SJohn Marino.\"    documentation and/or other materials provided with the distribution.
15*86d7f5d3SJohn Marino.\"
16*86d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
17*86d7f5d3SJohn Marino.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18*86d7f5d3SJohn Marino.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19*86d7f5d3SJohn Marino.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
20*86d7f5d3SJohn Marino.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21*86d7f5d3SJohn Marino.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22*86d7f5d3SJohn Marino.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23*86d7f5d3SJohn Marino.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24*86d7f5d3SJohn Marino.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25*86d7f5d3SJohn Marino.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26*86d7f5d3SJohn Marino.\"
27*86d7f5d3SJohn Marino.\" $FreeBSD: src/share/man/man9/VOP_PATHCONF.9,v 1.6.2.3 2001/12/17 11:30:18 ru Exp $
28*86d7f5d3SJohn Marino.\"
29*86d7f5d3SJohn Marino.Dd July 24, 1996
30*86d7f5d3SJohn Marino.Dt VOP_PATHCONF 9
31*86d7f5d3SJohn Marino.Os
32*86d7f5d3SJohn Marino.Sh NAME
33*86d7f5d3SJohn Marino.Nm VOP_PATHCONF
34*86d7f5d3SJohn Marino.Nd return POSIX pathconf information
35*86d7f5d3SJohn Marino.Sh SYNOPSIS
36*86d7f5d3SJohn Marino.In sys/param.h
37*86d7f5d3SJohn Marino.In sys/vnode.h
38*86d7f5d3SJohn Marino.In sys/unistd.h
39*86d7f5d3SJohn Marino.Ft int
40*86d7f5d3SJohn Marino.Fn VOP_PATHCONF "struct vnode *vp" "int name" "int *retval"
41*86d7f5d3SJohn Marino.Sh DESCRIPTION
42*86d7f5d3SJohn MarinoThe arguments are:
43*86d7f5d3SJohn Marino.Bl -tag -width retval
44*86d7f5d3SJohn Marino.It Fa vp
45*86d7f5d3SJohn Marinothe vnode to get information about
46*86d7f5d3SJohn Marino.It Fa name
47*86d7f5d3SJohn Marinothe type of information to return
48*86d7f5d3SJohn Marino.It Fa retval
49*86d7f5d3SJohn Marinothe place to return the information
50*86d7f5d3SJohn Marino.El
51*86d7f5d3SJohn Marino.Pp
52*86d7f5d3SJohn MarinoThe value of
53*86d7f5d3SJohn Marino.Fa name
54*86d7f5d3SJohn Marinospecifies what should be returned:
55*86d7f5d3SJohn Marino.Bl -tag -width ".Dv _PC_CHOWN_RESTRICTED"
56*86d7f5d3SJohn Marino.It Dv _PC_LINK_MAX
57*86d7f5d3SJohn MarinoThe maximum number of links to a file.
58*86d7f5d3SJohn Marino.It Dv _PC_NAME_MAX
59*86d7f5d3SJohn MarinoThe maximum number of bytes in a file name.
60*86d7f5d3SJohn Marino.It Dv _PC_PATH_MAX
61*86d7f5d3SJohn MarinoThe maximum number of bytes in a pathname.
62*86d7f5d3SJohn Marino.It Dv _PC_PIPE_BUF
63*86d7f5d3SJohn MarinoThe maximum number of bytes which will be written atomically to a pipe.
64*86d7f5d3SJohn Marino.It Dv _PC_CHOWN_RESTRICTED
65*86d7f5d3SJohn MarinoReturn 1 if appropriate privileges are required for the
66*86d7f5d3SJohn Marino.Xr chown 2
67*86d7f5d3SJohn Marinosystem call, otherwise 0.
68*86d7f5d3SJohn Marino.It Dv _PC_NO_TRUNC
69*86d7f5d3SJohn MarinoReturn 1 if file names longer than
70*86d7f5d3SJohn Marino.Dv KERN_NAME_MAX
71*86d7f5d3SJohn Marinoare truncated.
72*86d7f5d3SJohn Marino.El
73*86d7f5d3SJohn Marino.Sh RETURN VALUES
74*86d7f5d3SJohn MarinoIf
75*86d7f5d3SJohn Marino.Fa name
76*86d7f5d3SJohn Marinois recognized,
77*86d7f5d3SJohn Marino.Fa *retval
78*86d7f5d3SJohn Marinois set to the specified value and zero is returned, otherwise
79*86d7f5d3SJohn Marino.Er EINVAL
80*86d7f5d3SJohn Marinois returned.
81*86d7f5d3SJohn Marino.Sh SEE ALSO
82*86d7f5d3SJohn Marino.Xr pathconf 2 ,
83*86d7f5d3SJohn Marino.Xr vnode 9
84*86d7f5d3SJohn Marino.Sh AUTHORS
85*86d7f5d3SJohn MarinoThis man page was written by
86*86d7f5d3SJohn Marino.An Doug Rabson .
87