sbin/mount_ptyfs/mount_ptyfs.8

   1 .\"     $NetBSD: mount_ptyfs.8,v 1.7 2009/03/15 16:47:45 christos Exp $
   2 .\"
   3 .\"
   4 .\" Copyright (c) 2004 The NetBSD Foundation, Inc.
   5 .\" All rights reserved.
   6 .\"
   7 .\" This code is derived from software contributed to The NetBSD Foundation
   8 .\" by Christos Zoulas.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29 .\" POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .Dd March 15, 2009
  32 .Dt MOUNT_PTYFS 8
  33 .Os
  34 .Sh NAME
  35 .Nm mount_ptyfs
  36 .Nd mount the /dev/pts file system
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl c
  40 .Op Fl g Ar group|gid
  41 .Op Fl m Ar mode
  42 .Op Fl o Ar options
  43 .Ar ptyfs
  44 .Ar mount_point
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 command attaches an instance of the pseudo-terminal device filesystem
  49 to the global filesystem namespace.
  50 The conventional mount point is
  51 .Pa /dev/pts .
  52 The directory specified by
  53 .Ar mount_point
  54 is converted to an absolute path before use.
  55 This command is normally executed by
  56 .Xr mount 8
  57 at boot time.
  58 .Pp
  59 The filesystem contains pseudo-terminal slave device nodes which are
  60 allocated dynamically via
  61 .Xr ptm 4 ,
  62 or they are already open via traditional BSD style ptys.
  63 .Pp
  64 The options are as follows:
  65 .Bl -tag -width indent
  66 .It Fl c
  67 Allows
  68 .Ar ptyfs
  69 to be mounted inside a chrooted environment.
  70 .It Fl g Ar group|gid
  71 Specify the group ownership of the slave pseudo-tty.
  72 .It Fl m Ar mode
  73 Specify the default
  74 .Ar mode
  75 of the slave pseudo-tty.
  76 .It Fl o
  77 Options are specified with a
  78 .Fl o
  79 flag followed by a comma separated string of options.
  80 .Pp
  81 .Nm
  82 specific options are
  83 .Dv chroot
  84 which corresponds to
  85 .Fl c ,
  86 .Dv group
  87 which corresponds to
  88 .Fl g ,
  89 and
  90 .Dv mode
  91 which corresponds to
  92 .Fl m .
  93 See the
  94 .Xr mount 8
  95 man page for possible options and their meanings.
  96 .El
  97 .Sh FILES
  98 .Bl -tag -width n -compact
  99 .It Pa n
 100 The nth pseudo-terminal device in use.
 101 .El
 102 .Sh SEE ALSO
 103 .Xr mount 2 ,
 104 .Xr unmount 2 ,
 105 .Xr ptm 4 ,
 106 .Xr fstab 5 ,
 107 .Xr mount 8
 108 .Sh HISTORY
 109 The
 110 .Nm
 111 utility first appeared in
 112 .Nx 3.0 .
 113 .Sh BUGS
 114 This filesystem may not be NFS-exported.
 115 This filesystem is experimental.