This file is indexed.

/usr/share/gtk-doc/html/exo-1/exo-Executing-Applications.html is in libexo-1-dev 0.6.2-4.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Executing Applications</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Exo Reference Manual">
<link rel="up" href="exo-miscelleanous.html" title="Part VII. Miscelleanous">
<link rel="prev" href="exo-Binding-Properties-Functions.html" title="Binding Properties Functions">
<link rel="next" href="exo-String-Utility-Functions.html" title="String Utility Functions">
<meta name="generator" content="GTK-Doc V1.17 (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="exo-Binding-Properties-Functions.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="exo-miscelleanous.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">Exo Reference Manual</th>
<td><a accesskey="n" href="exo-String-Utility-Functions.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#exo-Executing-Applications.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#exo-Executing-Applications.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="exo-Executing-Applications"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="exo-Executing-Applications.top_of_page"></a>Executing Applications</span></h2>
<p>Executing Applications — Execute preferred applications</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="exo-Executing-Applications.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;exo/exo.h&gt;

<span class="returnvalue">gboolean</span>            <a class="link" href="exo-Executing-Applications.html#exo-execute-preferred-application" title="exo_execute_preferred_application ()">exo_execute_preferred_application</a>   (<em class="parameter"><code>const <span class="type">gchar</span> *category</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *parameter</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *working_directory</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **envp</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="exo-Executing-Applications.html#exo-execute-preferred-application-on-screen" title="exo_execute_preferred_application_on_screen ()">exo_execute_preferred_application_on_screen</a>
                                                        (<em class="parameter"><code>const <span class="type">gchar</span> *category</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *parameter</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *working_directory</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **envp</code></em>,
                                                         <em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="exo-Executing-Applications.html#exo-execute-terminal-shell" title="exo_execute_terminal_shell ()">exo_execute_terminal_shell</a>          (<em class="parameter"><code>const <span class="type">gchar</span> *command_line</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *working_directory</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **envp</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="exo-Executing-Applications.html#exo-execute-terminal-shell-on-screen" title="exo_execute_terminal_shell_on_screen ()">exo_execute_terminal_shell_on_screen</a>
                                                        (<em class="parameter"><code>const <span class="type">gchar</span> *command_line</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *working_directory</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **envp</code></em>,
                                                         <em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="exo-Executing-Applications.description"></a><h2>Description</h2>
<p>
This module provides functions to execute certain kinds of applications,
for which users can select their preferred ones. For example, whenever
you need to run a command in a terminal emulator from within your
application you should use <a class="link" href="exo-Executing-Applications.html#exo-execute-terminal-shell" title="exo_execute_terminal_shell ()"><code class="function">exo_execute_terminal_shell()</code></a> or
<a class="link" href="exo-Executing-Applications.html#exo-execute-terminal-shell-on-screen" title="exo_execute_terminal_shell_on_screen ()"><code class="function">exo_execute_terminal_shell_on_screen()</code></a> to make sure you run the user's
preferred terminal emulator.
On the other hand if you need to display an URL (i.e. you want to point
the user to the website of your application), you should use <code class="function">gtk_show_uri()</code>
instead, as it will try to automatically determine the appropriate
viewer for a given URI.
</p>
</div>
<div class="refsect1">
<a name="exo-Executing-Applications.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="exo-execute-preferred-application"></a><h3>exo_execute_preferred_application ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            exo_execute_preferred_application   (<em class="parameter"><code>const <span class="type">gchar</span> *category</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *parameter</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *working_directory</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **envp</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Convenience wrapper to <a class="link" href="exo-Executing-Applications.html#exo-execute-preferred-application-on-screen" title="exo_execute_preferred_application_on_screen ()"><code class="function">exo_execute_preferred_application_on_screen()</code></a>, which
runs the preferred application for <em class="parameter"><code>category</code></em> on the default <span class="type">GdkScreen</span>.
</p>
<p>
Note that even if this method returns <code class="literal">TRUE</code> there's no warranty that
the preferred application for <em class="parameter"><code>category</code></em> was run successfully, because
of the way the helper framework is implemented. But you can be sure
that if the execution fails at a later stage, the library will popup
an error dialog to inform the user that the execution failed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
<td>the category of the preferred application to launch.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parameter</code></em> :</span></p></td>
<td>additional parameter to pass to the preferred application
(i.e. an URL to pass to the preferred browser) or <code class="literal">NULL</code>
to pass no parameter.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>working_directory</code></em> :</span></p></td>
<td>path to the directory in which to execute the
preferred application for <em class="parameter"><code>category</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>envp</code></em> :</span></p></td>
<td>child's environment, or <code class="literal">NULL</code> to inherit parent's.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for errors or <code class="literal">NULL</code>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success, else <code class="literal">FALSE</code>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3.1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-execute-preferred-application-on-screen"></a><h3>exo_execute_preferred_application_on_screen ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            exo_execute_preferred_application_on_screen
                                                        (<em class="parameter"><code>const <span class="type">gchar</span> *category</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *parameter</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *working_directory</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **envp</code></em>,
                                                         <em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Launches the preferred application for the given <em class="parameter"><code>category</code></em> with the
<em class="parameter"><code>parameter</code></em> on <em class="parameter"><code>screen</code></em> in the specified <em class="parameter"><code>working_directory</code></em>.
</p>
<p>
libexo currently supports the following categories: %"WebBrowser",
%"MailReader" and %"TerminalEmulator". If you specify an invalid
<em class="parameter"><code>category</code></em> here, the execution will fail at a later stage and the
user will be presented with an error dialog.
</p>
<p>
Note that even if this method returns <code class="literal">TRUE</code> there's no warranty that
the preferred application for <em class="parameter"><code>category</code></em> was run successfully, because
of the way the helper framework is implemented. But you can be sure
that if the execution fails at a later stage, the library will popup
an error dialog to inform the user that the execution failed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
<td>the category of the preferred application to launch.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parameter</code></em> :</span></p></td>
<td>additional parameter to pass to the preferred application
(i.e. an URL to pass to the preferred browser) or <code class="literal">NULL</code>
to pass no parameter.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>working_directory</code></em> :</span></p></td>
<td>path to the directory in which to execute the
preferred application for <em class="parameter"><code>category</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>envp</code></em> :</span></p></td>
<td>child's environment, or <code class="literal">NULL</code> to inherit parent's.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>screen</code></em> :</span></p></td>
<td>the <span class="type">GdkScreen</span> on which to run the preferred
application for <em class="parameter"><code>category</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for errors or <code class="literal">NULL</code>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success, else <code class="literal">FALSE</code>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3.1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-execute-terminal-shell"></a><h3>exo_execute_terminal_shell ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            exo_execute_terminal_shell          (<em class="parameter"><code>const <span class="type">gchar</span> *command_line</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *working_directory</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **envp</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Convenience wrapper to <a class="link" href="exo-Executing-Applications.html#exo-execute-terminal-shell-on-screen" title="exo_execute_terminal_shell_on_screen ()"><code class="function">exo_execute_terminal_shell_on_screen()</code></a>, which
executes the <em class="parameter"><code>command_line</code></em> on the default <span class="type">GdkScreen</span>.
</p>
<p>
Note that even if this method returns <code class="literal">TRUE</code> there's no warranty that
the <em class="parameter"><code>command_line</code></em> was run successfully, because of the way the helper
framework is implemented. But you can be sure that if the execution
fails at a later stage, the library will popup an error dialog to
inform the user that the execution failed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>command_line</code></em> :</span></p></td>
<td>shell command line to execute.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>working_directory</code></em> :</span></p></td>
<td>path to the directory in which to execute <em class="parameter"><code>command_line</code></em>
or <code class="literal">NULL</code> to use the current working directory.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>envp</code></em> :</span></p></td>
<td>child's environment, or <code class="literal">NULL</code> to inherit parent's.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for errors or <code class="literal">NULL</code>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success, else <code class="literal">FALSE</code>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3.1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-execute-terminal-shell-on-screen"></a><h3>exo_execute_terminal_shell_on_screen ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            exo_execute_terminal_shell_on_screen
                                                        (<em class="parameter"><code>const <span class="type">gchar</span> *command_line</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *working_directory</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **envp</code></em>,
                                                         <em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Executes <em class="parameter"><code>command_line</code></em> in the default terminal emulator on the specified
<em class="parameter"><code>screen</code></em>.
</p>
<p>
If no preferred terminal emulator was chosen by the user so far and
no sane fallback could be located, the user will be presented with
the preferred application chooser dialog, which prompts to choose
a default terminal emulator, and the <em class="parameter"><code>command_line</code></em> will be run
afterwards using the new default.
</p>
<p>
Note that even if this method returns <code class="literal">TRUE</code> there's no warranty that
the <em class="parameter"><code>command_line</code></em> was run successfully, because of the way the helper
framework is implemented. But you can be sure that if the execution
fails at a later stage, the library will popup an error dialog to
inform the user that the execution failed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>command_line</code></em> :</span></p></td>
<td>shell command line to execute.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>working_directory</code></em> :</span></p></td>
<td>path to the directory in which to execute <em class="parameter"><code>command_line</code></em>
or <code class="literal">NULL</code> to use the current working directory.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>envp</code></em> :</span></p></td>
<td>child's environment, or <code class="literal">NULL</code> to inherit parent's.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>screen</code></em> :</span></p></td>
<td>the <span class="type">GdkScreen</span> on which to run the <em class="parameter"><code>command_line</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for errors or <code class="literal">NULL</code>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success, else <code class="literal">FALSE</code>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3.1.3</p>
</div>
</div>
<div class="refsect1">
<a name="exo-Executing-Applications.see-also"></a><h2>See Also</h2>
gtk_show_uri()
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17</div>
</body>
</html>