share/man/man5/fdescfs.5

   1 .\" Copyright (c) 1996
   2 .\"     Mike Pritchard <mpp@FreeBSD.org>.  All rights reserved.
   3 .\"
   4 .\" Copyright (c) 1992, 1993, 1994
   5 .\"     The Regents of the University of California.  All rights reserved.
   6 .\" All rights reserved.
   7 .\"
   8 .\" This code is derived from software donated to Berkeley by
   9 .\" Jan-Simon Pendry.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  14 .\" 1. Redistributions of source code must retain the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer.
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in the
  18 .\"    documentation and/or other materials provided with the distribution.
  19 .\" 3. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\" $FreeBSD$
  36 .\"
  37 .Dd August 1, 2017
  38 .Dt FDESCFS 5
  39 .Os
  40 .Sh NAME
  41 .Nm fdescfs
  42 .Nd file-descriptor file system
  43 .Sh SYNOPSIS
  44 .Bd -literal
  45 fdescfs /dev/fd fdescfs rw 0 0
  46 .Ed
  47 .Sh DESCRIPTION
  48 The file-descriptor file system, or
  49 .Nm ,
  50 provides access to the per-process file descriptor
  51 namespace in the global file system namespace.
  52 The conventional mount point is
  53 .Pa /dev/fd .
  54 .Pp
  55 The file system's contents
  56 appear as a list of numbered files
  57 which correspond to the open files of the process reading the
  58 directory.
  59 The files
  60 .Pa /dev/fd/0
  61 through
  62 .Pa /dev/fd/#
  63 refer to file descriptors which can be accessed through the file
  64 system.
  65 If the file descriptor is open and the mode the file is being opened
  66 with is a subset of the mode of the existing descriptor, the call:
  67 .Bd -literal -offset indent
  68 fd = open("/dev/fd/0", mode);
  69 .Ed
  70 .Pp
  71 and the call:
  72 .Bd -literal -offset indent
  73 fd = fcntl(0, F_DUPFD, 0);
  74 .Ed
  75 .Pp
  76 are equivalent.
  77 .Pp
  78 Flags to the
  79 .Xr open 2
  80 call other than
  81 .Dv O_RDONLY ,
  82 .Dv O_WRONLY
  83 and
  84 .Dv O_RDWR
  85 are ignored.
  86 .Pp
  87 .Em "Note:"
  88 .Pa /dev/fd/0 ,
  89 .Pa /dev/fd/1
  90 and
  91 .Pa /dev/fd/2
  92 files are created by default when devfs alone is mounted.
  93 .Nm
  94 creates entries for all file descriptors opened by the process.
  95 .Pp
  96 For
  97 .Xr linux 4
  98 ABI compatibility mount
  99 .Nm
 100 volume with
 101 .Cm linrdlnk
 102 option.
 103 .Sh FILES
 104 .Bl -tag -width /dev/stderr -compact
 105 .It Pa /dev/fd/#
 106 .El
 107 .Sh EXAMPLES
 108 To mount a
 109 .Nm
 110 volume located on
 111 .Pa /dev/fd :
 112 .Pp
 113 .Dl "mount -t fdescfs null /dev/fd"
 114 .Pp
 115 For
 116 .Xr linux 4
 117 ABI compatibility:
 118 .Pp
 119 .Dl "mount -t fdescfs -o linrdlnk null /compat/linux/dev/fd"
 120 .Sh SEE ALSO
 121 .Xr devfs 5 ,
 122 .Xr mount 8
 123 .Sh HISTORY
 124 The
 125 .Nm
 126 file system first appeared in
 127 .Bx 4.4 .
 128 The
 129 .Nm
 130 manual page first appeared in
 131 .Fx 2.2 .
 132 .Sh AUTHORS
 133 .An -nosplit
 134 The
 135 .Nm
 136 manual page was written by
 137 .An Mike Pritchard Aq Mt mpp@FreeBSD.org ,
 138 and was based on the
 139 manual page written by
 140 .An Jan-Simon Pendry .