Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-04 15:48:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Change doc/ subdir into a git submodule

Browse source 
The docs now live at https://github.com/zeek/zeek-docs
This commit is contained in:
Jon Siwek 2019-01-17 14:09:29 -06:00
parent 0d685efbf5
commit 2ff746fea7
693 changed files with 26 additions and 105609 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/scripts/base/frameworks/sumstats/plugins/__load__.bro.rst
View file

@ -1,14 +0,0 @@
:tocdepth: 3
base/frameworks/sumstats/plugins/__load__.bro
=============================================
:Imports: :doc:`base/frameworks/sumstats/plugins/average.bro </scripts/base/frameworks/sumstats/plugins/average.bro>`, :doc:`base/frameworks/sumstats/plugins/hll_unique.bro </scripts/base/frameworks/sumstats/plugins/hll_unique.bro>`, :doc:`base/frameworks/sumstats/plugins/last.bro </scripts/base/frameworks/sumstats/plugins/last.bro>`, :doc:`base/frameworks/sumstats/plugins/max.bro </scripts/base/frameworks/sumstats/plugins/max.bro>`, :doc:`base/frameworks/sumstats/plugins/min.bro </scripts/base/frameworks/sumstats/plugins/min.bro>`, :doc:`base/frameworks/sumstats/plugins/sample.bro </scripts/base/frameworks/sumstats/plugins/sample.bro>`, :doc:`base/frameworks/sumstats/plugins/std-dev.bro </scripts/base/frameworks/sumstats/plugins/std-dev.bro>`, :doc:`base/frameworks/sumstats/plugins/sum.bro </scripts/base/frameworks/sumstats/plugins/sum.bro>`, :doc:`base/frameworks/sumstats/plugins/topk.bro </scripts/base/frameworks/sumstats/plugins/topk.bro>`, :doc:`base/frameworks/sumstats/plugins/unique.bro </scripts/base/frameworks/sumstats/plugins/unique.bro>`, :doc:`base/frameworks/sumstats/plugins/variance.bro </scripts/base/frameworks/sumstats/plugins/variance.bro>`
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

24
doc/scripts/base/frameworks/sumstats/plugins/average.bro.rst
View file

@ -1,24 +0,0 @@
:tocdepth: 3
base/frameworks/sumstats/plugins/average.bro
============================================
.. bro:namespace:: SumStats
Calculate the average.
:Namespace: SumStats
:Imports: :doc:`base/frameworks/sumstats/main.bro </scripts/base/frameworks/sumstats/main.bro>`
Summary
~~~~~~~
Redefinitions
#############
=================================================== =
:bro:type:`SumStats::Calculation`: :bro:type:`enum`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
=================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~

26
doc/scripts/base/frameworks/sumstats/plugins/hll_unique.bro.rst
View file

@ -1,26 +0,0 @@
:tocdepth: 3
base/frameworks/sumstats/plugins/hll_unique.bro
===============================================
.. bro:namespace:: SumStats
Calculate the number of unique values (using the HyperLogLog algorithm).
:Namespace: SumStats
:Imports: :doc:`base/frameworks/sumstats </scripts/base/frameworks/sumstats/index>`
Summary
~~~~~~~
Redefinitions
#############
=================================================== =
:bro:type:`SumStats::Calculation`: :bro:type:`enum`
:bro:type:`SumStats::Reducer`: :bro:type:`record`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
=================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~

54
doc/scripts/base/frameworks/sumstats/plugins/index.rst
View file

@ -1,54 +0,0 @@
:orphan:
Package: base/frameworks/sumstats/plugins
=========================================
Plugins for the summary statistics framework.
:doc:`/scripts/base/frameworks/sumstats/plugins/__load__.bro`
:doc:`/scripts/base/frameworks/sumstats/plugins/average.bro`
Calculate the average.
:doc:`/scripts/base/frameworks/sumstats/plugins/hll_unique.bro`
Calculate the number of unique values (using the HyperLogLog algorithm).
:doc:`/scripts/base/frameworks/sumstats/plugins/last.bro`
Keep the last X observations.
:doc:`/scripts/base/frameworks/sumstats/plugins/max.bro`
Find the maximum value.
:doc:`/scripts/base/frameworks/sumstats/plugins/min.bro`
Find the minimum value.
:doc:`/scripts/base/frameworks/sumstats/plugins/sample.bro`
Keep a random sample of values.
:doc:`/scripts/base/frameworks/sumstats/plugins/std-dev.bro`
Calculate the standard deviation.
:doc:`/scripts/base/frameworks/sumstats/plugins/variance.bro`
Calculate the variance.
:doc:`/scripts/base/frameworks/sumstats/plugins/sum.bro`
Calculate the sum.
:doc:`/scripts/base/frameworks/sumstats/plugins/topk.bro`
Keep the top-k (i.e., most frequently occurring) observations.
:doc:`/scripts/base/frameworks/sumstats/plugins/unique.bro`
Calculate the number of unique values.

39
doc/scripts/base/frameworks/sumstats/plugins/last.bro.rst
View file

@ -1,39 +0,0 @@
:tocdepth: 3
base/frameworks/sumstats/plugins/last.bro
=========================================
.. bro:namespace:: SumStats
Keep the last X observations.
:Namespace: SumStats
:Imports: :doc:`base/frameworks/sumstats </scripts/base/frameworks/sumstats/index>`, :doc:`base/utils/queue.bro </scripts/base/utils/queue.bro>`
Summary
~~~~~~~
Redefinitions
#############
=================================================== =
:bro:type:`SumStats::Calculation`: :bro:type:`enum`
:bro:type:`SumStats::Reducer`: :bro:type:`record`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
=================================================== =
Functions
#########
================================================== ================================================
:bro:id:`SumStats::get_last`: :bro:type:`function` Get a vector of element values from a ResultVal.
================================================== ================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. bro:id:: SumStats::get_last
:Type: :bro:type:`function` (rv: :bro:type:`SumStats::ResultVal`) : :bro:type:`vector` of :bro:type:`SumStats::Observation`
Get a vector of element values from a ResultVal.

