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.
45b7aad2b5
That page existed only in our redmine. Updated and added a few things, like a paragraph about our expectations for feature contributors. Also updated links, contacts and some other processes that may have changed since last edition. Added some section labels in related documents, for ease of referencing. Task #4929 |
2 years ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | ||
| capture-hardware | ||
| configuration | ||
| devguide | 2 years ago | |
| file-extraction | ||
| licenses | ||
| lua | ||
| manpages | ||
| output | ||
| partials | ||
| performance | ||
| reputation | ||
| rule-management | ||
| rules | ||
| setting-up-ipsinline-for-linux | ||
| upgrade | ||
| .gitignore | ||
| Makefile.am | ||
| Makefile.sphinx | ||
| README.md | ||
| acknowledgements.rst | ||
| command-line-options.rst | ||
| conf.py | ||
| convert.py | ||
| index.rst | ||
| initscripts.rst | ||
| install.rst | ||
| make-sense-alerts.rst | ||
| public-data-sets.rst | ||
| quickstart.rst | ||
| setting-up-ipsinline-for-linux.rst | ||
| setting-up-ipsinline-for-windows.rst | ||
| unix-socket.rst | ||
| upgrade.rst | ||
| 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.