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