← Back to branch summary

~ubuntu-branches/ubuntu/precise/vte/precise

« back to all changes in this revision

Viewing changes to doc/reference/html/vte-Vte-PTY.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Vogt
  • Date: 2011-06-16 17:59:49 UTC
  • mfrom: (1.1.65 upstream) (3.1.14 sid)
  • Revision ID: james.westby@ubuntu.com-20110616175949-dexr6gu2dxiifi00
Tags: 1:0.28.1-1ubuntu1
* Merge from debian unstable.  Remaining changes:
  - Add 93_add_alt_screen_scroll_toggle.patch: Handle scrolling differently
    when using alternate screen or scrolling is restricted.
  - Add lp246701_scroll_region_updates.patch: Bug fix. (LP #246701)
  - 91_keep_fds.patch:
    vte-2.90 does not yet support G_SPAWN_LEAVE_DESCRIPTORS_OPEN
    when calling vte_terminal_fork_command_full() until that is
    fixed we need to keep this patch

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/vte-Vte-PTY.html
47
47
<a name="VtePty"></a><pre class="synopsis">enum                <a class="link" href="vte-Vte-PTY.html#VtePtyFlags" title="enum VtePtyFlags">VtePtyFlags</a>;
48
48
enum                <a class="link" href="vte-Vte-PTY.html#VtePtyError" title="enum VtePtyError">VtePtyError</a>;
49
49
                    <a class="link" href="vte-Vte-PTY.html#VtePty-struct" title="VtePty">VtePty</a>;
50
 
<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>,
 
50
<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-sync" title="vte_pty_new_sync ()">vte_pty_new_sync</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>,
 
51
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
51
52
                                                         <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>);
52
 
<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>,
 
53
<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-sync" title="vte_pty_new_foreign_sync ()">vte_pty_new_foreign_sync</a>            (<em class="parameter"><code><span class="type">int</span> fd</code></em>,
 
54
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
53
55
                                                         <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>);
54
56
<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>);
55
57
<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>);
182
184
</div>
183
185
<hr>
184
186
<div class="refsect2">
185
 
<a name="vte-pty-new"></a><h3>vte_pty_new ()</h3>
186
 
<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>,
 
187
<a name="vte-pty-new-sync"></a><h3>vte_pty_new_sync ()</h3>
 
188
<pre class="programlisting"><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="returnvalue">VtePty</span></a> *            vte_pty_new_sync                    (<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>,
 
189
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
187
190
                                                         <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>
188
191
<p>
189
192
Allocates a new pseudo-terminal.
190
193
</p>
191
194
<p>
192
 
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> familty of functions
 
195
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
193
196
to start a process on the PTY.
194
197
</p>
195
198
<p>
199
202
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
200
203
<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
201
204
<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.
202
 
</p>
203
 
<p>
204
205
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.
205
206
</p>
206
207
<p>
207
 
When using the GNOME PTY Helper,
 
208
If GNOME PTY Helper is available and
208
209
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
209
210
<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
210
211
session is logged in the corresponding lastlog, utmp or wtmp
211
 
system files.
212
 
</p>
213
 
<p>
214
 
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
215
 
GNOME PTY Helper bypassed entirely.
 
212
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
 
213
GNOME PTY Helper is bypassed entirely.
216
214
</p>
217
215
<p>
218
216
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>,
228
226
</td>
229
227
</tr>
230
228
<tr>
 
229
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
230
<td> a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</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>
 
231
</td>
 
232
</tr>
 
233
<tr>
231
234
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
232
235
<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>
233
236
</td>
243
246
</div>
244
247
<hr>
245
248
<div class="refsect2">
246
 
<a name="vte-pty-new-foreign"></a><h3>vte_pty_new_foreign ()</h3>
247
 
<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>,
 
249
<a name="vte-pty-new-foreign-sync"></a><h3>vte_pty_new_foreign_sync ()</h3>
 
250
<pre class="programlisting"><a class="link" href="vte-Vte-PTY.html#VtePty"><span class="returnvalue">VtePty</span></a> *            vte_pty_new_foreign_sync            (<em class="parameter"><code><span class="type">int</span> fd</code></em>,
 
251
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
248
252
                                                         <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>
249
253
<p>
250
254
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>.
265
269
</td>
266
270
</tr>
267
271
<tr>
 
272
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
273
<td> a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</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>
 
274
</td>
 
275
</tr>
 
276
<tr>
268
277
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
269
278
<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>
270
279
</td>