1994-05-27 05:00:24 +00:00
|
|
|
.\" Copyright (c) 1993
|
|
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
|
|
.\"
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
.\" are met:
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
2017-02-28 23:42:47 +00:00
|
|
|
.\" 3. Neither the name of the University nor the names of its contributors
|
1994-05-27 05:00:24 +00:00
|
|
|
.\" may be used to endorse or promote products derived from this software
|
|
|
|
.\" without specific prior written permission.
|
|
|
|
.\"
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
.\"
|
|
|
|
.\" @(#)pathconf.2 8.1 (Berkeley) 6/4/93
|
1999-08-28 00:22:10 +00:00
|
|
|
.\" $FreeBSD$
|
1994-05-27 05:00:24 +00:00
|
|
|
.\"
|
2021-08-06 23:09:57 +00:00
|
|
|
.Dd August 6, 2021
|
1994-05-27 05:00:24 +00:00
|
|
|
.Dt PATHCONF 2
|
2001-07-10 13:41:46 +00:00
|
|
|
.Os
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh NAME
|
|
|
|
.Nm pathconf ,
|
2009-07-08 15:23:18 +00:00
|
|
|
.Nm lpathconf ,
|
1994-05-27 05:00:24 +00:00
|
|
|
.Nm fpathconf
|
|
|
|
.Nd get configurable pathname variables
|
2000-04-21 09:42:15 +00:00
|
|
|
.Sh LIBRARY
|
|
|
|
.Lb libc
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh SYNOPSIS
|
2001-10-01 16:09:29 +00:00
|
|
|
.In unistd.h
|
1994-05-27 05:00:24 +00:00
|
|
|
.Ft long
|
|
|
|
.Fn pathconf "const char *path" "int name"
|
|
|
|
.Ft long
|
2009-07-08 15:23:18 +00:00
|
|
|
.Fn lpathconf "const char *path" "int name"
|
|
|
|
.Ft long
|
1994-05-27 05:00:24 +00:00
|
|
|
.Fn fpathconf "int fd" "int name"
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
The
|
2009-07-08 15:23:18 +00:00
|
|
|
.Fn pathconf ,
|
|
|
|
.Fn lpathconf
|
1994-05-27 05:00:24 +00:00
|
|
|
and
|
|
|
|
.Fn fpathconf
|
2002-12-18 09:22:32 +00:00
|
|
|
system calls provide a method for applications to determine the current
|
1994-05-27 05:00:24 +00:00
|
|
|
value of a configurable system limit or option variable associated
|
|
|
|
with a pathname or file descriptor.
|
|
|
|
.Pp
|
|
|
|
For
|
2009-07-08 15:23:18 +00:00
|
|
|
.Fn pathconf
|
|
|
|
and
|
|
|
|
.Fn lpathconf ,
|
1994-05-27 05:00:24 +00:00
|
|
|
the
|
|
|
|
.Fa path
|
|
|
|
argument is the name of a file or directory.
|
|
|
|
For
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn fpathconf ,
|
1994-05-27 05:00:24 +00:00
|
|
|
the
|
|
|
|
.Fa fd
|
|
|
|
argument is an open file descriptor.
|
|
|
|
The
|
|
|
|
.Fa name
|
|
|
|
argument specifies the system variable to be queried.
|
|
|
|
Symbolic constants for each name value are found in the include file
|
|
|
|
.Li <unistd.h> .
|
|
|
|
.Pp
|
2009-07-08 15:23:18 +00:00
|
|
|
The
|
|
|
|
.Fn lpathconf
|
|
|
|
system call is like
|
|
|
|
.Fn pathconf
|
|
|
|
except in the case where the named file is a symbolic link,
|
|
|
|
in which case
|
|
|
|
.Fn lpathconf
|
|
|
|
returns information about the link,
|
|
|
|
while
|
|
|
|
.Fn pathconf
|
|
|
|
returns information about the file the link references.
|
|
|
|
.Pp
|
1994-05-27 05:00:24 +00:00
|
|
|
The available values are as follows:
|
2000-12-29 14:08:20 +00:00
|
|
|
.Bl -tag -width 6n
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Li _PC_LINK_MAX
|
|
|
|
The maximum file link count.
|
|
|
|
.It Li _PC_MAX_CANON
|
|
|
|
The maximum number of bytes in terminal canonical input line.
|
|
|
|
.It Li _PC_MAX_INPUT
|
|
|
|
The minimum maximum number of bytes for which space is available in
|
|
|
|
a terminal input queue.
|
|
|
|
.It Li _PC_NAME_MAX
|
|
|
|
The maximum number of bytes in a file name.
|
|
|
|
.It Li _PC_PATH_MAX
|
|
|
|
The maximum number of bytes in a pathname.
|
|
|
|
.It Li _PC_PIPE_BUF
|
|
|
|
The maximum number of bytes which will be written atomically to a pipe.
|
|
|
|
.It Li _PC_CHOWN_RESTRICTED
|
2004-07-08 20:27:38 +00:00
|
|
|
Return 1 if appropriate privilege is required for the
|
1994-05-27 05:00:24 +00:00
|
|
|
.Xr chown 2
|
|
|
|
system call, otherwise 0.
|
2004-07-08 20:27:38 +00:00
|
|
|
.St -p1003.1-2001
|
|
|
|
requires appropriate privilege in all cases, but this behavior was optional
|
|
|
|
in prior editions of the standard.
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Li _PC_NO_TRUNC
|
2004-07-08 20:27:38 +00:00
|
|
|
Return greater than zero if attempts to use pathname components longer than
|
2005-01-11 20:50:51 +00:00
|
|
|
.Brq Dv NAME_MAX
|
2004-07-08 20:27:38 +00:00
|
|
|
will result in an
|
|
|
|
.Bq Er ENAMETOOLONG
|
|
|
|
error; otherwise, such components will be truncated to
|
2005-01-11 20:50:51 +00:00
|
|
|
.Brq Dv NAME_MAX .
|
2004-07-08 20:27:38 +00:00
|
|
|
.St -p1003.1-2001
|
|
|
|
requires the error in all cases, but this behavior was optional in prior
|
|
|
|
editions of the standard, and some
|
2005-01-11 20:50:51 +00:00
|
|
|
.No non- Ns Tn POSIX Ns -compliant
|
|
|
|
file systems do not support this behavior.
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Li _PC_VDISABLE
|
|
|
|
Returns the terminal character disabling value.
|
2002-11-04 07:21:44 +00:00
|
|
|
.It Li _PC_ASYNC_IO
|
|
|
|
Return 1 if asynchronous I/O is supported, otherwise 0.
|
|
|
|
.It Li _PC_PRIO_IO
|
|
|
|
Returns 1 if prioritised I/O is supported for this file,
|
|
|
|
otherwise 0.
|
|
|
|
.It Li _PC_SYNC_IO
|
|
|
|
Returns 1 if synchronised I/O is supported for this file, otherwise 0.
|
|
|
|
.It Li _PC_ALLOC_SIZE_MIN
|
|
|
|
Minimum number of bytes of storage allocated for any portion of a file.
|
|
|
|
.It Li _PC_FILESIZEBITS
|
2003-01-07 05:06:27 +00:00
|
|
|
Number of bits needed to represent the maximum file size.
|
2002-11-04 07:21:44 +00:00
|
|
|
.It Li _PC_REC_INCR_XFER_SIZE
|
|
|
|
Recommended increment for file transfer sizes between
|
|
|
|
.Dv _PC_REC_MIN_XFER_SIZE
|
|
|
|
and
|
|
|
|
.Dv _PC_REC_MAX_XFER_SIZE .
|
|
|
|
.It Li _PC_REC_MAX_XFER_SIZE
|
|
|
|
Maximum recommended file transfer size.
|
|
|
|
.It Li _PC_REC_MIN_XFER_SIZE
|
|
|
|
Minimum recommended file transfer size.
|
|
|
|
.It Li _PC_REC_XFER_ALIGN
|
|
|
|
Recommended file transfer buffer alignment.
|
|
|
|
.It Li _PC_SYMLINK_MAX
|
|
|
|
Maximum number of bytes in a symbolic link.
|
|
|
|
.It Li _PC_ACL_EXTENDED
|
|
|
|
Returns 1 if an Access Control List (ACL) can be set on the specified
|
|
|
|
file, otherwise 0.
|
Add NFSv4 ACL support to libc.
This adds the following functions to the acl(3) API: acl_add_flag_np,
acl_clear_flags_np, acl_create_entry_np, acl_delete_entry_np,
acl_delete_flag_np, acl_get_extended_np, acl_get_flag_np, acl_get_flagset_np,
acl_set_extended_np, acl_set_flagset_np, acl_to_text_np, acl_is_trivial_np,
acl_strip_np, acl_get_brand_np. Most of them are similar to what Darwin
does. There are no backward-incompatible changes.
Approved by: rwatson@
2009-06-25 12:46:59 +00:00
|
|
|
.It Li _PC_ACL_NFS4
|
|
|
|
Returns 1 if an NFSv4 ACLs can be set on the specified
|
|
|
|
file, otherwise 0.
|
2002-11-04 07:21:44 +00:00
|
|
|
.It Li _PC_ACL_PATH_MAX
|
|
|
|
Maximum number of ACL entries per file.
|
|
|
|
.It Li _PC_CAP_PRESENT
|
|
|
|
Returns 1 if a capability state can be set on the specified file,
|
|
|
|
otherwise 0.
|
|
|
|
.It Li _PC_INF_PRESENT
|
|
|
|
Returns 1 if an information label can be set on the specified file,
|
|
|
|
otherwise 0.
|
|
|
|
.It Li _PC_MAC_PRESENT
|
|
|
|
Returns 1 if a Mandatory Access Control (MAC) label can be set on the
|
|
|
|
specified file, otherwise 0.
|
2007-04-05 21:10:53 +00:00
|
|
|
.It Li _PC_MIN_HOLE_SIZE
|
|
|
|
If a file system supports the reporting of holes (see
|
2012-05-08 18:56:21 +00:00
|
|
|
.Xr lseek 2 ) ,
|
2007-04-05 21:10:53 +00:00
|
|
|
.Fn pathconf
|
|
|
|
and
|
|
|
|
.Fn fpathconf
|
|
|
|
return a positive number that represents the minimum hole size returned in
|
|
|
|
bytes.
|
|
|
|
The offsets of holes returned will be aligned to this same value.
|
|
|
|
A special value of 1 is returned if the file system does not specify the minimum
|
2012-03-29 05:02:12 +00:00
|
|
|
hole size but still reports holes.
|
2021-08-06 23:09:57 +00:00
|
|
|
.It Li _PC_DEALLOC_PRESENT
|
|
|
|
Return 1 if a file system supports hole-punching (see
|
|
|
|
.Xr fspacectl 2 ) ,
|
|
|
|
otherwise 0.
|
1994-05-27 05:00:24 +00:00
|
|
|
.El
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
If the call to
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn pathconf
|
1994-05-27 05:00:24 +00:00
|
|
|
or
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn fpathconf
|
1994-05-27 05:00:24 +00:00
|
|
|
is not successful, \-1 is returned and
|
|
|
|
.Va errno
|
|
|
|
is set appropriately.
|
|
|
|
Otherwise, if the variable is associated with functionality that does
|
|
|
|
not have a limit in the system, \-1 is returned and
|
|
|
|
.Va errno
|
|
|
|
is not modified.
|
|
|
|
Otherwise, the current variable value is returned.
|
|
|
|
.Sh ERRORS
|
|
|
|
If any of the following conditions occur, the
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn pathconf
|
1994-05-27 05:00:24 +00:00
|
|
|
and
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn fpathconf
|
2002-12-18 09:22:32 +00:00
|
|
|
system calls shall return -1 and set
|
1994-05-27 05:00:24 +00:00
|
|
|
.Va errno
|
|
|
|
to the corresponding value.
|
|
|
|
.Bl -tag -width Er
|
|
|
|
.It Bq Er EINVAL
|
|
|
|
The value of the
|
|
|
|
.Fa name
|
|
|
|
argument is invalid.
|
|
|
|
.It Bq Er EINVAL
|
|
|
|
The implementation does not support an association of the variable
|
|
|
|
name with the associated file.
|
|
|
|
.El
|
2000-11-22 16:02:00 +00:00
|
|
|
.Pp
|
2002-12-18 09:22:32 +00:00
|
|
|
The
|
|
|
|
.Fn pathconf
|
|
|
|
system call
|
1994-05-27 05:00:24 +00:00
|
|
|
will fail if:
|
2000-11-22 16:02:00 +00:00
|
|
|
.Bl -tag -width Er
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Bq Er ENOTDIR
|
|
|
|
A component of the path prefix is not a directory.
|
|
|
|
.It Bq Er ENAMETOOLONG
|
2005-01-11 20:50:51 +00:00
|
|
|
A component of a pathname exceeded
|
2004-07-08 20:27:38 +00:00
|
|
|
.Brq Dv NAME_MAX
|
|
|
|
characters (but see
|
|
|
|
.Dv _PC_NO_TRUNC
|
|
|
|
above),
|
2005-01-11 20:50:51 +00:00
|
|
|
or an entire path name exceeded
|
2004-07-08 20:27:38 +00:00
|
|
|
.Brq Dv PATH_MAX
|
|
|
|
characters.
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Bq Er ENOENT
|
|
|
|
The named file does not exist.
|
|
|
|
.It Bq Er EACCES
|
|
|
|
Search permission is denied for a component of the path prefix.
|
|
|
|
.It Bq Er ELOOP
|
|
|
|
Too many symbolic links were encountered in translating the pathname.
|
|
|
|
.It Bq Er EIO
|
|
|
|
An I/O error occurred while reading from or writing to the file system.
|
2020-03-30 21:44:00 +00:00
|
|
|
.It Bq Er EINTEGRITY
|
|
|
|
Corrupted data was detected while reading from the file system.
|
1994-05-27 05:00:24 +00:00
|
|
|
.El
|
|
|
|
.Pp
|
2002-12-18 09:22:32 +00:00
|
|
|
The
|
|
|
|
.Fn fpathconf
|
|
|
|
system call
|
1994-05-27 05:00:24 +00:00
|
|
|
will fail if:
|
2010-10-21 12:27:13 +00:00
|
|
|
.Bl -tag -width Er
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Bq Er EBADF
|
2002-12-19 09:40:28 +00:00
|
|
|
The
|
1994-05-27 05:00:24 +00:00
|
|
|
.Fa fd
|
2002-12-19 09:40:28 +00:00
|
|
|
argument
|
1994-05-27 05:00:24 +00:00
|
|
|
is not a valid open file descriptor.
|
|
|
|
.It Bq Er EIO
|
|
|
|
An I/O error occurred while reading from or writing to the file system.
|
2020-03-30 21:44:00 +00:00
|
|
|
.It Bq Er EINTEGRITY
|
|
|
|
Corrupted data was detected while reading from the file system.
|
1994-05-27 05:00:24 +00:00
|
|
|
.El
|
|
|
|
.Sh SEE ALSO
|
2007-04-05 21:10:53 +00:00
|
|
|
.Xr lseek 2 ,
|
1994-05-27 05:00:24 +00:00
|
|
|
.Xr sysctl 3
|
|
|
|
.Sh HISTORY
|
|
|
|
The
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn pathconf
|
1994-05-27 05:00:24 +00:00
|
|
|
and
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn fpathconf
|
2002-12-18 09:22:32 +00:00
|
|
|
system calls first appeared in
|
1996-08-22 23:31:07 +00:00
|
|
|
.Bx 4.4 .
|
2009-07-08 15:23:18 +00:00
|
|
|
The
|
|
|
|
.Fn lpathconf
|
|
|
|
system call first appeared in
|
|
|
|
.Fx 8.0 .
|