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
Wes Hurd aee41957e1 doc: add docutils.conf to disable smart quotes 2 years ago
..
3rd-party-integration doc/userguide: new 3rd party section, add bluecoat 6 years ago
_static
capture-hardware netmap: Correct LB + Netmap YAML usage 2 years ago
configuration yaml: grammar fixup 2 years ago
devguide devguide: clarify clang formatting changes policy 2 years ago
file-extraction http2: allow filestore to work with HTTP2 5 years ago
licenses doc: convert fancy quotes to straight quotes 6 years ago
lua doc: Document SCByteVarGet lua function 3 years ago
manpages userguide: update references to Suricata website 4 years ago
output doc: add version filed in NTLMSSP documentation 2 years ago
partials doc/userguide: document --include command line option 2 years ago
performance docs: remove obsolete af-packet warning 2 years ago
reputation userguide: remove old reference to rule-reload option 6 years ago
rule-management doc: Improve grammar, spelling and clarifications 5 years ago
rules doc: add note on the hashsize recommendation for datasets 2 years ago
setting-up-ipsinline-for-linux
upgrade doc: document removal of unified2 5 years ago
.gitignore
Makefile.am devguide: drop use of mscgen script in builds/make 3 years ago
Makefile.sphinx
README.md devguide: move into userguide as last chapter 3 years ago
acknowledgements.rst doc/acknowledgements: add a few more names 3 years ago
command-line-options.rst doc: Improve grammar, spelling and clarifications 5 years ago
conf.py doc/conf: fix sphinx language setting 3 years ago
convert.py doc/optimization: move "convert.py" to Python3 2 years ago
docutils.conf doc: add docutils.conf to disable smart quotes 2 years ago
index.rst devguide: move into userguide as last chapter 3 years ago
initscripts.rst doc: Improve grammar, spelling and clarifications 5 years ago
install.rst doc/userguide: ubuntu: install software-properties-common 3 years ago
make-sense-alerts.rst doc: Improve grammar, spelling and clarifications 5 years ago
public-data-sets.rst userguide: update wiresharkwiki in public datasets 4 years ago
quickstart.rst devguide: add page on installing suricata from git 3 years ago
setting-up-ipsinline-for-linux.rst doc: fix description of iptables rules 2 years ago
setting-up-ipsinline-for-windows.rst doc: Improve grammar, spelling and clarifications 5 years ago
unix-socket.rst doc: fix URL for unix-socket python example 5 years ago
upgrade.rst doc: security.limit-noproc upgrade note 2 years ago
what-is-suricata.rst doc: Improve grammar, spelling and clarifications 5 years ago

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.