Documentation - (Kevux) Firewall
Author: Kevin Day
Description: Kevux firewall program documentation.
Keywords: Kevin Day, Kevux, FLL, Featureless, Linux, Library, Firewall, Iptables, Open-Source

# (Kevux) Firewall Documentation

The (Kevux) Firewall program, called `firewall`, is a tool for simplifying and automating the `iptables` program.

There are plans for making major changes to ths tool now that the iptables program is outdated. The latest iptables program replacement (the nftables program) is superior and the firewall will need major rewrites to utilize the replacement.

This tools is one of the original two programs of the FLL project and is designed to be a fully functional proof of concept for the FLL project.

## Standard Parameters

Short | Long | Description
--- | --- | ---
`-h` | `--help` | Print the help message.
`+C` | `++copyright` | Print the copyright.
`+d` | `++dark` | Output using colors that show up better on dark backgrounds.
`+l` | `++light` | Output using colors that show up better on light backgrounds.
`+n` | `++no_color` | Do not print using color.
`+Q` | `++quiet` | Decrease verbosity, silencing most output.
`+E` | `++error` | Decrease verbosity, using only error output.
`+N` | `++normal` | Set verbosity to normal.
`+V` | `++verbose` | Increase verbosity beyond normal output.
`+D` | `++debug` | Enable debugging, significantly increasing verbosity beyond normal output.
`+v` | `++version` | Print only the version number.

The `+Q/++quiet` parameter silences all output that is not the intent and purpose of the program.
For example, the purpose of the utf8 program is to print the Unicode code point or the UTF-8 byte code.
The `+Q/++quiet` will not suppress this output.
The new line printed at the end of the program, is however, not printed.
The `+Q/++quiet` is ideal for using in scripting to help guarantee more consistent and controlled output.

The `+N/++no_color` simplifies the output to avoid the special color character codes.
The special color character codes tend to take up a lot of extra space and may slow down printing performance.

## Program Parameters

Short | Long | Description
--- | --- | ---
`-4` |  | Explicitly use IPv4 for show and rules to use iptables.
`-6` |  | Explicitly use IPv6 and rules to use ip6tables.

## Commands

Command | Description
--- | ---
`start` | Turn on the firewall.
`stop` | Turn off the firewall.
`restart` | Turn off and then turn on the firewall.
`lock` | Prevent all communication.
`show` | Show active firewall settings.