]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
doc: restructure directory layout
authorJason Ish <ish@unx.ca>
Fri, 4 Dec 2015 18:04:46 +0000 (12:04 -0600)
committerVictor Julien <victor@inliniac.net>
Wed, 28 Sep 2016 11:11:10 +0000 (13:11 +0200)
119 files changed:
doc/sphinx/index.rst
doc/sphinx/rules/adding-your-own-rules.rst [moved from doc/sphinx/adding-your-own-rules.rst with 100% similarity]
doc/sphinx/rules/dnp3-keywords.rst [moved from doc/sphinx/dnp3-keywords.rst with 100% similarity]
doc/sphinx/rules/dns-keywords.rst [moved from doc/sphinx/dns-keywords.rst with 100% similarity]
doc/sphinx/rules/dns-keywords/dns_query.png [moved from doc/sphinx/dns-keywords/dns_query.png with 100% similarity]
doc/sphinx/rules/fast-pattern-explained.rst [moved from doc/sphinx/fast-pattern-explained.rst with 100% similarity]
doc/sphinx/rules/fast-pattern.rst [moved from doc/sphinx/fast-pattern.rst with 100% similarity]
doc/sphinx/rules/fast-pattern/fast_pattern.png [moved from doc/sphinx/fast-pattern/fast_pattern.png with 100% similarity]
doc/sphinx/rules/file-keywords.rst [moved from doc/sphinx/file-keywords.rst with 100% similarity]
doc/sphinx/rules/flow-keywords.rst [moved from doc/sphinx/flow-keywords.rst with 100% similarity]
doc/sphinx/rules/flow-keywords/Flow1.png [moved from doc/sphinx/flow-keywords/Flow1.png with 100% similarity]
doc/sphinx/rules/flow-keywords/Flow2.png [moved from doc/sphinx/flow-keywords/Flow2.png with 100% similarity]
doc/sphinx/rules/flow-keywords/Flowbit_3.png [moved from doc/sphinx/flow-keywords/Flowbit_3.png with 100% similarity]
doc/sphinx/rules/flowint.rst [moved from doc/sphinx/flowint.rst with 100% similarity]
doc/sphinx/rules/header-keywords.rst [moved from doc/sphinx/header-keywords.rst with 100% similarity]
doc/sphinx/rules/header-keywords/ICMP_type_code.png [moved from doc/sphinx/header-keywords/ICMP_type_code.png with 100% similarity]
doc/sphinx/rules/header-keywords/ICMP_types.png [moved from doc/sphinx/header-keywords/ICMP_types.png with 100% similarity]
doc/sphinx/rules/header-keywords/Window.png [moved from doc/sphinx/header-keywords/Window.png with 100% similarity]
doc/sphinx/rules/header-keywords/Wireshark_ack.png [moved from doc/sphinx/header-keywords/Wireshark_ack.png with 100% similarity]
doc/sphinx/rules/header-keywords/Wireshark_seq.png [moved from doc/sphinx/header-keywords/Wireshark_seq.png with 100% similarity]
doc/sphinx/rules/header-keywords/ack.png [moved from doc/sphinx/header-keywords/ack.png with 100% similarity]
doc/sphinx/rules/header-keywords/fragbits.png [moved from doc/sphinx/header-keywords/fragbits.png with 100% similarity]
doc/sphinx/rules/header-keywords/fragoffset.png [moved from doc/sphinx/header-keywords/fragoffset.png with 100% similarity]
doc/sphinx/rules/header-keywords/icmp_id.png [moved from doc/sphinx/header-keywords/icmp_id.png with 100% similarity]
doc/sphinx/rules/header-keywords/icmp_seq.png [moved from doc/sphinx/header-keywords/icmp_seq.png with 100% similarity]
doc/sphinx/rules/header-keywords/icmp_type.png [moved from doc/sphinx/header-keywords/icmp_type.png with 100% similarity]
doc/sphinx/rules/header-keywords/icode.png [moved from doc/sphinx/header-keywords/icode.png with 100% similarity]
doc/sphinx/rules/header-keywords/id.png [moved from doc/sphinx/header-keywords/id.png with 100% similarity]
doc/sphinx/rules/header-keywords/ip_proto.png [moved from doc/sphinx/header-keywords/ip_proto.png with 100% similarity]
doc/sphinx/rules/header-keywords/ipopts.png [moved from doc/sphinx/header-keywords/ipopts.png with 100% similarity]
doc/sphinx/rules/header-keywords/ipopts_rule.png [moved from doc/sphinx/header-keywords/ipopts_rule.png with 100% similarity]
doc/sphinx/rules/header-keywords/sameip.png [moved from doc/sphinx/header-keywords/sameip.png with 100% similarity]
doc/sphinx/rules/header-keywords/seq.png [moved from doc/sphinx/header-keywords/seq.png with 100% similarity]
doc/sphinx/rules/header-keywords/ttl.png [moved from doc/sphinx/header-keywords/ttl.png with 100% similarity]
doc/sphinx/rules/http-keywords.rst [moved from doc/sphinx/http-keywords.rst with 100% similarity]
doc/sphinx/rules/http-keywords/Legenda_rules.png [moved from doc/sphinx/http-keywords/Legenda_rules.png with 100% similarity]
doc/sphinx/rules/http-keywords/client_body.png [moved from doc/sphinx/http-keywords/client_body.png with 100% similarity]
doc/sphinx/rules/http-keywords/client_body1.png [moved from doc/sphinx/http-keywords/client_body1.png with 100% similarity]
doc/sphinx/rules/http-keywords/cookie.png [moved from doc/sphinx/http-keywords/cookie.png with 100% similarity]
doc/sphinx/rules/http-keywords/cookie1.png [moved from doc/sphinx/http-keywords/cookie1.png with 100% similarity]
doc/sphinx/rules/http-keywords/fast_pattern.png [moved from doc/sphinx/http-keywords/fast_pattern.png with 100% similarity]
doc/sphinx/rules/http-keywords/file_data.png [moved from doc/sphinx/http-keywords/file_data.png with 100% similarity]
doc/sphinx/rules/http-keywords/header.png [moved from doc/sphinx/http-keywords/header.png with 100% similarity]
doc/sphinx/rules/http-keywords/header1.png [moved from doc/sphinx/http-keywords/header1.png with 100% similarity]
doc/sphinx/rules/http-keywords/http_server_body.png [moved from doc/sphinx/http-keywords/http_server_body.png with 100% similarity]
doc/sphinx/rules/http-keywords/http_uri.png [moved from doc/sphinx/http-keywords/http_uri.png with 100% similarity]
doc/sphinx/rules/http-keywords/method.png [moved from doc/sphinx/http-keywords/method.png with 100% similarity]
doc/sphinx/rules/http-keywords/method1.png [moved from doc/sphinx/http-keywords/method1.png with 100% similarity]
doc/sphinx/rules/http-keywords/method2.png [moved from doc/sphinx/http-keywords/method2.png with 100% similarity]
doc/sphinx/rules/http-keywords/request.png [moved from doc/sphinx/http-keywords/request.png with 100% similarity]
doc/sphinx/rules/http-keywords/request2.png [moved from doc/sphinx/http-keywords/request2.png with 100% similarity]
doc/sphinx/rules/http-keywords/response1.png [moved from doc/sphinx/http-keywords/response1.png with 100% similarity]
doc/sphinx/rules/http-keywords/stat-code1.png [moved from doc/sphinx/http-keywords/stat-code1.png with 100% similarity]
doc/sphinx/rules/http-keywords/stat_code.png [moved from doc/sphinx/http-keywords/stat_code.png with 100% similarity]
doc/sphinx/rules/http-keywords/stat_msg.png [moved from doc/sphinx/http-keywords/stat_msg.png with 100% similarity]
doc/sphinx/rules/http-keywords/stat_msg_1.png [moved from doc/sphinx/http-keywords/stat_msg_1.png with 100% similarity]
doc/sphinx/rules/http-keywords/uri.png [moved from doc/sphinx/http-keywords/uri.png with 100% similarity]
doc/sphinx/rules/http-keywords/uri1.png [moved from doc/sphinx/http-keywords/uri1.png with 100% similarity]
doc/sphinx/rules/http-keywords/uricontent.png [moved from doc/sphinx/http-keywords/uricontent.png with 100% similarity]
doc/sphinx/rules/http-keywords/uricontent1.png [moved from doc/sphinx/http-keywords/uricontent1.png with 100% similarity]
doc/sphinx/rules/http-keywords/urilen.png [moved from doc/sphinx/http-keywords/urilen.png with 100% similarity]
doc/sphinx/rules/http-keywords/urilen1.png [moved from doc/sphinx/http-keywords/urilen1.png with 100% similarity]
doc/sphinx/rules/http-keywords/user_agent.png [moved from doc/sphinx/http-keywords/user_agent.png with 100% similarity]
doc/sphinx/rules/http-keywords/user_agent_match.png [moved from doc/sphinx/http-keywords/user_agent_match.png with 100% similarity]
doc/sphinx/rules/index.rst [moved from doc/sphinx/rules.rst with 95% similarity]
doc/sphinx/rules/intro.rst [moved from doc/sphinx/rules-intro.rst with 94% similarity]
doc/sphinx/rules/intro/Dest_port.png [moved from doc/sphinx/rules/Dest_port.png with 100% similarity]
doc/sphinx/rules/intro/Direction.png [moved from doc/sphinx/rules/Direction.png with 100% similarity]
doc/sphinx/rules/intro/Source-port.png [moved from doc/sphinx/rules/Source-port.png with 100% similarity]
doc/sphinx/rules/intro/Source.png [moved from doc/sphinx/rules/Source.png with 100% similarity]
doc/sphinx/rules/intro/TCP-session.png [moved from doc/sphinx/rules/TCP-session.png with 100% similarity]
doc/sphinx/rules/intro/action.png [moved from doc/sphinx/rules/action.png with 100% similarity]
doc/sphinx/rules/intro/destination.png [moved from doc/sphinx/rules/destination.png with 100% similarity]
doc/sphinx/rules/intro/intro_sig.png [moved from doc/sphinx/rules/intro_sig.png with 100% similarity]
doc/sphinx/rules/intro/protocol.png [moved from doc/sphinx/rules/protocol.png with 100% similarity]
doc/sphinx/rules/live-rule-swap.rst [moved from doc/sphinx/live-rule-swap.rst with 100% similarity]
doc/sphinx/rules/meta.rst [moved from doc/sphinx/meta.rst with 100% similarity]
doc/sphinx/rules/meta/classification.png [moved from doc/sphinx/meta/classification.png with 100% similarity]
doc/sphinx/rules/meta/classtype.png [moved from doc/sphinx/meta/classtype.png with 100% similarity]
doc/sphinx/rules/meta/gid.png [moved from doc/sphinx/meta/gid.png with 100% similarity]
doc/sphinx/rules/meta/msg.png [moved from doc/sphinx/meta/msg.png with 100% similarity]
doc/sphinx/rules/meta/reference.png [moved from doc/sphinx/meta/reference.png with 100% similarity]
doc/sphinx/rules/meta/rev.png [moved from doc/sphinx/meta/rev.png with 100% similarity]
doc/sphinx/rules/meta/sid.png [moved from doc/sphinx/meta/sid.png with 100% similarity]
doc/sphinx/rules/modbus-keyword.rst [moved from doc/sphinx/modbus-keyword.rst with 100% similarity]
doc/sphinx/rules/normalized-buffers.rst [moved from doc/sphinx/normalized-buffers.rst with 100% similarity]
doc/sphinx/rules/normalized-buffers/normalization1.png [moved from doc/sphinx/normalized-buffers/normalization1.png with 100% similarity]
doc/sphinx/rules/payload-keywords.rst [moved from doc/sphinx/payload-keywords.rst with 100% similarity]
doc/sphinx/rules/payload-keywords/Legenda_rules.png [moved from doc/sphinx/payload-keywords/Legenda_rules.png with 100% similarity]
doc/sphinx/rules/payload-keywords/content.png [moved from doc/sphinx/payload-keywords/content.png with 100% similarity]
doc/sphinx/rules/payload-keywords/content2.png [moved from doc/sphinx/payload-keywords/content2.png with 100% similarity]
doc/sphinx/rules/payload-keywords/content3.png [moved from doc/sphinx/payload-keywords/content3.png with 100% similarity]
doc/sphinx/rules/payload-keywords/content4.png [moved from doc/sphinx/payload-keywords/content4.png with 100% similarity]
doc/sphinx/rules/payload-keywords/content5.png [moved from doc/sphinx/payload-keywords/content5.png with 100% similarity]
doc/sphinx/rules/payload-keywords/content6.png [moved from doc/sphinx/payload-keywords/content6.png with 100% similarity]
doc/sphinx/rules/payload-keywords/distance.png [moved from doc/sphinx/payload-keywords/distance.png with 100% similarity]
doc/sphinx/rules/payload-keywords/distance1.png [moved from doc/sphinx/payload-keywords/distance1.png with 100% similarity]
doc/sphinx/rules/payload-keywords/distance3.png [moved from doc/sphinx/payload-keywords/distance3.png with 100% similarity]
doc/sphinx/rules/payload-keywords/distance4.png [moved from doc/sphinx/payload-keywords/distance4.png with 100% similarity]
doc/sphinx/rules/payload-keywords/distance5.png [moved from doc/sphinx/payload-keywords/distance5.png with 100% similarity]
doc/sphinx/rules/payload-keywords/dsize.png [moved from doc/sphinx/payload-keywords/dsize.png with 100% similarity]
doc/sphinx/rules/payload-keywords/isdataat1.png [moved from doc/sphinx/payload-keywords/isdataat1.png with 100% similarity]
doc/sphinx/rules/payload-keywords/replace.png [moved from doc/sphinx/payload-keywords/replace.png with 100% similarity]
doc/sphinx/rules/payload-keywords/replace1.png [moved from doc/sphinx/payload-keywords/replace1.png with 100% similarity]
doc/sphinx/rules/payload-keywords/rpc.png [moved from doc/sphinx/payload-keywords/rpc.png with 100% similarity]
doc/sphinx/rules/payload-keywords/within1.png [moved from doc/sphinx/payload-keywords/within1.png with 100% similarity]
doc/sphinx/rules/payload-keywords/within2.png [moved from doc/sphinx/payload-keywords/within2.png with 100% similarity]
doc/sphinx/rules/payload-keywords/within_distance.png [moved from doc/sphinx/payload-keywords/within_distance.png with 100% similarity]
doc/sphinx/rules/payload-keywords/within_distance2.png [moved from doc/sphinx/payload-keywords/within_distance2.png with 100% similarity]
doc/sphinx/rules/pcre.rst [moved from doc/sphinx/pcre.rst with 100% similarity]
doc/sphinx/rules/pcre/pcre.png [moved from doc/sphinx/pcre/pcre.png with 100% similarity]
doc/sphinx/rules/pcre/pcre3.png [moved from doc/sphinx/pcre/pcre3.png with 100% similarity]
doc/sphinx/rules/pcre/pcre4.png [moved from doc/sphinx/pcre/pcre4.png with 100% similarity]
doc/sphinx/rules/pcre/pcre5.png [moved from doc/sphinx/pcre/pcre5.png with 100% similarity]
doc/sphinx/rules/pcre/pcre6.png [moved from doc/sphinx/pcre/pcre6.png with 100% similarity]
doc/sphinx/rules/rule-lua-scripting.rst [moved from doc/sphinx/rule-lua-scripting.rst with 100% similarity]
doc/sphinx/rules/rule-profiling.rst [moved from doc/sphinx/rule-profiling.rst with 100% similarity]
doc/sphinx/rules/thresholding.rst [moved from doc/sphinx/thresholding.rst with 100% similarity]
doc/sphinx/rules/tls-keywords.rst [moved from doc/sphinx/tls-keywords.rst with 100% similarity]

