Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-07 09:08:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Misc. documentation fixes.

Browse source 
Silences some warnings from Sphinx.
This commit is contained in:
Jon Siwek 2014-03-04 13:14:32 -06:00
parent d6d26a3ea7
commit 4fd1098949
4 changed files with 11 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/broids/index.rst
View file

@ -15,9 +15,9 @@ conditions specific to your particular case.
In the following sections, we present a few examples of common uses of In the following sections, we present a few examples of common uses of
Bro as an IDS. Bro as an IDS.
------------------------------------------------ -------------------------------------------------
Detecting an FTP Brute-force Attack and Notifying Detecting an FTP Brute-force Attack and Notifying
------------------------------------------------ -------------------------------------------------
For the purpose of this exercise, we define FTP brute-forcing as too many For the purpose of this exercise, we define FTP brute-forcing as too many
rejected usernames and passwords occurring from a single address. We rejected usernames and passwords occurring from a single address. We

2
doc/index.rst
View file

@ -17,6 +17,8 @@ Introduction Section
.. ..
.. _using-bro:
Using Bro Section Using Bro Section
================= =================

7
doc/quickstart/index.rst
View file

@ -292,9 +292,10 @@ tweak the most basic options. Here's some suggestions on what to explore next:
* We only looked at how to change options declared in the notice framework, * We only looked at how to change options declared in the notice framework,
there's many more options to look at in other script packages. there's many more options to look at in other script packages.
* Continue reading with :ref:`using-bro` chapter which goes into more * Continue reading with :ref:`Using Bro <using-bro>` chapter which goes
depth on working with Bro; then look at :ref:`writing-scripts` for into more depth on working with Bro; then look at
learning how to start writing your own scripts. :ref:`writing-scripts` for learning how to start writing your own
scripts.
* Look at the scripts in ``$PREFIX/share/bro/policy`` for further ones * Look at the scripts in ``$PREFIX/share/bro/policy`` for further ones
you may want to load; you can browse their documentation at the you may want to load; you can browse their documentation at the
:ref:`overview of script packages <script-packages>`. :ref:`overview of script packages <script-packages>`.

6
doc/scripting/index.rst
View file

@ -345,13 +345,13 @@ keyword. Unlike globals, constants can only be set or altered at
parse time if the ``&redef`` attribute has been used. Afterwards (in parse time if the ``&redef`` attribute has been used. Afterwards (in
runtime) the constants are unalterable. In most cases, re-definable runtime) the constants are unalterable. In most cases, re-definable
constants are used in Bro scripts as containers for configuration constants are used in Bro scripts as containers for configuration
options. For example, the configuration option to log password options. For example, the configuration option to log passwords
decrypted from HTTP streams is stored in decrypted from HTTP streams is stored in
``HTTP::default_capture_password`` as shown in the stripped down :bro:see:`HTTP::default_capture_password` as shown in the stripped down
excerpt from :doc:`/scripts/base/protocols/http/main.bro` below. excerpt from :doc:`/scripts/base/protocols/http/main.bro` below.
.. btest-include:: ${BRO_SRC_ROOT}/scripts/base/protocols/http/main.bro .. btest-include:: ${BRO_SRC_ROOT}/scripts/base/protocols/http/main.bro
:lines: 8-10,19-21,120 :lines: 9-11,20-22,121
Because the constant was declared with the ``&redef`` attribute, if we Because the constant was declared with the ``&redef`` attribute, if we
needed to turn this option on globally, we could do so by adding the needed to turn this option on globally, we could do so by adding the