.\" Automatically generated by Pandoc 3.1.3
.nh
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "fireqos" "1" "Built 30 Mar 2024" "FireQOS Reference" "3.1.7"
.hy
.SH NAME
.PP
fireqos - an easy to use but powerful traffic shaping tool
.SH SYNOPSIS
.PP
fireqos \f[I]CONFIGFILE\f[R] [start | debug] [ \[en] conf-arg \&...
]
.PP
fireqos { stop | clear_all_qos }
.PP
fireqos status [\f[I]name\f[R] [ dump [\f[I]class\f[R]]]]
.PP
fireqos { dump | tcpdump } \f[I]name\f[R] \f[I]class\f[R] [
\f[I]tcpdump-arg\f[R] \&...
]
.PP
fireqos { drops | overlimits | requeues } \f[I]name\f[R]
.SH DESCRIPTION
.PP
FireQOS is a program that helps you configure traffic shaping on Linux.
.PP
Run without any arguments, \f[V]fireqos\f[R] will present some help on
usage.
.PP
When given \f[I]CONFIGFILE\f[R], \f[V]fireqos\f[R] will use the named
file instead of \f[V]/etc/firehol/fireqos.conf\f[R] as its
configuration.
.PP
The parameter \f[I]name\f[R] always refers to an interface name from the
configuration file.
The parameter \f[I]class\f[R] always refers to a named class within a
named interface.
.PP
It is possible to pass arguments for use by the configuration file
separating any conf-arg values from the rest of the arguments with
\f[V]--\f[R].
The arguments are accessible in the configuration using standard bash(1)
syntax e.g.\ $1, $2, etc.
.SH COMMANDS
.TP
start; debug
Activates traffic shaping on all interfaces, as given in the
configuration file.
When invoked as \f[V]debug\f[R], FireQOS also prints all of the tc(8)
commands it executes.
.TP
stop
Removes all traffic shaping applied by FireQOS (it does not touch QoS on
other interfaces and IFBs used by other tools).
.TP
clear_all_qos
Removes all traffic shaping on all network interfaces and removes all
IFB devices from the system, even those applied by other tools.
.TP
status
Shows live utilisation for the specified interface.
FireQOS will show you the rate of traffic on all classes, adding one
line per second (similarly to vmstat, iostat, etc.)
.RS
.PP
If \f[V]dump\f[R] is specified, it tcpdumps the traffic in the given
class of the interface.
.RE
.TP
tcpdump; dump
FireQOS temporarily mirrors the traffic of any leaf class to an IFB
device.
Then it runs tcpdump(8) on this interface to dump the traffic to your
console.
.RS
.PP
You may add any tcpdump(8) parameters you like to the command line, (to
dump the traffic to a file, match a subset of the traffic, etc.), for
example this:
.IP
.nf
\f[C]
fireqos tcpdump adsl-in voip -n
\f[R]
.fi
.PP
will start a tcpdump of all traffic on interface adsl-in, in class voip.
The parameter \f[V]-n\f[R] is a tcpdump(8) parameter.
.RS
.PP
\f[B]Note\f[R]
.PP
When FireQOS is running in \f[V]tcpdump\f[R] mode, it locks itself and
will refuse to run in parallel with another FireQOS altering the QoS, or
tcpdumping other traffic.
This is because FireQOS reserves device ifb0 for monitoring.
If two FireQOS processes were allowed to \f[V]tcpdump\f[R] in parallel,
your dumps would be wrong.
So it locks itself to prevent such a case.
.RE
.RE
.TP
drops
Shows packets dropped per second, per class, for the specified
interface.
.TP
overlimits
Shows packets delayed per second, per class, for the specified
interface.
.TP
requeues
Shows packets requeued per second, per class, for the specified
interface.
.SH FILES
.PP
\f[V]/etc/firehol/fireqos.conf\f[R]
.SH SEE ALSO
.IP \[bu] 2
fireqos.conf(5) - FireQOS configuration file
.IP \[bu] 2
FireHOL Website (http://firehol.org/)
.IP \[bu] 2
FireQOS Online PDF Manual (http://firehol.org/fireqos-manual.pdf)
.IP \[bu] 2
FireQOS Online Documentation (http://firehol.org/documentation/)
.IP \[bu] 2
tc(8) (http://lartc.org/manpages/tc.html) - show / manipulate traffic
control settings
.IP \[bu] 2
tcpdump(8) (http://www.tcpdump.org/manpages/tcpdump.1.html) - show /
manipulate traffic control settings
.SH AUTHORS
FireHOL Team.