1TRICKLE(1) BSD General Commands Manual TRICKLE(1)
2
4 trickle — a lightweight userspace bandwidth shaper
5
7 trickle [-h] [-v] [-V] [-s] [-d rate] [-u rate] [-w length] [-t time]
8 [-l length] [-n path] command ...
9
11 trickle is a userspace bandwidth manager. Currently, trickle supports
12 the shaping of any SOCK_STREAM (see socket(2)) connection established via
13 the socket(2) interface. Furthermore, trickle will not work with stati‐
14 cally linked executables, nor with setuid(2) executables. trickle is
15 highly configurable; download and upload rates can be set separately, or
16 in an aggregate fashion.
17
18 The options are as follows:
19
20 -h Displays help.
21
22 -v Increases the verbosity level (can be specified multiple
23 times).
24
25 -V Prints version.
26
27 -s Runs trickle in standalone mode, independent of trickled(8).
28
29 -d rate Limit the download bandwidth consumption to rate KB/s.
30
31 -u rate Limit the upload bandwidth consumption to rate KB/s.
32
33 -w length Set peak detection window size to length KB. This deter‐
34 mines how aggressive trickle is at eliminating bandwidth
35 consumption peaks. Lower values will be more aggressive,
36 but may also result in over shaping. The default value (512
37 KB) is usually sufficient.
38
39 -t seconds Set smoothing time to seconds s. The smoothing time deter‐
40 mines with what intervals trickle will try to let the appli‐
41 cation transcieve data. Smaller values will result in a
42 more continuous (smooth) session, while larger values may
43 produce bursts in the sending and receiving data. Smaller
44 values (0.1 - 1 s) are ideal for interactive applications
45 while slightly larger values (1 - 10 s) are better for
46 applications that need bulk transfer.
47
48 -l length Set smoothing length to length KB. The smoothing length is
49 a fallback of the smoothing time. If trickle cannot meet
50 the requested smoothing time, it will instead fall back on
51 sending length KB of data. The default value is 10 KB.
52
53 -n path Use trickled(8) socket path to communicate with trickled(8).
54 By default, /tmp/.trickled.sock is used.
55
57 trickle -u 10 -d 20 ncftp
58
59 Launch ncftp(1) limiting its upload capacity to 10 KB/s, and download
60 capacity at 20 KB/s.
61
63 trickled(8), syslog(3), socket(2), netintro(4)
64
66 trickle has been developed by Marius Aamodt Eriksen ⟨marius@monkey.org⟩.
67
69 Does not support executables utilizing kqueue(2). Does not support stat‐
70 ically linked executables.
71
72BSD November 10, 2002 BSD