mirror of
https://github.com/zeek/zeek.git
synced 2025-10-03 23:28:20 +00:00
Remove broxygen Sphinx integration
The broxygen-generated files now live in the git repo, have tests that check that they are up-to-date, and a script to re-generate them on-demand.
This commit is contained in:
parent
9e5e9d04b7
commit
7e9d48f532
549 changed files with 89909 additions and 100 deletions
14
doc/scripts/base/protocols/rfb/__load__.bro.rst
Normal file
14
doc/scripts/base/protocols/rfb/__load__.bro.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/rfb/__load__.bro
|
||||
===============================
|
||||
|
||||
|
||||
:Imports: :doc:`base/protocols/rfb/main.bro </scripts/base/protocols/rfb/main.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
13
doc/scripts/base/protocols/rfb/index.rst
Normal file
13
doc/scripts/base/protocols/rfb/index.rst
Normal file
|
@ -0,0 +1,13 @@
|
|||
:orphan:
|
||||
|
||||
Package: base/protocols/rfb
|
||||
===========================
|
||||
|
||||
Support for Remote FrameBuffer analysis. This includes all VNC servers.
|
||||
|
||||
:doc:`/scripts/base/protocols/rfb/__load__.bro`
|
||||
|
||||
|
||||
:doc:`/scripts/base/protocols/rfb/main.bro`
|
||||
|
||||
|
92
doc/scripts/base/protocols/rfb/main.bro.rst
Normal file
92
doc/scripts/base/protocols/rfb/main.bro.rst
Normal file
|
@ -0,0 +1,92 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/protocols/rfb/main.bro
|
||||
===========================
|
||||
.. bro:namespace:: RFB
|
||||
|
||||
|
||||
:Namespace: RFB
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Types
|
||||
#####
|
||||
========================================= =========================================================
|
||||
:bro:type:`RFB::Info`: :bro:type:`record` The record type which contains the fields of the RFB log.
|
||||
========================================= =========================================================
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
========================================== =
|
||||
:bro:type:`Log::ID`: :bro:type:`enum`
|
||||
:bro:type:`connection`: :bro:type:`record`
|
||||
========================================== =
|
||||
|
||||
Events
|
||||
######
|
||||
========================================= =
|
||||
:bro:id:`RFB::log_rfb`: :bro:type:`event`
|
||||
========================================= =
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Types
|
||||
#####
|
||||
.. bro:type:: RFB::Info
|
||||
|
||||
:Type: :bro:type:`record`
|
||||
|
||||
ts: :bro:type:`time` :bro:attr:`&log`
|
||||
Timestamp for when the event happened.
|
||||
|
||||
uid: :bro:type:`string` :bro:attr:`&log`
|
||||
Unique ID for the connection.
|
||||
|
||||
id: :bro:type:`conn_id` :bro:attr:`&log`
|
||||
The connection's 4-tuple of endpoint addresses/ports.
|
||||
|
||||
client_major_version: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Major version of the client.
|
||||
|
||||
client_minor_version: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Minor version of the client.
|
||||
|
||||
server_major_version: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Major version of the server.
|
||||
|
||||
server_minor_version: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Minor version of the server.
|
||||
|
||||
authentication_method: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Identifier of authentication method used.
|
||||
|
||||
auth: :bro:type:`bool` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Whether or not authentication was successful.
|
||||
|
||||
share_flag: :bro:type:`bool` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Whether the client has an exclusive or a shared session.
|
||||
|
||||
desktop_name: :bro:type:`string` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Name of the screen that is being shared.
|
||||
|
||||
width: :bro:type:`count` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Width of the screen that is being shared.
|
||||
|
||||
height: :bro:type:`count` :bro:attr:`&log` :bro:attr:`&optional`
|
||||
Height of the screen that is being shared.
|
||||
|
||||
done: :bro:type:`bool` :bro:attr:`&default` = ``F`` :bro:attr:`&optional`
|
||||
Internally used value to determine if this connection
|
||||
has already been logged.
|
||||
|
||||
The record type which contains the fields of the RFB log.
|
||||
|
||||
Events
|
||||
######
|
||||
.. bro:id:: RFB::log_rfb
|
||||
|
||||
:Type: :bro:type:`event` (rec: :bro:type:`RFB::Info`)
|
||||
|
||||
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue