libfm-doc 1.2.0-1ubuntu2 / usr / share / gtk-doc / html / libfm / FmTerminal.html

This file is indexed.

/usr/share/gtk-doc/html/libfm/FmTerminal.html is in libfm-doc 1.2.0-1ubuntu2.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Libfm Reference Manual: FmTerminal</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libfm Reference Manual">
<link rel="up" href="libfm-core.html" title="Libfm Core Reference.">
<link rel="prev" href="FmTemplate.html" title="FmTemplate">
<link rel="next" href="libfm-FmThumbnailLoader.html" title="FmThumbnailLoader">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
                  <a href="#FmTerminal.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#FmTerminal.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libfm-core.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="FmTemplate.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libfm-FmThumbnailLoader.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="FmTerminal"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="FmTerminal.top_of_page"></a>FmTerminal</span></h2>
<p>FmTerminal — Terminals representation for libfm.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="FmTerminal.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="FmTerminal.html#FM-TERMINAL-TYPE:CAPS" title="FM_TERMINAL_TYPE">FM_TERMINAL_TYPE</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="FmTerminal.html" title="FmTerminal"><span class="returnvalue">FmTerminal</span></a> *
</td>
<td class="function_name">
<a class="link" href="FmTerminal.html#fm-terminal-dup-default" title="fm_terminal_dup_default ()">fm_terminal_dup_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="FmTerminal.html#fm-terminal-launch" title="fm_terminal_launch ()">fm_terminal_launch</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmTerminal.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="FmTerminal.html#FmTerminal-struct" title="struct FmTerminal">FmTerminal</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="FmTerminal.html#FmTerminalClass" title="FmTerminalClass">FmTerminalClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmTerminal.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
    <span class="lineart">╰──</span> FmTerminal
</pre>
</div>
<div class="refsect1">
<a name="FmTerminal.description"></a><h2>Description</h2>
<p><em class="parameter"><code>include</code></em>
: libfm/fm.h</p>
<p>The FmTerminal object represents description how applications which
require start in terminal should be started.</p>
</div>
<div class="refsect1">
<a name="FmTerminal.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="FM-TERMINAL-TYPE:CAPS"></a><h3>FM_TERMINAL_TYPE</h3>
<pre class="programlisting">#define FM_TERMINAL_TYPE               (fm_terminal_get_type())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="fm-terminal-dup-default"></a><h3>fm_terminal_dup_default ()</h3>
<pre class="programlisting"><a class="link" href="FmTerminal.html" title="FmTerminal"><span class="returnvalue">FmTerminal</span></a> *
fm_terminal_dup_default (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Retrieves description of terminal which is defined in libfm config.
Returned data should be freed with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> after usage.</p>
<div class="refsect3">
<a name="id-1.2.3.20.7.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> location of error to set. </p></td>
<td class="parameter_annotations"><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>
</div>
<div class="refsect3">
<a name="id-1.2.3.20.7.3.6"></a><h4>Returns</h4>
<p> terminal descriptor or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no terminal is set. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since 1.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-terminal-launch"></a><h3>fm_terminal_launch ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
fm_terminal_launch (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dir</code></em>,
                    <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Spawns a terminal window in requested <em class="parameter"><code>dir</code></em>
. If <em class="parameter"><code>dir</code></em>
 is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then it
will be spawned in current working directory.</p>
<div class="refsect3">
<a name="id-1.2.3.20.7.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dir</p></td>
<td class="parameter_description"><p> a directory to launch. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> location of error to set. </p></td>
<td class="parameter_annotations"><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>
</div>
<div class="refsect3">
<a name="id-1.2.3.20.7.4.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if spawn was succesful.</p>
<p></p>
</div>
<p class="since">Since 1.2.0</p>
</div>
</div>
<div class="refsect1">
<a name="FmTerminal.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FmTerminal-struct"></a><h3>struct FmTerminal</h3>
<pre class="programlisting">struct FmTerminal {
    char* program;
    char* open_arg;
    char* noclose_arg;
    char* launch;
    char* desktop_id;
    char* custom_args;
};
</pre>
<p>A terminal description. If application should be ran in terminal libfm
may do it either default way (closing terminal window after exit):</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><em class="parameter"><code>program</code></em>
 <em class="parameter"><code>custom_args</code></em>
 <em class="parameter"><code>open_arg</code></em>
 &lt;cmd&gt; [&lt;args&gt;]</p></li></ul></div>
<p>or alternate way (not closing terminal window after exit):</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><em class="parameter"><code>program</code></em>
 <em class="parameter"><code>custom_args</code></em>
 <em class="parameter"><code>noclose_arg</code></em>
 &lt;cmd&gt; [&lt;args&gt;]</p></li></ul></div>
<p>If terminal doesn't support not closing terminal window after exit then
default way should be used.</p>
<div class="refsect3">
<a name="id-1.2.3.20.8.2.9"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="FmTerminal-struct.program"></a>program</code></em>;</p></td>
<td class="struct_member_description"><p>archiver program</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="FmTerminal-struct.open-arg"></a>open_arg</code></em>;</p></td>
<td class="struct_member_description"><p>options to insert before &lt;cmd&gt; [&lt;args&gt;] to run command in terminal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="FmTerminal-struct.noclose-arg"></a>noclose_arg</code></em>;</p></td>
<td class="struct_member_description"><p>options to insert to run command without closing terminal or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="FmTerminal-struct.launch"></a>launch</code></em>;</p></td>
<td class="struct_member_description"><p>options if required to launch in current directory</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="FmTerminal-struct.desktop-id"></a>desktop_id</code></em>;</p></td>
<td class="struct_member_description"><p>desktop ID to search for icon and descriptions</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="FmTerminal-struct.custom-args"></a>custom_args</code></em>;</p></td>
<td class="struct_member_description"><p>custom arguments (only from libfm.conf)</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="FmTerminalClass"></a><h3>FmTerminalClass</h3>
<pre class="programlisting">typedef struct _FmTerminalClass FmTerminalClass;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.