Command Line Arguments

Below is a list of the command line arguments used in snortsnarf2. They are seperated by Implemented and Unimplemented sections, so as to both outline and specify the parameters available and their planned implementation within the same document.

Implemented Arguments

Unimplemented Arguments

--DEBUG:
Enables debug mode in snortsnarf2. Used for debug handling and verbose console output

--BENCHMARK:
Enables benchmark mode in snortsnarf2. Including this flag will enable metrics for measuring performance of snortsnarf2 on your system

-d <directory>:
Set the directory the html data will be generated to. If not included, the default directory www will be created at the project root storing the output

-a <directory> :
Set the directory of the alert file to be read in and parsed by snortsnarf2. This parameter is used to determine if snortsnarf2 is parsing specifically an alert file. Combining this with parameters for reading in SQL data or other sources may cause unexpected results

-db <connectionstring> :
The connection string for connecting to a snort MySQL database. Formatting of the connection string is as follows: <username>:<password>@<host>:<port>. By default localhost and the default MySQL port will be used if they are not supplied in the connection string. Additionaly, this parameter is used by snortsnarf2 to determine that it is parsing a MySQL database. Use of this parameter in combination with parameters identifying an Alert file may cause unexpected results.

--VERSION :
Outputs version information on the downloaded snortsnarf2. If this flag is detected, regardless of what other flags are included, the version information will be printed and snortsnarf2 will not execute anything further

--HELP :
Outputs basic usage help. This may include simply a link to this wiki page. Or additional basic usage information