mirror of https://github.com/OISF/suricata
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.
02bdea2bce
When setting up a Lua output script for streaming data, we're explicitly requesting stream data. Just pass the streaming data as arguments, rather than requiring the script to make an extra call to get the stream data. The streaming data will be passed in the "stream" field of the args passed to the log function. Eliminates the SCStreamingBuffer Lua function. |
6 months ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | ||
| appendix | ||
| capture-hardware | 6 months ago | |
| configuration | 6 months ago | |
| devguide | 7 months ago | |
| file-extraction | ||
| firewall | 7 months ago | |
| licenses | ||
| lua | 6 months ago | |
| manpages | 8 months ago | |
| output | 6 months ago | |
| partials | 6 months ago | |
| performance | 8 months ago | |
| plugins | 8 months ago | |
| reputation | ||
| rule-management | ||
| rules | 6 months ago | |
| setting-up-ipsinline-for-linux | ||
| upgrade | 7 months ago | |
| .gitignore | ||
| Makefile.am | 8 months ago | |
| Makefile.sphinx | ||
| README.md | ||
| acknowledgements.rst | ||
| command-line-options.rst | ||
| conf.py | ||
| convert.py | ||
| docutils.conf | ||
| generate-evedoc.sh | ||
| index.rst | 8 months ago | |
| initscripts.rst | ||
| install.rst | ||
| make-sense-alerts.rst | ||
| public-data-sets.rst | ||
| quickstart.rst | 8 months ago | |
| requirements.txt | ||
| security.rst | ||
| setting-up-ipsinline-for-linux.rst | 8 months ago | |
| setting-up-ipsinline-for-windows.rst | ||
| support-status.rst | ||
| unix-socket.rst | ||
| upgrade.rst | 6 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.