← Back to branch summary

~ubuntu-branches/ubuntu/karmic/exo/karmic

« back to all changes in this revision

Viewing changes to docs/reference/xml/exo-mount-point.xml

  • Committer: Bazaar Package Importer
  • Author(s): Lionel Le Folgoc
  • Date: 2009-08-21 14:28:56 UTC
  • mfrom: (1.1.22 upstream)
  • Revision ID: james.westby@ubuntu.com-20090821142856-xp7o7hl7x9xa2213
Tags: 0.3.102-1ubuntu1
* Merge from Debian unstable, remaining Ubuntu changes:
  - debian/rules:
    + Removed mangling of helpers.rc
    + Add --enable-gtk-doc switch to configure
  - debian/control:
    + Add build-dep on gtk-doc-tools
    + Update Vcs-* fields
  - debian/patches:
    + 04_update_helpers.patch: patched libexo's firefox helper desktop file
      to use firefox-3.0 icon instead of firefox icon
    + xubuntu-default-mount-options.patch: change default mount options for
      vfat, iso9660, ntfs
    + series: refreshed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/exo-mount-point.xml
8
8
<refnamediv>
9
9
<refname>Mount Points</refname>
10
10
<refpurpose>Functions to query active and configured mount points</refpurpose>
11
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
11
</refnamediv>
13
12
 
14
13
<refsynopsisdiv id="exo-Mount-Points.synopsis" role="synopsis">
20
19
 
21
20
enum                <link linkend="ExoMountPointFlags">ExoMountPointFlags</link>;
22
21
                    <link linkend="ExoMountPoint">ExoMountPoint</link>;
23
 
<link linkend="ExoMountPoint">ExoMountPoint</link>*      <link linkend="exo-mount-point-dup">exo_mount_point_dup</link>                 (const <link linkend="ExoMountPoint">ExoMountPoint</link> *mount_point);
 
22
<link linkend="ExoMountPoint">ExoMountPoint</link> *     <link linkend="exo-mount-point-dup">exo_mount_point_dup</link>                 (const <link linkend="ExoMountPoint">ExoMountPoint</link> *mount_point);
24
23
<link linkend="void">void</link>                <link linkend="exo-mount-point-free">exo_mount_point_free</link>                (<link linkend="ExoMountPoint">ExoMountPoint</link> *mount_point);
25
24
enum                <link linkend="ExoMountPointMatchMask">ExoMountPointMatchMask</link>;
26
 
