[svn/Prometheus-QoS/.git] / prometheus.1

.TH prometheus 1 "January 3, 2008"
.LO 1
.SH NAME
prometheus \- Traffic shaper replacement for Internet Service Providers
.SH SYNOPSIS
.ll +8
.B prometheus
.RB [ " \-dfnpv9 " ]
.RB [ " \-c\ filename " ]
.RB [ " \-h\ filename " ]
.SH DESCRIPTION
Prometheus QoS generates multiple nested HTB tc classes with various
rate and ceil values, and implements optional daily traffic quotas and
data transfer statistics (as HTML). It is compatible with NAT, both
asymetrical and symetrical, yet still provides good two-way shaping
and prioritizing, both upload and download.
.SH OPTIONS
.TP
.B \-?, --help
this help screen
.TP
.B \-c filename
force alternative /etc/prometheus.conf filename
.TP
.B \-d
dry run (preview tc and iptables commands on stdout)
.TP
.B \-h filename
force alternative /etc/hosts filename (overrides hosts keyword)
.TP
.B \-f
just flush iptables and tc classes and exit (stop shaping)
.TP
.B \-n
run Now (start shaping without delay - overrides qos-free-delay keyword)
.TP
.B \-r
Run (reset all statistics and start shaping)
.TP
.B \-p
just generate preview of data transfer statistics and exit
.TP
.B \-l Mmm YYYY
generate HTML summary of traffic logs (Mmm=Jan-Dec or Year, YYYY=year)
.TP
.B \-m
generate HTML summary of traffic logs for yesterday's month
.TP
.B \-y
generate HTML summary of traffic logs for yesterday's year
.TP
.B \-v, --version 
show version number of this utility and exit
.TP
.B \-9
emergency iptables flush (do not read data transfer statistics)
.SH SEE ALSO
iptables(8), tc(8), prometheus.conf(5)
.SH AVAILABILITY
Prometheus is available at https://dev.arachne.cz/svn/prometheus/downloads
Commit	Line	Data
81edff80	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
94760911	35	run Now (start shaping without delay - overrides qos-free-delay keyword)
	36	.TP
	37	.B \-r
	38	Run (reset all statistics and start shaping)
81edff80	39	.TP
	40	.B \-p
	41	just generate preview of data transfer statistics and exit
	42	.TP
5b902402	43	.B \-l Mmm YYYY
	44	generate HTML summary of traffic logs (Mmm=Jan-Dec or Year, YYYY=year)
	45	.TP
	46	.B \-m
	47	generate HTML summary of traffic logs for yesterday's month
	48	.TP
	49	.B \-y
	50	generate HTML summary of traffic logs for yesterday's year
	51	.TP
81edff80	52	.B \-v, --version
	53	show version number of this utility and exit
	54	.TP
	55	.B \-9
	56	emergency iptables flush (do not read data transfer statistics)
81edff80	57	.SH SEE ALSO
	58	iptables(8), tc(8), prometheus.conf(5)
	59	.SH AVAILABILITY
	60	Prometheus is available at https://dev.arachne.cz/svn/prometheus/downloads