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.
35bd603ba3
Pygments 2.21 lexes "x < 0 or x > y" in Lua as a Lua 5.4 variable attribute (e.g. "<const>"), producing an error token on the "0". Sphinx reports this as a highlighting failure warning, and as the PDF build treats warnings as errors, "make dist" fails while building the PDF. Reorder the comparisons so the Lua example is lexed correctly. The logic of the example is unchanged. |
4 weeks ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | ||
| appendix | ||
| capture-hardware | 5 months ago | |
| configuration | 2 months ago | |
| devguide | 4 weeks ago | |
| file-extraction | 1 year ago | |
| firewall | 2 months ago | |
| install | 11 months ago | |
| ips | 10 months ago | |
| licenses | ||
| lua | 5 months ago | |
| manpages | 5 months ago | |
| output | 2 months ago | |
| partials | 5 months ago | |
| performance | 5 months ago | |
| plugins | ||
| protocols | ||
| reputation | ||
| rule-management | 8 months ago | |
| rules | 4 weeks ago | |
| upgrade | ||
| .gitignore | ||
| Makefile.am | 9 months ago | |
| Makefile.sphinx | ||
| README.md | ||
| acknowledgements.rst | ||
| command-line-options.rst | ||
| conf.py | 6 months ago | |
| convert.py | ||
| docutils.conf | ||
| generate-evedoc.sh | ||
| index.rst | ||
| initscripts.rst | ||
| install.rst | 2 months ago | |
| make-sense-alerts.rst | ||
| public-data-sets.rst | 8 months ago | |
| quickstart.rst | 4 months ago | |
| requirements.txt | ||
| security.rst | ||
| support-status.rst | ||
| unix-socket.rst | ||
| upgrade.rst | 1 month ago | |
| verifying-source-files.rst | 10 months 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.