xref: /illumos-gate/usr/src/man/man4d/zcons.4d (revision ddb365bfc9e868ad24ccdcb0dc91af18b10df082)
1'\" te
2.\"  Copyright 2003 Sun Microsystems, Inc. All rights reserved.
3.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6.\" Copyright 2022 Oxide Computer Company
7.Dd February 5, 2022
8.Dt ZCONS 4D
9.Os
10.Sh NAME
11.Nm zcons
12.Nd Zone console device driver
13.Sh DESCRIPTION
14The
15.Nm zcons
16character driver exports the console for system zones.
17The driver is fundamentally similar to a pseudo-terminal device, and is thus
18comprised of two sides:
19.Bl -bullet
20.It
21a manager device, which applications in the global zone can open for
22communication
23.It
24a subsidiary device, which processes in the non-global zone can write to, to
25communicate with global zone management applications
26.El
27.Pp
28Applications must not depend on the location of
29.Pa /dev
30or
31.Pa /devices
32entries exposed by
33.Nm zcons
34in the global zone.
35Inside a non-global zone, the
36.Nm zcons
37subsidiary device is fronted by
38.Pa /dev/console
39and other console-related symbolic links, which are used by applications that
40expect to write to the system console.
41.Pp
42The
43.Nm
44driver is not a
45.Sy Committed
46interface, and may change at any time.
47.Sh FILES
48.Bl -tag -width Pa
49.It Pa /dev/zcons/ZONENAME/globalconsole
50Global zone console manager device for zone
51.Sy ZONENAME .
52.It Pa /dev/zcons/ZONENAME/zoneconsole
53Global zone console subsidiary device for zone
54.Sy ZONENAME .
55.It Pa /dev/zconsole
56Non-global zone console (subsidiary device).
57.El
58.Sh INTERFACE STABILITY
59.Sy Uncommitted
60.Sh SEE ALSO
61.Xr attributes 7 ,
62.Xr zones 7 ,
63.Xr zoneadm 8 ,
64.Xr zonecfg 8
65