share/man/man9/VOP_PATHCONF.9

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