One Hat Cyber Team

Edit File: mod_ratio.html

<!DOCTYPE html>
<html>
<head>
<title>ProFTPD module mod_ratio</title>
</head>

<hr>
<center>
<h2>ProFTPD module <code>mod_ratio</code></h2>
</center>
<hr>

The <code>mod_ratio</code> module

This module is contained in the <code>mod_ratio.c</code> file for
ProFTPD 1.3.x, and is not compiled by default. Installation
instructions are discussed <a href="#Installation">here</a>; a discussion
on <a href="#Usage">usage</a> is also available.

The most current version of <code>mod_ratio</code> is distributed with the
ProFTPD source code.

<h2>Author</h2>

Please contact TJ Saunders &lt;tj at castaglia.org&gt; with any
questions, concerns, or suggestions regarding this module.

<h2>Directives</h2>
<ul>
 <li><a href="#AnonRatio">AnonRatio</a>
 <li><a href="#ByteRatioErrMsg">ByteRatioErrMsg</a>
 <li><a href="#CwdRatioMsg">CwdRatioMsg</a>
 <li><a href="#FileRatioErrMsg">FileRatioErrMsg</a>
 <li><a href="#GroupRatio">GroupRatio</a>
 <li><a href="#HostRatio">HostRatio</a>
 <li><a href="#LeechRatioMsg">LeechRatioMsg</a>
 <li><a href="#RatioFile">RatioFile</a>
 <li><a href="#Ratios">Ratios</a>
 <li><a href="#RatioTempFile">RatioTempFile</a>
 <li><a href="#SaveRatios">Ratios</a>
 <li><a href="#UserRatio">UserRatio</a>
</ul>

<hr>
<h3><a name="AnonRatio">AnonRatio</a></h3>
Syntax: AnonRatio name file-ratio file-credit byte-ratio byte-credit 
Default: None 
Context: server config, &lt;VirtualHost&gt;, &lt;Global&gt;, &lt;Directory&gt;, &lt;Anonymous&gt; 
Module: mod_ratio 
Compatibility: 1.2.2 and later

The <code>AnonRatio</code> directive

<hr>
<h3><a name="ByteRatioErrMsg">ByteRatioErrMsg</a></h3>
Syntax: ByteRatioErrMsg message 
Default: None 
Context: server config, &lt;VirtualHost&gt;, &lt;Global&gt;, &lt;Directory&gt;, &lt;Anonymous&gt; 
Module: mod_ratio 
Compatibility: 1.2.2 and later

The <code>ByteRatioErrMsg</code> directive

<hr>
<h3><a name="CwdRatioMsg">CwdRatioMsg</a></h3>
Syntax: CwdRatioMsg message 
Default: None 
Context: server config, &lt;VirtualHost&gt;, &lt;Global&gt;, &lt;Directory&gt;, &lt;Anonymous&gt; 
Module: mod_ratio 
Compatibility: 1.2.2 and later

The <code>CwdRatioMsg</code> directive

<hr>
<h3><a name="FileRatioErrMsg">FileRatioErrMsg</a></h3>
Syntax: FileRatioErrMsg message 
Default: None 
Context: server config, &lt;VirtualHost&gt;, &lt;Global&gt;, &lt;Directory&gt;, &lt;Anonymous&gt; 
Module: mod_ratio 
Compatibility: 1.2.2 and later

The <code>FileRatioErrMsg</code> directive

<hr>
<h3><a name="GroupRatio">GroupRatio</a></h3>
Syntax: GroupRatio name file-ratio file-credit byte-ratio byte-credit 
Default: None 
Context: server config, &lt;VirtualHost&gt;, &lt;Global&gt;, &lt;Directory&gt;, &lt;Anonymous&gt; 
Module: mod_ratio 
Compatibility: 1.2.2 and later

The <code>GroupRatio</code> directive

<hr>
<h3><a name="HostRatio">HostRatio</a></h3>
Syntax: HostRatio name file-ratio file-credit byte-ratio byte-credit 
Default: None 
Context: server config, &lt;VirtualHost&gt;, &lt;Global&gt;, &lt;Directory&gt;, &lt;Anonymous&gt; 
Module: mod_ratio 
Compatibility: 1.2.2 and later

The <code>HostRatio</code> directive

<hr>
<h3><a name="LeechRatioMsg">LeechRatioMsg</a></h3>
Syntax: LeechRatioMsg message 
Default: None 
Context: server config, &lt;VirtualHost&gt;, &lt;Global&gt;, &lt;Directory&gt;, &lt;Anonymous&gt; 
Module: mod_ratio 
Compatibility: 1.2.2 and later

The <code>LeechRatioMsg</code> directive

<hr>
<h3><a name="RatioFile">RatioFile</a></h3>
Syntax: RatioFile path 
Default: None 
Context: server config, &lt;VirtualHost&gt;, &lt;Global&gt;, &lt;Directory&gt;, &lt;Anonymous&gt; 
Module: mod_ratio 
Compatibility: 1.2.2 and later

The <code>RatioFile</code> directive

<hr>
<h3><a name="Ratios">Ratios</a></h3>
Syntax: Ratios on|off 
Default: Off 
Context: server config, &lt;VirtualHost&gt;, &lt;Global&gt;, &lt;Directory&gt;, &lt;Anonymous&gt; 
Module: mod_ratio 
Compatibility: 1.2.2 and later

The <code>Ratios</code> directive

<hr>
<h3><a name="RatioTempFile">RatioTempFile</a></h3>
Syntax: RatioTempFile path 
Default: None 
Context: server config, &lt;VirtualHost&gt;, &lt;Global&gt;, &lt;Directory&gt;, &lt;Anonymous&gt; 
Module: mod_ratio 
Compatibility: 1.2.2 and later

The <code>RatioTempFile</code> directive

<hr>
<h3><a name="SaveRatios">SaveRatios</a></h3>
Syntax: SaveRatios on|off 
Default: Off 
Context: server config, &lt;VirtualHost&gt;, &lt;Global&gt;, &lt;Directory&gt;, &lt;Anonymous&gt; 
Module: mod_ratio 
Compatibility: 1.2.2 and later

The <code>SaveRatios</code> directive

<hr>
<h3><a name="UserRatio">UserRatio</a></h3>
Syntax: UserRatio name file-ratio file-credit byte-ratio byte-credit 
Default: None 
Context: server config, &lt;VirtualHost&gt;, &lt;Global&gt;, &lt;Directory&gt;, &lt;Anonymous&gt; 
Module: mod_ratio 
Compatibility: 1.2.2 and later

The <code>UserRatio</code> directive

<hr>
<h2><a name="Installation">Installation</a></h2>
The <code>mod_ratio</code> module is distributed with ProFTPD. Simply follow
the normal steps for using third-party modules in ProFTPD:
<pre>
 $ ./configure --with-modules=mod_ratio
 $ make
 $ make install
</pre>
Alternatively, <code>mod_ratio</code> can be built as a DSO module:
<pre>
 $ ./configure --enable-dso --with-shared=mod_ratio ...
</pre>
Then follow the usual steps:
<pre>
 $ make
 $ make install
</pre>

For those with an existing ProFTPD installation, you can use the
<code>prxs</code> tool to add <code>mod_ratio</code>, as a DSO module, to
your existing server:
<pre>
 $ prxs -c -i -d mod_ratio.c
</pre>

<hr> 
<h2><a name="Usage">Usage</a></h2>
To use <code>mod_ratio</code>

</body>
</html>