package eio

  1. Overview
  2. Docs
Effect-based direct-style IO API for OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (22)

Authors

  1. A
    Anil Madhavapeddy
  2. T
    Thomas Leonard

Maintainers

  1. A
    anil@recoil.org

Sources

eio-1.6.tbz
sha256=c1f04986b401094176494863dde1ca9b292b59fdc679a9d7023e558d80fb5b15
sha512=92ed8cf20300b8a4e0141bdbc373c0803c5a24530cb65852637d905fff4a5b956a8859a00a424034ff78c1112da9b0391194bcd558326168bdebd1ce683a8890

doc/eio.unix/Eio_unix/Pty/index.html

Module Eio_unix.PtySource

Creating and controlling pseudoterminals.

Pseudoterminal (PTY) support.

A pseudoterminal is a pair of connected file descriptors emulating a terminal. The pseudoterminal device is used by a controlling program such as a terminal emulator, while the terminal device is used by a child process as its controlling terminal.

  • since 1.4
Sourcetype t

A connected pseudoterminal pair.

Sourceval open_pty : sw:Eio.Std.Switch.t -> unit -> t

open_pty ~sw () allocates a new pseudoterminal pair.

Both file descriptors are closed when sw finishes. The pty end is non-blocking; the tty end is blocking and so suitable as the child's controlling terminal.

Not a multi-domain-safe function on some platforms without reentrant ptsname support.

Sourceval pty : t -> Fd.t

pty t is the pseudoterminal-device end.

Sourceval tty : t -> Fd.t

tty t is the terminal-device end.

Sourceval name : t -> string

name t is the path of the terminal device.

source t reads the output the child writes to terminal.

sink t writes input for the child to read from its terminal.

Sourcetype winsize = {
  1. rows : int;
    (*

    Height of the terminal in character rows.

    *)
  2. cols : int;
    (*

    Width of the terminal in character columns.

    *)
  3. xpixel : int;
    (*

    Width in pixels (0 if unknown).

    *)
  4. ypixel : int;
    (*

    Height in pixels (0 if unknown).

    *)
}

Terminal window dimensions.

Sourceval get_window_size : Fd.t -> winsize

get_window_size fd returns the window size of terminal fd.

Sourceval set_window_size : Fd.t -> winsize -> unit

set_window_size fd ws sets the window size of terminal fd.

Setting it on the pty end updates the terminal and delivers SIGWINCH to the foreground process group attached to the terminal.

Sourcemodule Tc : sig ... end

Terminal attributes control. These raise Unix.Unix_error if fd is not a terminal.