TRICKLE(1)                 OpenBSD Reference Manual                 TRICKLE(1)

NAME
     trickle - a lightweight userspace bandwidth shaper

SYNOPSIS
     trickle [-h] [-v] [-V] [-u rate] [-d rate] [-w size] [-n path] command
             ...

DESCRIPTION
     trickle is a userspace bandwidth manager.  Currently, trickle supports
     the shaping of any SOCK_STREAM (see socket(2)) connection established via
     the socket(2) interface.  Furthermore, trickle will not work with stati-
     cally linked executables, nor with setuid(2) executables.  trickle is
     highly configurable; download and upload rates can be set separately, or
     in an aggregate fashion.

     The options are as follows:

     -h           Displays help.

     -v           Increases the verbosity level (can be specified multiple
                  times).

     -V           Prints version.

     -u rate      Limit the upload bandwidth consumption to rate KB/s.

     -d rate      Limit the download bandwidth consumption to rate KB/s.

     -w size      Set peak detection window size to size KB.  This determines
                  how aggressive trickle is at eliminating bandwidth consump-
                  tion peaks.  Lower values will be more aggressive, but may
                  also result in over shaping.  The default value (512 KB) is
                  usually sufficient.

     -n path      Use trickled(8) socket path to communicate with trickled(8).
                  By default, /tmp/.trickled.sock is used.

EXAMPLES
     trickle -u 10 -d 20 ncftp

     Launch ncftp(1) limiting its upload capacity to 10 KB/s, and download ca-
     pacity at 20 KB/s.

SEE ALSO
     trickled(8), syslog(3), socket(2), netintro(4)

AUTHORS
     trickle has been developed by Marius Aamodt Eriksen <marius@monkey.org>.

BUGS
     Does not support executables utilizing kqueue(2). Does not support stati-
     cally linked executables.

OpenBSD 3.3                    November 10, 2002                             1