From 485544d88559239efb83223babb5b1e66ccf106d Mon Sep 17 00:00:00 2001 From: Victor Julien Date: Wed, 28 Sep 2016 20:44:17 +0200 Subject: [PATCH] doc: improve commandline options --- doc/userguide/command-line-options.rst | 48 ++++++++++++++++---------- 1 file changed, 30 insertions(+), 18 deletions(-) diff --git a/doc/userguide/command-line-options.rst b/doc/userguide/command-line-options.rst index de981ba44e..15f9c61651 100644 --- a/doc/userguide/command-line-options.rst +++ b/doc/userguide/command-line-options.rst @@ -15,8 +15,7 @@ Suricata's command line options: .. option:: -c - The -c option the most important option. After -c you can enter the - path to the location of suricata.yaml. + Select suricata.yaml configuration file. .. option:: -i @@ -62,23 +61,13 @@ Suricata's command line options: able to use the console for other tasks without disturbing the engine running. -.. option:: --list-app-layer-protos - - List supported app layer protocols. - -.. option:: --list-keywords[=all|csv|] - - List keywords implemented by the engine - -.. option:: --list-runmodes - - The option --list-runmodes lists all possible runmodes. - .. option:: --runmode - (in combination with the command line opion -i or -r) With - the --runmode option you can set the runmode that you would like to - use. This command line option can override the yaml runmode option. + With the --runmode option you can set the runmode that you would + like to use. This command line option can override the yaml + runmode option. + + Runmodes are: workers, autofp and single. For more information about runmodes see: :doc:`performance/runmodes` @@ -101,9 +90,32 @@ Capture Options .. option:: --netmap= Enable capture of packet using NETMAP on FreeBSD or Linux. If no - device is supplied, the list of devices from the af-packet section + device is supplied, the list of devices from the netmap section in the yaml is used. +Advanced Options +~~~~~~~~~~~~~~~~ + +.. option:: --dump-config + + Displays a list of key value pairs with Suricata's configuration. + +.. option:: --set = + + Override any configuration option. + +.. option:: --list-app-layer-protos + + List supported app layer protocols. + +.. option:: --list-keywords[=all|csv|] + + List keywords implemented by the engine + +.. option:: --list-runmodes + + The option --list-runmodes lists all possible runmodes. + Unit Tests ~~~~~~~~~~