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
Victor Julien 07738af868 detect/content: introduce startswith modifier
Add startswith modifier to simplify matching patterns at the start
of a buffer.

Instead of:
    content:"abc"; depth:3;
This enables:
    content:"abc"; startswith;

Especially with longer patterns this makes the intention of the rule
more clear and eases writing the rules.

Internally it's simply a shorthand for 'depth:<pattern len>;'.

Ticket https://redmine.openinfosecfoundation.org/issues/742
8 years ago
..
_static doc: Add suricata.css to allow for some custom styling 8 years ago
capture-hardware doc/napatech: formatting fixes 8 years ago
configuration doc: document file-store v2 8 years ago
file-extraction doc: document file-store v2 8 years ago
licenses
manpages
output doc: update docs for DNS flags logging 8 years ago
partials source-pcap-file: Pcap Directory Mode (Feature #2222) 8 years ago
performance
reputation doc: Move IP reputation keyword to rules section 8 years ago
rule-management doc: initial suricata-update page 8 years ago
rules detect/content: introduce startswith modifier 8 years ago
setting-up-ipsinline-for-linux
.gitignore
Makefile.am
Makefile.sphinx
README.md
acknowledgements.rst doc: Add my own name to the acknowledgements 8 years ago
command-line-options.rst
conf.py doc: Add suricata.css to allow for some custom styling 8 years ago
convert.py
index.rst doc: Restructure ToC 8 years ago
initscripts.rst
install.rst doc: add rust and update version in install 8 years ago
make-sense-alerts.rst
public-data-sets.rst
setting-up-ipsinline-for-linux.rst
unix-socket.rst doc: add memcap commands in unix-socket section 8 years ago
what-is-suricata.rst

README.md

Suricata User Guide

This directory contains the Suricata Guide. The Sphinx Document Generate is used to build the documentation. For a primer os reStructuredText see the reStructuredText Primer.

Development Server

To help with writing documentation there is a development web server with live reload. To get run the live server you will first need npm installed then run the following:

npm install
gulp serve

Then point your browser at http://localhost:8000/_build/html/index.html

Any edits to .rst files should trigger a "make html" and cause your browser to refresh.