mirror of
https://github.com/zeek/zeek.git
synced 2025-10-17 14:08:20 +00:00
Copy docs into Zeek repo directly
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
This commit is contained in:
parent
83f1e74643
commit
ded98cd373
1074 changed files with 169319 additions and 0 deletions
14
doc/scripts/base/protocols/finger/__load__.zeek.rst
Normal file
14
doc/scripts/base/protocols/finger/__load__.zeek.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/finger/__load__.zeek
|
||||
===================================
|
||||
|
||||
|
||||
:Imports: :doc:`base/protocols/finger/main.zeek </scripts/base/protocols/finger/main.zeek>`, :doc:`base/protocols/finger/spicy-events.zeek </scripts/base/protocols/finger/spicy-events.zeek>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
18
doc/scripts/base/protocols/finger/index.rst
Normal file
18
doc/scripts/base/protocols/finger/index.rst
Normal file
|
@ -0,0 +1,18 @@
|
|||
:orphan:
|
||||
|
||||
Package: base/protocols/finger
|
||||
==============================
|
||||
|
||||
|
||||
:doc:`/scripts/base/protocols/finger/__load__.zeek`
|
||||
|
||||
|
||||
:doc:`/scripts/base/protocols/finger/spicy-events.zeek`
|
||||
|
||||
Events generated by the Finger analyzer.
|
||||
|
||||
:doc:`/scripts/base/protocols/finger/main.zeek`
|
||||
|
||||
Implements base functionality for Finger analysis. We currently do not generate
|
||||
a log file, but just configure the analyzer.
|
||||
|
45
doc/scripts/base/protocols/finger/main.zeek.rst
Normal file
45
doc/scripts/base/protocols/finger/main.zeek.rst
Normal file
|
@ -0,0 +1,45 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/finger/main.zeek
|
||||
===============================
|
||||
.. zeek:namespace:: Finger
|
||||
|
||||
Implements base functionality for Finger analysis. We currently do not generate
|
||||
a log file, but just configure the analyzer.
|
||||
|
||||
:Namespace: Finger
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Constants
|
||||
#########
|
||||
========================================== =
|
||||
:zeek:id:`Finger::ports`: :zeek:type:`set`
|
||||
========================================== =
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
==================================================================== =
|
||||
:zeek:id:`likely_server_ports`: :zeek:type:`set` :zeek:attr:`&redef`
|
||||
==================================================================== =
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Constants
|
||||
#########
|
||||
.. zeek:id:: Finger::ports
|
||||
:source-code: base/protocols/finger/main.zeek 7 7
|
||||
|
||||
:Type: :zeek:type:`set` [:zeek:type:`port`]
|
||||
:Default:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
79/tcp
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
65
doc/scripts/base/protocols/finger/spicy-events.zeek.rst
Normal file
65
doc/scripts/base/protocols/finger/spicy-events.zeek.rst
Normal file
|
@ -0,0 +1,65 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/finger/spicy-events.zeek
|
||||
=======================================
|
||||
|
||||
Events generated by the Finger analyzer.
|
||||
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Events
|
||||
######
|
||||
============================================= ==============================
|
||||
:zeek:id:`finger_reply`: :zeek:type:`event` Generated for Finger replies.
|
||||
:zeek:id:`finger_request`: :zeek:type:`event` Generated for Finger requests.
|
||||
============================================= ==============================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Events
|
||||
######
|
||||
.. zeek:id:: finger_reply
|
||||
:source-code: base/protocols/finger/spicy-events.zeek 31 31
|
||||
|
||||
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, reply_line: :zeek:type:`string`)
|
||||
|
||||
Generated for Finger replies.
|
||||
|
||||
See `Wikipedia <http://en.wikipedia.org/wiki/Finger_protocol>`__ for more
|
||||
information about the Finger protocol.
|
||||
|
||||
|
||||
:param c: The connection.
|
||||
|
||||
|
||||
:param reply_line: The reply as returned by the server
|
||||
|
||||
.. zeek:see:: finger_request
|
||||
|
||||
.. zeek:id:: finger_request
|
||||
:source-code: base/protocols/finger/spicy-events.zeek 19 19
|
||||
|
||||
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, full: :zeek:type:`bool`, username: :zeek:type:`string`, hostname: :zeek:type:`string`)
|
||||
|
||||
Generated for Finger requests.
|
||||
|
||||
See `Wikipedia <http://en.wikipedia.org/wiki/Finger_protocol>`__ for more
|
||||
information about the Finger protocol.
|
||||
|
||||
|
||||
:param c: The connection.
|
||||
|
||||
|
||||
:param full: True if verbose information is requested (``/W`` switch).
|
||||
|
||||
|
||||
:param username: The request's user name.
|
||||
|
||||
|
||||
:param hostname: The request's host name.
|
||||
|
||||
.. zeek:see:: finger_reply
|
||||
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue