1
1
<refentry id="libuser-quota">
3
<refentrytitle>quota</refentrytitle>
3
<refentrytitle id="top_of_page">quota</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>LIBUSER Library</refmiscinfo>
9
<refname>quota</refname><refpurpose>Functions for manipulating disk quotas.</refpurpose>
9
<refname>quota</refname>
10
<refpurpose>Functions for manipulating disk quotas.</refpurpose>
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
<refsynopsisdiv><title>Synopsis</title>
14
<refsynopsisdiv id="synopsis">
15
<title id="synopsis.title">Synopsis</title>
71
<title>Description</title>
74
<title id="desc.title">Description</title>
73
76
quota.h declares functions which are useful for querying and manipulating
74
77
user and group disk quotas under Linux. These routines are not portable
80
<title>Details</title>
82
<refsect1 id="details">
83
<title id="details.title">Details</title>
82
<title><anchor id="quota-on"/>quota_on ()</title>
85
<title><anchor id="quota-on" role="function"/>quota_on ()</title>
83
86
<indexterm><primary>quota_on</primary></indexterm><programlisting><link linkend="int">int</link> quota_on (void);</programlisting>
85
88
Enables enforcing quotas on filesystems where quotas are configured.
90
93
</simpara></listitem></varlistentry>
91
94
</variablelist></refsect2>
93
<title><anchor id="quota-off"/>quota_off ()</title>
96
<title><anchor id="quota-off" role="function"/>quota_off ()</title>
94
97
<indexterm><primary>quota_off</primary></indexterm><programlisting><link linkend="int">int</link> quota_off (void);</programlisting>
96
99
Disables enforcing quotas on filesystems where quotas are configured.
101
104
</simpara></listitem></varlistentry>
102
105
</variablelist></refsect2>
104
<title><anchor id="quota-get-specials-user"/>quota_get_specials_user ()</title>
107
<title><anchor id="quota-get-specials-user" role="function"/>quota_get_specials_user ()</title>
105
108
<indexterm><primary>quota_get_specials_user</primary></indexterm><programlisting><link linkend="char">char</link>** quota_get_specials_user (void);</programlisting>
107
110
Gets a list of currently mounted filesystems which have user quotas enabled.
108
111
</para><variablelist role="params">
109
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>If sucessful, a <literal>NULL</literal>-terminated array of device names that should
110
be freed by <link linkend="quota-free-specials"><function>quota_free_specials()</function></link>. On error returns <literal>NULL</literal>.
112
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>If sucessful, a <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated array of device names that should
113
be freed by <link linkend="quota-free-specials"><function>quota_free_specials()</function></link>. On error returns <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
113
116
</simpara></listitem></varlistentry>
114
117
</variablelist></refsect2>
116
<title><anchor id="quota-get-specials-group"/>quota_get_specials_group ()</title>
119
<title><anchor id="quota-get-specials-group" role="function"/>quota_get_specials_group ()</title>
117
120
<indexterm><primary>quota_get_specials_group</primary></indexterm><programlisting><link linkend="char">char</link>** quota_get_specials_group (void);</programlisting>
119
122
Gets a list of currently mounted filesystems which have group quotas enabled.
120
123
</para><variablelist role="params">
121
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>If sucessful, a <literal>NULL</literal>-terminated array of device names that should
122
be freed by <link linkend="quota-free-specials"><function>quota_free_specials()</function></link>. On error returns <literal>NULL</literal>.
124
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>If sucessful, a <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated array of device names that should
125
be freed by <link linkend="quota-free-specials"><function>quota_free_specials()</function></link>. On error returns <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
125
128
</simpara></listitem></varlistentry>
126
129
</variablelist></refsect2>
128
<title><anchor id="quota-free-specials"/>quota_free_specials ()</title>
131
<title><anchor id="quota-free-specials" role="function"/>quota_free_specials ()</title>
129
132
<indexterm><primary>quota_free_specials</primary></indexterm><programlisting><link linkend="void">void</link> quota_free_specials (<link linkend="char">char</link> **specials);</programlisting>
131
134
Frees the array returned by <link linkend="quota-get-specials-user"><function>quota_get_specials_user()</function></link> or
138
141
</simpara></listitem></varlistentry>
139
142
</variablelist></refsect2>
141
<title><anchor id="quota-get-user"/>quota_get_user ()</title>
144
<title><anchor id="quota-get-user" role="function"/>quota_get_user ()</title>
142
145
<indexterm><primary>quota_get_user</primary></indexterm><programlisting><link linkend="int">int</link> quota_get_user (<link linkend="uid-t">uid_t</link> uid,
143
146
const <link linkend="char">char</link> *special,
144
147
<link linkend="int32-t">int32_t</link> *inode_usage,
188
191
</simpara></listitem></varlistentry>
189
192
</variablelist></refsect2>
191
<title><anchor id="quota-set-user"/>quota_set_user ()</title>
194
<title><anchor id="quota-set-user" role="function"/>quota_set_user ()</title>
192
195
<indexterm><primary>quota_set_user</primary></indexterm><programlisting><link linkend="int">int</link> quota_set_user (<link linkend="uid-t">uid_t</link> uid,
193
196
const <link linkend="char">char</link> *special,
194
197
<link linkend="int32-t">int32_t</link> inode_soft,
230
233
</simpara></listitem></varlistentry>
231
234
</variablelist></refsect2>
233
<title><anchor id="quota-get-group"/>quota_get_group ()</title>
236
<title><anchor id="quota-get-group" role="function"/>quota_get_group ()</title>
234
237
<indexterm><primary>quota_get_group</primary></indexterm><programlisting><link linkend="int">int</link> quota_get_group (<link linkend="gid-t">gid_t</link> gid,
235
238
const <link linkend="char">char</link> *special,
236
239
<link linkend="int32-t">int32_t</link> *inode_usage,
280
283
</simpara></listitem></varlistentry>
281
284
</variablelist></refsect2>
283
<title><anchor id="quota-set-group"/>quota_set_group ()</title>
286
<title><anchor id="quota-set-group" role="function"/>quota_set_group ()</title>
284
287
<indexterm><primary>quota_set_group</primary></indexterm><programlisting><link linkend="int">int</link> quota_set_group (<link linkend="gid-t">gid_t</link> gid,
285
288
const <link linkend="char">char</link> *special,
286
289
<link linkend="int32-t">int32_t</link> inode_soft,
added
removed
docs/reference/xml/quota.xml
