← Back to branch summary

~ubuntu-branches/ubuntu/feisty/libgnome/feisty

« back to all changes in this revision

Viewing changes to doc/reference/html/libgnome-gnome-exec.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-01-09 10:07:49 UTC
  • mfrom: (1.1.12 upstream)
  • Revision ID: james.westby@ubuntu.com-20070109100749-uc3lve73086th31g
Tags: 2.17.2-0ubuntu1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/libgnome-gnome-exec.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gnome-exec</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
7
7
<link rel="start" href="index.html" title="GNOME Library Reference Manual">
8
8
<link rel="up" href="ch01.html" title="Initializing Applications and Starting Programs">
9
9
<link rel="prev" href="libgnome-gnome-init.html" title="gnome-init">
37
37
<th width="100%" align="center">GNOME Library Reference Manual</th>
38
38
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
39
39
</tr>
40
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2730813" class="shortcut">Top</a>
 
40
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2532533" class="shortcut">Top</a>
41
41
                  &#160;|&#160;
42
 
                  <a href="#id2732400" class="shortcut">Description</a></nobr></td></tr>
 
42
                  <a href="#id2533982" class="shortcut">Description</a></nobr></td></tr>
43
43
</table>
44
44
<div class="refentry" lang="en">
45
45
<a name="libgnome-gnome-exec"></a><div class="titlepage"></div>
46
46
<div class="refnamediv"><table width="100%"><tr>
47
47
<td valign="top">
48
48
<h2>
49
 
<a name="id2730813"></a><span class="refentrytitle">gnome-exec</span>
 
49
<a name="id2532533"></a><span class="refentrytitle">gnome-exec</span>
50
50
</h2>
51
51
<p>gnome-exec &#8212; Execution of programs from within GNOME applications.</p>
52
52
</td>
85
85
</pre>
86
86
</div>
87
87
<div class="refsect1" lang="en">
88
 
<a name="id2732400"></a><h2>Description</h2>
 
88
<a name="id2533982"></a><h2>Description</h2>
89
89
<p>
90
90
The gnome-execute family of functions are provided to simplify execution of
91
91
programs from withing GNOME applications.  These routines are required to avoid
98
98
</p>
99
99
</div>
100
100
<div class="refsect1" lang="en">
101
 
<a name="id2732425"></a><h2>Details</h2>
 
101
<a name="id2534007"></a><h2>Details</h2>
102
102
<div class="refsect2" lang="en">
103
 
<a name="id2732435"></a><h3>
 
103
<a name="id2534017"></a><h3>
104
104
<a name="gnome-execute-async"></a>gnome_execute_async ()</h3>
105
 
