suricata/doc/userguide
Jeff Lucovsky 1721ba1ba5 doc/subslice: Document the subslice transform
Add documentation for the subslice transform.

Issue: 7672
2026-04-28 12:18:42 +00:00
..
3rd-party-integration doc/userguide: new 3rd party section, add bluecoat 2019-03-05 11:41:08 +01:00
_static doc/userguide: avoid horizontal scroll on rtd 2023-07-15 17:12:51 +02:00
appendix doc: adjust for master to main rename 2025-09-16 17:20:56 +02:00
capture-hardware doc: move more rules to dedicated css container 2026-04-26 15:21:01 +00:00
configuration doc: move more rules to dedicated css container 2026-04-26 15:21:01 +00:00
devguide rust/ffi: add eve callback handler 2026-04-16 05:58:15 +00:00
file-extraction doc: minor verbiage tweaks and reST fix 2025-10-18 03:53:40 +02:00
firewall doc/userguide: add note on rule reloads 2026-03-31 05:34:16 +00:00
install doc/userguide: update windivert instructions 2025-12-11 04:30:42 +00:00
ips src: doc: remove double-space typos 2026-01-04 08:11:43 +00:00
licenses doc: convert fancy quotes to straight quotes 2019-06-17 20:09:08 +02:00
lua doc: fix rules 2026-04-16 05:58:14 +00:00
manpages userguide/suricatactl: use suricata community page 2025-03-09 21:52:42 +01:00
output doc/config: Update flushing description 2026-03-23 21:10:03 +00:00
partials ntp: add transaction logging 2026-04-16 16:10:34 -06:00
performance hs: warn about the same cache directory 2026-01-16 06:09:37 +00:00
plugins doc/ndpi: move ndpi docs to new plugins section 2025-03-29 22:14:00 +01:00
protocols doc/userguide: add initial protocols overview 2025-09-23 21:32:15 +02:00
reputation doc: spelling 2023-05-08 11:59:32 +02:00
rule-management userguide: add references to rules/README to docs 2026-03-10 14:18:47 +00:00
rules doc/subslice: Document the subslice transform 2026-04-28 12:18:42 +00:00
upgrade doc: upgrade notes for changes to ike output 2025-10-06 19:56:12 +02:00
.gitignore doc/userguide: generate eve documentation 2024-10-07 22:28:04 +02:00
acknowledgements.rst doc: Add missing contributors to ack file 2025-06-05 19:14:36 +02:00
command-line-options.rst doc: Improve grammar, spelling and clarifications 2020-09-03 13:11:40 +02:00
conf.py docs: fix deprecated inclusion of rtd theme path 2025-08-27 08:42:36 +02:00
convert.py doc/optimization: move "convert.py" to Python3 2023-05-05 11:11:26 +02:00
docutils.conf doc: add docutils.conf to disable smart quotes 2023-05-05 18:59:33 +02:00
generate-evedoc.sh doc/userguide: generate eve documentation 2024-10-07 22:28:04 +02:00
index.rst doc/userguide: add initial protocols overview 2025-09-23 21:32:15 +02:00
initscripts.rst doc: Improve grammar, spelling and clarifications 2020-09-03 13:11:40 +02:00
install.rst docs: use correct suricata version mentions 2026-01-14 12:49:11 +00:00
make-sense-alerts.rst doc: Improve grammar, spelling and clarifications 2020-09-03 13:11:40 +02:00
Makefile.am userguide/Makefile: don't add "install" to EXTRA_DIST 2026-02-13 13:34:26 +00:00
Makefile.sphinx doc: hook sphinx into build 2016-09-28 13:11:10 +02:00
public-data-sets.rst doc: add more public datasets 2026-02-25 17:57:34 +00:00
quickstart.rst doc: move more rules to dedicated css container 2026-04-26 15:21:01 +00:00
README.md devguide: move into userguide as last chapter 2022-03-29 07:56:03 +02:00
requirements.txt docs: adjust readthedocs config to new options 2023-10-06 21:28:15 +02:00
security.rst doc: fix typo /var/run/suricata in file permissions docs. 2025-09-20 09:08:40 +02:00
support-status.rst devguide: make 'contributing' a chapter 2024-01-04 15:51:21 +01:00
unix-socket.rst doc: adjust for master to main rename 2025-09-16 17:20:56 +02:00
upgrade.rst doc/userguide: improve pkthdr docs 2026-03-31 05:34:16 +00:00
verifying-source-files.rst docs: use correct suricata version mentions 2026-01-14 12:49:11 +00:00
what-is-suricata.rst doc: Improve grammar, spelling and clarifications 2020-09-03 13:11:40 +02:00

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.