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.
Philippe Antoine
95f225e8fb
doc: update sphinx api to use add_css_file
instead of deprecated add_stylesheet
|
4 years ago |
| .. |
|
3rd-party-integration
|
doc/userguide: new 3rd party section, add bluecoat
|
6 years ago |
|
_static
|
doc: Add suricata.css to allow for some custom styling
|
8 years ago |
|
capture-hardware
|
napatech: Added comment indicating that hba will be deprecated
|
5 years ago |
|
configuration
|
http: makes decompression time limit configurable
|
4 years ago |
|
file-extraction
|
http2: allow filestore to work with HTTP2
|
5 years ago |
|
licenses
|
doc: convert fancy quotes to straight quotes
|
6 years ago |
|
lua
|
doc/lua: Lua API name consistency
|
5 years ago |
|
manpages
|
doc/manpage: improve intro, add examples
|
5 years ago |
|
output
|
doc/modbus: add eve logging documentation
|
4 years ago |
|
partials
|
ikev1: rename ikev2 to common ike
|
4 years ago |
|
performance
|
doc: fix ubuntu pkg name for tcmalloc
|
4 years ago |
|
reputation
|
userguide: remove old reference to rule-reload option
|
6 years ago |
|
rule-management
|
doc: Improve grammar, spelling and clarifications
|
5 years ago |
|
rules
|
ike: set event for multiple server proposals
|
4 years ago |
|
setting-up-ipsinline-for-linux
|
doc: rename from "sphinx" to "userguide"
|
9 years ago |
|
upgrade
|
doc: document removal of unified2
|
5 years ago |
|
.gitignore
|
doc: hook sphinx into build
|
9 years ago |
|
Makefile.am
|
doc: build all manpages
|
5 years ago |
|
Makefile.sphinx
|
doc: hook sphinx into build
|
9 years ago |
|
README.md
|
doc: Fix typo Generate -> Generator
|
5 years ago |
|
acknowledgements.rst
|
doc: Add my own name to the acknowledgements
|
8 years ago |
|
command-line-options.rst
|
doc: Improve grammar, spelling and clarifications
|
5 years ago |
|
conf.py
|
doc: update sphinx api to use add_css_file
|
4 years ago |
|
convert.py
|
doc: rename from "sphinx" to "userguide"
|
9 years ago |
|
index.rst
|
doc: add upgrade page
|
6 years ago |
|
initscripts.rst
|
doc: Improve grammar, spelling and clarifications
|
5 years ago |
|
install.rst
|
doc: update installation documentation for CentOS and Fedora
|
4 years ago |
|
make-sense-alerts.rst
|
doc: Improve grammar, spelling and clarifications
|
5 years ago |
|
public-data-sets.rst
|
doc: Improve grammar, spelling and clarifications
|
5 years ago |
|
quickstart.rst
|
doc/quickstart: use new test url that works
|
4 years ago |
|
setting-up-ipsinline-for-linux.rst
|
doc: Improve grammar, spelling and clarifications
|
5 years ago |
|
setting-up-ipsinline-for-windows.rst
|
doc: Improve grammar, spelling and clarifications
|
5 years ago |
|
unix-socket.rst
|
doc: fix URL for unix-socket python example
|
5 years ago |
|
upgrade.rst
|
doc: Protocol name/case change for upgrade doc
|
4 years ago |
|
what-is-suricata.rst
|
doc: Improve grammar, spelling and clarifications
|
5 years ago |
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.