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.
55b922ceed
Since enabling custom logging will replace the extended logging, thus possibly leading to certain fields disappearing from the logs, mention this aspect. Related to Bug #7333 |
10 months ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | 7 years ago | |
| _static | 2 years ago | |
| appendix | 10 months ago | |
| capture-hardware | 1 year ago | |
| configuration | 11 months ago | |
| devguide | 11 months ago | |
| file-extraction | 12 months ago | |
| licenses | 6 years ago | |
| lua | 2 years ago | |
| manpages | 2 years ago | |
| output | 10 months ago | |
| partials | 11 months ago | |
| performance | 12 months ago | |
| reputation | 2 years ago | |
| rule-management | 12 months ago | |
| rules | 11 months ago | |
| setting-up-ipsinline-for-linux | 9 years ago | |
| upgrade | 10 months ago | |
| .gitignore | 10 months ago | |
| Makefile.am | 10 months ago | |
| Makefile.sphinx | 9 years ago | |
| README.md | 3 years ago | |
| acknowledgements.rst | 3 years ago | |
| command-line-options.rst | 5 years ago | |
| conf.py | 10 months ago | |
| convert.py | 2 years ago | |
| docutils.conf | 2 years ago | |
| generate-evedoc.sh | 10 months ago | |
| index.rst | 10 months ago | |
| initscripts.rst | 5 years ago | |
| install.rst | 11 months ago | |
| make-sense-alerts.rst | 5 years ago | |
| public-data-sets.rst | 12 months ago | |
| quickstart.rst | 2 years ago | |
| requirements.txt | 2 years ago | |
| security.rst | 2 years ago | |
| setting-up-ipsinline-for-linux.rst | 2 years ago | |
| setting-up-ipsinline-for-windows.rst | 5 years ago | |
| support-status.rst | 2 years ago | |
| unix-socket.rst | 2 years ago | |
| upgrade.rst | 10 months ago | |
| verifying-source-files.rst | 1 year 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.