man-pages/man3/getpt.3.html
2021-03-31 01:06:50 +01:00

140 lines
3.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of GETPT</TITLE>
</HEAD><BODY>
<H1>GETPT</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2020-02-09<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
getpt - open the pseudoterminal master (PTM)
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#define _GNU_SOURCE</B> /* See <A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A>(7) */
<B>#include &lt;<A HREF="file:///usr/include/stdlib.h">stdlib.h</A>&gt;</B>
<B>int getpt(void);</B>
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>getpt</B>()
opens a pseudoterminal master and returns its file descriptor.
It is equivalent to
<P>
open(&quot;/dev/ptmx&quot;, O_RDWR);
<P>
on Linux systems, though the pseudoterminal master is located
elsewhere on some systems that use GNU Libc.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
<B>getpt</B>()
returns an open file descriptor upon successful completion.
Otherwise, it
returns -1 and sets
<I>errno</I>
to indicate the error.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
<B>getpt</B>()
can fail with various errors described in
<B><A HREF="/cgi-bin/man/man2html?2+open">open</A></B>(2).
<A NAME="lbAG">&nbsp;</A>
<H2>VERSIONS</H2>
<B>getpt</B>()
is provided in glibc since version 2.1.
<A NAME="lbAH">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>getpt</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<A NAME="lbAI">&nbsp;</A>
<H2>CONFORMING TO</H2>
<B>getpt</B>()
is glibc-specific;
use
<B><A HREF="/cgi-bin/man/man2html?3+posix_openpt">posix_openpt</A></B>(3)
instead.
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+grantpt">grantpt</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+posix_openpt">posix_openpt</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+ptsname">ptsname</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+unlockpt">unlockpt</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?4+ptmx">ptmx</A></B>(4),
<B><A HREF="/cgi-bin/man/man2html?7+pty">pty</A></B>(7)
<A NAME="lbAK">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="4"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="5"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="6"><A HREF="#lbAG">VERSIONS</A><DD>
<DT id="7"><A HREF="#lbAH">ATTRIBUTES</A><DD>
<DT id="8"><A HREF="#lbAI">CONFORMING TO</A><DD>
<DT id="9"><A HREF="#lbAJ">SEE ALSO</A><DD>
<DT id="10"><A HREF="#lbAK">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:44 GMT, March 31, 2021
</BODY>
</HTML>