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.
10 lines
770 B
Markdown
10 lines
770 B
Markdown
# Suricata Developer Guide
|
|
|
|
This directory contains the Suricata Developer's Guide. It is built as part of the Suricata Userguide.
|
|
|
|
The Sequence Diagrams seen in the Transactions documentation are generated with Mscgen. Mscgen is a small program to parse Message Sequence Charts that can be represented as text and can then converted to image.
|
|
|
|
If you need to update the diagrams, please edit the ``.msc`` files present in the diagrams directory (extending/app-layer/diagrams). Once those have been changed, in the ``scripts`` directory (in the main Suricata dir) there's a scrip that will generate images for all files: ``generate-images.sh`` (you'll have to install Mscgen for that to work).
|
|
|
|
More info about Mscgen can be found at: https://www.mcternan.me.uk/mscgen/
|