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.

History

…
..
3rd-party-integration	…
_static	…
appendix	…
capture-hardware	…
configuration	…
devguide	…
file-extraction	…
firewall	…
install	…
licenses	…
lua	…
manpages	…
output	…
partials	…
performance	…
plugins	…
reputation	…
rule-management	…
rules	…
setting-up-ipsinline-for-linux	…
upgrade	…
.gitignore	…
Makefile.am	…
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	…
make-sense-alerts.rst	…
public-data-sets.rst	…
quickstart.rst	…
requirements.txt	…
security.rst	…
setting-up-ipsinline-for-linux.rst	…
setting-up-ipsinline-for-windows.rst	…
support-status.rst	…
unix-socket.rst	…
upgrade.rst	…
verifying-source-files.rst	…
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.