index 40581d2bce35ba87ecc16938d6c9c56679f4f920..9c75ba65217a0cabcb369029c7547d5a9aae5de6 100644 (file)
@@ -6,4 +6,4 @@ Suricata User Guide
    :titlesonly:
 
    what-is-suricata
-   rules
+   rules/index.rst
similarity index 95%
rename from doc/sphinx/rules.rst
rename to doc/sphinx/rules/index.rst
index 8b5f5e95eee340d0ab93fd1988b1a47d3c8a8401..6f73db0cf62fca7ba1b74b0b3713bf640dd2bd85 100644 (file)
@@ -3,7 +3,7 @@ Suricata Rules
 
 .. toctree::
 
-   rules-intro
+   intro
    meta
    header-keywords
    payload-keywords
@@ -21,4 +21,3 @@ Suricata Rules
    rule-profiling
    modbus-keyword
    dnp3-keywords
-
similarity index 94%
rename from doc/sphinx/rules-intro.rst
rename to doc/sphinx/rules/intro.rst
index 960da6994a89e37da60c58c613a554152b6e3030..e834c31e59018f827301d99966ea16def43a55eb 100644 (file)
@@ -17,7 +17,7 @@ A rule/signature consists of the following:
 
 Example of a signature:
 
-.. image:: rules/intro_sig.png
+.. image:: intro/intro_sig.png
 
 Action
 ------
