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