vte_pty_new_sync ()

VtePty *
vte_pty_new_sync (VtePtyFlags flags,
                  GCancellable *cancellable,
                  GError **error);

Allocates a new pseudo-terminal.

You can later use fork() or the g_spawn_async() family of functions to start a process on the PTY.

If using fork(), you MUST call vte_pty_child_setup() in the child.

If using g_spawn_async() and friends, you MUST either use vte_pty_child_setup() directly as the child setup function, or call vte_pty_child_setup() from your own child setup function supplied.

When using vte_terminal_spawn_sync() with a custom child setup function, vte_pty_child_setup() will be called before the supplied function; you must not call it again.

Also, you MUST pass the G_SPAWN_DO_NOT_REAP_CHILD flag.

[constructor]

vte_pty_new_foreign_sync ()

VtePty *
vte_pty_new_foreign_sync (int fd,
                          GCancellable *cancellable,
                          GError **error);

Creates a new VtePty for the PTY master fd .

No entry will be made in the lastlog, utmp or wtmp system files.

Note that the newly created VtePty will take ownership of fd and close it on finalize.

[constructor]

vte_pty_child_setup ()

void
vte_pty_child_setup (VtePty *pty);

FIXMEchpe

vte_pty_get_fd ()

int
vte_pty_get_fd (VtePty *pty);

vte_pty_set_size ()

gboolean
vte_pty_set_size (VtePty *pty,
                  int rows,
                  int columns,
                  GError **error);

Attempts to resize the pseudo terminal's window size. If successful, the OS kernel will send SIGWINCH to the child process group.

If setting the window size failed, error will be set to a GIOError.

vte_pty_get_size ()

gboolean
vte_pty_get_size (VtePty *pty,
                  int *rows,
                  int *columns,
                  GError **error);

Reads the pseudo terminal's window size.

If getting the window size failed, error will be set to a GIOError.

vte_pty_set_utf8 ()

gboolean
vte_pty_set_utf8 (VtePty *pty,
                  gboolean utf8,
                  GError **error);

Tells the kernel whether the terminal is UTF-8 or not, in case it can make use of the info. Linux 2.6.5 or so defines IUTF8 to make the line discipline do multibyte backspace correctly.

vte_pty_spawn_async ()

void
vte_pty_spawn_async (VtePty *pty,
                     const char *working_directory,
                     char **argv,
                     char **envv,
                     GSpawnFlags spawn_flags,
                     GSpawnChildSetupFunc child_setup,
                     gpointer child_setup_data,
                     GDestroyNotify child_setup_data_destroy,
                     int timeout,
                     GCancellable *cancellable,
                     GAsyncReadyCallback callback,
                     gpointer user_data);

Starts the specified command under the pseudo-terminal pty . The argv and envv lists should be NULL-terminated. The "TERM" environment variable is automatically set to a default value, but can be overridden from envv . pty_flags controls logging the session to the specified system log files.

Note that G_SPAWN_DO_NOT_REAP_CHILD will always be added to spawn_flags .

Note that all open file descriptors will be closed in the child. If you want to keep some file descriptor open for use in the child process, you need to use a child setup function that unsets the FD_CLOEXEC flag on that file descriptor.

See vte_pty_new(), g_spawn_async() and vte_terminal_watch_child() for more information.

Since: 0.48

vte_pty_spawn_finish ()

gboolean
vte_pty_spawn_finish (VtePty *pty,
                      GAsyncResult *result,
                      GPid *child_pid,
                      GError **error);

Since: 0.48

vte_pty_close ()

void
vte_pty_close (VtePty *pty);

Since 0.42 this is a no-op.

enum VtePtyFlags

enum VtePtyError

VtePty

typedef struct _VtePty VtePty;

The “fd” property

  “fd”                       gint

The file descriptor of the PTY master.

Flags: Read / Write / Construct Only

Allowed values: >= -1

Default value: -1

The “flags” property

  “flags”                    VtePtyFlags

Flags.

Flags: Read / Write / Construct Only