Skip to content

Commit

Permalink
doc: rules-meta small cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
victorjulien committed Oct 4, 2016
1 parent 3cf1b12 commit 76b5521
Showing 1 changed file with 6 additions and 11 deletions.
17 changes: 6 additions & 11 deletions doc/userguide/rules/meta.rst
Original file line number Diff line number Diff line change
@@ -1,25 +1,21 @@
Meta-settings
=============

Meta-settings have no effect on Suricata's inspection; they have an
effect on the way Suricata reports events.
Meta-settings have no effect on Suricata's inspection; they do have an effect on the way Suricata reports events.

msg (message)
-------------

The keyword msg gives more information about the signature and the
possible alert. The first part shows the filename of the
signature. It is a convention that part is written in uppercase
The keyword msg gives more information about the signature and the possible alert. The first part shows the class of the signature. It is a convention that part is written in uppercase
characters.

The format of msg is:

::

msg: "some description";

msg: “..........”;

Example:
Examples:

::

Expand All @@ -28,7 +24,7 @@ Example:

::

It is a convention that msg is always the first keyword of a signature.
It is a convention that msg is always the first keyword of a signature.

Another example of msg in a signature:

Expand All @@ -39,8 +35,7 @@ In this example the red, bold-faced part is the msg.
Sid (signature id)
------------------

The keyword sid gives every signature its own id. This id is stated
with a number.
The keyword sid gives every signature its own id. This id is stated with a number.

The format of sid is:

Expand Down

0 comments on commit 76b5521

Please sign in to comment.