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