lib/libc/stdlib/ptsname.3

   1 .\" $NetBSD: ptsname.3,v 1.5 2008/04/30 13:10:51 martin Exp $
   2 .\"
   3 .\" Copyright (c) 2004 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Christos Zoulas.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd May 25, 2004
  31 .Dt PTSNAME 3
  32 .Os
  33 .Sh NAME
  34 .Nm ptsname
  35 .Nd get the pathname of the slave pseudo-terminal device
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In stdlib.h
  40 .Ft char *
  41 .Fn ptsname "int masterfd"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn ptsname
  45 function returns the pathname of the slave pseudo-terminal device
  46 that corresponds to the master pseudo-terminal device associated with
  47 .Fa masterfd .
  48 The
  49 .Fn ptsname
  50 function is not reentrant or thread-safe.
  51 .Sh RETURN VALUES
  52 If successful,
  53 .Fn ptsname
  54 returns a pointer to a nul-terminated string containing the pathname
  55 of the slave pseudo-terminal device.
  56 If an error occurs
  57 .Fn ptsname
  58 will return
  59 .Dv NULL
  60 and
  61 .Va errno
  62 is set to indicate the error.
  63 .Sh ERRORS
  64 The
  65 .Fn ptsname
  66 function will fail if:
  67 .Bl -tag -width Er
  68 .It Bq Er EACCESS
  69 the corresponding pseudo-terminal device could not be accessed.
  70 .It Bq Er EBADF
  71 .Fa masterfd
  72 is not a valid descriptor.
  73 .It Bq Er EINVAL
  74 .Fa masterfd
  75 is not associated with a master pseudo-terminal device.
  76 .El
  77 .Sh NOTES
  78 The error returns of
  79 .Fn ptsname
  80 are a
  81 .Nx
  82 extension.
  83 The
  84 .Fn ptsname
  85 function is equivalent to:
  86 .Bd -literal
  87         struct ptmget pm;
  88         return ioctl(masterfd, TIOCPTSNAME, \*[Am]pm) == -1 ? NULL : pm.ps;
  89 .Ed
  90 .Sh SEE ALSO
  91 .Xr ioctl 2 ,
  92 .Xr grantpt 3 ,
  93 .Xr posix_openpt 3 ,
  94 .Xr unlockpt 3
  95 .Sh STANDARDS
  96 The
  97 .Fn ptsname
  98 function conforms to
  99 .St -p1003.1-2001 .
 100 Its first release was in
 101 .St -xpg4.2 .