1.\" Copyright (c) 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)pathconf.2 8.1 (Berkeley) 6/4/93 33.\" $FreeBSD: src/lib/libc/sys/pathconf.2,v 1.4.2.6 2001/12/14 18:34:01 ru Exp $ 34.\" $DragonFly: src/lib/libc/sys/pathconf.2,v 1.5 2008/05/02 02:05:04 swildner Exp $ 35.\" 36.Dd June 4, 1993 37.Dt PATHCONF 2 38.Os 39.Sh NAME 40.Nm pathconf , 41.Nm fpathconf 42.Nd get configurable pathname variables 43.Sh LIBRARY 44.Lb libc 45.Sh SYNOPSIS 46.In unistd.h 47.Ft long 48.Fn pathconf "const char *path" "int name" 49.Ft long 50.Fn fpathconf "int fd" "int name" 51.Sh DESCRIPTION 52The 53.Fn pathconf 54and 55.Fn fpathconf 56functions provide a method for applications to determine the current 57value of a configurable system limit or option variable associated 58with a pathname or file descriptor. 59.Pp 60For 61.Fn pathconf , 62the 63.Fa path 64argument is the name of a file or directory. 65For 66.Fn fpathconf , 67the 68.Fa fd 69argument is an open file descriptor. 70The 71.Fa name 72argument specifies the system variable to be queried. 73Symbolic constants for each name value are found in the include file 74.In unistd.h . 75.Pp 76The available values are as follows: 77.Bl -tag -width 6n 78.It Li _PC_LINK_MAX 79The maximum file link count. 80.It Li _PC_MAX_CANON 81The maximum number of bytes in terminal canonical input line. 82.It Li _PC_MAX_INPUT 83The minimum maximum number of bytes for which space is available in 84a terminal input queue. 85.It Li _PC_NAME_MAX 86The maximum number of bytes in a file name. 87.It Li _PC_PATH_MAX 88The maximum number of bytes in a pathname. 89.It Li _PC_PIPE_BUF 90The maximum number of bytes which will be written atomically to a pipe. 91.It Li _PC_CHOWN_RESTRICTED 92Return 1 if appropriate privileges are required for the 93.Xr chown 2 94system call, otherwise 0. 95.It Li _PC_NO_TRUNC 96Return 1 if file names longer than KERN_NAME_MAX are truncated. 97.It Li _PC_VDISABLE 98Returns the terminal character disabling value. 99.El 100.Sh RETURN VALUES 101If the call to 102.Fn pathconf 103or 104.Fn fpathconf 105is not successful, \-1 is returned and 106.Va errno 107is set appropriately. 108Otherwise, if the variable is associated with functionality that does 109not have a limit in the system, \-1 is returned and 110.Va errno 111is not modified. 112Otherwise, the current variable value is returned. 113.Sh ERRORS 114If any of the following conditions occur, the 115.Fn pathconf 116and 117.Fn fpathconf 118functions shall return -1 and set 119.Va errno 120to the corresponding value. 121.Bl -tag -width Er 122.It Bq Er EINVAL 123The value of the 124.Fa name 125argument is invalid. 126.It Bq Er EINVAL 127The implementation does not support an association of the variable 128name with the associated file. 129.El 130.Pp 131.Fn Pathconf 132will fail if: 133.Bl -tag -width Er 134.It Bq Er ENOTDIR 135A component of the path prefix is not a directory. 136.It Bq Er ENAMETOOLONG 137A component of a pathname exceeded 255 characters, 138or an entire path name exceeded 1023 characters. 139.It Bq Er ENOENT 140The named file does not exist. 141.It Bq Er EACCES 142Search permission is denied for a component of the path prefix. 143.It Bq Er ELOOP 144Too many symbolic links were encountered in translating the pathname. 145.It Bq Er EIO 146An I/O error occurred while reading from or writing to the file system. 147.El 148.Pp 149.Fn Fpathconf 150will fail if: 151.Bl -tag -width Er 152.It Bq Er EBADF 153.Fa fd 154is not a valid open file descriptor. 155.It Bq Er EIO 156An I/O error occurred while reading from or writing to the file system. 157.El 158.Sh SEE ALSO 159.Xr sysctl 3 160.Sh HISTORY 161The 162.Fn pathconf 163and 164.Fn fpathconf 165functions first appeared in 166.Bx 4.4 . 167