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.
633180c93f
Ticket: 6724 Allows sugar syntax for bitflags keywords. While the expressivity does not increase, because we could already use numerial values with all generic integer modes, this modifier prefix is used with the strings, and follows the syntax that is already used for fragbits and tcp.flags keyword. |
1 year ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | ||
| appendix | 1 year ago | |
| capture-hardware | 1 year ago | |
| configuration | 1 year ago | |
| devguide | 1 year ago | |
| file-extraction | 2 years ago | |
| firewall | 1 year ago | |
| install | 1 year ago | |
| ips | 1 year ago | |
| licenses | ||
| lua | 1 year ago | |
| manpages | 2 years ago | |
| output | 1 year ago | |
| partials | 1 year ago | |
| performance | 1 year ago | |
| plugins | 2 years ago | |
| protocols | 1 year ago | |
| reputation | ||
| rule-management | 1 year ago | |
| rules | 1 year ago | |
| upgrade | 1 year ago | |
| .gitignore | 2 years ago | |
| Makefile.am | 1 year ago | |
| Makefile.sphinx | ||
| README.md | ||
| acknowledgements.rst | 1 year ago | |
| command-line-options.rst | ||
| conf.py | 1 year ago | |
| convert.py | ||
| docutils.conf | ||
| generate-evedoc.sh | 2 years ago | |
| index.rst | 1 year ago | |
| initscripts.rst | ||
| install.rst | 1 year ago | |
| make-sense-alerts.rst | ||
| public-data-sets.rst | 2 years ago | |
| quickstart.rst | 2 years ago | |
| requirements.txt | ||
| security.rst | 1 year ago | |
| support-status.rst | ||
| unix-socket.rst | 1 year ago | |
| upgrade.rst | 1 year ago | |
| verifying-source-files.rst | 2 years 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.