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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gnome-exec</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GNOME Library Reference Manual">
<link rel="up" href="ch01.html" title="Initializing Applications and Starting Programs">
<link rel="prev" href="libgnome-gnome-init.html" title="gnome-init">
<link rel="next" href="ch02.html" title="Configuration">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgnome.html" title="Part I. GNOME Library (libgnome)">
<link rel="chapter" href="ch01.html" title="Initializing Applications and Starting Programs">
<link rel="chapter" href="ch02.html" title="Configuration">
<link rel="chapter" href="ch03.html" title="Displaying Help and External Info">
<link rel="chapter" href="ch04.html" title="Miscellaneous">
<link rel="chapter" href="ch05.html" title="Lower Level Interactions">
<link rel="chapter" href="ch06.html" title="Deprecated Modules">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
<link rel="index" href="ix08.html" title="Index of new symbols in 2.12">
<link rel="index" href="ix09.html" title="Index of new symbols in 2.14">
<link rel="index" href="ix10.html" title="Index of new symbols in 2.16">
</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="libgnome-gnome-init.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">GNOME Library Reference Manual</th>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2532533" class="shortcut">Top</a>
 | 
<a href="#id2533982" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgnome-gnome-exec"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2532533"></a><span class="refentrytitle">gnome-exec</span>
</h2>
<p>gnome-exec — Execution of programs from within GNOME applications.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnome/libgnome.h>
int <a href="libgnome-gnome-exec.html#gnome-execute-async">gnome_execute_async</a> (const char *dir,
int argc);
int <a href="libgnome-gnome-exec.html#gnome-execute-async-fds">gnome_execute_async_fds</a> (const char *dir,
int argc);
int <a href="libgnome-gnome-exec.html#gnome-execute-async-with-env">gnome_execute_async_with_env</a> (const char *dir,
int argc);
int <a href="libgnome-gnome-exec.html#gnome-execute-async-with-env-fds">gnome_execute_async_with_env_fds</a>
(const char *dir,
int argc);
int <a href="libgnome-gnome-exec.html#gnome-execute-shell">gnome_execute_shell</a> (const char *dir,
const char *commandline);
int <a href="libgnome-gnome-exec.html#gnome-execute-shell-fds">gnome_execute_shell_fds</a> (const char *dir,
const char *commandline,
gboolean close_fds);
void <a href="libgnome-gnome-exec.html#gnome-prepend-terminal-to-vector">gnome_prepend_terminal_to_vector</a>
(int *argc,
char ***argv);
int <a href="libgnome-gnome-exec.html#gnome-execute-terminal-shell">gnome_execute_terminal_shell</a> (const char *dir,
const char *commandline);
int <a href="libgnome-gnome-exec.html#gnome-execute-terminal-shell-fds">gnome_execute_terminal_shell_fds</a>
(const char *dir,
const char *commandline,
gboolean close_fds);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2533982"></a><h2>Description</h2>
<p>
The gnome-execute family of functions are provided to simplify execution of
programs from withing GNOME applications. These routines are required to avoid
passing opened file descriptors to a child process (like the X11 sockets and
CORBA sockets). They will also make sure to terminate properly.
</p>
<p>
The range of possibilities goes from the most simple use to the most
specialized ones.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2534007"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2534017"></a><h3>
<a name="gnome-execute-async"></a>gnome_execute_async ()</h3>
<a class="indexterm" name="id2534030"></a><pre class="programlisting">int gnome_execute_async (const char *dir,
int argc);</pre>
<p>
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
to child's environment.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
<td> Directory in which child should be executesd, or <code class="literal">NULL</code> for current
directory
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
<td> Number of arguments
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> process id of child, or <code class="literal">-1</code> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534145"></a><h3>
<a name="gnome-execute-async-fds"></a>gnome_execute_async_fds ()</h3>
<a class="indexterm" name="id2534158"></a><pre class="programlisting">int gnome_execute_async_fds (const char *dir,
int argc);</pre>
<p>
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
anything to child's environment.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
<td> Directory in which child should be executed, or <code class="literal">NULL</code> for current
directory
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
<td> Number of arguments
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> process id of child, or <code class="literal">-1</code> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534272"></a><h3>
<a name="gnome-execute-async-with-env"></a>gnome_execute_async_with_env ()</h3>
<a class="indexterm" name="id2534285"></a><pre class="programlisting">int gnome_execute_async_with_env (const char *dir,
int argc);</pre>
<p>
This function forks and executes some program in the
background. On error, returns <code class="literal">-1</code>; in this case, <span class="type">errno</span> should hold a useful
value. Searches the path to find the child. Environment settings in <em class="parameter"><code>envv</code></em>
are added to the existing environment -- they do not completely replace it.
This function closes all fds besides 0, 1, and 2 for the child</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
<td> Directory in which child should be executed, or NULL for current
directory
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
<td> Number of arguments
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the process id, or <code class="literal">-1</code> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534408"></a><h3>
<a name="gnome-execute-async-with-env-fds"></a>gnome_execute_async_with_env_fds ()</h3>
<a class="indexterm" name="id2534422"></a><pre class="programlisting">int gnome_execute_async_with_env_fds
(const char *dir,
int argc);</pre>
<p>
Like <a href="libgnome-gnome-exec.html#gnome-execute-async-with-env"><code class="function">gnome_execute_async_with_env()</code></a> but has a flag to
decide whether or not to close fd's</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
<td> Directory in which child should be executed, or <code class="literal">NULL</code> for current
directory
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
<td> Number of arguments
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the process id, or <code class="literal">-1</code> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534537"></a><h3>
<a name="gnome-execute-shell"></a>gnome_execute_shell ()</h3>
<a class="indexterm" name="id2534551"></a><pre class="programlisting">int gnome_execute_shell (const char *dir,
const char *commandline);</pre>
<p>
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
to run the desired program. Note that the pid of the shell is returned, not
the pid of the user's program.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
<td> Directory in which child should be executed, or <code class="literal">NULL</code> for current
directory
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>commandline</code></em> :</span></td>
<td> Shell command to execute
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> process id of shell, or <code class="literal">-1</code> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534667"></a><h3>
<a name="gnome-execute-shell-fds"></a>gnome_execute_shell_fds ()</h3>
<a class="indexterm" name="id2534679"></a><pre class="programlisting">int gnome_execute_shell_fds (const char *dir,
const char *commandline,
gboolean close_fds);</pre>
<p>
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 uses the user's
shell to run the desired program. Note that the pid of the shell is
returned, not the pid of the user's program.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
<td> Directory in which child should be executed, or <code class="literal">NULL</code> for current
directory
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>commandline</code></em> :</span></td>
<td> Shell command to execute
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>close_fds</code></em> :</span></td>
<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>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> process id of shell, or <code class="literal">-1</code> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534829"></a><h3>
<a name="gnome-prepend-terminal-to-vector"></a>gnome_prepend_terminal_to_vector ()</h3>
<a class="indexterm" name="id2534842"></a><pre class="programlisting">void gnome_prepend_terminal_to_vector
(int *argc,
char ***argv);</pre>
<p>
Prepends a terminal (either the one configured as default in
the user's GNOME setup, or one of the common xterm emulators) to the passed
in vector, modifying it in the process. The vector should be allocated with
<span class="type">g_malloc</span>, as this will <span class="type">g_free</span> the original vector. Also all elements must
have been allocated separately. That is the standard glib/GNOME way of
doing vectors however. If the integer that <em class="parameter"><code>argc</code></em> points to is negative, the
size will first be computed. Also note that passing in pointers to a vector
that is empty, will just create a new vector for you.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
<td> a pointer to the vector size
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
<td> a pointer to the vector
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534947"></a><h3>
<a name="gnome-execute-terminal-shell"></a>gnome_execute_terminal_shell ()</h3>
<a class="indexterm" name="id2534960"></a><pre class="programlisting">int gnome_execute_terminal_shell (const char *dir,
const char *commandline);</pre>
<p>
Like <a href="libgnome-gnome-exec.html#gnome-execute-async"><span class="type">gnome_execute_async</span></a>, except that it runs the
terminal as well. Note that the pid of the terminal is
returned, not the pid of the user's program.
If commandline is <code class="literal">NULL</code>, just the shell is run.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
<td> Directory in which child should be executed, or NULL for current
directory
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>commandline</code></em> :</span></td>
<td> Shell command to execute
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> process id of terminal, or <code class="literal">-1</code> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2535074"></a><h3>
<a name="gnome-execute-terminal-shell-fds"></a>gnome_execute_terminal_shell_fds ()</h3>
<a class="indexterm" name="id2535088"></a><pre class="programlisting">int gnome_execute_terminal_shell_fds
(const char *dir,
const char *commandline,
gboolean close_fds);</pre>
<p>
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
terminal as well. Note that the pid of the terminal is
returned, not the pid of the user's program.
If commandline is <code class="literal">NULL</code>, just the shell is run.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
<td> Directory in which child should be executed, or <code class="literal">NULL</code> for current
directory
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>commandline</code></em> :</span></td>
<td> Shell command to execute
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>close_fds</code></em> :</span></td>
<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>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> process id of terminal, or <code class="literal">-1</code> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|