@@ -27,7 +27,7 @@ For more information read 'Action Order' in the
 
 Example:
 
-.. image:: rules/action.png
+.. image:: intro/action.png
 
 In this example the red, bold-faced part is the action.
 
@@ -45,7 +45,7 @@ match if it concerns http-traffic.
 
 Example:
 
-.. image:: rules/protocol.png
+.. image:: intro/protocol.png
 
 In this example the red, bold-faced part is the protocol.
 
@@ -83,11 +83,11 @@ You can not write a signature using EXTERNAL_NET because it stands for
 
 Example of source and destination in a signature:
 
-.. image:: rules/Source.png
+.. image:: intro/Source.png
 
 The red, bold-faced part is the source.
 
-.. image:: rules/destination.png
+.. image:: intro/destination.png
 
 The red, bold-faced part is the destination.
 
@@ -120,10 +120,10 @@ Example::
 
 Example of ports in a signature:
 
-.. image:: rules/Source-port.png
+.. image:: intro/Source-port.png
 
 
-.. image:: rules/Dest_port.png
+.. image:: intro/Dest_port.png
 
 In this example, the red, bold-faced part is the port.
 
@@ -145,14 +145,14 @@ Example::
 
 Example 1     tcp-session
 
-.. image:: rules/TCP-session.png
+.. image:: intro/TCP-session.png
 
 In this example there will only be a match if the signature has the
 same order/direction as the payload.
 
 Example of direction in a signature:
 
-.. image:: rules/Direction.png
+.. image:: intro/Direction.png
 
 In this example the red, bold-faced part is the direction.