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.
dc07c1fe13
This also removes the "args" parameter of the hooking functions in the examples, since this parameter is unused in all functions. It would not be very helpful anyways since 3 of the 4 functions don't get passed any parameters. The only exception is init() which gets a table containing: script_api_ver = 1 |
7 years ago | |
|---|---|---|
| .. | ||
| _static | 8 years ago | |
| capture-hardware | 7 years ago | |
| configuration | 7 years ago | |
| file-extraction | 7 years ago | |
| licenses | ||
| manpages | 9 years ago | |
| output | 7 years ago | |
| partials | 7 years ago | |
| performance | 8 years ago | |
| reputation | 8 years ago | |
| rule-management | 7 years ago | |
| rules | 7 years ago | |
| setting-up-ipsinline-for-linux | ||
| .gitignore | ||
| Makefile.am | 9 years ago | |
| Makefile.sphinx | ||
| README.md | ||
| acknowledgements.rst | 8 years ago | |
| command-line-options.rst | 9 years ago | |
| conf.py | 8 years ago | |
| convert.py | ||
| index.rst | 8 years ago | |
| initscripts.rst | ||
| install.rst | 8 years ago | |
| make-sense-alerts.rst | 7 years ago | |
| public-data-sets.rst | 8 years ago | |
| setting-up-ipsinline-for-linux.rst | ||
| unix-socket.rst | 7 years ago | |
| what-is-suricata.rst | 9 years ago | |
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.