first draft of prometheus manual page
[svn/Prometheus-QoS/.git] / prometheus.1
1 .TH prometheus 1 "January 3, 2008"
2 .LO 1
3 .SH NAME
4 prometheus \- Traffic shaper replacement for Internet Service Providers
5 .SH SYNOPSIS
6 .ll +8
7 .B prometheus
8 .RB [ " \-dfnpv9 " ]
9 .RB [ " \-c\ filename " ]
10 .RB [ " \-h\ filename " ]
11 .SH DESCRIPTION
12 Prometheus QoS generates multiple nested HTB tc classes with various
13 rate and ceil values, and implements optional daily traffic quotas and
14 data transfer statistics (as HTML). It is compatible with NAT, both
15 asymetrical and symetrical, yet still provides good two-way shaping
16 and prioritizing, both upload and download.
17 .SH OPTIONS
18 .TP
19 .B \-?, --help
20 this help screen
21 .TP
22 .B \-c filename
23 force alternative /etc/prometheus.conf filename
24 .TP
25 .B \-d
26 dry run (preview tc and iptables commands on stdout)
27 .TP
28 .B \-h filename
29 force alternative /etc/hosts filename (overrides hosts keyword)
30 .TP
31 .B \-f
32 just flush iptables and tc classes and exit (stop shaping)
33 .TP
34 .B \-n
35 no delay (overrides qos-free-delay keyword)
36 .TP
37 .B \-p
38 just generate preview of data transfer statistics and exit
39 .TP
40 .B \-v, --version
41 show version number of this utility and exit
42 .TP
43 .B \-9
44 emergency iptables flush (do not read data transfer statistics)
45 .SH KNOWN BUGS
46 Prometheus is slow. This will be changed as soon as the new
47 iptables-save/load mechanism makes it into stable release.
48 Future implementation may call netfilter directly via libiptables.
49 .SH SEE ALSO
50 iptables(8), tc(8), prometheus.conf(5)
51 .SH AVAILABILITY
52 Prometheus is available at https://dev.arachne.cz/svn/prometheus/downloads
This page took 0.24322 seconds and 4 git commands to generate.