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
Jeff Lucovsky 62e3c02914 doc: Add missing contributors to ack file
Add missing contributors as identified by
    git shortlog -s -n --no-merges -- .
2 months ago
..
3rd-party-integration
_static
appendix
capture-hardware pcap-file: document capture method options 2 months ago
configuration docs/exceptions: minor improvements 2 months ago
devguide doc/devguide: document the rate filter callback 3 months ago
file-extraction
firewall doc/ssh: document hooks 3 months ago
licenses
lua doc/lua: document request_host lua lib 2 months ago
manpages userguide/suricatactl: use suricata community page 5 months ago
output pgsql: rename copy in/out response field 2 months ago
partials pcap-file: document capture method options 2 months ago
performance doc: stylistic and grammar fixes 4 months ago
plugins doc/ndpi: move ndpi docs to new plugins section 4 months ago
reputation
rule-management
rules doc/payload: fix typo, minor formatting changes 2 months ago
setting-up-ipsinline-for-linux
upgrade doc/userguide: type in pfring upgrade notes 4 months ago
.gitignore
Makefile.am doc/firewall: start of documentation 4 months ago
Makefile.sphinx
README.md
acknowledgements.rst doc: Add missing contributors to ack file 2 months ago
command-line-options.rst
conf.py
convert.py
docutils.conf
generate-evedoc.sh
index.rst doc/firewall: start of documentation 4 months ago
initscripts.rst
install.rst
make-sense-alerts.rst
public-data-sets.rst
quickstart.rst af-packet: remove use-mmap option 4 months ago
requirements.txt
security.rst
setting-up-ipsinline-for-linux.rst af-packet: remove use-mmap option 4 months ago
setting-up-ipsinline-for-windows.rst
support-status.rst
unix-socket.rst
upgrade.rst doc: move upgrade note to correct section 2 months ago
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.