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.
67af1504b3
Currently, it seems easier to upload the diagram images to git than to try to make the image generation script work with out of the tree builds and other corner cases. This means, however, that one must activelly remember to update msc diagram files, run the script and re-add new png files, if those ever need to be updated. To raise awareness to that, a watermark was added to the diagram images. Also removed configuration steps that added mscgen as dependency (locally and for workflow builds and readthedocs). |
4 years ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | ||
| capture-hardware | ||
| configuration | 5 years ago | |
| devguide | 4 years ago | |
| file-extraction | ||
| licenses | ||
| lua | 5 years ago | |
| manpages | 5 years ago | |
| output | 5 years ago | |
| partials | ||
| performance | 5 years ago | |
| reputation | ||
| rule-management | ||
| rules | 5 years ago | |
| setting-up-ipsinline-for-linux | ||
| upgrade | ||
| .gitignore | ||
| Makefile.am | 4 years ago | |
| Makefile.sphinx | ||
| README.md | 4 years ago | |
| acknowledgements.rst | ||
| command-line-options.rst | ||
| conf.py | 4 years ago | |
| convert.py | ||
| index.rst | 4 years ago | |
| initscripts.rst | ||
| install.rst | 5 years ago | |
| make-sense-alerts.rst | ||
| public-data-sets.rst | 5 years ago | |
| quickstart.rst | ||
| setting-up-ipsinline-for-linux.rst | ||
| setting-up-ipsinline-for-windows.rst | ||
| unix-socket.rst | ||
| upgrade.rst | 4 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.