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.
55843aee8e
Use it to explain how to go about the sequence diagram images (generation, updating, what is mscgen etc). Also remove portion that referred to Sphinx builds, as these don't make sense now. |
3 years ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | 7 years ago | |
| _static | ||
| capture-hardware | 5 years ago | |
| configuration | 4 years ago | |
| devguide | 3 years ago | |
| file-extraction | 5 years ago | |
| licenses | 6 years ago | |
| lua | 4 years ago | |
| manpages | 4 years ago | |
| output | 4 years ago | |
| partials | 5 years ago | |
| performance | 4 years ago | |
| reputation | 6 years ago | |
| rule-management | 5 years ago | |
| rules | 4 years ago | |
| setting-up-ipsinline-for-linux | ||
| upgrade | 5 years ago | |
| .gitignore | ||
| Makefile.am | 3 years ago | |
| Makefile.sphinx | ||
| README.md | 3 years ago | |
| acknowledgements.rst | 8 years ago | |
| command-line-options.rst | 5 years ago | |
| conf.py | 3 years ago | |
| convert.py | ||
| index.rst | 3 years ago | |
| initscripts.rst | 5 years ago | |
| install.rst | 4 years ago | |
| make-sense-alerts.rst | 5 years ago | |
| public-data-sets.rst | 4 years ago | |
| quickstart.rst | 5 years ago | |
| setting-up-ipsinline-for-linux.rst | 5 years ago | |
| setting-up-ipsinline-for-windows.rst | 5 years ago | |
| unix-socket.rst | 5 years ago | |
| upgrade.rst | 3 years ago | |
| what-is-suricata.rst | 5 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.