sbin/mount_fdesc/mount_fdesc.8

   1 .\"     $NetBSD: mount_fdesc.8,v 1.14 2003/08/07 10:04:27 agc Exp $
   2 .\"
   3 .\" Copyright (c) 1992, 1993, 1994
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software donated to Berkeley by
   7 .\" Jan-Simon Pendry.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .\"     @(#)mount_fdesc.8       8.2 (Berkeley) 3/27/94
  34 .\"
  35 .Dd March 27, 1994
  36 .Dt MOUNT_FDESC 8
  37 .Os
  38 .Sh NAME
  39 .Nm mount_fdesc
  40 .Nd mount the file-descriptor file system
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl o Ar options
  44 .Ar fdesc
  45 .Ar mount_point
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 command attaches an instance of the per-process file descriptor
  50 namespace to 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 The directory specified by
  57 .Ar mount_point
  58 is converted to an absolute path before use.
  59 .Pp
  60 This command is normally executed by
  61 .Xr mount 8
  62 at boot time.
  63 .Pp
  64 The options are as follows:
  65 .Bl -tag -width indent
  66 .It Fl o
  67 Options are specified with a
  68 .Fl o
  69 flag followed by a comma separated string of options.
  70 See the
  71 .Xr mount 8
  72 man page for possible options and their meanings.
  73 .El
  74 .Pp
  75 The contents of the mount point are
  76 .Pa fd ,
  77 .Pa stderr ,
  78 .Pa stdin ,
  79 .Pa stdout
  80 and
  81 .Pa tty .
  82 .Pp
  83 .Pa fd
  84 is a directory whose contents
  85 appear as a list of numbered files
  86 which correspond to the open files of the process reading the
  87 directory.
  88 The files
  89 .Pa /dev/fd/0
  90 through
  91 .Pa /dev/fd/#
  92 refer to file descriptors which can be accessed through the file
  93 system.
  94 If the file descriptor is open and the mode the file is being opened
  95 with is a subset of the mode of the existing descriptor, the call:
  96 .Bd -literal -offset indent
  97 fd = open("/dev/fd/0", mode);
  98 .Ed
  99 .Pp
 100 and the call:
 101 .Bd -literal -offset indent
 102 fd = fcntl(0, F_DUPFD, 0);
 103 .Ed
 104 .Pp
 105 are equivalent.
 106 .Pp
 107 The files
 108 .Pa /dev/stdin ,
 109 .Pa /dev/stdout
 110 and
 111 .Pa /dev/stderr
 112 appear as symlinks to the relevant entry in the
 113 .Pa /dev/fd
 114 sub-directory.
 115 Opening them is equivalent to the following calls:
 116 .Bd -literal -offset indent
 117 fd = fcntl(STDIN_FILENO,  F_DUPFD, 0);
 118 fd = fcntl(STDOUT_FILENO, F_DUPFD, 0);
 119 fd = fcntl(STDERR_FILENO, F_DUPFD, 0);
 120 .Ed
 121 .Pp
 122 Flags to the
 123 .Xr open 2
 124 call other than
 125 .Dv O_RDONLY ,
 126 .Dv O_WRONLY
 127 and
 128 .Dv O_RDWR
 129 are ignored.
 130 .Pp
 131 The
 132 .Pa /dev/tty
 133 entry is an indirect reference to the current process's controlling terminal.
 134 It appears as a named pipe (FIFO) but behaves in exactly the same way as
 135 the real controlling terminal device.
 136 .Sh FILES
 137 .Bl -tag -width /dev/stderr -compact
 138 .It Pa /dev/fd/#
 139 .It Pa /dev/stdin
 140 .It Pa /dev/stdout
 141 .It Pa /dev/stderr
 142 .It Pa /dev/tty
 143 .El
 144 .Sh SEE ALSO
 145 .Xr mount 2 ,
 146 .Xr unmount 2 ,
 147 .Xr tty 4 ,
 148 .Xr fstab 5 ,
 149 .Xr mount 8
 150 .Sh HISTORY
 151 The
 152 .Nm
 153 utility first appeared in
 154 .Bx 4.4 .
 155 .Sh BUGS
 156 This filesystem may not be NFS-exported.