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.
de0ce26e3f
Many places were still referencing the old Suricata page. Used git grep with replace to update them. Checked that new links work. Left old references when they were only documentation examples (for output or unittests). Task#4915 |
5 years ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | 8 years ago | |
| _static | 9 years ago | |
| capture-hardware | 6 years ago | |
| configuration | 5 years ago | |
| file-extraction | 6 years ago | |
| licenses | 7 years ago | |
| lua | 5 years ago | |
| manpages | 5 years ago | |
| output | 5 years ago | |
| partials | 5 years ago | |
| performance | 5 years ago | |
| reputation | 7 years ago | |
| rule-management | 6 years ago | |
| rules | 5 years ago | |
| setting-up-ipsinline-for-linux | ||
| upgrade | 6 years ago | |
| .gitignore | 10 years ago | |
| Makefile.am | 6 years ago | |
| Makefile.sphinx | 10 years ago | |
| README.md | 6 years ago | |
| acknowledgements.rst | 9 years ago | |
| command-line-options.rst | 6 years ago | |
| conf.py | 5 years ago | |
| convert.py | ||
| index.rst | 7 years ago | |
| initscripts.rst | 6 years ago | |
| install.rst | 5 years ago | |
| make-sense-alerts.rst | 6 years ago | |
| public-data-sets.rst | 5 years ago | |
| quickstart.rst | 6 years ago | |
| setting-up-ipsinline-for-linux.rst | 6 years ago | |
| setting-up-ipsinline-for-windows.rst | 6 years ago | |
| unix-socket.rst | 6 years ago | |
| upgrade.rst | 5 years ago | |
| what-is-suricata.rst | 6 years ago | |
README.md
Suricata User Guide
This directory contains the Suricata 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.