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 .\" $DragonFly: src/share/man/man9/VOP_PATHCONF.9,v 1.4 2004/06/01 11:36:53 hmp Exp $
  29 .\"
  30 .Dd July 24, 1996
  31 .Os
  32 .Dt VOP_PATHCONF 9
  33 .Sh NAME
  34 .Nm VOP_PATHCONF
  35 .Nd return POSIX pathconf information
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/vnode.h
  39 .In sys/unistd.h
  40 .Ft int
  41 .Fn VOP_PATHCONF "struct vnode *vp" "int name" "int *retval"
  42 .Sh DESCRIPTION
  43 The arguments are:
  44 .Bl -tag -width retval
  45 .It Fa vp
  46 the vnode to get information about
  47 .It Fa name
  48 the type of information to return
  49 .It Fa retval
  50 the place to return the information
  51 .El
  52 .Pp
  53 The value of
  54 .Fa name
  55 specifies what should be returned:
  56 .Bl -tag -width _PC_CHOWN_RESTRICTED
  57 .It Dv _PC_LINK_MAX
  58 The maximum number of links to a file.
  59 .It Dv _PC_NAME_MAX
  60 The maximum number of bytes in a file name.
  61 .It Dv _PC_PATH_MAX
  62 The maximum number of bytes in a pathname.
  63 .It Dv _PC_PIPE_BUF
  64 The maximum number of bytes which will be written atomically to a pipe.
  65 .It Dv _PC_CHOWN_RESTRICTED
  66 Return 1 if appropriate privileges are required for the
  67 .Xr chown 2
  68 system call, otherwise 0.
  69 .It Dv _PC_NO_TRUNC
  70 Return 1 if file names longer than
  71 .Dv KERN_NAME_MAX
  72 are truncated.
  73 .El
  74 .Sh RETURN VALUES
  75 If
  76 .Fa name
  77 is recognized,
  78 .Fa *retval
  79 is set to the specified value and zero is returned, otherwise
  80 .Er EINVAL
  81 is returned.
  82 .Sh SEE ALSO
  83 .Xr pathconf 2 ,
  84 .Xr vnode 9
  85 .Sh AUTHORS
  86 This man page was written by
  87 .An Doug Rabson .