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