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.
suricata/doc/userguide
Jason Ish ad94ebddb7 doc/userguide: avoid horizontal scroll on rtd
Add CSS to avoid horizontal scroll in tables on ReadTheDocs. This will
wrap the text instead.

Also, vertically align to top so if a cell does wrap, other cells that
do not wrap don't place the text in the middle of the cell.
2 years ago
..
3rd-party-integration doc/userguide: new 3rd party section, add bluecoat 6 years ago
_static doc/userguide: avoid horizontal scroll on rtd 2 years ago
capture-hardware doc: add DPDK Bond PMD docs 2 years ago
configuration userguide: add details about tcp flow pass 2 years ago
devguide doc: GitHub PRs workflow 2 years ago
file-extraction doc/userguide: spelling 2 years ago
licenses doc: convert fancy quotes to straight quotes 6 years ago
lua doc/userguide: spelling 2 years ago
manpages doc/userguide: spelling 2 years ago
output userguide/eve: format and reorganize alert section 2 years ago
partials doc: spelling 2 years ago
performance doc: hyperscan information updated 2 years ago
reputation doc: spelling 2 years ago
rule-management profiling/rules: doc updates 2 years ago
rules doc: add multi buffer support note to keyword docs 2 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/userguide: start on a security chapter 2 years ago
Makefile.sphinx doc: hook sphinx into build 9 years ago
README.md devguide: move into userguide as last chapter 3 years ago
acknowledgements.rst doc/acknowledgements: add a few more names 3 years ago
command-line-options.rst doc: Improve grammar, spelling and clarifications 5 years ago
conf.py doc/conf: fix sphinx language setting 3 years ago
convert.py doc/optimization: move "convert.py" to Python3 2 years ago
docutils.conf doc: add docutils.conf to disable smart quotes 2 years ago
index.rst doc/userguide: start on a security chapter 2 years ago
initscripts.rst doc: Improve grammar, spelling and clarifications 5 years ago
install.rst doc: update install instructions 2 years ago
make-sense-alerts.rst doc: Improve grammar, spelling and clarifications 5 years ago
public-data-sets.rst userguide: update wiresharkwiki in public datasets 4 years ago
quickstart.rst devguide: add page on installing suricata from git 3 years ago
security.rst userguide/security: grammar fixes 2 years ago
setting-up-ipsinline-for-linux.rst doc: fix description of iptables rules 2 years ago
setting-up-ipsinline-for-windows.rst doc: Improve grammar, spelling and clarifications 5 years ago
unix-socket.rst suricatasc: update running instructions 2 years ago
upgrade.rst doc/upgrade: add more 6 to 7 changes and minor improvements 2 years ago
what-is-suricata.rst doc: Improve grammar, spelling and clarifications 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.