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.
2defd5ae5a
Adding the directory "install" to EXTRA_DIST, actually triggers make to run "make install", which is not what we want. Instead, avoid this magic keyword and list the files in the install directory individually. If the user doesn't have permission to install files to the prefix, like "/usr", then "make dist" can fail. Worse, even they do have permission to write into the prefix, a "make dist" will install files there when it shouldn't. Ticket: #8279 |
9 months ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | 3 years ago | |
| appendix | 1 year ago | |
| capture-hardware | 10 months ago | |
| configuration | 9 months ago | |
| devguide | 9 months ago | |
| file-extraction | 1 year ago | |
| firewall | 1 year ago | |
| install | 11 months ago | |
| ips | 10 months ago | |
| licenses | ||
| lua | 11 months ago | |
| manpages | 2 years ago | |
| output | 9 months ago | |
| partials | 9 months ago | |
| performance | 10 months ago | |
| plugins | 2 years ago | |
| protocols | 1 year ago | |
| reputation | 4 years ago | |
| rule-management | 1 year ago | |
| rules | 9 months ago | |
| upgrade | 1 year ago | |
| .gitignore | 2 years ago | |
| Makefile.am | 9 months ago | |
| Makefile.sphinx | ||
| README.md | ||
| acknowledgements.rst | 1 year ago | |
| command-line-options.rst | ||
| conf.py | 1 year ago | |
| convert.py | ||
| docutils.conf | 4 years ago | |
| generate-evedoc.sh | 2 years ago | |
| index.rst | 1 year ago | |
| initscripts.rst | ||
| install.rst | 10 months ago | |
| make-sense-alerts.rst | ||
| public-data-sets.rst | 2 years ago | |
| quickstart.rst | 2 years ago | |
| requirements.txt | 3 years ago | |
| security.rst | 1 year ago | |
| support-status.rst | 3 years ago | |
| unix-socket.rst | 1 year ago | |
| upgrade.rst | 9 months ago | |
| verifying-source-files.rst | 10 months 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.