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

Copy docs into Zeek repo directly

Browse source 
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the
zeek-docs repo.
This commit is contained in:
Tim Wojtulewicz 2025-09-15 15:52:18 -07:00
parent 83f1e74643
commit ded98cd373
1074 changed files with 169319 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

60
doc/scripts/base/protocols/ftp/utils.zeek.rst Normal file
View file

@ -0,0 +1,60 @@
:tocdepth: 3
base/protocols/ftp/utils.zeek
=============================
.. zeek:namespace:: FTP
Utilities specific for FTP processing.
:Namespace: FTP
:Imports: :doc:`base/protocols/ftp/info.zeek </scripts/base/protocols/ftp/info.zeek>`, :doc:`base/utils/addrs.zeek </scripts/base/utils/addrs.zeek>`, :doc:`base/utils/paths.zeek </scripts/base/utils/paths.zeek>`
Summary
~~~~~~~
Functions
#########
==================================================== ===========================================================
:zeek:id:`FTP::build_url`: :zeek:type:`function` Creates a URL from an :zeek:type:`FTP::Info` record.
:zeek:id:`FTP::build_url_ftp`: :zeek:type:`function` Creates a URL from an :zeek:type:`FTP::Info` record.
:zeek:id:`FTP::describe`: :zeek:type:`function` Create an extremely shortened representation of a log line.
==================================================== ===========================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. zeek:id:: FTP::build_url
:source-code: base/protocols/ftp/utils.zeek 28 38
:Type: :zeek:type:`function` (rec: :zeek:type:`FTP::Info`) : :zeek:type:`string`
Creates a URL from an :zeek:type:`FTP::Info` record.
:param rec: An :zeek:type:`FTP::Info` record.
:returns: A URL, not prefixed by ``"ftp://"``.
.. zeek:id:: FTP::build_url_ftp
:source-code: base/protocols/ftp/utils.zeek 40 43
:Type: :zeek:type:`function` (rec: :zeek:type:`FTP::Info`) : :zeek:type:`string`
Creates a URL from an :zeek:type:`FTP::Info` record.
:param rec: An :zeek:type:`FTP::Info` record.
:returns: A URL prefixed with ``"ftp://"``.
.. zeek:id:: FTP::describe
:source-code: base/protocols/ftp/utils.zeek 45 48
:Type: :zeek:type:`function` (rec: :zeek:type:`FTP::Info`) : :zeek:type:`string`
Create an extremely shortened representation of a log line.