## ProFTPD module `mod_ratio`

The `mod_ratio` module

This module is contained in the `mod_ratio.c` file for ProFTPD 1.3.x, and is not compiled by default. Installation instructions are discussed here; a discussion on usage is also available.

The most current version of `mod_ratio` is distributed with the ProFTPD source code.

## Author

Please contact TJ Saunders <tj at castaglia.org> with any questions, concerns, or suggestions regarding this module.

## Directives

- AnonRatio
- ByteRatioErrMsg
- CwdRatioMsg
- FileRatioErrMsg
- GroupRatio
- HostRatio
- LeechRatioMsg
- RatioFile
- Ratios
- RatioTempFile
- Ratios
- UserRatio

### AnonRatio

Syntax: AnonRatio name file-ratio file-credit byte-ratio byte-credit
Default: None
Context: server config, <VirtualHost>, <Global>, <Directory>, <Anonymous>
Module: mod_ratio
Compatibility: 1.2.2 and later

The `AnonRatio` directive

### ByteRatioErrMsg

Syntax: ByteRatioErrMsg message
Default: None
Context: server config, <VirtualHost>, <Global>, <Directory>, <Anonymous>
Module: mod_ratio
Compatibility: 1.2.2 and later

The `ByteRatioErrMsg` directive

### CwdRatioMsg

Syntax: CwdRatioMsg message
Default: None
Context: server config, <VirtualHost>, <Global>, <Directory>, <Anonymous>
Module: mod_ratio
Compatibility: 1.2.2 and later

The `CwdRatioMsg` directive

### FileRatioErrMsg

Syntax: FileRatioErrMsg message
Default: None
Context: server config, <VirtualHost>, <Global>, <Directory>, <Anonymous>
Module: mod_ratio
Compatibility: 1.2.2 and later

The `FileRatioErrMsg` directive

### GroupRatio

Syntax: GroupRatio name file-ratio file-credit byte-ratio byte-credit
Default: None
Context: server config, <VirtualHost>, <Global>, <Directory>, <Anonymous>
Module: mod_ratio
Compatibility: 1.2.2 and later

The `GroupRatio` directive

### HostRatio

Syntax: HostRatio name file-ratio file-credit byte-ratio byte-credit
Default: None
Context: server config, <VirtualHost>, <Global>, <Directory>, <Anonymous>
Module: mod_ratio
Compatibility: 1.2.2 and later

The `HostRatio` directive

### LeechRatioMsg

Syntax: LeechRatioMsg message
Default: None
Context: server config, <VirtualHost>, <Global>, <Directory>, <Anonymous>
Module: mod_ratio
Compatibility: 1.2.2 and later

The `LeechRatioMsg` directive

### RatioFile

Syntax: RatioFile path
Default: None
Context: server config, <VirtualHost>, <Global>, <Directory>, <Anonymous>
Module: mod_ratio
Compatibility: 1.2.2 and later

The `RatioFile` directive

### Ratios

Syntax: Ratios on|off
Default: Off
Context: server config, <VirtualHost>, <Global>, <Directory>, <Anonymous>
Module: mod_ratio
Compatibility: 1.2.2 and later

The `Ratios` directive

### RatioTempFile

Syntax: RatioTempFile path
Default: None
Context: server config, <VirtualHost>, <Global>, <Directory>, <Anonymous>
Module: mod_ratio
Compatibility: 1.2.2 and later

The `RatioTempFile` directive

### SaveRatios

Syntax: SaveRatios on|off
Default: Off
Context: server config, <VirtualHost>, <Global>, <Directory>, <Anonymous>
Module: mod_ratio
Compatibility: 1.2.2 and later

The `SaveRatios` directive

### UserRatio

Syntax: UserRatio name file-ratio file-credit byte-ratio byte-credit
Default: None
Context: server config, <VirtualHost>, <Global>, <Directory>, <Anonymous>
Module: mod_ratio
Compatibility: 1.2.2 and later

The `UserRatio` directive

## Installation

The `mod_ratio` module is distributed with ProFTPD. Simply follow the normal steps for using third-party modules in ProFTPD:

      $ ./configure --with-modules=mod_ratio
      $ make
      $ make install

Alternatively, `mod_ratio` can be built as a DSO module:

      $ ./configure --enable-dso --with-shared=mod_ratio ...

Then follow the usual steps:

      $ make
      $ make install

For those with an existing ProFTPD installation, you can use the `prxs` tool to add `mod_ratio`, as a DSO module, to your existing server:

      $ prxs -c -i -d mod_ratio.c

## Usage

To use `mod_ratio`

© Copyright 2013 TJ Saunders
All Rights Reserved