You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
suricata/doc/userguide
Jason Ish 713e4eb900 ntp: convert reference_id to buffer and add keyword
Store the NTP reference ID as raw network-order bytes so it can be
exposed as a sticky buffer and matched with payload keywords. The
reference ID is often a 4 character string, or an IP address and not
just an integer identifier.

Updates the log reference ID to be a string of colon separated hex
digits as this matches what tshark does.

Ticket: #8488
4 months ago
..
3rd-party-integration
_static
appendix
capture-hardware rules: fix typos & missing keywords in examples 5 months ago
configuration userguide/exceptions: update for qa-simulation use 5 months ago
devguide rust/ffi: add eve callback handler 4 months ago
file-extraction
firewall doc/userguide: add note on rule reloads 4 months ago
install
ips src: doc: remove double-space typos 7 months ago
licenses
lua doc: fix rules 4 months ago
manpages
output doc/config: Update flushing description 5 months ago
partials ntp: add transaction logging 4 months ago
performance hs: warn about the same cache directory 7 months ago
plugins
protocols
reputation
rule-management userguide: add references to rules/README to docs 5 months ago
rules ntp: convert reference_id to buffer and add keyword 4 months ago
upgrade
.gitignore
Makefile.am userguide/Makefile: don't add "install" to EXTRA_DIST 6 months ago
Makefile.sphinx
README.md
acknowledgements.rst
command-line-options.rst
conf.py
convert.py
docutils.conf
generate-evedoc.sh
index.rst
initscripts.rst
install.rst docs: use correct suricata version mentions 7 months ago
make-sense-alerts.rst
public-data-sets.rst doc: add more public datasets 5 months ago
quickstart.rst
requirements.txt
security.rst
support-status.rst
unix-socket.rst
upgrade.rst doc/userguide: improve pkthdr docs 4 months ago
verifying-source-files.rst docs: use correct suricata version mentions 7 months ago
what-is-suricata.rst

README.md

Suricata User Guide

This directory contains the Suricata Guide. The Suricata Developer's guide is included as a chapter of the Guide. The Sphinx Document Generator is used to build the documentation. For a primer os reStructuredText see the reStructuredText Primer.

Verifying Changes

There are a number of output formats to choose from when making the source documentation locally (e.g. html, pdf, man).

The documentation source can be built with make -f Makefile.sphinx html. Substitute the 'html' word for desired output format.

There are different application dependencies based on the output desired.