24
doc/scripts/base/frameworks/sumstats/plugins/max.bro.rst
View file

@ -1,24 +0,0 @@
:tocdepth: 3
base/frameworks/sumstats/plugins/max.bro
========================================
.. bro:namespace:: SumStats
Find the maximum value.
:Namespace: SumStats
:Imports: :doc:`base/frameworks/sumstats/main.bro </scripts/base/frameworks/sumstats/main.bro>`
Summary
~~~~~~~
Redefinitions
#############
=================================================== =
:bro:type:`SumStats::Calculation`: :bro:type:`enum`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
=================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~

24
doc/scripts/base/frameworks/sumstats/plugins/min.bro.rst
View file

@ -1,24 +0,0 @@
:tocdepth: 3
base/frameworks/sumstats/plugins/min.bro
========================================
.. bro:namespace:: SumStats
Find the minimum value.
:Namespace: SumStats
:Imports: :doc:`base/frameworks/sumstats/main.bro </scripts/base/frameworks/sumstats/main.bro>`
Summary
~~~~~~~
Redefinitions
#############
=================================================== =
:bro:type:`SumStats::Calculation`: :bro:type:`enum`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
=================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~

26
doc/scripts/base/frameworks/sumstats/plugins/sample.bro.rst
View file

@ -1,26 +0,0 @@
:tocdepth: 3
base/frameworks/sumstats/plugins/sample.bro
===========================================
.. bro:namespace:: SumStats
Keep a random sample of values.
:Namespace: SumStats
:Imports: :doc:`base/frameworks/sumstats/main.bro </scripts/base/frameworks/sumstats/main.bro>`
Summary
~~~~~~~
Redefinitions
#############
=================================================== =
:bro:type:`SumStats::Calculation`: :bro:type:`enum`
:bro:type:`SumStats::Reducer`: :bro:type:`record`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
=================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~

24
doc/scripts/base/frameworks/sumstats/plugins/std-dev.bro.rst
View file

@ -1,24 +0,0 @@
:tocdepth: 3
base/frameworks/sumstats/plugins/std-dev.bro
============================================
.. bro:namespace:: SumStats
Calculate the standard deviation.
:Namespace: SumStats
:Imports: :doc:`base/frameworks/sumstats/main.bro </scripts/base/frameworks/sumstats/main.bro>`, :doc:`base/frameworks/sumstats/plugins/variance.bro </scripts/base/frameworks/sumstats/plugins/variance.bro>`
Summary
~~~~~~~
Redefinitions
#############
=================================================== =
:bro:type:`SumStats::Calculation`: :bro:type:`enum`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
=================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~

24
doc/scripts/base/frameworks/sumstats/plugins/sum.bro.rst
View file

@ -1,24 +0,0 @@
:tocdepth: 3
base/frameworks/sumstats/plugins/sum.bro
========================================
.. bro:namespace:: SumStats
Calculate the sum.
:Namespace: SumStats
:Imports: :doc:`base/frameworks/sumstats/main.bro </scripts/base/frameworks/sumstats/main.bro>`
Summary
~~~~~~~
Redefinitions
#############
=================================================== =
:bro:type:`SumStats::Calculation`: :bro:type:`enum`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
=================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~

25
doc/scripts/base/frameworks/sumstats/plugins/topk.bro.rst
View file

@ -1,25 +0,0 @@
:tocdepth: 3
base/frameworks/sumstats/plugins/topk.bro
=========================================
.. bro:namespace:: SumStats
Keep the top-k (i.e., most frequently occurring) observations.
:Namespace: SumStats
:Imports: :doc:`base/frameworks/sumstats </scripts/base/frameworks/sumstats/index>`
Summary
~~~~~~~
Redefinitions
#############
=================================================== =
:bro:type:`SumStats::Calculation`: :bro:type:`enum`
:bro:type:`SumStats::Reducer`: :bro:type:`record`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
=================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~

26
doc/scripts/base/frameworks/sumstats/plugins/unique.bro.rst
View file

@ -1,26 +0,0 @@
:tocdepth: 3
base/frameworks/sumstats/plugins/unique.bro
===========================================
.. bro:namespace:: SumStats
Calculate the number of unique values.
:Namespace: SumStats
:Imports: :doc:`base/frameworks/sumstats/main.bro </scripts/base/frameworks/sumstats/main.bro>`
Summary
~~~~~~~
Redefinitions
#############
=================================================== =
:bro:type:`SumStats::Calculation`: :bro:type:`enum`
:bro:type:`SumStats::Reducer`: :bro:type:`record`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
=================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~

25
doc/scripts/base/frameworks/sumstats/plugins/variance.bro.rst
View file

@ -1,25 +0,0 @@
:tocdepth: 3
base/frameworks/sumstats/plugins/variance.bro
=============================================
.. bro:namespace:: SumStats
Calculate the variance.
:Namespace: SumStats
:Imports: :doc:`base/frameworks/sumstats/main.bro </scripts/base/frameworks/sumstats/main.bro>`, :doc:`base/frameworks/sumstats/plugins/average.bro </scripts/base/frameworks/sumstats/plugins/average.bro>`
Summary
~~~~~~~
Redefinitions
#############
=================================================== =
:bro:type:`SumStats::Calculation`: :bro:type:`enum`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
=================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~