ptsname.3c

.\"
.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
.\" permission to reproduce portions of its copyrighted documentation.
.\" Original documentation from The Open Group can be obtained online at
.\" http://www.opengroup.org/bookstore/.
.\"
.\" The Institute of Electrical and Electronics Engineers and The Open
.\" Group, have given us permission to reprint portions of their
.\" documentation.
.\"
.\" In the following statement, the phrase ``this text'' refers to portions
.\" of the system documentation.
.\"
.\" Portions of this text are reprinted and reproduced in electronic form
.\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
.\" Standard for Information Technology -- Portable Operating System
.\" Interface (POSIX), The Open Group Base Specifications Issue 6,
.\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
.\" Engineers, Inc and The Open Group.  In the event of any discrepancy
.\" between these versions and the original IEEE and The Open Group
.\" Standard, the original IEEE and The Open Group Standard is the referee
.\" document.  The original Standard can be obtained online at
.\" http://www.opengroup.org/unix/online.html.
.\"
.\" This notice shall appear on any product containing this material.
.\"
.\" 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.
.\"
.\" 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.
.\"
.\" 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]
.\"
.\"
.\" Copyright 1989 AT&T
.\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
.\" Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved.
.\" Copyright 2024 Oxide Computer Company
.\"
.Dd July 2, 2024
.Dt PTSNAME 3C
.Os
.Sh NAME
.Nm ptsname ,
.Nm ptsname_r
.Nd get the name of the subsidiary device of a pseudo-terminal
.Sh SYNOPSIS
.In stdlib.h
.Ft char *
.Fo ptsname
.Fa "int fildes"
.Fc
.Ft int
.Fo ptsname_r
.Fa "int fildes"
.Fa "char *name"
.Fa "size_t namelen"
.Fc
.Sh DESCRIPTION
The
.Fn ptsname
function returns the name of the pseudo-terminal subsidiary device associated
with a pseudo-terminal manager device.
The
.Fa fildes
argument is a file descriptor returned from a successful open of the
pseudo-terminal manager device; e.g., by calling
.Xr posix_openpt 3C
or by performing an
.Xr open 2
of the
.Xr ptm 4D
device.
.Pp
The
.Fn ptsname
function returns a pointer to a string containing the null-terminated
path name of the subsidiary device.
This string is of the form
.Pa /dev/pts/N ,
where
.Sy N
is a non-negative integer.
Callers should generally assume that a subsequent call to
.Fn ptsname
will overwrite the returned buffer.
POSIX does not require that the interface be thread-safe.
While a per-thread buffer is currently being used, that should not be relied
upon by portable applications and is not a system guarantee.
.Pp
The
.Fn ptsname_r
function behaves similarly to the
.Fn ptsname
function, but rather than use a thread-specific buffer, stores the name of the
pseudo-terminal subsidiary device of
.Fa fildes
in
.Fa name .
The size of
.Fa name
is indicated by
.Fa namelen .
If the buffer is not large enough, then the function will fail with
.Er ERANGE .
The name's length will not exceed
.Brq TTY_NAME_MAX ,
which can be determined at runtime by calling
.Xr sysconf 3C
with the name
.Dv _SC_TTY_NAME_MAX .
.Sh RETURN VALUES
Upon successful completion, the
.Fn ptsname
function returns a pointer to a string which is the name of the pseudo-terminal
subsidiary device.
This value points to a static data area that is overwritten by each call to
.Fn ptsname
by the same thread.
Otherwise,
.Dv NULL
is returned and
.Va errno
is set to indicate the error that occurred.
.Pp
Upon successful completion, the
.Fn ptsname_r
function will return
.Sy 0
and
.Fa name
will be filled in with the subsidiary device's name.
Otherwise, an error number will be returned.
.Sh ERRORS
The
.Fn ptsname
and
.Fn ptsname_r
functions will fail if:
.Bl -tag -width Er
.It Er EBADF
The file descriptor,
.Fa fildes ,
does not refer to a valid file descriptor.
.It Er EINVAL
The file descriptor,
.Fa fildes ,
does not refer to a manager pseudo-terminal device.
.Pp
For the
.Fn ptsname_r
function,
.Fa name
is a
.Dv NULL
pointer.
.It Er ENOTTY
The file descriptor,
.Fa fildes ,
does not refer to a manager pseudo-terminal device.
.It Er ERANGE
For the
.Fn ptsname_r
function, the buffer
.Fa name 's
size as indicated by
.Fa namelen
was too small to hold the actual subsidiary device's name.
.El
.Sh INTERFACE STABILITY
.Sy Committed
.Sh MT LEVEL
The
.Fn ptsname
function is
.Sy Safe .
.Pp
The
.Fn ptsname_r
function is
.Sy MT-Safe .
.Sh SEE ALSO
.Xr open 2 ,
.Xr grantpt 3C ,
.Xr posix_openpt 3C ,
.Xr ttyname 3C ,
.Xr unlockpt 3C ,
.Xr ptm 4D ,
.Xr pts 4D ,
.Xr attributes 7 ,
.Xr standards 7