<a class="indexterm" name="id2732448"></a><pre class="programlisting">int         gnome_execute_async             (const char *dir,
 
105
<a class="indexterm" name="id2534030"></a><pre class="programlisting">int         gnome_execute_async             (const char *dir,
106
106
                                             int argc);</pre>
107
107
<p>
108
108
Like <a href="libgnome-gnome-exec.html#gnome-execute-async-with-env"><code class="function">gnome_execute_async_with_env()</code></a>, but doesn't add anything
114
114
<col align="left" valign="top">
115
115
<tbody>
116
116
<tr>
117
 
<td><span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
118
 
<td> Directory in which child should be executesd, or <a
119
 
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
120
 
><code class="literal">NULL</code></a> for current
 
117
<td>
 
118
<span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
 
119
<td> Directory in which child should be executesd, or <code class="literal">NULL</code> for current
121
120
      directory
122
121
</td>
123
122
</tr>
124
123
<tr>
125
 
<td><span class="term"><em class="parameter"><code>argc</code></em>&#160;:</span></td>
 
124
<td>
 
125
<span class="term"><em class="parameter"><code>argc</code></em>&#160;:</span></td>
126
126
<td> Number of arguments
127
127
</td>
128
128
</tr>
129
129
<tr>
130
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
130
<td>
 
131
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
131
132
<td> process id of child, or <code class="literal">-1</code> on error.
132
133
</td>
133
134
</tr>
136
137
</div>
137
138
<hr>
138
139
<div class="refsect2" lang="en">
139
 
<a name="id2732563"></a><h3>
 
140
<a name="id2534145"></a><h3>
140
141
<a name="gnome-execute-async-fds"></a>gnome_execute_async_fds ()</h3>
141
 
<a class="indexterm" name="id2732576"></a><pre class="programlisting">int         gnome_execute_async_fds         (const char *dir,
 
142
<a class="indexterm" name="id2534158"></a><pre class="programlisting">int         gnome_execute_async_fds         (const char *dir,
142
143
                                             int argc);</pre>
143
144
<p>
144
145
Like <a href="libgnome-gnome-exec.html#gnome-execute-async-with-env-fds"><code class="function">gnome_execute_async_with_env_fds()</code></a>, but doesn't add
150
151
<col align="left" valign="top">
151
152
<tbody>
152
153
<tr>
153
 
<td><span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
154
 
<td> Directory in which child should be executed, or <a
155
 
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
156
 
><code class="literal">NULL</code></a> for current
 
154
<td>
 
155
<span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
 
156
<td> Directory in which child should be executed, or <code class="literal">NULL</code> for current
157
157
      directory
158
158
</td>
159
159
</tr>
160
160
<tr>
161
 
<td><span class="term"><em class="parameter"><code>argc</code></em>&#160;:</span></td>
 
161
<td>
 
162
<span class="term"><em class="parameter"><code>argc</code></em>&#160;:</span></td>
162
163
<td> Number of arguments
163
164
</td>
164
165
</tr>
165
166
<tr>
166
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
167
<td>
 
168
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
167
169
<td> process id of child, or <code class="literal">-1</code> on error.
168
170
</td>
169
171
</tr>
172
174
</div>
173
175
<hr>
174
176
<div class="refsect2" lang="en">
175
 
<a name="id2732690"></a><h3>
 
177
<a name="id2534272"></a><h3>
176
178
<a name="gnome-execute-async-with-env"></a>gnome_execute_async_with_env ()</h3>
177
 
<a class="indexterm" name="id2732703"></a><pre class="programlisting">int         gnome_execute_async_with_env    (const char *dir,
 
179
<a class="indexterm" name="id2534285"></a><pre class="programlisting">int         gnome_execute_async_with_env    (const char *dir,
178
180
                                             int argc);</pre>
179
181
<p>
180
182
This function forks and executes some program in the
189
191
<col align="left" valign="top">
190
192
<tbody>
191
193
<tr>
192
 
<td><span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
 
194
<td>
 
195
<span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
193
196
<td> Directory in which child should be executed, or NULL for current
194
197
      directory
195
198
</td>
196
199
</tr>
197
200
<tr>
198
 
<td><span class="term"><em class="parameter"><code>argc</code></em>&#160;:</span></td>
 
201
<td>
 
202
<span class="term"><em class="parameter"><code>argc</code></em>&#160;:</span></td>
199
203
<td> Number of arguments
200
204
</td>
201
205
</tr>
202
206
<tr>
203
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
207
<td>
 
208
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
204
209
<td> the process id, or <code class="literal">-1</code> on error.
205
210
</td>
206
211
</tr>
209
214
</div>
210
215
<hr>
211
216
<div class="refsect2" lang="en">
212
 
<a name="id2732826"></a><h3>
 
217
<a name="id2534408"></a><h3>
213
218
<a name="gnome-execute-async-with-env-fds"></a>gnome_execute_async_with_env_fds ()</h3>
214
 
<a class="indexterm" name="id2732840"></a><pre class="programlisting">int         gnome_execute_async_with_env_fds
 
219
<a class="indexterm" name="id2534422"></a><pre class="programlisting">int         gnome_execute_async_with_env_fds
215
220
                                            (const char *dir,
216
221
                                             int argc);</pre>
217
222
<p>
224
229
<col align="left" valign="top">
225
230
<tbody>
226
231
<tr>
227
 
<td><span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
228
 
<td> Directory in which child should be executed, or <a
229
 
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
230
 
><code class="literal">NULL</code></a> for current
 
232
<td>
 
233
<span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
 
234
<td> Directory in which child should be executed, or <code class="literal">NULL</code> for current
231
235
      directory
232
236
</td>
233
237
</tr>
234
238
<tr>
235
 
<td><span class="term"><em class="parameter"><code>argc</code></em>&#160;:</span></td>
 
239
<td>
 
240
<span class="term"><em class="parameter"><code>argc</code></em>&#160;:</span></td>
236
241
<td> Number of arguments
237
242
</td>
238
243
</tr>
239
244
<tr>
240
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
245
<td>
 
246
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
241
247
<td> the process id, or <code class="literal">-1</code> on error.
242
248
</td>
243
249
</tr>
246
252
</div>
247
253
<hr>
248
254
<div class="refsect2" lang="en">
249
 
<a name="id2732955"></a><h3>
 
255
<a name="id2534537"></a><h3>
250
256
<a name="gnome-execute-shell"></a>gnome_execute_shell ()</h3>
251
 
<a class="indexterm" name="id2732969"></a><pre class="programlisting">int         gnome_execute_shell             (const char *dir,
 
257
<a class="indexterm" name="id2534551"></a><pre class="programlisting">int         gnome_execute_shell             (const char *dir,
252
258
                                             const char *commandline);</pre>
253
259
<p>
254
260
Like <a href="libgnome-gnome-exec.html#gnome-execute-async-with-env"><code class="function">gnome_execute_async_with_env()</code></a>, but uses the user's shell
261
267
<col align="left" valign="top">
262
268
<tbody>
263
269
<tr>
264
 
<td><span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
265
 
<td> Directory in which child should be executed, or <a
266
 
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
267
 
><code class="literal">NULL</code></a> for current
 
270
<td>
 
271
<span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
 
272
<td> Directory in which child should be executed, or <code class="literal">NULL</code> for current
268
273
      directory
269
274
</td>
270
275
</tr>
271
276
<tr>
272
 
<td><span class="term"><em class="parameter"><code>commandline</code></em>&#160;:</span></td>
 
277
<td>
 
278
<span class="term"><em class="parameter"><code>commandline</code></em>&#160;:</span></td>
273
279
<td> Shell command to execute
274
280
</td>
275
281
</tr>
276
282
<tr>
277
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
283
<td>
 
284
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
278
285
<td> process id of shell, or <code class="literal">-1</code> on error.
279
286
</td>
280
287
</tr>
283
290
</div>
284
291
<hr>
285
292
<div class="refsect2" lang="en">
286
 
<a name="id2733085"></a><h3>
 
293
<a name="id2534667"></a><h3>
287
294
<a name="gnome-execute-shell-fds"></a>gnome_execute_shell_fds ()</h3>
288
 
<a class="indexterm" name="id2733098"></a><pre class="programlisting">int         gnome_execute_shell_fds         (const char *dir,
 
295
<a class="indexterm" name="id2534679"></a><pre class="programlisting">int         gnome_execute_shell_fds         (const char *dir,
289
296
                                             const char *commandline,
290
297
                                             gboolean close_fds);</pre>
291
298
<p>
299
306
<col align="left" valign="top">
300
307
<tbody>
301
308
<tr>
302
 
<td><span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
303
 
<td> Directory in which child should be executed, or <a
304
 
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
305
 
><code class="literal">NULL</code></a> for current
 
309
<td>
 
310
<span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
 
311
<td> Directory in which child should be executed, or <code class="literal">NULL</code> for current
306
312
      directory
307
313
</td>
308
314
</tr>
309
315
<tr>
310
 
<td><span class="term"><em class="parameter"><code>commandline</code></em>&#160;:</span></td>
 
316
<td>
 
317
<span class="term"><em class="parameter"><code>commandline</code></em>&#160;:</span></td>
311
318
<td> Shell command to execute
312
319
</td>
313
320
</tr>
314
321
<tr>
315
 
<td><span class="term"><em class="parameter"><code>close_fds</code></em>&#160;:</span></td>
 
322
<td>
 
323
<span class="term"><em class="parameter"><code>close_fds</code></em>&#160;:</span></td>
316
324
<td> Like close_fds in <a href="libgnome-gnome-exec.html#gnome-execute-async-with-env-fds"><code class="function">gnome_execute_async_with_env_fds()</code></a>
317
325
</td>
318
326
</tr>
319
327
<tr>
320
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
328
<td>
 
329
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
321
330
<td> process id of shell, or <code class="literal">-1</code> on error.
322
331
</td>
323
332
</tr>
326
335
</div>
327
336
<hr>
328
337
<div class="refsect2" lang="en">
329
 
<a name="id2733247"></a><h3>
 
338
<a name="id2534829"></a><h3>
330
339
<a name="gnome-prepend-terminal-to-vector"></a>gnome_prepend_terminal_to_vector ()</h3>
331
 
<a class="indexterm" name="id2733260"></a><pre class="programlisting">void        gnome_prepend_terminal_to_vector
 
340
<a class="indexterm" name="id2534842"></a><pre class="programlisting">void        gnome_prepend_terminal_to_vector
332
341
                                            (int *argc,
333
342
                                             char ***argv);</pre>
334
343
<p>
347
356
<col align="left" valign="top">
348
357
<tbody>
349
358
<tr>
350
 
<td><span class="term"><em class="parameter"><code>argc</code></em>&#160;:</span></td>
 
359
<td>
 
360
<span class="term"><em class="parameter"><code>argc</code></em>&#160;:</span></td>
351
361
<td> a pointer to the vector size
352
362
</td>
353
363
</tr>
354
364
<tr>
355
 
<td><span class="term"><em class="parameter"><code>argv</code></em>&#160;:</span></td>
 
365
<td>
 
366
<span class="term"><em class="parameter"><code>argv</code></em>&#160;:</span></td>
356
367
<td> a pointer to the vector
357
368
</td>
358
369
</tr>
361
372
</div>
362
373
<hr>
363
374
<div class="refsect2" lang="en">
364
 
<a name="id2733365"></a><h3>
 
375
<a name="id2534947"></a><h3>
365
376
<a name="gnome-execute-terminal-shell"></a>gnome_execute_terminal_shell ()</h3>
366
 
<a class="indexterm" name="id2733378"></a><pre class="programlisting">int         gnome_execute_terminal_shell    (const char *dir,
 
377
<a class="indexterm" name="id2534960"></a><pre class="programlisting">int         gnome_execute_terminal_shell    (const char *dir,
367
378
                                             const char *commandline);</pre>
368
379
<p>
369
380
Like <a href="libgnome-gnome-exec.html#gnome-execute-async"><span class="type">gnome_execute_async</span></a>, except that it runs the
370
381
terminal as well.  Note that the pid of the terminal is
371
382
returned, not the pid of the user's program.
372
 
If commandline is <a
373
 
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
374
 
><code class="literal">NULL</code></a>, just the shell is run.</p>
 
383
If commandline is <code class="literal">NULL</code>, just the shell is run.</p>
375
384
<p>
376
385
 
377
386
</p>
379
388
<col align="left" valign="top">
380
389
<tbody>
381
390
<tr>
382
 
<td><span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
 
391
<td>
 
392
<span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
383
393
<td> Directory in which child should be executed, or NULL for current
384
394
      directory
385
395
</td>
386
396
</tr>
387
397
<tr>
388
 
<td><span class="term"><em class="parameter"><code>commandline</code></em>&#160;:</span></td>
 
398
<td>
 
399
<span class="term"><em class="parameter"><code>commandline</code></em>&#160;:</span></td>
389
400
<td> Shell command to execute
390
401
</td>
391
402
</tr>
392
403
<tr>
393
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
404
<td>
 
405
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
394
406
<td> process id of terminal, or <code class="literal">-1</code> on error.
395
407
</td>
396
408
</tr>
399
411
</div>
400
412
<hr>
401
413
<div class="refsect2" lang="en">
402
 
<a name="id2733492"></a><h3>
 
414
<a name="id2535074"></a><h3>
403
415
<a name="gnome-execute-terminal-shell-fds"></a>gnome_execute_terminal_shell_fds ()</h3>
404
 
<a class="indexterm" name="id2733506"></a><pre class="programlisting">int         gnome_execute_terminal_shell_fds
 
416
<a class="indexterm" name="id2535088"></a><pre class="programlisting">int         gnome_execute_terminal_shell_fds
405
417
                                            (const char *dir,
406
418
                                             const char *commandline,
407
419
                                             gboolean close_fds);</pre>
409
421
Like <a href="libgnome-gnome-exec.html#gnome-execute-shell-fds"><code class="function">gnome_execute_shell_fds()</code></a>, except that it runs the
410
422
terminal as well.  Note that the pid of the terminal is
411
423
returned, not the pid of the user's program.
412
 
If commandline is <a
413
 
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
414
 
><code class="literal">NULL</code></a>, just the shell is run.</p>
 
424
If commandline is <code class="literal">NULL</code>, just the shell is run.</p>
415
425
<p>
416
426
 
417
427
</p>
419
429
<col align="left" valign="top">
420
430
<tbody>
421
431
<tr>
422
 
<td><span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
423
 
<td> Directory in which child should be executed, or <a
424
 
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
425
 
><code class="literal">NULL</code></a> for current
 
432
<td>
 
433
<span class="term"><em class="parameter"><code>dir</code></em>&#160;:</span></td>
 
434
<td> Directory in which child should be executed, or <code class="literal">NULL</code> for current
426
435
      directory
427
436
</td>
428
437
</tr>
429
438
<tr>
430
 
<td><span class="term"><em class="parameter"><code>commandline</code></em>&#160;:</span></td>
 
439
<td>
 
440
<span class="term"><em class="parameter"><code>commandline</code></em>&#160;:</span></td>
431
441
<td> Shell command to execute
432
442
</td>
433
443
</tr>
434
444
<tr>
435
 
<td><span class="term"><em class="parameter"><code>close_fds</code></em>&#160;:</span></td>
 
445
<td>
 
446
<span class="term"><em class="parameter"><code>close_fds</code></em>&#160;:</span></td>
436
447
<td> Like close_fds in <a href="libgnome-gnome-exec.html#gnome-execute-async-with-env-fds"><code class="function">gnome_execute_async_with_env_fds()</code></a>
437
448
</td>
438
449
</tr>
439
450
<tr>
440
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
451
<td>
 
452
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
441
453
<td> process id of terminal, or <code class="literal">-1</code> on error.
442
454
</td>
443
455
</tr>