/usr/share/gtk-doc/html/vte-0.0/vte-Vte-PTY.html is in libvte-doc 1:0.28.2-5ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Vte PTY</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="VTE Reference Manual">
<link rel="up" href="ch02.html" title="">
<link rel="prev" href="ch02.html" title="">
<link rel="next" href="ch03.html" title="">
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch02.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">VTE Reference Manual</th>
<td><a accesskey="n" href="ch03.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#vte-Vte-PTY.synopsis" class="shortcut">Top</a>
|
<a href="#vte-Vte-PTY.description" class="shortcut">Description</a>
|
<a href="#vte-Vte-PTY.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#vte-Vte-PTY.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#vte-Vte-PTY.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="vte-Vte-PTY"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="vte-Vte-PTY.top_of_page"></a>Vte PTY</span></h2>
<p>Vte PTY — Functions for starting a new process on a new pseudo-terminal and for
manipulating pseudo-terminals</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="vte-Vte-PTY.synopsis"></a><h2>Synopsis</h2>
<a name="VtePty"></a><pre class="synopsis">enum <a class="link" href="vte-Vte-PTY.html#VtePtyFlags" title="enum VtePtyFlags">VtePtyFlags</a>;
enum <a class="link" href="vte-Vte-PTY.html#VtePtyError" title="enum VtePtyError">VtePtyError</a>;
<a class="link" href="vte-Vte-PTY.html#VtePty-struct" title="VtePty">VtePty</a>;
<a class="link" href="vte-Vte-PTY.html#VtePty"><span class="returnvalue">VtePty</span></a> * <a class="link" href="vte-Vte-PTY.html#vte-pty-new" title="vte_pty_new ()">vte_pty_new</a> (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePtyFlags" title="enum VtePtyFlags"><span class="type">VtePtyFlags</span></a> flags</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a class="link" href="vte-Vte-PTY.html#VtePty"><span class="returnvalue">VtePty</span></a> * <a class="link" href="vte-Vte-PTY.html#vte-pty-new-foreign" title="vte_pty_new_foreign ()">vte_pty_new_foreign</a> (<em class="parameter"><code><span class="type">int</span> fd</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="vte-Vte-PTY.html#vte-pty-close" title="vte_pty_close ()">vte_pty_close</a> (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> *pty</code></em>);
<span class="returnvalue">void</span> <a class="link" href="vte-Vte-PTY.html#vte-pty-child-setup" title="vte_pty_child_setup ()">vte_pty_child_setup</a> (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> *pty</code></em>);
<span class="returnvalue">int</span> <a class="link" href="vte-Vte-PTY.html#vte-pty-get-fd" title="vte_pty_get_fd ()">vte_pty_get_fd</a> (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> *pty</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="vte-Vte-PTY.html#vte-pty-set-size" title="vte_pty_set_size ()">vte_pty_set_size</a> (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> *pty</code></em>,
<em class="parameter"><code><span class="type">int</span> rows</code></em>,
<em class="parameter"><code><span class="type">int</span> columns</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="vte-Vte-PTY.html#vte-pty-get-size" title="vte_pty_get_size ()">vte_pty_get_size</a> (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> *pty</code></em>,
<em class="parameter"><code><span class="type">int</span> *rows</code></em>,
<em class="parameter"><code><span class="type">int</span> *columns</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="vte-Vte-PTY.html#vte-pty-set-term" title="vte_pty_set_term ()">vte_pty_set_term</a> (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> *pty</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *emulation</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="vte-Vte-PTY.html#vte-pty-set-utf8" title="vte_pty_set_utf8 ()">vte_pty_set_utf8</a> (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> *pty</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> utf8</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="vte-Vte-PTY.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----VtePty
</pre>
</div>
<div class="refsect1">
<a name="vte-Vte-PTY.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
VtePty implements
<a href="http://library.gnome.org/devel/gio/unstable/GInitable.html">GInitable</a>.</p>
</div>
<div class="refsect1">
<a name="vte-Vte-PTY.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="vte-Vte-PTY.html#VtePty--fd" title='The "fd" property'>fd</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct Only
"<a class="link" href="vte-Vte-PTY.html#VtePty--flags" title='The "flags" property'>flags</a>" <a class="link" href="vte-Vte-PTY.html#VtePtyFlags" title="enum VtePtyFlags"><span class="type">VtePtyFlags</span></a> : Read / Write / Construct Only
"<a class="link" href="vte-Vte-PTY.html#VtePty--term" title='The "term" property'>term</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="vte-Vte-PTY.description"></a><h2>Description</h2>
<p>
The terminal widget uses these functions to start commands with new controlling
pseudo-terminals and to resize pseudo-terminals.
</p>
</div>
<div class="refsect1">
<a name="vte-Vte-PTY.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="VtePtyFlags"></a><h3>enum VtePtyFlags</h3>
<pre class="programlisting">typedef enum {
VTE_PTY_NO_LASTLOG = 1 << 0,
VTE_PTY_NO_UTMP = 1 << 1,
VTE_PTY_NO_WTMP = 1 << 2,
VTE_PTY_NO_HELPER = 1 << 3,
VTE_PTY_NO_FALLBACK = 1 << 4,
VTE_PTY_DEFAULT = 0
} VtePtyFlags;
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="VTE-PTY-NO-LASTLOG:CAPS"></a><span class="term"><code class="literal">VTE_PTY_NO_LASTLOG</code></span></p></td>
<td>don't record the session in lastlog
</td>
</tr>
<tr>
<td><p><a name="VTE-PTY-NO-UTMP:CAPS"></a><span class="term"><code class="literal">VTE_PTY_NO_UTMP</code></span></p></td>
<td>don't record the session in utmp
</td>
</tr>
<tr>
<td><p><a name="VTE-PTY-NO-WTMP:CAPS"></a><span class="term"><code class="literal">VTE_PTY_NO_WTMP</code></span></p></td>
<td>don't record the session in wtmp
</td>
</tr>
<tr>
<td><p><a name="VTE-PTY-NO-HELPER:CAPS"></a><span class="term"><code class="literal">VTE_PTY_NO_HELPER</code></span></p></td>
<td>don't use the GNOME PTY helper to allocate the PTY
</td>
</tr>
<tr>
<td><p><a name="VTE-PTY-NO-FALLBACK:CAPS"></a><span class="term"><code class="literal">VTE_PTY_NO_FALLBACK</code></span></p></td>
<td>when allocating the PTY with the PTY helper fails,
don't fall back to try using PTY98
</td>
</tr>
<tr>
<td><p><a name="VTE-PTY-DEFAULT:CAPS"></a><span class="term"><code class="literal">VTE_PTY_DEFAULT</code></span></p></td>
<td>the default flags
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.26</p>
</div>
<hr>
<div class="refsect2">
<a name="VtePtyError"></a><h3>enum VtePtyError</h3>
<pre class="programlisting">typedef enum {
VTE_PTY_ERROR_PTY_HELPER_FAILED = 0,
VTE_PTY_ERROR_PTY98_FAILED
} VtePtyError;
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="VTE-PTY-ERROR-PTY-HELPER-FAILED:CAPS"></a><span class="term"><code class="literal">VTE_PTY_ERROR_PTY_HELPER_FAILED</code></span></p></td>
<td>failure when using the GNOME PTY helper to
allocate the PTY
</td>
</tr>
<tr>
<td><p><a name="VTE-PTY-ERROR-PTY98-FAILED:CAPS"></a><span class="term"><code class="literal">VTE_PTY_ERROR_PTY98_FAILED</code></span></p></td>
<td>failure when using PTY98 to allocate the PTY
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.26</p>
</div>
<hr>
<div class="refsect2">
<a name="VtePty-struct"></a><h3>VtePty</h3>
<pre class="programlisting">typedef struct _VtePty VtePty;</pre>
<p class="since">Since 0.26</p>
</div>
<hr>
<div class="refsect2">
<a name="vte-pty-new"></a><h3>vte_pty_new ()</h3>
<pre class="programlisting"><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="returnvalue">VtePty</span></a> * vte_pty_new (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePtyFlags" title="enum VtePtyFlags"><span class="type">VtePtyFlags</span></a> flags</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Allocates a new pseudo-terminal.
</p>
<p>
You can later use <code class="function">fork()</code> or the <a href="http://library.gnome.org/devel/glib/unstable/glib-Spawning-Processes.html#g-spawn-async"><code class="function">g_spawn_async()</code></a> family of functions
to start a process on the PTY.
</p>
<p>
If using <code class="function">fork()</code>, you MUST call <a class="link" href="vte-Vte-PTY.html#vte-pty-child-setup" title="vte_pty_child_setup ()"><code class="function">vte_pty_child_setup()</code></a> in the child.
</p>
<p>
If using <a href="http://library.gnome.org/devel/glib/unstable/glib-Spawning-Processes.html#g-spawn-async"><code class="function">g_spawn_async()</code></a> and friends, you MUST either use
<a class="link" href="vte-Vte-PTY.html#vte-pty-child-setup" title="vte_pty_child_setup ()"><code class="function">vte_pty_child_setup()</code></a> directly as the child setup function, or call
<a class="link" href="vte-Vte-PTY.html#vte-pty-child-setup" title="vte_pty_child_setup ()"><code class="function">vte_pty_child_setup()</code></a> from your own child setup function supplied.
Also, you MUST pass the <a href="http://library.gnome.org/devel/glib/unstable/glib-Spawning-Processes.html#G-SPAWN-DO-NOT-REAP-CHILD:CAPS"><code class="literal">G_SPAWN_DO_NOT_REAP_CHILD</code></a> flag.
</p>
<p>
If GNOME PTY Helper is available and
unless some of the <a class="link" href="vte-Vte-PTY.html#VTE-PTY-NO-LASTLOG:CAPS"><code class="literal">VTE_PTY_NO_LASTLOG</code></a>, <a class="link" href="vte-Vte-PTY.html#VTE-PTY-NO-UTMP:CAPS"><code class="literal">VTE_PTY_NO_UTMP</code></a> or
<a class="link" href="vte-Vte-PTY.html#VTE-PTY-NO-WTMP:CAPS"><code class="literal">VTE_PTY_NO_WTMP</code></a> flags are passed in <em class="parameter"><code>flags</code></em>, the
session is logged in the corresponding lastlog, utmp or wtmp
system files. When passing <a class="link" href="vte-Vte-PTY.html#VTE-PTY-NO-HELPER:CAPS"><code class="literal">VTE_PTY_NO_HELPER</code></a> in <em class="parameter"><code>flags</code></em>, the
GNOME PTY Helper is bypassed entirely.
</p>
<p>
When passing <a class="link" href="vte-Vte-PTY.html#VTE-PTY-NO-FALLBACK:CAPS"><code class="literal">VTE_PTY_NO_FALLBACK</code></a> in <em class="parameter"><code>flags</code></em>,
and opening a PTY using the PTY helper fails, there will
be no fallback to allocate a PTY using Unix98 PTY functions.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>flags from <a class="link" href="vte-Vte-PTY.html#VtePtyFlags" title="enum VtePtyFlags"><span class="type">VtePtyFlags</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error with <em class="parameter"><code>error</code></em> filled in. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.26</p>
</div>
<hr>
<div class="refsect2">
<a name="vte-pty-new-foreign"></a><h3>vte_pty_new_foreign ()</h3>
<pre class="programlisting"><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="returnvalue">VtePty</span></a> * vte_pty_new_foreign (<em class="parameter"><code><span class="type">int</span> fd</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Creates a new <a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> for the PTY master <em class="parameter"><code>fd</code></em>.
</p>
<p>
No entry will be made in the lastlog, utmp or wtmp system files.
</p>
<p>
Note that the newly created <a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> will take ownership of <em class="parameter"><code>fd</code></em>
and close it on finalize.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
<td> a file descriptor to the PTY. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> for <em class="parameter"><code>fd</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error with <em class="parameter"><code>error</code></em> filled in. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.26</p>
</div>
<hr>
<div class="refsect2">
<a name="vte-pty-close"></a><h3>vte_pty_close ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> vte_pty_close (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> *pty</code></em>);</pre>
<p>
Cleans up the PTY, specifically any logging performed for the session.
The file descriptor to the PTY master remains open.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>pty</code></em> :</span></p></td>
<td>a <a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.26</p>
</div>
<hr>
<div class="refsect2">
<a name="vte-pty-child-setup"></a><h3>vte_pty_child_setup ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> vte_pty_child_setup (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> *pty</code></em>);</pre>
<p>
FIXMEchpe
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>pty</code></em> :</span></p></td>
<td>a <a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.26</p>
</div>
<hr>
<div class="refsect2">
<a name="vte-pty-get-fd"></a><h3>vte_pty_get_fd ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> vte_pty_get_fd (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> *pty</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pty</code></em> :</span></p></td>
<td>a <a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the file descriptor of the PTY master in <em class="parameter"><code>pty</code></em>. The
file descriptor belongs to <em class="parameter"><code>pty</code></em> and must not be closed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="vte-pty-set-size"></a><h3>vte_pty_set_size ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> vte_pty_set_size (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> *pty</code></em>,
<em class="parameter"><code><span class="type">int</span> rows</code></em>,
<em class="parameter"><code><span class="type">int</span> columns</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Attempts to resize the pseudo terminal's window size. If successful, the
OS kernel will send <span class="type">SIGWINCH</span> to the child process group.
</p>
<p>
If setting the window size failed, <em class="parameter"><code>error</code></em> will be set to a <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOError"><span class="type">GIOError</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pty</code></em> :</span></p></td>
<td>a <a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rows</code></em> :</span></p></td>
<td>the desired number of rows
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>columns</code></em> :</span></p></td>
<td>the desired number of columns
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>(allow-none); return location to store a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure with <em class="parameter"><code>error</code></em> filled in
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.26</p>
</div>
<hr>
<div class="refsect2">
<a name="vte-pty-get-size"></a><h3>vte_pty_get_size ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> vte_pty_get_size (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> *pty</code></em>,
<em class="parameter"><code><span class="type">int</span> *rows</code></em>,
<em class="parameter"><code><span class="type">int</span> *columns</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Reads the pseudo terminal's window size.
</p>
<p>
If getting the window size failed, <em class="parameter"><code>error</code></em> will be set to a <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOError"><span class="type">GIOError</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pty</code></em> :</span></p></td>
<td>a <a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rows</code></em> :</span></p></td>
<td> a location to store the number of rows, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>columns</code></em> :</span></p></td>
<td> a location to store the number of columns, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location to store a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure with <em class="parameter"><code>error</code></em> filled in
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.26</p>
</div>
<hr>
<div class="refsect2">
<a name="vte-pty-set-term"></a><h3>vte_pty_set_term ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> vte_pty_set_term (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> *pty</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *emulation</code></em>);</pre>
<p>
Sets what value of the TERM environment variable to set just after forking.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pty</code></em> :</span></p></td>
<td>a <a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>emulation</code></em> :</span></p></td>
<td> the name of a terminal description, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.26</p>
</div>
<hr>
<div class="refsect2">
<a name="vte-pty-set-utf8"></a><h3>vte_pty_set_utf8 ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> vte_pty_set_utf8 (<em class="parameter"><code><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a> *pty</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> utf8</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pty</code></em> :</span></p></td>
<td>a <a class="link" href="vte-Vte-PTY.html#VtePty"><span class="type">VtePty</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>utf8</code></em> :</span></p></td>
<td>whether or not the pty is in UTF-8 mode
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> return location to store a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure with <em class="parameter"><code>error</code></em> filled in
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.26</p>
</div>
</div>
<div class="refsect1">
<a name="vte-Vte-PTY.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="VtePty--fd"></a><h3>The <code class="literal">"fd"</code> property</h3>
<pre class="programlisting"> "fd" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct Only</pre>
<p>
The file descriptor of the PTY master.
</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
<p class="since">Since 0.26</p>
</div>
<hr>
<div class="refsect2">
<a name="VtePty--flags"></a><h3>The <code class="literal">"flags"</code> property</h3>
<pre class="programlisting"> "flags" <a class="link" href="vte-Vte-PTY.html#VtePtyFlags" title="enum VtePtyFlags"><span class="type">VtePtyFlags</span></a> : Read / Write / Construct Only</pre>
<p>
Controls how the session is recorded in lastlog, utmp, and wtmp,
and whether to use the GNOME PTY helper.
</p>
<p class="since">Since 0.26</p>
</div>
<hr>
<div class="refsect2">
<a name="VtePty--term"></a><h3>The <code class="literal">"term"</code> property</h3>
<pre class="programlisting"> "term" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>
The value to set for the TERM environment variable just after
forking.
</p>
<p>Default value: "xterm"</p>
<p class="since">Since 0.26</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15.1</div>
</body>
</html>
|