Debian Codegraph @

doc/reference/html/OobsShareNFS.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>OobsShareNFS</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="Liboobs (System configuration management) Reference Manual">
8 <link rel="up" href="ch03.html" title="Shared folders management">
9 <link rel="prev" href="OobsShare.html" title="OobsShare">
10 <link rel="next" href="OobsShareSMB.html" title="OobsShareSMB">
11 <meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="OobsShare.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Liboobs (System configuration management) Reference Manual</th>
21 <td><a accesskey="n" href="OobsShareSMB.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#OobsShareNFS.synopsis" class="shortcut">Top</a>
25  | 
26 <a href="#OobsShareNFS.description" class="shortcut">Description</a>
27  | 
28 <a href="#OobsShareNFS.object-hierarchy" class="shortcut">Object Hierarchy</a>
29 </td></tr>
30 </table>
31 <div class="refentry" title="OobsShareNFS">
32 <a name="OobsShareNFS"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
34 <td valign="top">
35 <h2><span class="refentrytitle"><a name="OobsShareNFS.top_of_page"></a>OobsShareNFS</span></h2>
36 <p>OobsShareNFS — Object that represents NFS configuration</p>
37 </td>
38 <td valign="top" align="right"></td>
39 </tr></table></div>
40 <div class="refsynopsisdiv" title="Synopsis">
41 <a name="OobsShareNFS.synopsis"></a><h2>Synopsis</h2>
42 <pre class="synopsis"> <a class="link" href="OobsShareNFS.html#OobsShareNFS-struct" title="OobsShareNFS">OobsShareNFS</a>;
43 <a class="link" href="OobsShareNFS.html#OobsShareNFSClass" title="OobsShareNFSClass">OobsShareNFSClass</a>;
44 <a class="link" href="OobsShareNFS.html#OobsShareAclElement" title="OobsShareAclElement">OobsShareAclElement</a>;
45 <a class="link" href="OobsShare.html" title="OobsShare"><span class="returnvalue">OobsShare</span></a>* <a class="link" href="OobsShareNFS.html#oobs-share-nfs-new" title="oobs_share_nfs_new ()">oobs_share_nfs_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);
46 <span class="returnvalue">void</span> <a class="link" href="OobsShareNFS.html#oobs-share-nfs-add-acl-element" title="oobs_share_nfs_add_acl_element ()">oobs_share_nfs_add_acl_element</a> (<em class="parameter"><code><a class="link" href="OobsShareNFS.html" title="OobsShareNFS"><span class="type">OobsShareNFS</span></a> *share</code></em>,
47 <em class="parameter"><code>const <span class="type">gchar</span> *element</code></em>,
48 <em class="parameter"><code><span class="type">gboolean</span> read_only</code></em>);
49 <span class="returnvalue">void</span> <a class="link" href="OobsShareNFS.html#oobs-share-nfs-set-acl" title="oobs_share_nfs_set_acl ()">oobs_share_nfs_set_acl</a> (<em class="parameter"><code><a class="link" href="OobsShareNFS.html" title="OobsShareNFS"><span class="type">OobsShareNFS</span></a> *share</code></em>,
50 <em class="parameter"><code><span class="type">GSList</span> *acl</code></em>);
51 <span class="returnvalue">GSList</span>* <a class="link" href="OobsShareNFS.html#oobs-share-nfs-get-acl" title="oobs_share_nfs_get_acl ()">oobs_share_nfs_get_acl</a> (<em class="parameter"><code><a class="link" href="OobsShareNFS.html" title="OobsShareNFS"><span class="type">OobsShareNFS</span></a> *share</code></em>);
52 </pre>
53 </div>
54 <div class="refsect1" title="Object Hierarchy">
55 <a name="OobsShareNFS.object-hierarchy"></a><h2>Object Hierarchy</h2>
56 <pre class="synopsis">
57 GObject
58 +----<a class="link" href="OobsShare.html" title="OobsShare">OobsShare</a>
59 +----OobsShareNFS
60 </pre>
61 </div>
62 <div class="refsect1" title="Description">
63 <a name="OobsShareNFS.description"></a><h2>Description</h2>
64 </div>
65 <div class="refsect1" title="Details">
66 <a name="OobsShareNFS.details"></a><h2>Details</h2>
67 <div class="refsect2" title="OobsShareNFS">
68 <a name="OobsShareNFS-struct"></a><h3>OobsShareNFS</h3>
69 <pre class="programlisting">typedef struct _OobsShareNFS OobsShareNFS;</pre>
70 <p>
71 </p>
72 </div>
73 <hr>
74 <div class="refsect2" title="OobsShareNFSClass">
75 <a name="OobsShareNFSClass"></a><h3>OobsShareNFSClass</h3>
76 <pre class="programlisting">typedef struct {
77 OobsShareClass parent_class;
78
79 void (*_oobs_padding1) (void);
80 void (*_oobs_padding2) (void);
81 } OobsShareNFSClass;
82 </pre>
83 <p>
84 </p>
85 </div>
86 <hr>
87 <div class="refsect2" title="OobsShareAclElement">
88 <a name="OobsShareAclElement"></a><h3>OobsShareAclElement</h3>
89 <pre class="programlisting">typedef struct {
90 gchar *element;
91 gboolean read_only;
92 } OobsShareAclElement;
93 </pre>
94 <p>
95 </p>
96 </div>
97 <hr>
98 <div class="refsect2" title="oobs_share_nfs_new ()">
99 <a name="oobs-share-nfs-new"></a><h3>oobs_share_nfs_new ()</h3>
100 <pre class="programlisting"><a class="link" href="OobsShare.html" title="OobsShare"><span class="returnvalue">OobsShare</span></a>* oobs_share_nfs_new (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre>
101 <p>
102 Returns a new NFS share for the given path.
103 </p>
104 <div class="variablelist"><table border="0">
105 <col align="left" valign="top">
106 <tbody>
107 <tr>
108 <td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
109 <td>share path.
110 </td>
111 </tr>
112 <tr>
113 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
114 <td> A newly allocated <a class="link" href="OobsShareNFS.html" title="OobsShareNFS"><span class="type">OobsShareNFS</span></a>.
115 </td>
116 </tr>
117 </tbody>
118 </table></div>
119 </div>
120 <hr>
121 <div class="refsect2" title="oobs_share_nfs_add_acl_element ()">
122 <a name="oobs-share-nfs-add-acl-element"></a><h3>oobs_share_nfs_add_acl_element ()</h3>
123 <pre class="programlisting"><span class="returnvalue">void</span> oobs_share_nfs_add_acl_element (<em class="parameter"><code><a class="link" href="OobsShareNFS.html" title="OobsShareNFS"><span class="type">OobsShareNFS</span></a> *share</code></em>,
124 <em class="parameter"><code>const <span class="type">gchar</span> *element</code></em>,
125 <em class="parameter"><code><span class="type">gboolean</span> read_only</code></em>);</pre>
126 <p>
127 Adds an ACL entry for a host, <em class="parameter"><code>element</code></em> may be a host name,
128 an IP address or a combination in the form "IP address/Network mask".
129 </p>
130 <div class="variablelist"><table border="0">
131 <col align="left" valign="top">
132 <tbody>
133 <tr>
134 <td><p><span class="term"><em class="parameter"><code>share</code></em> :</span></p></td>
135 <td>An <a class="link" href="OobsShareNFS.html" title="OobsShareNFS"><span class="type">OobsShareNFS</span></a>.
136 </td>
137 </tr>
138 <tr>
139 <td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
140 <td>Host in the share ACL.
141 </td>
142 </tr>
143 <tr>
144 <td><p><span class="term"><em class="parameter"><code>read_only</code></em> :</span></p></td>
145 <td>Whether the share is read only for the element.
146 </td>
147 </tr>
148 </tbody>
149 </table></div>
150 </div>
151 <hr>
152 <div class="refsect2" title="oobs_share_nfs_set_acl ()">
153 <a name="oobs-share-nfs-set-acl"></a><h3>oobs_share_nfs_set_acl ()</h3>
154 <pre class="programlisting"><span class="returnvalue">void</span> oobs_share_nfs_set_acl (<em class="parameter"><code><a class="link" href="OobsShareNFS.html" title="OobsShareNFS"><span class="type">OobsShareNFS</span></a> *share</code></em>,
155 <em class="parameter"><code><span class="type">GSList</span> *acl</code></em>);</pre>
156 <p>
157 Overwrites the list of ACL entries for the share. The previous list and its
158 contents will be free, so any merging will have to be done by hand.
159 Alternatively, you can use <a class="link" href="OobsShareNFS.html#oobs-share-nfs-add-acl-element" title="oobs_share_nfs_add_acl_element ()"><code class="function">oobs_share_nfs_add_acl_element()</code></a>.
160 </p>
161 <div class="variablelist"><table border="0">
162 <col align="left" valign="top">
163 <tbody>
164 <tr>
165 <td><p><span class="term"><em class="parameter"><code>share</code></em> :</span></p></td>
166 <td>An <a class="link" href="OobsShareNFS.html" title="OobsShareNFS"><span class="type">OobsShareNFS</span></a>.
167 </td>
168 </tr>
169 <tr>
170 <td><p><span class="term"><em class="parameter"><code>acl</code></em> :</span></p></td>
171 <td>A <span class="type">GList</span> of <a class="link" href="OobsShareNFS.html#OobsShareAclElement" title="OobsShareAclElement"><span class="type">OobsShareAclElement</span></a>.
172 </td>
173 </tr>
174 </tbody>
175 </table></div>
176 </div>
177 <hr>
178 <div class="refsect2" title="oobs_share_nfs_get_acl ()">
179 <a name="oobs-share-nfs-get-acl"></a><h3>oobs_share_nfs_get_acl ()</h3>
180 <pre class="programlisting"><span class="returnvalue">GSList</span>* oobs_share_nfs_get_acl (<em class="parameter"><code><a class="link" href="OobsShareNFS.html" title="OobsShareNFS"><span class="type">OobsShareNFS</span></a> *share</code></em>);</pre>
181 <p>
182 Returns the ACL defined for this share.
183 </p>
184 <div class="variablelist"><table border="0">
185 <col align="left" valign="top">
186 <tbody>
187 <tr>
188 <td><p><span class="term"><em class="parameter"><code>share</code></em> :</span></p></td>
189 <td>An <a class="link" href="OobsShareNFS.html" title="OobsShareNFS"><span class="type">OobsShareNFS</span></a>.
190 </td>
191 </tr>
192 <tr>
193 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
194 <td> A <span class="type">GList</span> containing <a class="link" href="OobsShareNFS.html#OobsShareAclElement" title="OobsShareAclElement"><span class="type">OobsShareAclElement</span></a> structs,
195 this list must be freed with <code class="function">g_list_free()</code>.
196 </td>
197 </tr>
198 </tbody>
199 </table></div>
200 </div>
201 </div>
202 <div class="refsect1" title="See Also">
203 <a name="OobsShareNFS.see-also"></a><h2>See Also</h2>
204 <a class="link" href="OobsShare.html" title="OobsShare"><span class="type">OobsShare</span></a>, <a class="link" href="OobsNFSConfig.html" title="OobsNFSConfig"><span class="type">OobsNFSConfig</span></a>
205 </div>
206 </div>
207 <div class="footer">
208 <hr>
209 Generated by GTK-Doc V1.15</div>
210 </body>
211 </html>