ptsname.3c (66492cf01c4f0eb178cb6e056451d04be61a0374) ptsname.3c (1fa2a66491e7d8ae0be84e7da4da8e812480c710)
1.\"
2.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3.\" permission to reproduce portions of its copyrighted documentation.
4.\" Original documentation from The Open Group can be obtained online at
5.\" http://www.opengroup.org/bookstore/.
6.\"
7.\" The Institute of Electrical and Electronics Engineers and The Open
8.\" Group, have given us permission to reprint portions of their

--- 29 unchanged lines hidden (view full) ---

38.\" If applicable, add the following below this CDDL HEADER, with the
39.\" fields enclosed by brackets "[]" replaced with your own identifying
40.\" information: Portions Copyright [yyyy] [name of copyright owner]
41.\"
42.\"
43.\" Copyright 1989 AT&T
44.\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
45.\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
1.\"
2.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3.\" permission to reproduce portions of its copyrighted documentation.
4.\" Original documentation from The Open Group can be obtained online at
5.\" http://www.opengroup.org/bookstore/.
6.\"
7.\" The Institute of Electrical and Electronics Engineers and The Open
8.\" Group, have given us permission to reprint portions of their

--- 29 unchanged lines hidden (view full) ---

38.\" If applicable, add the following below this CDDL HEADER, with the
39.\" fields enclosed by brackets "[]" replaced with your own identifying
40.\" information: Portions Copyright [yyyy] [name of copyright owner]
41.\"
42.\"
43.\" Copyright 1989 AT&T
44.\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
45.\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
46.\" Copyright 2022 Oxide Computer Company
46.\"
47.\"
47.TH PTSNAME 3C "Aug 14, 2002"
48.SH NAME
49ptsname \- get name of the slave pseudo-terminal device
50.SH SYNOPSIS
51.LP
52.nf
53#include <stdlib.h>
54
55\fBchar *\fR\fBptsname\fR(\fBint\fR \fIfildes\fR);
56.fi
57
58.SH DESCRIPTION
59.sp
60.LP
61The \fBptsname()\fR function returns the name of the slave pseudo-terminal
62device associated with a master pseudo-terminal device. \fIfildes\fR is a file
63descriptor returned from a successful open of the master device.
64\fBptsname()\fR returns a pointer to a string containing the null-terminated
65path name of the slave device of the form \fB/dev/pts/N\fR, where \fBN\fR is a
66non-negative integer.
67.SH RETURN VALUES
68.sp
69.LP
70Upon successful completion, the function \fBptsname()\fR returns a pointer to a
71string which is the name of the pseudo-terminal slave device. This value points
72to a static data area that is overwritten by each call to \fBptsname()\fR. Upon
73failure, \fBptsname()\fR returns \fINULL\fR. This could occur if \fIfildes\fR
74is an invalid file descriptor or if the slave device name does not exist in
75the file system.
76.SH ATTRIBUTES
77.sp
78.LP
79See \fBattributes\fR(5) for descriptions of the following attributes:
80.sp
81
82.sp
83.TS
84box;
85c | c
86l | l .
87ATTRIBUTE TYPE ATTRIBUTE VALUE
88_
89Interface Stability Standard
90_
91MT-Level Safe
92.TE
93
94.SH SEE ALSO
95.sp
96.LP
97\fBopen\fR(2), \fBgrantpt\fR(3C), \fBttyname\fR(3C), \fBunlockpt\fR(3C),
98\fBattributes\fR(5), \fBstandards\fR(5)
99.sp
100.LP
101\fISTREAMS Programming Guide\fR
48.Dd February 5, 2022
49.Dt PTSNAME 3C
50.Os
51.Sh NAME
52.Nm ptsname
53.Nd get the name of the subsidiary device of a pseudo-terminal
54.Sh SYNOPSIS
55.In stdlib.h
56.Ft char *
57.Fo ptsname
58.Fa "int fildes"
59.Fc
60.Sh DESCRIPTION
61The
62.Fn ptsname
63function returns the name of the pseudo-terminal subsidiary device associated
64with a pseudo-terminal manager device.
65The
66.Fa fildes
67argument is a file descriptor returned from a successful open of the
68pseudo-terminal manager device; e.g., by calling
69.Xr posix_openpt 3C
70or by performing an
71.Xr open 2
72of the
73.Xr ptm 7D
74device.
75.Pp
76The
77.Fn ptsname
78function returns a pointer to a string containing the null-terminated
79path name of the subsidiary device.
80This string is of the form
81.Pa /dev/pts/N ,
82where
83.Sy N
84is a non-negative integer.
85.Sh RETURN VALUES
86If successful, the
87.Fn ptsname
88function returns a pointer to a string which is the name of the pseudo-terminal
89subsidiary device.
90This value points to a static data area that is overwritten by each call to
91.Fn ptsname .
92.Pp
93Upon failure,
94.Fn ptsname
95returns
96.Dv NULL .
97This could occur if
98.Fa fildes
99is an invalid file descriptor or if the subsidiary device name does not exist
100in the file system.
101.Sh INTERFACE STABILITY
102.Sy Committed
103.Sh MT LEVEL
104.Sy Safe
105.Sh SEE ALSO
106.Xr open 2 ,
107.Xr grantpt 3C ,
108.Xr posix_openpt 3C ,
109.Xr ttyname 3C ,
110.Xr unlockpt 3C ,
111.Xr attributes 5 ,
112.Xr standards 5 ,
113.Xr ptm 7D ,
114.Xr pts 7D