xref: /netbsd-src/sbin/mount_ptyfs/mount_ptyfs.8 (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1.\"	$NetBSD: mount_ptyfs.8,v 1.13 2014/04/04 21:19:35 christos Exp $
2.\"
3.\"
4.\" Copyright (c) 2004, 2014 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 April 4, 2014
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 g Ar group|gid
40.Op Fl m Ar mode
41.Op Fl o Ar options
42.Ar ptyfs
43.Ar mount_point
44.Sh DESCRIPTION
45The
46.Nm
47command attaches an instance of the pseudo-terminal device filesystem
48to the global filesystem namespace.
49The conventional mount point is
50.Pa /dev/pts .
51The directory specified by
52.Ar mount_point
53is converted to an absolute path before use.
54This command is normally executed by
55.Xr mount 8
56at boot time.
57.Pp
58The filesystem contains pseudo-terminal slave device nodes which are
59allocated dynamically via
60.Xr ptm 4 ,
61or they are already open via traditional BSD style ptys.
62.Pp
63The options are as follows:
64.Bl -tag -width indent
65.It Fl g Ar group|gid
66Specify the group ownership of the slave pseudo-tty.
67.It Fl m Ar mode
68Specify the default
69.Ar mode
70of the slave pseudo-tty.
71.It Fl o
72Options are specified with a
73.Fl o
74flag followed by a comma separated string of options.
75.Pp
76.Nm
77specific options are
78.Dv group
79which corresponds to
80.Fl g ,
81and
82.Dv mode
83which corresponds to
84.Fl m .
85See the
86.Xr mount 8
87man page for possible options and their meanings.
88.El
89.Sh FILES
90.Bl -tag -width n -compact
91.It Pa n
92The nth pseudo-terminal device in use.
93.El
94.Sh SEE ALSO
95.Xr mount 2 ,
96.Xr unmount 2 ,
97.Xr ptm 4 ,
98.Xr fstab 5 ,
99.Xr mount 8
100.Sh HISTORY
101The
102.Nm
103utility first appeared in
104.Nx 3.0 .
105