Skip to content

Commit

Permalink
Base: Add man page for posix_openpt(3)
Browse files Browse the repository at this point in the history
  • Loading branch information
awesomekling committed Feb 7, 2020
1 parent d217d3f commit d34ad44
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions Base/usr/share/man/man3/posix_openpt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## Name

posix\_openpt - open a pseudo-terminal device

## Synopsis

```**c++
#include <stdlib.h>
#include <fcntl.h>
int posix_openpt(int flags);
```

## Description

Open a pseudo-terminal master using the given *flags*.

The *flags* argument accepts a bitmask of the following flags:

* `O_RDWR`: Open for both reading and writing.
* `O_NOCTTY`: The opened pseudo-terminal will not be made the controlling TTY for the process.
* `O_CLOEXEC`: The opened fd shall be closed on [`exec`(2)](../man2/exec.md).

## Return value

On success, a pseudo-terminal device is allocated and `posix_openpt()` returns a file descriptor for it. Otherwise, it returns -1 and sets `errno` to describe the error.

## Errors

Returns the same errors as [`open`(2)](../man2/open.md).

## See also

* [`open`(2)](../man2/open.md)

0 comments on commit d34ad44

Please sign in to comment.