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 4a647784c7 doc/bytemath: document the result of wide shifts
Record that << and >> yield 0 when rvalue is 64 or more, beside the
existing note about division by zero. A shift count can come from a
byte_extract variable, so the rule text alone does not say which
counts land in that case.

Issue: 8845
2 months ago
..
3rd-party-integration doc/userguide: new 3rd party section, add bluecoat 8 years ago
_static doc/userguide: avoid horizontal scroll on rtd 3 years ago
appendix doc: adjust for master to main rename 1 year ago
capture-hardware pcap-file: skip setvbuf on non-seekable streams 5 months ago
configuration detect/flowbits: add max usage per signature limit 4 months ago
devguide rust/ffi: add safe flow storage wrapper 2 months ago
file-extraction doc: minor verbiage tweaks and reST fix 1 year ago
firewall firewall: validate action scope against the hook class 2 months ago
install doc/userguide: update windivert instructions 11 months ago
ips src: doc: remove double-space typos 10 months ago
licenses doc: convert fancy quotes to straight quotes 7 years ago
lua http-log: remove support for http-log 5 months ago
manpages doc: improve manpage of suricatasc 5 months ago
output dcerpc/log: map uuid, opnum to service and procedure 3 months ago
partials pcap-file: skip setvbuf on non-seekable streams 5 months ago
performance http-log: remove support for http-log 5 months ago
plugins doc/ndpi: move ndpi docs to new plugins section 2 years ago
protocols doc/userguide: add initial protocols overview 1 year ago
reputation doc: spelling 4 years ago
rule-management userguide: add references to rules/README to docs 8 months ago
rules doc/bytemath: document the result of wide shifts 2 months ago
upgrade doc: upgrade notes for changes to ike output 1 year ago
.gitignore doc/userguide: generate eve documentation 2 years ago
Makefile.am userguide/Makefile: don't add "install" to EXTRA_DIST 9 months ago
Makefile.sphinx
…
README.md devguide: move into userguide as last chapter 5 years ago
acknowledgements.rst doc: Add missing contributors to ack file 1 year ago
command-line-options.rst doc: Improve grammar, spelling and clarifications 6 years ago
conf.py doc: address config conversion note 6 months ago
convert.py doc/optimization: move "convert.py" to Python3 4 years ago
docutils.conf doc: add docutils.conf to disable smart quotes 4 years ago
generate-evedoc.sh doc/userguide: generate eve documentation 2 years ago
index.rst doc/userguide: add initial protocols overview 1 year ago
initscripts.rst doc: Improve grammar, spelling and clarifications 6 years ago
install.rst github-ci: break ubuntu/debian script into 2 scripts 2 months ago
make-sense-alerts.rst doc: Improve grammar, spelling and clarifications 6 years ago
public-data-sets.rst doc: add more public datasets 8 months ago
quickstart.rst doc: clarify suricata.yaml location per install 4 months ago
requirements.txt docs: adjust readthedocs config to new options 3 years ago
security.rst doc: fix typo /var/run/suricata in file permissions docs. 1 year ago
support-status.rst devguide: make 'contributing' a chapter 3 years ago
unix-socket.rst doc: adjust for master to main rename 1 year ago
upgrade.rst flowbits: deprecate toggle command 5 months ago
verifying-source-files.rst docs: use correct suricata version mentions 10 months ago
what-is-suricata.rst doc: Improve grammar, spelling and clarifications 6 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.