2004-12-17 12:53:02 +00:00
|
|
|
.\" Hey Emacs! This file is -*- nroff -*- source.
|
|
|
|
.\"
|
|
|
|
.\" Copyright (C) 2004 Michael Kerrisk
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-12-17 12:53:02 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-12-17 12:53:02 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
2010-10-04 02:46:56 +00:00
|
|
|
.TH POSIX_OPENPT 3 2010-10-04 "" "Linux Programmer's Manual"
|
2004-12-17 12:53:02 +00:00
|
|
|
.SH NAME
|
open.2, poll.2, select_tut.2, getpt.3, openpty.3, posix_openpt.3, ptsname.3, unlockpt.3, pts.4, tty_ioctl.4, proc.5, pty.7: spfix: s/psuedoterminal/psuedoterminal/g
Reported-by: Denis Barbier <bouzim@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-13 03:32:15 +00:00
|
|
|
posix_openpt \- open a pseudoterminal device
|
2004-12-17 12:53:02 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <stdlib.h>
|
|
|
|
.B #include <fcntl.h>
|
|
|
|
.sp
|
2006-11-30 05:30:15 +00:00
|
|
|
.BI "int posix_openpt(int " flags ");"
|
2004-12-17 12:53:02 +00:00
|
|
|
.fi
|
2007-07-08 12:11:40 +00:00
|
|
|
.sp
|
|
|
|
.in -4n
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
|
|
.BR feature_test_macros (7)):
|
|
|
|
.in
|
|
|
|
.sp
|
|
|
|
.ad l
|
|
|
|
.BR posix_openpt ():
|
2010-09-27 16:17:05 +00:00
|
|
|
_XOPEN_SOURCE\ >=\ 600
|
2007-07-08 12:11:40 +00:00
|
|
|
.ad b
|
2004-12-17 12:53:02 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
The
|
|
|
|
.BR posix_openpt ()
|
open.2, poll.2, select_tut.2, getpt.3, openpty.3, posix_openpt.3, ptsname.3, unlockpt.3, pts.4, tty_ioctl.4, proc.5, pty.7: spfix: s/psuedoterminal/psuedoterminal/g
Reported-by: Denis Barbier <bouzim@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-13 03:32:15 +00:00
|
|
|
function opens an unused pseudoterminal master device, returning a
|
2004-12-17 12:53:02 +00:00
|
|
|
file descriptor that can be used to refer to that device.
|
|
|
|
|
|
|
|
The
|
|
|
|
.I flags
|
|
|
|
argument is a bit mask that ORs together zero or more of
|
|
|
|
the following flags:
|
|
|
|
.TP
|
2005-04-18 13:35:29 +00:00
|
|
|
.B O_RDWR
|
2004-12-17 12:53:02 +00:00
|
|
|
Open the device for both reading and writing.
|
|
|
|
It is usual to specify this flag.
|
|
|
|
.TP
|
|
|
|
.B O_NOCTTY
|
|
|
|
Do not make this device the controlling terminal for the process.
|
|
|
|
.SH "RETURN VALUE"
|
|
|
|
On success,
|
2006-12-16 04:59:54 +00:00
|
|
|
.BR posix_openpt ()
|
_syscall.2, accept.2, epoll_create.2, inotify_add_watch.2, ioctl.2, msgget.2, msgop.2, open.2, prctl.2, sched_setscheduler.2, semctl.2, semget.2, swapon.2, addseverity.3, cacosh.3, csqrt.3, dirfd.3, drand48.3, fputws.3, mq_send.3, posix_openpt.3, puts.3, sched_getcpu.3, shm_open.3, sqrt.3, sysconf.3, tgamma.3, ulimit.3, credentials.7, svipc.7: Global fix: s/non-negative/nonnegative/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:44:48 +00:00
|
|
|
returns a nonnegative file descriptor which is the lowest
|
2004-12-17 12:53:02 +00:00
|
|
|
numbered unused descriptor.
|
2005-06-15 14:10:23 +00:00
|
|
|
On failure, \-1 is returned, and
|
2004-12-17 12:53:02 +00:00
|
|
|
.I errno
|
|
|
|
is set to indicate the error.
|
|
|
|
.SH ERRORS
|
|
|
|
See
|
|
|
|
.BR open (2).
|
2007-06-05 06:48:20 +00:00
|
|
|
.SH VERSIONS
|
|
|
|
Glibc support for
|
|
|
|
.BR posix_openpt ()
|
|
|
|
has been provided since version 2.2.1.
|
2004-12-17 12:53:02 +00:00
|
|
|
.SH "CONFORMING TO"
|
|
|
|
.BR posix_openpt ()
|
open.2, poll.2, select_tut.2, getpt.3, openpty.3, posix_openpt.3, ptsname.3, unlockpt.3, pts.4, tty_ioctl.4, proc.5, pty.7: spfix: s/psuedoterminal/psuedoterminal/g
Reported-by: Denis Barbier <bouzim@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-13 03:32:15 +00:00
|
|
|
is part of the UNIX 98 pseudoterminal support (see
|
2004-12-17 12:53:02 +00:00
|
|
|
.BR pts (4)).
|
2006-08-03 13:57:30 +00:00
|
|
|
This function is specified in POSIX.1-2001.
|
2004-12-17 12:53:02 +00:00
|
|
|
.SH NOTES
|
|
|
|
This function is a recent invention in POSIX.
|
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/
The man pages were rather inconsistent in the use of "Unix"
versus "UNIX". Let's go with the trademark usage.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
|
|
|
Some UNIX implementations that support System V
|
open.2, poll.2, select_tut.2, getpt.3, openpty.3, posix_openpt.3, ptsname.3, unlockpt.3, pts.4, tty_ioctl.4, proc.5, pty.7: spfix: s/psuedoterminal/psuedoterminal/g
Reported-by: Denis Barbier <bouzim@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-13 03:32:15 +00:00
|
|
|
(aka UNIX 98) pseudoterminals don't have this function, but it
|
2004-12-17 12:53:02 +00:00
|
|
|
is easy to implement:
|
2007-12-19 05:53:30 +00:00
|
|
|
.in +4n
|
2004-12-17 12:53:02 +00:00
|
|
|
.nf
|
|
|
|
|
|
|
|
int
|
|
|
|
posix_openpt(int flags)
|
|
|
|
{
|
|
|
|
return open("/dev/ptmx", flags);
|
|
|
|
}
|
|
|
|
.fi
|
2007-12-19 05:53:30 +00:00
|
|
|
.in
|
2004-12-17 12:53:02 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR open (2),
|
|
|
|
.BR getpt (3),
|
|
|
|
.BR grantpt (3),
|
|
|
|
.BR ptsname (3),
|
2007-06-02 05:53:40 +00:00
|
|
|
.BR unlockpt (3),
|
2005-10-10 13:14:12 +00:00
|
|
|
.BR pts (4),
|
|
|
|
.BR pty (7)
|