lib/libc/sys/pathconf.2

   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 .\"     $Id$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt PATHCONF 2
  37 .Os BSD 4
  38 .Sh NAME
  39 .Nm pathconf ,
  40 .Nm fpathconf
  41 .Nd get configurable pathname variables
  42 .Sh SYNOPSIS
  43 .Fd #include <unistd.h>
  44 .Ft long
  45 .Fn pathconf "const char *path" "int name"
  46 .Ft long
  47 .Fn fpathconf "int fd" "int name"
  48 .Sh DESCRIPTION
  49 .Pp
  50 The
  51 .Fn pathconf
  52 and
  53 .Fn fpathconf
  54 functions provides a method for applications to determine the current
  55 value of a configurable system limit or option variable associated
  56 with a pathname or file descriptor.
  57 .Pp
  58 For
  59 .Fn pathconf ,
  60 the
  61 .Fa path
  62 argument is the name of a file or directory.
  63 For
  64 .Fn fpathconf ,
  65 the
  66 .Fa fd
  67 argument is an open file descriptor.
  68 The
  69 .Fa name
  70 argument specifies the system variable to be queried.
  71 Symbolic constants for each name value are found in the include file
  72 .Li <unistd.h> .
  73 .Pp
  74 The available values are as follows:
  75 .Pp
  76 .Bl -tag -width "123456"
  77 .Pp
  78 .It Li _PC_LINK_MAX
  79 The maximum file link count.
  80 .It Li _PC_MAX_CANON
  81 The maximum number of bytes in terminal canonical input line.
  82 .It Li _PC_MAX_INPUT
  83 The minimum maximum number of bytes for which space is available in
  84 a terminal input queue.
  85 .It Li _PC_NAME_MAX
  86 The maximum number of bytes in a file name.
  87 .It Li _PC_PATH_MAX
  88 The maximum number of bytes in a pathname.
  89 .It Li _PC_PIPE_BUF
  90 The maximum number of bytes which will be written atomically to a pipe.
  91 .It Li _PC_CHOWN_RESTRICTED
  92 Return 1 if appropriate privileges are required for the
  93 .Xr chown 2
  94 system call, otherwise 0.
  95 .It Li _PC_NO_TRUNC
  96 Return 1 if file names longer than KERN_NAME_MAX are truncated.
  97 .It Li _PC_VDISABLE
  98 Returns the terminal character disabling value.
  99 .El
 100 .Sh RETURN VALUES
 101 If the call to
 102 .Fn pathconf
 103 or
 104 .Fn fpathconf
 105 is not successful, \-1 is returned and
 106 .Va errno
 107 is set appropriately.
 108 Otherwise, if the variable is associated with functionality that does
 109 not have a limit in the system, \-1 is returned and
 110 .Va errno
 111 is not modified.
 112 Otherwise, the current variable value is returned.
 113 .Sh ERRORS
 114 If any of the following conditions occur, the
 115 .Fn pathconf
 116 and
 117 .Fn fpathconf
 118 functions shall return -1 and set
 119 .Va errno
 120 to the corresponding value.
 121 .Bl -tag -width Er
 122 .It Bq Er EINVAL
 123 The value of the
 124 .Fa name
 125 argument is invalid.
 126 .It Bq Er EINVAL
 127 The implementation does not support an association of the variable
 128 name with the associated file.
 129 .El
 130 .Fn Pathconf
 131 will fail if:
 132 .Bl -tag -width ENAMETOOLONGAA
 133 .It Bq Er ENOTDIR
 134 A component of the path prefix is not a directory.
 135 .It Bq Er ENAMETOOLONG
 136 A component of a pathname exceeded 255 characters,
 137 or an entire path name exceeded 1023 characters.
 138 .It Bq Er ENOENT
 139 The named file does not exist.
 140 .It Bq Er EACCES
 141 Search permission is denied for a component of the path prefix.
 142 .It Bq Er ELOOP
 143 Too many symbolic links were encountered in translating the pathname.
 144 .It Bq Er EIO
 145 An I/O error occurred while reading from or writing to the file system.
 146 .El
 147 .Pp
 148 .Bl -tag -width [EFAULT]
 149 .Fn Fpathconf
 150 will fail if:
 151 .It Bq Er EBADF
 152 .Fa fd
 153 is not a valid open file descriptor.
 154 .It Bq Er EIO
 155 An I/O error occurred while reading from or writing to the file system.
 156 .El
 157 .Sh SEE ALSO
 158 .Xr sysctl 3
 159 .Sh HISTORY
 160 The
 161 .Fn pathconf
 162 and
 163 .Fn fpathconf
 164 functions first appeared in
 165 .Bx 4.4 .