libvtemm Reference Documentation
Main Page   Namespaces  

Gnome::Vte::Pty Namespace Reference


Functions

void _close (int pty)
 Close a pty.
int _get_size (int master, int& columns, int& rows)
 Read the size of a terminal.
int _open (Glib::Pid& child, const Glib::StringArrayHandle& env_add, const std::string& command, const Glib::StringArrayHandle& argv, const std::string& directory, int columns, int rows, bool lastlog, bool utmp, bool wtmp)
 Start up the given binary (exact path, not interpreted at all) in a pseudo-terminal of its own, returning the descriptor for the master side of the PTY pair, logging the session to the specified files, and storing the child's PID in the given argument.
int _set_size (int master, int columns, int rows)
 Set the size of a terminal.
void _set_utf8 (int pty, bool utf8)
 Try to let the kernel know that the terminal is or is not UTF-8.

Function Documentation

void Gnome::Vte::Pty::_close ( int  pty  ) 

Close a pty.

Parameters:
pty Descriptor for the master side of the PTY pair.

int Gnome::Vte::Pty::_get_size ( int  master,
int &  columns,
int &  rows 
)

Read the size of a terminal.

Parameters:
master Descriptor for the master side of the PTY pair.
columns Stored number of columns.
rows Stored number of rows.
Returns:
Returns 0 on success, -1 on failure, with errno set to defined return codes from ioctl().

int Gnome::Vte::Pty::_open ( Glib::Pid child,
const Glib::StringArrayHandle env_add,
const std::string &  command,
const Glib::StringArrayHandle argv,
const std::string &  directory,
int  columns,
int  rows,
bool  lastlog,
bool  utmp,
bool  wtmp 
)

Start up the given binary (exact path, not interpreted at all) in a pseudo-terminal of its own, returning the descriptor for the master side of the PTY pair, logging the session to the specified files, and storing the child's PID in the given argument.

Parameters:
child Stored child's PID.
env_add Empty string terminated list of environment variables to be added before executing a command.
command Command to be executed (not interpreted at all).
argv Empty string terminated list of arguments given to executed binary (argv[0] should be a binary name)
directory Path where command have to be executed
columns Number of columns of pty.
rows Number of rows of pty.
lastlog TRUE if the session should be logged to the lastlog
utmp TRUE if the session should be logged to the utmp/utmpx log
wtmp TRUE if the session should be logged to the wtmp/wtmpx log
Returns:
Descriptor for the master side of the PTY pair.

int Gnome::Vte::Pty::_set_size ( int  master,
int  columns,
int  rows 
)

Set the size of a terminal.

Parameters:
master Descriptor for the master side of the PTY pair.
columns Number of columns to set.
rows Number of rows to set.
Returns:
Returns 0 on success, -1 on failure, with errno set to defined return codes from ioctl().

void Gnome::Vte::Pty::_set_utf8 ( int  pty,
bool  utf8 
)

Try to let the kernel know that the terminal is or is not UTF-8.

Parameters:
pty Descriptor for the master side of the PTY pair.
utf8 TRUE if the terminal is UTF-8.


Generated for libvtemm by Doxygen 1.5.8 © 1997-2008