<link linkend="GSList">GSList</link>*             <link linkend="exo-mount-point-list-matched">exo_mount_point_list_matched</link>        (<link linkend="ExoMountPointMatchMask">ExoMountPointMatchMask</link> mask,
 
25
<link linkend="GSList">GSList</link> *            <link linkend="exo-mount-point-list-matched">exo_mount_point_list_matched</link>        (<link linkend="ExoMountPointMatchMask">ExoMountPointMatchMask</link> mask,
27
26
                                                         const <link linkend="gchar">gchar</link> *device,
28
27
                                                         const <link linkend="gchar">gchar</link> *folder,
29
28
                                                         const <link linkend="gchar">gchar</link> *fstype,
55
54
<title role="details.title">Details</title>
56
55
<refsect2 id="ExoMountPointFlags" role="enum" condition="since:0.3.1.13">
57
56
<title>enum ExoMountPointFlags</title>
58
 
<indexterm zone="ExoMountPointFlags" role="0.3.1.13"><primary>ExoMountPointFlags</primary></indexterm><programlisting>typedef enum /*&lt; flags &gt;*/
 
57
<indexterm zone="ExoMountPointFlags" role="0.3.1.13"><primary sortas="ExoMountPointFlags">ExoMountPointFlags</primary></indexterm><programlisting>typedef enum /*&lt; flags &gt;*/
59
58
{
60
59
  EXO_MOUNT_POINT_READ_ONLY = (1L &lt;&lt; 0),
61
60
} ExoMountPointFlags;
63
62
<para>
64
63
Identifies options of <link linkend="ExoMountPoint"><type>ExoMountPoint</type></link><!---->s.</para>
65
64
<para>
66
 
 
67
65
</para><variablelist role="enum">
68
 
</variablelist><para role="since">Since  0.3.1.13
69
 
</para></refsect2>
 
66
</variablelist><para role="since">Since 0.3.1.13</para></refsect2>
70
67
<refsect2 id="ExoMountPoint" role="struct">
71
68
<title>ExoMountPoint</title>
72
 
<indexterm zone="ExoMountPoint"><primary>ExoMountPoint</primary></indexterm><programlisting>typedef struct {
 
69
<indexterm zone="ExoMountPoint"><primary sortas="ExoMountPoint">ExoMountPoint</primary></indexterm><programlisting>typedef struct {
73
70
  ExoMountPointFlags flags;
74
71
  gchar             *device;
75
72
  gchar             *folder;
84
81
  <filename>/etc/vfstab</filename>).
85
82
</para><variablelist role="struct">
86
83
<varlistentry>
87
 
<term><link linkend="ExoMountPointFlags">ExoMountPointFlags</link>&nbsp;<structfield>flags</structfield>;</term>
 
84
<term><link linkend="ExoMountPointFlags">ExoMountPointFlags</link>&#160;<structfield>flags</structfield>;</term>
88
85
<listitem><simpara>see <link linkend="ExoMountPointFlags"><type>ExoMountPointFlags</type></link>.
89
86
</simpara></listitem>
90
87
</varlistentry>
91
88
<varlistentry>
92
 
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>device</structfield>;</term>
 
89
<term><link linkend="gchar">gchar</link>&#160;*<structfield>device</structfield>;</term>
93
90
<listitem><simpara>the device file path.
94
91
</simpara></listitem>
95
92
</varlistentry>
96
93
<varlistentry>
97
 
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>folder</structfield>;</term>
 
94
<term><link linkend="gchar">gchar</link>&#160;*<structfield>folder</structfield>;</term>
98
95
<listitem><simpara>the folder where the device is mounted (or may be mounted).
99
96
</simpara></listitem>
100
97
</varlistentry>
101
98
<varlistentry>
102
 
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>fstype</structfield>;</term>
 
99
<term><link linkend="gchar">gchar</link>&#160;*<structfield>fstype</structfield>;</term>
103
100
<listitem><simpara>the type of the file system used for the device.
104
 
 
105
101
</simpara></listitem>
106
102
</varlistentry>
107
103
</variablelist></refsect2>
108
104
<refsect2 id="exo-mount-point-dup" role="function" condition="since:0.3.1.13">
109
105
<title>exo_mount_point_dup ()</title>
110
 
<indexterm zone="exo-mount-point-dup" role="0.3.1.13"><primary>exo_mount_point_dup</primary></indexterm><programlisting><link linkend="ExoMountPoint">ExoMountPoint</link>*      exo_mount_point_dup                 (const <link linkend="ExoMountPoint">ExoMountPoint</link> *mount_point);</programlisting>
 
106
<indexterm zone="exo-mount-point-dup" role="0.3.1.13"><primary sortas="exo_mount_point_dup">exo_mount_point_dup</primary></indexterm><programlisting><link linkend="ExoMountPoint">ExoMountPoint</link> *     exo_mount_point_dup                 (const <link linkend="ExoMountPoint">ExoMountPoint</link> *mount_point);</programlisting>
111
107
<para>
112
108
Duplicates the specified <parameter>mount_point</parameter> and returns
113
 
the duplicate. If <parameter>mount_point</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, this simply
114
 
returns <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
 
109
the duplicate. If <parameter>mount_point</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, this simply
 
110
returns <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
115
111
</para>
116
112
<para>
117
113
The caller is responsible to free the returned mount
118
114
point using <link linkend="exo-mount-point-free"><function>exo_mount_point_free()</function></link> when no longer
119
115
needed.</para>
120
116
<para>
121
 
 
122
117
</para><variablelist role="params">
123
 
<varlistentry><term><parameter>mount_point</parameter>&nbsp;:</term>
 
118
<varlistentry><term><parameter>mount_point</parameter>&#160;:</term>
124
119
<listitem><simpara> an <link linkend="ExoMountPoint"><type>ExoMountPoint</type></link>.
125
120
</simpara></listitem></varlistentry>
126
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a copy of the specified <parameter>mount_point</parameter>.
 
121
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a copy of the specified <parameter>mount_point</parameter>.
127
122
 
128
123
</simpara></listitem></varlistentry>
129
 
</variablelist><para role="since">Since  0.3.1.13
130
 
</para></refsect2>
 
124
</variablelist><para role="since">Since 0.3.1.13</para></refsect2>
131
125
<refsect2 id="exo-mount-point-free" role="function" condition="since:0.3.1.13">
132
126
<title>exo_mount_point_free ()</title>
133
 
<indexterm zone="exo-mount-point-free" role="0.3.1.13"><primary>exo_mount_point_free</primary></indexterm><programlisting><link linkend="void">void</link>                exo_mount_point_free                (<link linkend="ExoMountPoint">ExoMountPoint</link> *mount_point);</programlisting>
 
127
<indexterm zone="exo-mount-point-free" role="0.3.1.13"><primary sortas="exo_mount_point_free">exo_mount_point_free</primary></indexterm><programlisting><link linkend="void">void</link>                exo_mount_point_free                (<link linkend="ExoMountPoint">ExoMountPoint</link> *mount_point);</programlisting>
134
128
<para>
135
129
Frees the resources allocated to the specified <parameter>mount_point</parameter>.
136
 
If <parameter>mount_point</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, this function does nothing.</para>
 
130
If <parameter>mount_point</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, this function does nothing.</para>
137
131
<para>
138
 
 
139
132
</para><variablelist role="params">
140
 
<varlistentry><term><parameter>mount_point</parameter>&nbsp;:</term>
 
133
<varlistentry><term><parameter>mount_point</parameter>&#160;:</term>
141
134
<listitem><simpara> an <link linkend="ExoMountPoint"><type>ExoMountPoint</type></link>.
142
135
</simpara></listitem></varlistentry>
143
 
</variablelist><para role="since">Since  0.3.1.13
144
 
</para></refsect2>
 
136
</variablelist><para role="since">Since 0.3.1.13</para></refsect2>
145
137
<refsect2 id="ExoMountPointMatchMask" role="enum" condition="since:0.3.1.13">
146
138
<title>enum ExoMountPointMatchMask</title>
147
 
<indexterm zone="ExoMountPointMatchMask" role="0.3.1.13"><primary>ExoMountPointMatchMask</primary></indexterm><programlisting>typedef enum /*&lt; skip &gt;*/
 
139
<indexterm zone="ExoMountPointMatchMask" role="0.3.1.13"><primary sortas="ExoMountPointMatchMask">ExoMountPointMatchMask</primary></indexterm><programlisting>typedef enum /*&lt; skip &gt;*/
148
140
{
149
141
  EXO_MOUNT_POINT_MATCH_ACTIVE      = (0L &lt;&lt; 0),
150
142
  EXO_MOUNT_POINT_MATCH_CONFIGURED  = (1L &lt;&lt; 0),
158
150
will be returned. The fewer match options are specified, the more mount
159
151
points will usually match (surprising, eh?).</para>
160
152
<para>
161
 
 
162
153
</para><variablelist role="enum">
163
 
</variablelist><para role="since">Since  0.3.1.13
164
 
</para></refsect2>
 
154
</variablelist><para role="since">Since 0.3.1.13</para></refsect2>
165
155
<refsect2 id="exo-mount-point-list-matched" role="function" condition="since:0.3.1.13">
166
156
<title>exo_mount_point_list_matched ()</title>
167
 
<indexterm zone="exo-mount-point-list-matched" role="0.3.1.13"><primary>exo_mount_point_list_matched</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*             exo_mount_point_list_matched        (<link linkend="ExoMountPointMatchMask">ExoMountPointMatchMask</link> mask,
 
157
<indexterm zone="exo-mount-point-list-matched" role="0.3.1.13"><primary sortas="exo_mount_point_list_matched">exo_mount_point_list_matched</primary></indexterm><programlisting><link linkend="GSList">GSList</link> *            exo_mount_point_list_matched        (<link linkend="ExoMountPointMatchMask">ExoMountPointMatchMask</link> mask,
168
158
                                                         const <link linkend="gchar">gchar</link> *device,
169
159
                                                         const <link linkend="gchar">gchar</link> *folder,
170
160
                                                         const <link linkend="gchar">gchar</link> *fstype,
171
161
                                                         <link linkend="GError">GError</link> **error);</programlisting>
172
162
<para>
173
163
Lists mount points matching the given <parameter>mask</parameter> and optionally the parameters <parameter>device</parameter>,
174
 
<parameter>folder</parameter> and <parameter>fstype</parameter>. If an error occurrs and <parameter>error</parameter> is non-<link linkend="NULL:CAPS"><literal>NULL</literal></link>, the <parameter>error</parameter> will
175
 
be set to point to a <link linkend="GError"><type>GError</type></link> describing the problem, and <link linkend="NULL:CAPS"><literal>NULL</literal></link> will be returned.
176
 
Note, however, that <link linkend="NULL:CAPS"><literal>NULL</literal></link> may also be returned if no mount points match.
 
164
<parameter>folder</parameter> and <parameter>fstype</parameter>. If an error occurrs and <parameter>error</parameter> is non-<link linkend="NULL--CAPS"><literal>NULL</literal></link>, the <parameter>error</parameter> will
 
165
be set to point to a <link linkend="GError"><type>GError</type></link> describing the problem, and <link linkend="NULL--CAPS"><literal>NULL</literal></link> will be returned.
 
166
Note, however, that <link linkend="NULL--CAPS"><literal>NULL</literal></link> may also be returned if no mount points match.
177
167
</para>
178
168
<para>
179
 
If <parameter>mask</parameter> includes <link linkend="EXO-MOUNT-POINT-MATCH-ACTIVE:CAPS"><literal>EXO_MOUNT_POINT_MATCH_ACTIVE</literal></link>, the currently active mount points will
 
169
If <parameter>mask</parameter> includes <link linkend="EXO-MOUNT-POINT-MATCH-ACTIVE--CAPS"><literal>EXO_MOUNT_POINT_MATCH_ACTIVE</literal></link>, the currently active mount points will
180
170
be matched, that is, the currently mounted file systems, queried from the kernel. Otherwise
181
 
if <link linkend="EXO-MOUNT-POINT-MATCH-CONFIGURED:CAPS"><literal>EXO_MOUNT_POINT_MATCH_CONFIGURED</literal></link> is specified, the configured mount points from the
 
171
if <link linkend="EXO-MOUNT-POINT-MATCH-CONFIGURED--CAPS"><literal>EXO_MOUNT_POINT_MATCH_CONFIGURED</literal></link> is specified, the configured mount points from the
182
172
file system table (usually <filename>/etc/fstab</filename> or <filename>/etc/vfstab</filename>)
183
173
will be matched.
184
174
</para>
190
180
</programlisting></informalexample>
191
181
when no longer needed.</para>
192
182
<para>
193
 
 
194
183
</para><variablelist role="params">
195
 
<varlistentry><term><parameter>mask</parameter>&nbsp;:</term>
 
184
<varlistentry><term><parameter>mask</parameter>&#160;:</term>
196
185
<listitem><simpara> the mask of flags that have to match for a mount point to be returned.
197
186
</simpara></listitem></varlistentry>
198
 
<varlistentry><term><parameter>device</parameter>&nbsp;:</term>
199
 
<listitem><simpara> the device file to match if <link linkend="EXO-MOUNT-POINT-MATCH-DEVICE:CAPS"><literal>EXO_MOUNT_POINT_MATCH_DEVICE</literal></link> is specified.
200
 
</simpara></listitem></varlistentry>
201
 
<varlistentry><term><parameter>folder</parameter>&nbsp;:</term>
202
 
<listitem><simpara> the folder to match if <link linkend="EXO-MOUNT-POINT-MATCH-FOLDER:CAPS"><literal>EXO_MOUNT_POINT_MATCH_FOLDER</literal></link> is specified.
203
 
</simpara></listitem></varlistentry>
204
 
<varlistentry><term><parameter>fstype</parameter>&nbsp;:</term>
205
 
<listitem><simpara> the file system type to match if <link linkend="EXO-MOUNT-POINT-MATCH-FSTYPE:CAPS"><literal>EXO_MOUNT_POINT_MATCH_FSTYPE</literal></link> is specified.
206
 
</simpara></listitem></varlistentry>
207
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
208
 
<listitem><simpara> return location for errors or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
209
 
</simpara></listitem></varlistentry>
210
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the list of matching <link linkend="ExoMountPoint"><type>ExoMountPoint</type></link><!---->s.
 
187
<varlistentry><term><parameter>device</parameter>&#160;:</term>
 
188
<listitem><simpara> the device file to match if <link linkend="EXO-MOUNT-POINT-MATCH-DEVICE--CAPS"><literal>EXO_MOUNT_POINT_MATCH_DEVICE</literal></link> is specified.
 
189
</simpara></listitem></varlistentry>
 
190
<varlistentry><term><parameter>folder</parameter>&#160;:</term>
 
191
<listitem><simpara> the folder to match if <link linkend="EXO-MOUNT-POINT-MATCH-FOLDER--CAPS"><literal>EXO_MOUNT_POINT_MATCH_FOLDER</literal></link> is specified.
 
192
</simpara></listitem></varlistentry>
 
193
<varlistentry><term><parameter>fstype</parameter>&#160;:</term>
 
194
<listitem><simpara> the file system type to match if <link linkend="EXO-MOUNT-POINT-MATCH-FSTYPE--CAPS"><literal>EXO_MOUNT_POINT_MATCH_FSTYPE</literal></link> is specified.
 
195
</simpara></listitem></varlistentry>
 
196
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
197
<listitem><simpara> return location for errors or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
 
198
</simpara></listitem></varlistentry>
 
199
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the list of matching <link linkend="ExoMountPoint"><type>ExoMountPoint</type></link><!---->s.
211
200
 
212
201
</simpara></listitem></varlistentry>
213
 
</variablelist><para role="since">Since  0.3.1.13
214
 
</para></refsect2>
 
202
</variablelist><para role="since">Since 0.3.1.13</para></refsect2>
215
203
<refsect2 id="exo-mount-point-list-active" role="macro" condition="since:0.3.1.13">
216
204
<title>exo_mount_point_list_active()</title>
217
 
<indexterm zone="exo-mount-point-list-active" role="0.3.1.13"><primary>exo_mount_point_list_active</primary></indexterm><programlisting>#define             exo_mount_point_list_active(error)</programlisting>
 
205
<indexterm zone="exo-mount-point-list-active" role="0.3.1.13"><primary sortas="exo_mount_point_list_active">exo_mount_point_list_active</primary></indexterm><programlisting>#define             exo_mount_point_list_active(error)</programlisting>
218
206
<para>
219
207
Convenience wrapper for <link linkend="exo-mount-point-list-matched"><function>exo_mount_point_list_matched()</function></link>, that returns the
220
 
currently active mount points, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> in case of an error.
 
208
currently active mount points, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> in case of an error.
221
209
</para>
222
210
<para>
223
211
The caller is responsible to free the returned list using
227
215
</programlisting></informalexample>
228
216
when no longer needed.</para>
229
217
<para>
230
 
 
231
218
</para><variablelist role="params">
232
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
233
 
<listitem><simpara> return location for errors or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
 
219
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
220
<listitem><simpara> return location for errors or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
234
221
</simpara></listitem></varlistentry>
235
 
</variablelist><para role="since">Since  0.3.1.13
236
 
</para></refsect2>
 
222
</variablelist><para role="since">Since 0.3.1.13</para></refsect2>
237
223
<refsect2 id="exo-mount-point-list-configured" role="macro" condition="since:0.3.1.13">
238
224
<title>exo_mount_point_list_configured()</title>
239
 
<indexterm zone="exo-mount-point-list-configured" role="0.3.1.13"><primary>exo_mount_point_list_configured</primary></indexterm><programlisting>#define             exo_mount_point_list_configured(error)</programlisting>
 
225
<indexterm zone="exo-mount-point-list-configured" role="0.3.1.13"><primary sortas="exo_mount_point_list_configured">exo_mount_point_list_configured</primary></indexterm><programlisting>#define             exo_mount_point_list_configured(error)</programlisting>
240
226
<para>
241
227
Convenience wrapper for <link linkend="exo-mount-point-list-matched"><function>exo_mount_point_list_matched()</function></link>, that returns the
242
228
configured mount points, i.e. the entries from the file system table (which
250
236
</programlisting></informalexample>
251
237
when no longer needed.</para>
252
238
<para>
253
 
 
254
239
</para><variablelist role="params">
255
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
256
 
<listitem><simpara> return location for errors or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
 
240
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
241
<listitem><simpara> return location for errors or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
257
242
</simpara></listitem></varlistentry>
258
 
</variablelist><para role="since">Since  0.3.1.13
259
 
</para></refsect2>
 
243
</variablelist><para role="since">Since 0.3.1.13</para></refsect2>
260
244
 
261
245
</refsect1>
262
246