mirror of https://github.com/OISF/suricata
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.
d2e3bf1d34
Add user-facing documentation for the xor transform's 'extract <nbytes> <offset>' syntax and offset parameter in rules/transforms.rst. Add a devguide section (devguide/extending/detect/transforms.rst) covering the detection pipeline execution order, how transforms run before detection-time keywords, and how xor reads key bytes directly from the raw buffer at a specified position and width. Explains how the engine deduplicates inspection buffers for rules with variable keys at different buffer positions. Issue: 8671 |
4 months ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | ||
| appendix | ||
| capture-hardware | 5 months ago | |
| configuration | 5 months ago | |
| devguide | 4 months ago | |
| file-extraction | ||
| firewall | 5 months ago | |
| install | 11 months ago | |
| ips | 10 months ago | |
| licenses | ||
| lua | 5 months ago | |
| manpages | 5 months ago | |
| output | 5 months ago | |
| partials | 5 months ago | |
| performance | 5 months ago | |
| plugins | ||
| protocols | ||
| reputation | ||
| rule-management | 8 months ago | |
| rules | 4 months ago | |
| upgrade | ||
| .gitignore | ||
| Makefile.am | 9 months ago | |
| Makefile.sphinx | ||
| README.md | ||
| acknowledgements.rst | ||
| command-line-options.rst | ||
| conf.py | 6 months ago | |
| convert.py | ||
| docutils.conf | ||
| generate-evedoc.sh | ||
| index.rst | ||
| initscripts.rst | ||
| install.rst | 10 months ago | |
| make-sense-alerts.rst | ||
| public-data-sets.rst | 8 months ago | |
| quickstart.rst | 4 months ago | |
| requirements.txt | ||
| security.rst | ||
| support-status.rst | ||
| unix-socket.rst | ||
| upgrade.rst | 5 months ago | |
| verifying-source-files.rst | 10 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.