From: Russ Combs Date: Sat, 4 Jul 2015 11:42:35 +0000 (-0400) Subject: fix Snort++ markup X-Git-Tag: 3.0.0-233~919 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=33015265aba9794fcfdae99610700ff3385a5836;p=thirdparty%2Fsnort3.git fix Snort++ markup --- diff --git a/doc/bugs.txt b/doc/bugs.txt index 0f976eb06..4a086c1a6 100644 --- a/doc/bugs.txt +++ b/doc/bugs.txt @@ -1,7 +1,7 @@ ==== Build -* configure bombs on OSX with g++ wrapper to clang because g++ version < 4.8 -(compare g++ -dumpversion and g++ --version) +* configure bombs on OSX with g\++ wrapper to clang because g++ version < 4.8 +(compare g\++ -dumpversion and g++ --version) workaround: export CXX=clang++ @@ -45,9 +45,9 @@ used to restrict the protocol of service rules. * uricontent:"foo"; content:"bar"; -> http_uri; content:"foo"; content:"bar"; (missing pkt_data) -* stream_tcp ports and protocols both go into a single -binder.when; this is incorrect as the when fields are logically anded -together (ie must all be true). should create 2 separate bindings. +* stream_tcp ports and protocols both go into a single binder.when; this is +incorrect as the when fields are logically anded together (ie must all be +true). should create 2 separate bindings. * There is a bug in pps_stream_tcp.cc.. when stream_tcp: is specified without any arguments, snort2lua doesn't convert it diff --git a/doc/extending.txt b/doc/extending.txt index 812543e00..441934a21 100644 --- a/doc/extending.txt +++ b/doc/extending.txt @@ -23,7 +23,7 @@ various other data and functions for their given roles. === Modules -The Module is pervasive in Snort++. It is how everything, including +The Module is pervasive in Snort\++. It is how everything, including plugins, are configured. It also provides access to builtin rules. And as the glue that binds functionality to Snort++, the capabilities of a Module are expected to grow to include statistics support, etc. diff --git a/doc/overview.txt b/doc/overview.txt index 4dd0c7ae6..04d3c36ef 100644 --- a/doc/overview.txt +++ b/doc/overview.txt @@ -298,7 +298,7 @@ is available. Snort has started to take this approach to pass some HTTP and SIP preprocessor data to app ID. However, it remains a peripheral feature and still requires the production of data that may not be consumed. -The basic processing steps Snort++ takes are similar to Snort's as seen in +The basic processing steps Snort\++ takes are similar to Snort's as seen in the following diagram. The preprocess step employs specific inspector types instead of a generalized list, but the basic procedure includes stateless packet decoding, TCP stream reassembly, and service specific @@ -331,6 +331,6 @@ URI logger. Inspection events coupled with pluggable inspectors provide a very flexible framework for implementing new features. And JIT buffer stuffers allow -Snort++ to work smarter, not harder. These capabilities will be leveraged +Snort\++ to work smarter, not harder. These capabilities will be leveraged more and more as Snort++ development continues. diff --git a/doc/snort2lua.txt b/doc/snort2lua.txt index 7e1c56403..19dae93dd 100644 --- a/doc/snort2lua.txt +++ b/doc/snort2lua.txt @@ -4,7 +4,7 @@ syntax while Snort 3.0 configuration files are written in Lua. Snort2Lua is a program specifically designed to convert Snort 2.9.X configuration files into Lua files that Snort 3.0 can understand. -Snort2Lua reads your legacy Snort conf file(s) and generates Snort\++ Lua +Snort2Lua reads your legacy Snort conf file(s) and generates Snort++ Lua and rules files. When running this program, the only mandatory option is to provide Snort2Lua with a Snort configuration file. The default output file file is snort.lua, the default error file will be snort.rej, and the @@ -58,7 +58,7 @@ As expected, quiet mode produces a Snort\++ configuration. All errors (aside from Fatal Snort2Lua errors), differences, and comments will omitted from the final output file. Default mode will print everything. That mean you will be able to see exactly what changes have occurred between Snort and -Snort\++ in addition to the new syntax, the original file's comments, and +Snort++ in addition to the new syntax, the original file's comments, and all errors that have occurred. Finally, differences mode will not actually output a valid Snort3.0 configuration. Instead, you can see the exact options from the input configuration that have changed. diff --git a/doc/snort_manual.txt b/doc/snort_manual.txt index 4610bff2a..754546882 100644 --- a/doc/snort_manual.txt +++ b/doc/snort_manual.txt @@ -4,10 +4,6 @@ :toc-placement: manual :toc-title: Contents ---------------- -:quotes.++: ---------------- - image::snorty.png["Snorty",width="480"] include::version.txt[] toc::[]