lib/libc/stdlib/posix_openpt.3

   1 .\" $NetBSD: posix_openpt.3,v 1.6 2011/05/05 07:36:44 wiz 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 POSIX_OPENPT 3
  32 .Os
  33 .Sh NAME
  34 .Nm posix_openpt
  35 .Nd open a pseudo-terminal device
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In stdlib.h
  40 .In fcntl.h
  41 .Ft int
  42 .Fn posix_openpt "int oflag"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn posix_openpt
  46 function searches for an unused master pseudo-terminal device,
  47 opens it, and returns a file descriptor associated with the now
  48 used pseudo-terminal device.
  49 The
  50 .Fa oflag
  51 argument has the same meaning as in the
  52 .Xr open 2
  53 call.
  54 .Sh RETURN VALUES
  55 If successful,
  56 .Fn posix_openpt
  57 returns a non-negative integer, which corresponds to a file descriptor
  58 pointing to the master pseudo-terminal device.
  59 Otherwise, a value of \-1 is returned and
  60 .Va errno
  61 is set to indicate the error.
  62 .Sh SEE ALSO
  63 .Xr ioctl 2 ,
  64 .Xr open 2 ,
  65 .Xr grantpt 3 ,
  66 .Xr ptsname 3 ,
  67 .Xr unlockpt 3
  68 .Sh RATIONALE
  69 The standards committee did not want to directly expose the cloning device,
  70 thus decided to wrap the functionality in this function.
  71 The equivalent code would be:
  72 .Bd -literal
  73         int
  74         posix_openpt(int oflag) {
  75                 return open("/dev/ptmx", oflag);
  76         }
  77 .Ed
  78 .Sh STANDARDS
  79 The
  80 .Fn posix_openpt
  81 function conforms to
  82 .St -p1003.1-2001 .