|
Server : Apache/2.2.2 (Fedora) System : Linux App1.pathumtani.go.th 2.6.20-1.2320.fc5smp #1 SMP Tue Jun 12 19:40:16 EDT 2007 i686 User : apache ( 48) PHP Version : 5.2.9 Disable Function : NONE Directory : /usr/share/gtk-doc/html/libuser/ |
Upload File : |
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>quota</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="libuser Reference Manual">
<link rel="up" href="ch01.html" title="libuser">
<link rel="prev" href="libuser-prompt.html" title="prompt">
<link rel="next" href="libuser-user.html" title="user">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="libuser">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libuser-prompt.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">libuser Reference Manual</th>
<td><a accesskey="n" href="libuser-user.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry" lang="en">
<a name="libuser-quota"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">quota</span></h2>
<p>quota — Functions for manipulating disk quotas.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
int <a href="libuser-quota.html#quota-on">quota_on</a> (void);
int <a href="libuser-quota.html#quota-off">quota_off</a> (void);
char** <a href="libuser-quota.html#quota-get-specials-user">quota_get_specials_user</a> (void);
char** <a href="libuser-quota.html#quota-get-specials-group">quota_get_specials_group</a> (void);
void <a href="libuser-quota.html#quota-free-specials">quota_free_specials</a> (char **specials);
int <a href="libuser-quota.html#quota-get-user">quota_get_user</a> (uid_t uid,
const char *special,
int32_t *inode_usage,
int32_t *inode_soft,
int32_t *inode_hard,
int32_t *inode_grace,
int32_t *block_usage,
int32_t *block_soft,
int32_t *block_hard,
int32_t *block_grace);
int <a href="libuser-quota.html#quota-set-user">quota_set_user</a> (uid_t uid,
const char *special,
int32_t inode_soft,
int32_t inode_hard,
int32_t inode_grace,
int32_t block_soft,
int32_t block_hard,
int32_t block_grace);
int <a href="libuser-quota.html#quota-get-group">quota_get_group</a> (gid_t gid,
const char *special,
int32_t *inode_usage,
int32_t *inode_soft,
int32_t *inode_hard,
int32_t *inode_grace,
int32_t *block_usage,
int32_t *block_soft,
int32_t *block_hard,
int32_t *block_grace);
int <a href="libuser-quota.html#quota-set-group">quota_set_group</a> (gid_t gid,
const char *special,
int32_t inode_soft,
int32_t inode_hard,
int32_t inode_grace,
int32_t block_soft,
int32_t block_hard,
int32_t block_grace);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2536143"></a><h2>Description</h2>
<p>
quota.h declares functions which are useful for querying and manipulating
user and group disk quotas under Linux. These routines are not portable
to other operating systems.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2536156"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2536162"></a><h3>
<a name="quota-on"></a>quota_on ()</h3>
<a class="indexterm" name="id2536172"></a><pre class="programlisting">int quota_on (void);</pre>
<p>
Enables enforcing quotas on filesystems where quotas are configured.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>0 on success, -1 on error
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2536209"></a><h3>
<a name="quota-off"></a>quota_off ()</h3>
<a class="indexterm" name="id2536219"></a><pre class="programlisting">int quota_off (void);</pre>
<p>
Disables enforcing quotas on filesystems where quotas are configured.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>0 on success, -1 on error
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2536256"></a><h3>
<a name="quota-get-specials-user"></a>quota_get_specials_user ()</h3>
<a class="indexterm" name="id2536266"></a><pre class="programlisting">char** quota_get_specials_user (void);</pre>
<p>
Gets a list of currently mounted filesystems which have user quotas enabled.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>If sucessful, a <code class="literal">NULL</code>-terminated array of device names that should
be freed by <a href="libuser-quota.html#quota-free-specials"><code class="function">quota_free_specials()</code></a>. On error returns <code class="literal">NULL</code>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2536328"></a><h3>
<a name="quota-get-specials-group"></a>quota_get_specials_group ()</h3>
<a class="indexterm" name="id2536339"></a><pre class="programlisting">char** quota_get_specials_group (void);</pre>
<p>
Gets a list of currently mounted filesystems which have group quotas enabled.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>If sucessful, a <code class="literal">NULL</code>-terminated array of device names that should
be freed by <a href="libuser-quota.html#quota-free-specials"><code class="function">quota_free_specials()</code></a>. On error returns <code class="literal">NULL</code>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2536401"></a><h3>
<a name="quota-free-specials"></a>quota_free_specials ()</h3>
<a class="indexterm" name="id2536411"></a><pre class="programlisting">void quota_free_specials (char **specials);</pre>
<p>
Frees the array returned by <a href="libuser-quota.html#quota-get-specials-user"><code class="function">quota_get_specials_user()</code></a> or
<a href="libuser-quota.html#quota-get-specials-group"><code class="function">quota_get_specials_group()</code></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>specials</code></em> :</span></td>
<td>array to be freed
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2536480"></a><h3>
<a name="quota-get-user"></a>quota_get_user ()</h3>
<a class="indexterm" name="id2536490"></a><pre class="programlisting">int quota_get_user (uid_t uid,
const char *special,
int32_t *inode_usage,
int32_t *inode_soft,
int32_t *inode_hard,
int32_t *inode_grace,
int32_t *block_usage,
int32_t *block_soft,
int32_t *block_hard,
int32_t *block_grace);</pre>
<p>
Gets information about user quota on a device.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>uid</code></em> :</span></td>
<td>UID to get information about
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>special</code></em> :</span></td>
<td>block device name
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>inode_usage</code></em> :</span></td>
<td>number of used inodes
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>inode_soft</code></em> :</span></td>
<td>soft inode limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>inode_hard</code></em> :</span></td>
<td>hard inode limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>inode_grace</code></em> :</span></td>
<td>inode grace time in seconds
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>block_usage</code></em> :</span></td>
<td>number of used blocks (each block is 1 kB)
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>block_soft</code></em> :</span></td>
<td>soft block limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>block_hard</code></em> :</span></td>
<td>hard block limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>block_grace</code></em> :</span></td>
<td>block grace time in seconds
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>0 on success, -1 on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2536744"></a><h3>
<a name="quota-set-user"></a>quota_set_user ()</h3>
<a class="indexterm" name="id2536754"></a><pre class="programlisting">int quota_set_user (uid_t uid,
const char *special,
int32_t inode_soft,
int32_t inode_hard,
int32_t inode_grace,
int32_t block_soft,
int32_t block_hard,
int32_t block_grace);</pre>
<p>
Sets user quota on a device.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>uid</code></em> :</span></td>
<td>UID to get information about
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>special</code></em> :</span></td>
<td>block device name
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>inode_soft</code></em> :</span></td>
<td>soft inode limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>inode_hard</code></em> :</span></td>
<td>hard inode limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>inode_grace</code></em> :</span></td>
<td>inode grace time in seconds
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>block_soft</code></em> :</span></td>
<td>soft block limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>block_hard</code></em> :</span></td>
<td>hard block limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>block_grace</code></em> :</span></td>
<td>block grace time in seconds
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>0 on success, -1 on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2536963"></a><h3>
<a name="quota-get-group"></a>quota_get_group ()</h3>
<a class="indexterm" name="id2536973"></a><pre class="programlisting">int quota_get_group (gid_t gid,
const char *special,
int32_t *inode_usage,
int32_t *inode_soft,
int32_t *inode_hard,
int32_t *inode_grace,
int32_t *block_usage,
int32_t *block_soft,
int32_t *block_hard,
int32_t *block_grace);</pre>
<p>
Gets information about group quota on a device.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>gid</code></em> :</span></td>
<td>GID to get information about
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>special</code></em> :</span></td>
<td>block device name
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>inode_usage</code></em> :</span></td>
<td>number of used inodes
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>inode_soft</code></em> :</span></td>
<td>soft inode limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>inode_hard</code></em> :</span></td>
<td>hard inode limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>inode_grace</code></em> :</span></td>
<td>inode grace time in seconds
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>block_usage</code></em> :</span></td>
<td>number of used blocks (each block is 1 kB)
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>block_soft</code></em> :</span></td>
<td>soft block limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>block_hard</code></em> :</span></td>
<td>hard block limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>block_grace</code></em> :</span></td>
<td>block grace time in seconds
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>0 on success, -1 on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2537227"></a><h3>
<a name="quota-set-group"></a>quota_set_group ()</h3>
<a class="indexterm" name="id2537237"></a><pre class="programlisting">int quota_set_group (gid_t gid,
const char *special,
int32_t inode_soft,
int32_t inode_hard,
int32_t inode_grace,
int32_t block_soft,
int32_t block_hard,
int32_t block_grace);</pre>
<p>
Sets group quota on a device.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>gid</code></em> :</span></td>
<td>GID to get information about
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>special</code></em> :</span></td>
<td>block device name
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>inode_soft</code></em> :</span></td>
<td>soft inode limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>inode_hard</code></em> :</span></td>
<td>hard inode limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>inode_grace</code></em> :</span></td>
<td>inode grace time in seconds
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>block_soft</code></em> :</span></td>
<td>soft block limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>block_hard</code></em> :</span></td>
<td>hard block limit
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>block_grace</code></em> :</span></td>
<td>block grace time in seconds
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>0 on success, -1 on failure
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libuser-prompt.html"><b><< prompt</b></a></td>
<td align="right"><a accesskey="n" href="libuser-user.html"><b>user >></b></a></td>
</tr></table>
</body>
</html>