26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  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 .\"
  47 .TH PTSNAME 3C "Aug 14, 2002"
  48 .SH NAME
  49 ptsname \- 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
  61 The \fBptsname()\fR function returns the name of the slave pseudo-terminal
  62 device associated with a master pseudo-terminal device. \fIfildes\fR is a file
  63 descriptor returned from a successful open of the master device.
  64 \fBptsname()\fR returns a pointer to a string containing the null-terminated
  65 path name of the slave device of the form \fB/dev/pts/N\fR, where \fBN\fR is a
  66 non-negative integer.
  67 .SH RETURN VALUES
  68 .sp
  69 .LP
  70 Upon successful completion, the function \fBptsname()\fR returns a pointer to a
  71 string which is the name of the pseudo-terminal slave device. This value points
  72 to a static data area that is overwritten by each call to \fBptsname()\fR. Upon
  73 failure, \fBptsname()\fR returns \fINULL\fR. This could occur if \fIfildes\fR
  74 is an invalid file descriptor or if  the slave device name does not exist in
  75 the file system.
  76 .SH ATTRIBUTES
  77 .sp
  78 .LP
  79 See \fBattributes\fR(5) for descriptions of the following attributes:
  80 .sp
  81 
  82 .sp
  83 .TS
  84 box;
  85 c | c
  86 l | l .
  87 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  88 _
  89 Interface Stability     Standard
  90 _
  91 MT-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

  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  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
  47 .\"
  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
  61 The
  62 .Fn ptsname
  63 function returns the name of the pseudo-terminal subsidiary device associated
  64 with a pseudo-terminal manager device.
  65 The
  66 .Fa fildes
  67 argument is a file descriptor returned from a successful open of the
  68 pseudo-terminal manager device; e.g., by calling
  69 .Xr posix_openpt 3C
  70 or by performing an
  71 .Xr open 2
  72 of the
  73 .Xr ptm 7D
  74 device.
  75 .Pp
  76 The
  77 .Fn ptsname
  78 function returns a pointer to a string containing the null-terminated
  79 path name of the subsidiary device.
  80 This string is of the form
  81 .Pa /dev/pts/N ,
  82 where
  83 .Sy N
  84 is a non-negative integer.
  85 .Sh RETURN VALUES
  86 If successful, the
  87 .Fn ptsname
  88 function returns a pointer to a string which is the name of the pseudo-terminal
  89 subsidiary device.
  90 This value points to a static data area that is overwritten by each call to
  91 .Fn ptsname .
  92 .Pp
  93 Upon failure,
  94 .Fn ptsname
  95 returns
  96 .Dv NULL .
  97 This could occur if
  98 .Fa fildes
  99 is an invalid file descriptor or if the subsidiary device name does not exist
 100 in 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