share/man/man9/VOP_PATHCONF.9

   1 .\" Copyright (c) 1996 Doug Rabson
   2 .\"
   3 .\" All rights reserved.
   4 .\"
   5 .\" This program is free software.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man9/VOP_PATHCONF.9,v 1.6.2.3 2001/12/17 11:30:18 ru Exp $
  28 .\"
  29 .Dd July 24, 1996
  30 .Dt VOP_PATHCONF 9
  31 .Os
  32 .Sh NAME
  33 .Nm VOP_PATHCONF
  34 .Nd return POSIX pathconf information
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/vnode.h
  38 .In sys/unistd.h
  39 .Ft int
  40 .Fn VOP_PATHCONF "struct vnode *vp" "int name" "int *retval"
  41 .Sh DESCRIPTION
  42 The arguments are:
  43 .Bl -tag -width retval
  44 .It Fa vp
  45 the vnode to get information about
  46 .It Fa name
  47 the type of information to return
  48 .It Fa retval
  49 the place to return the information
  50 .El
  51 .Pp
  52 The value of
  53 .Fa name
  54 specifies what should be returned:
  55 .Bl -tag -width ".Dv _PC_CHOWN_RESTRICTED"
  56 .It Dv _PC_LINK_MAX
  57 The maximum number of links to a file.
  58 .It Dv _PC_NAME_MAX
  59 The maximum number of bytes in a file name.
  60 .It Dv _PC_PATH_MAX
  61 The maximum number of bytes in a pathname.
  62 .It Dv _PC_PIPE_BUF
  63 The maximum number of bytes which will be written atomically to a pipe.
  64 .It Dv _PC_CHOWN_RESTRICTED
  65 Return 1 if appropriate privileges are required for the
  66 .Xr chown 2
  67 system call, otherwise 0.
  68 .It Dv _PC_NO_TRUNC
  69 Return 1 if file names longer than
  70 .Dv KERN_NAME_MAX
  71 are truncated.
  72 .El
  73 .Sh RETURN VALUES
  74 If
  75 .Fa name
  76 is recognized,
  77 .Fa *retval
  78 is set to the specified value and zero is returned, otherwise
  79 .Er EINVAL
  80 is returned.
  81 .Sh SEE ALSO
  82 .Xr pathconf 2 ,
  83 .Xr vnode 9
  84 .Sh AUTHORS
  85 This man page was written by
  86 .An Doug Rabson .