doc: improve commandline options

pull/2304/head
Victor Julien 10 years ago
parent 3ca663d7ff
commit 485544d885

@ -15,8 +15,7 @@ Suricata's command line options:
.. option:: -c <path> .. option:: -c <path>
The -c option the most important option. After -c you can enter the Select suricata.yaml configuration file.
path to the location of suricata.yaml.
.. option:: -i <interface> .. option:: -i <interface>
@ -62,23 +61,13 @@ Suricata's command line options:
able to use the console for other tasks without disturbing the able to use the console for other tasks without disturbing the
engine running. engine running.
.. option:: --list-app-layer-protos
List supported app layer protocols.
.. option:: --list-keywords[=all|csv|<kword>]
List keywords implemented by the engine
.. option:: --list-runmodes
The option --list-runmodes lists all possible runmodes.
.. option:: --runmode <runmode> .. option:: --runmode <runmode>
(in combination with the command line opion -i or -r) With With the --runmode option you can set the runmode that you would
the --runmode option you can set the runmode that you would like to like to use. This command line option can override the yaml
use. This command line option can override the yaml runmode option. runmode option.
Runmodes are: workers, autofp and single.
For more information about runmodes see: :doc:`performance/runmodes` For more information about runmodes see: :doc:`performance/runmodes`
@ -101,9 +90,32 @@ Capture Options
.. option:: --netmap=<device> .. option:: --netmap=<device>
Enable capture of packet using NETMAP on FreeBSD or Linux. If no 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. in the yaml is used.
Advanced Options
~~~~~~~~~~~~~~~~
.. option:: --dump-config
Displays a list of key value pairs with Suricata's configuration.
.. option:: --set <key>=<value>
Override any configuration option.
.. option:: --list-app-layer-protos
List supported app layer protocols.
.. option:: --list-keywords[=all|csv|<kword>]
List keywords implemented by the engine
.. option:: --list-runmodes
The option --list-runmodes lists all possible runmodes.
Unit Tests Unit Tests
~~~~~~~~~~ ~~~~~~~~~~

Loading…
Cancel
Save