share/man/man5/fdesc.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: src/share/man/man5/fdesc.5,v 1.6.2.4 2001/12/20 16:50:57 ru Exp $
  36 .\"
  37 .Dd December 14, 1996
  38 .Dt FDESC 5
  39 .Os
  40 .Sh NAME
  41 .Nm fdesc
  42 .Nd file-descriptor file system
  43 .Sh SYNOPSIS
  44 fdesc   /dev    fdesc rw 0 0
  45 .Sh DESCRIPTION
  46 The file-descriptor file system, or
  47 .Nm ,
  48 provides access to the per-process file descriptor
  49 namespace in the global filesystem namespace.
  50 The conventional mount point is
  51 .Pa /dev
  52 and the filesystem should be union mounted in order to augment,
  53 rather than replace, the existing entries in
  54 .Pa /dev .
  55 .Pp
  56 The contents of the mount point are
  57 .Pa fd ,
  58 .Pa stderr ,
  59 .Pa stdin ,
  60 .Pa stdout
  61 and
  62 .Pa tty .
  63 .Pp
  64 .Pa fd
  65 is a directory whose contents
  66 appear as a list of numbered files
  67 which correspond to the open files of the process reading the
  68 directory.
  69 The files
  70 .Pa /dev/fd/0
  71 through
  72 .Pa /dev/fd/#
  73 refer to file descriptors which can be accessed through the file
  74 system.
  75 If the file descriptor is open and the mode the file is being opened
  76 with is a subset of the mode of the existing descriptor, the call:
  77 .Bd -literal -offset indent
  78 fd = open("/dev/fd/0", mode);
  79 .Ed
  80 .Pp
  81 and the call:
  82 .Bd -literal -offset indent
  83 fd = fcntl(0, F_DUPFD, 0);
  84 .Ed
  85 .Pp
  86 are equivalent.
  87 .Pp
  88 The files
  89 .Pa /dev/stdin ,
  90 .Pa /dev/stdout
  91 and
  92 .Pa /dev/stderr
  93 appear as symlinks to the relevant entry in the
  94 .Pa /dev/fd
  95 sub-directory.
  96 Opening them is equivalent to the following calls:
  97 .Bd -literal -offset indent
  98 fd = fcntl(STDIN_FILENO,  F_DUPFD, 0);
  99 fd = fcntl(STDOUT_FILENO, F_DUPFD, 0);
 100 fd = fcntl(STDERR_FILENO, F_DUPFD, 0);
 101 .Ed
 102 .Pp
 103 Flags to the
 104 .Xr open 2
 105 call other than
 106 .Dv O_RDONLY ,
 107 .Dv O_WRONLY
 108 and
 109 .Dv O_RDWR
 110 are ignored.
 111 .Pp
 112 The
 113 .Pa /dev/tty
 114 entry is an indirect reference to the current process's controlling terminal.
 115 It appears as a named pipe (FIFO) but behaves in exactly the same way as
 116 the real controlling terminal device.
 117 .Sh FILES
 118 .Bl -tag -width /dev/stderr -compact
 119 .It Pa /dev/fd/#
 120 .It Pa /dev/stdin
 121 .It Pa /dev/stdout
 122 .It Pa /dev/stderr
 123 .It Pa /dev/tty
 124 .El
 125 .Sh SEE ALSO
 126 .Xr tty 4 ,
 127 .Xr mount_fdesc 8
 128 .Sh HISTORY
 129 The
 130 .Nm
 131 filesystem first appeared in
 132 .Bx 4.4 .
 133 The
 134 .Nm
 135 manual page first appeared in
 136 .Fx 2.2 .
 137 .Sh AUTHORS
 138 .An -nosplit
 139 The
 140 .Nm
 141 manual page was written by
 142 .An Mike Pritchard Aq Mt mpp@FreeBSD.org ,
 143 and was based on the
 144 .Xr mount_fdesc 8
 145 manual page written by
 146 .An Jan-Simon Pendry .