mirror of
https://github.com/zeek/zeek.git
synced 2025-10-13 20:18:20 +00:00
Change doc/ subdir into a git submodule
The docs now live at https://github.com/zeek/zeek-docs
This commit is contained in:
Jon Siwek
parent
0d685efbf5
commit
2ff746fea7
693 changed files with 26 additions and 105609 deletions
|
|
@ -1,14 +0,0 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/config/__load__.bro
|
||||
===================================
|
||||
|
||||
|
||||
:Imports: :doc:`base/frameworks/config/input.bro </scripts/base/frameworks/config/input.bro>`, :doc:`base/frameworks/config/main.bro </scripts/base/frameworks/config/main.bro>`, :doc:`base/frameworks/config/weird.bro </scripts/base/frameworks/config/weird.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
:orphan:
|
||||
|
||||
Package: base/frameworks/config
|
||||
===============================
|
||||
|
||||
The configuration framework provides a way to change the Bro configuration
|
||||
in "option" values at run-time.
|
||||
|
||||
:doc:`/scripts/base/frameworks/config/__load__.bro`
|
||||
|
||||
|
||||
:doc:`/scripts/base/frameworks/config/main.bro`
|
||||
|
||||
The configuration framework provides a way to change Bro options
|
||||
(as specified by the "option" keyword) at runtime. It also logs runtime
|
||||
changes to options to config.log.
|
||||
|
||||
:doc:`/scripts/base/frameworks/config/input.bro`
|
||||
|
||||
File input for the configuration framework using the input framework.
|
||||
|
||||
:doc:`/scripts/base/frameworks/config/weird.bro`
|
||||
|
||||
This script sets up the config framework change handlers for weirds.
|
||||
|
||||
|
|
@ -1,54 +0,0 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/config/input.bro
|
||||
================================
|
||||
.. bro:namespace:: Config
|
||||
|
||||
File input for the configuration framework using the input framework.
|
||||
|
||||
:Namespace: Config
|
||||
:Imports: :doc:`base/frameworks/cluster </scripts/base/frameworks/cluster/index>`, :doc:`base/frameworks/config/main.bro </scripts/base/frameworks/config/main.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
================================================================== ===============================================
|
||||
:bro:id:`Config::config_files`: :bro:type:`set` :bro:attr:`&redef` Configuration files that will be read off disk.
|
||||
================================================================== ===============================================
|
||||
|
||||
Functions
|
||||
#########
|
||||
=================================================== ===================================================================
|
||||
:bro:id:`Config::read_config`: :bro:type:`function` Read specified configuration file and apply values; updates to file
|
||||
are not tracked.
|
||||
=================================================== ===================================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
.. bro:id:: Config::config_files
|
||||
|
||||
:Type: :bro:type:`set` [:bro:type:`string`]
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``{}``
|
||||
|
||||
Configuration files that will be read off disk. Files are reread
|
||||
every time they are updated so updates should be atomic with "mv"
|
||||
instead of writing the file in place.
|
||||
|
||||
If the same configuration option is defined in several files with
|
||||
different values, behavior is unspecified.
|
||||
|
||||
Functions
|
||||
#########
|
||||
.. bro:id:: Config::read_config
|
||||
|
||||
:Type: :bro:type:`function` (filename: :bro:type:`string`) : :bro:type:`void`
|
||||
|
||||
Read specified configuration file and apply values; updates to file
|
||||
are not tracked.
|
||||
|
||||
|
||||
|
|
@ -1,101 +0,0 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/config/main.bro
|
||||
===============================
|
||||
.. bro:namespace:: Config
|
||||
|
||||
The configuration framework provides a way to change Bro options
|
||||
(as specified by the "option" keyword) at runtime. It also logs runtime
|
||||
changes to options to config.log.
|
||||
|
||||
:Namespace: Config
|
||||
:Imports: :doc:`base/frameworks/cluster </scripts/base/frameworks/cluster/index>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Types
|
||||
#####
|
||||
============================================ ==================================
|
||||
:bro:type:`Config::Info`: :bro:type:`record` Represents the data in config.log.
|
||||
============================================ ==================================
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
===================================== =====================================
|
||||
:bro:type:`Log::ID`: :bro:type:`enum` The config logging stream identifier.
|
||||
===================================== =====================================
|
||||
|
||||
Events
|
||||
######
|
||||
=============================================== ================================================================
|
||||
:bro:id:`Config::log_config`: :bro:type:`event` Event that can be handled to access the :bro:type:`Config::Info`
|
||||
record as it is sent on to the logging framework.
|
||||
=============================================== ================================================================
|
||||
|
||||
Functions
|
||||
#########
|
||||
================================================= ==================================================================
|
||||
:bro:id:`Config::set_value`: :bro:type:`function` This function is the config framework layer around the lower-level
|
||||
:bro:see:`Option::set` call.
|
||||
================================================= ==================================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Types
|
||||
#####
|
||||
.. bro:type:: Config::Info
|
||||
|
||||
:Type: :bro:type:`record`
|
||||
|
||||
ts: :bro:type:`time` :bro:attr:`&log`
|
||||
Timestamp at which the configuration change occured.
|
||||
|
||||
id: :bro:type:`string` :bro:attr:`&log`
|
||||
ID of the value that was changed.
|
||||
|
||||
old_value: :bro:type:`string` :bro:attr:`&log`
|
||||
Value before the change.
|
||||
|
||||
new_value: :bro:type:`string` :bro:attr:`&log`
|
||||
Value after the change.
|
||||
|
||||
location: :bro:type:`string` :bro:attr:`&optional` :bro:attr:`&log`
|
||||
Optional location that triggered the change.
|
||||
|
||||
Represents the data in config.log.
|
||||
|
||||
Events
|
||||
######
|
||||
.. bro:id:: Config::log_config
|
||||
|
||||
:Type: :bro:type:`event` (rec: :bro:type:`Config::Info`)
|
||||
|
||||
Event that can be handled to access the :bro:type:`Config::Info`
|
||||
record as it is sent on to the logging framework.
|
||||
|
||||
Functions
|
||||
#########
|
||||
.. bro:id:: Config::set_value
|
||||
|
||||
:Type: :bro:type:`function` (ID: :bro:type:`string`, val: :bro:type:`any`, location: :bro:type:`string` :bro:attr:`&default` = ``""`` :bro:attr:`&optional` :bro:attr:`&optional`) : :bro:type:`bool`
|
||||
|
||||
This function is the config framework layer around the lower-level
|
||||
:bro:see:`Option::set` call. Config::set_value will set the configuration
|
||||
value for all nodes in the cluster, no matter where it was called. Note
|
||||
that :bro:see:`Option::set` does not distribute configuration changes
|
||||
to other nodes.
|
||||
|
||||
|
||||
:ID: The ID of the option to update.
|
||||
|
||||
|
||||
:val: The new value of the option.
|
||||
|
||||
|
||||
:location: Optional parameter detailing where this change originated from.
|
||||
|
||||
|
||||
:returns: true on success, false when an error occurs.
|
||||
|
||||
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/config/weird.bro
|
||||
================================
|
||||
.. bro:namespace:: Config
|
||||
|
||||
This script sets up the config framework change handlers for weirds.
|
||||
|
||||
:Namespace: Config
|
||||
:Imports: :doc:`base/frameworks/config/main.bro </scripts/base/frameworks/config/main.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue