xref: /freebsd/share/man/man9/VOP_PATHCONF.9 (revision 4d846d26)
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.\" $FreeBSD$
30.\"
31.Dd December 31, 2020
32.Dt VOP_PATHCONF 9
33.Os
34.Sh NAME
35.Nm VOP_PATHCONF
36.Nd return POSIX pathconf information
37.Sh SYNOPSIS
38.In sys/param.h
39.In sys/vnode.h
40.In sys/unistd.h
41.Ft int
42.Fn VOP_PATHCONF "struct vnode *vp" "int name" "long *retval"
43.Sh DESCRIPTION
44The arguments are:
45.Bl -tag -width retval
46.It Fa vp
47The vnode to get information about.
48.It Fa name
49The type of information to return.
50.It Fa retval
51The place to return the information.
52.El
53.Pp
54The value of
55.Fa name
56specifies what should be returned:
57.Bl -tag -width _PC_CHOWN_RESTRICTED
58.It Dv _PC_LINK_MAX
59The maximum number of links to a file.
60.It Dv _PC_NAME_MAX
61The maximum number of bytes in a file name.
62.It Dv _PC_PATH_MAX
63The maximum number of bytes in a pathname.
64.It Dv _PC_PIPE_BUF
65The maximum number of bytes which will be written atomically to a pipe.
66.It Dv _PC_CHOWN_RESTRICTED
67Return 1 if appropriate privileges are required for the
68.Xr chown 2
69system call, otherwise 0.
70.It Dv _PC_NO_TRUNC
71Return 1 if file names longer than
72.Dv KERN_NAME_MAX
73are truncated.
74.El
75.Sh LOCKS
76The vnode will be locked on entry and should remain locked on return.
77.Sh RETURN VALUES
78If
79.Fa name
80is recognized,
81.Fa *retval
82is set to the specified value and zero is returned, otherwise
83.Er EINVAL
84is returned.
85.Sh SEE ALSO
86.Xr pathconf 2 ,
87.Xr vnode 9
88.Sh AUTHORS
89This manual page was written by
90.An Doug Rabson .
91