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
Jason Ish b51eeb3ab5 output-file: rename and document registration function
Rename OutputRegisterFileLogger to SCOutputRegisterFileLogger, add
function documentation and include in userguide.

Ticket: #7227
11 months ago
..
3rd-party-integration
_static doc/userguide: avoid horizontal scroll on rtd 2 years ago
capture-hardware doc: update eBPF compilation instructions 1 year ago
configuration userguide: expand documentation for rule profiling 11 months ago
devguide output-file: rename and document registration function 11 months ago
file-extraction doc/file-extraction: fix highlight syntax 11 months ago
licenses
lua doc/userguide: improve SCStreamingBuffer example 2 years ago
manpages
output userguide: fix spelling of `security_result` EVE field 11 months ago
partials pcap: implement pcap-file-buffer-size option 11 months ago
performance userguide: expand documentation for rule profiling 11 months ago
reputation doc: spelling 2 years ago
rule-management userguide: expand documentation for rule profiling 11 months ago
rules userguide: clarify flow:stateless explanation 12 months ago
setting-up-ipsinline-for-linux
upgrade doc: add pf-ring plugin upgrade notes 1 year ago
.gitignore
Makefile.am doc: add source verification docs 1 year ago
Makefile.sphinx
README.md
acknowledgements.rst
command-line-options.rst
conf.py docs/userguide: use a consistent date for reproducible builds 1 year ago
convert.py
docutils.conf
index.rst doc: add source verification docs 1 year ago
initscripts.rst
install.rst doc: port user install and build instruction from master-6.0.x 1 year ago
make-sense-alerts.rst
public-data-sets.rst userguide: update Security Onion docs reference 11 months ago
quickstart.rst doc/quickstart: add software-properties instruction 2 years ago
requirements.txt docs: adjust readthedocs config to new options 2 years ago
security.rst userguide/security: grammar fixes 2 years ago
setting-up-ipsinline-for-linux.rst
setting-up-ipsinline-for-windows.rst
support-status.rst devguide: make 'contributing' a chapter 2 years ago
unix-socket.rst suricatasc: update running instructions 2 years ago
upgrade.rst syslog: deprecate 11 months ago
verifying-source-files.rst doc: add source verification docs 1 year 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.