Top | ![]() |
![]() |
![]() |
![]() |
Vte PTYVte PTY — Functions for starting a new process on a new pseudo-terminal and for manipulating pseudo-terminals |
VtePty * | vte_pty_new_sync () |
VtePty * | vte_pty_new_foreign_sync () |
void | vte_pty_child_setup () |
int | vte_pty_get_fd () |
gboolean | vte_pty_set_size () |
gboolean | vte_pty_get_size () |
gboolean | vte_pty_set_utf8 () |
void | vte_pty_close () |
The terminal widget uses these functions to start commands with new controlling pseudo-terminals and to resize pseudo-terminals.
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.
flags |
flags from VtePtyFlags |
|
cancellable |
a GCancellable, or |
[allow-none] |
error |
return location for a GError, or |
[allow-none] |
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.
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.
pty |
a VtePty |
|
rows |
the desired number of rows |
|
columns |
the desired number of columns |
|
error |
return location to store a GError, or |
[allow-none] |
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.
pty |
a VtePty |
|
rows |
a location to store the number of rows, or |
[out][allow-none] |
columns |
a location to store the number of columns, or |
[out][allow-none] |
error |
return location to store a GError, or |
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.
pty |
a VtePty |
|
utf8 |
whether or not the pty is in UTF-8 mode |
|
error |
return location to store a GError, or |
[allow-none] |