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