Project

General

Profile

Actions

Documentation #5837

open

Unify documentation of command-line parameters

Added by Lukas Sismis almost 2 years ago.

Status:
New
Priority:
Normal
Assignee:
Target version:
Affected Versions:
Effort:
Difficulty:
Label:

Description

Currently, Suricata command line parameters are documented in the Sphinx docs and in the help message (with -h parameter).
However, not all parameters are documented everywhere.
This ticket aims to rethink whether parameters are documented on all places where they should be documented or potentially enforce documentation of all parameters everywhere.

All supported long parameters by Suricata code are located within suricata.c file in long_opts variable.
Parameters that are there but are not documented in the Sphinx documentation are:
@
capture-plugin
capture-plugin-args
dpdk
nflog
no-random
pfring-int
service-change-params
service-install
service-remove
windivert
windivert-forward
@

Parameters that are there but are not documented in the Suricata help message are:

@
capture-plugin
capture-plugin-args
data-diri
disable-hashing
nflog
no-random
simulate-alert-queue-realloc-failure
simulate-applayer-error-at-offset-tc
simulate-applayer-error-at-offset-ts
simulate-ips
simulate-packet-defrag-memcap
simulate-packet-flow-memcap
simulate-packet-loss
simulate-packet-tcp-reassembly-memcap
simulate-packet-tcp-ssn-memcap
strict-rule-keywords
unittest-filter
@

I haven't done an analysis on short parameters.

No data to display

Actions

Also available in: Atom PDF