From 6e90adad5bb20dd07767e9a89e7c883694b4e678 Mon Sep 17 00:00:00 2001 From: bol-van Date: Sun, 1 Feb 2026 09:56:24 +0300 Subject: [PATCH] update docs --- docs/manual.en.md | 10 +++++----- docs/manual.md | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/manual.en.md b/docs/manual.en.md index ef505dd..029b71f 100644 --- a/docs/manual.en.md +++ b/docs/manual.en.md @@ -2036,7 +2036,7 @@ Those functions receive an already prepared dissect. #### reconstruct_dissect ``` -function reconstruct_dissect(dissect, reconstruct_opts) +function reconstruct_dissect(dissect[, reconstruct_opts]) ``` Returns `raw_ip`. All checksums are calculated automatically. L4 checksums are intentionally corrupted if `badsum` is specified in `reconstruct_opts`. @@ -2060,7 +2060,7 @@ function reconstruct_tcphdr(tcp) function reconstruct_udphdr(udp) function reconstruct_icmphdr(icmp) function reconstruct_iphdr(ip) -function reconstruct_ip6hdr(ip6, reconstruct_opts) +function reconstruct_ip6hdr(ip6[, reconstruct_opts]) ``` Reconstructs the corresponding raw headers from the dissect tables. Returns the raw version of the header. @@ -2088,7 +2088,7 @@ Direct reconstruction of individual headers is rarely necessary. Typically, all ### conntrack ``` -function conntrack_feed(dissect/raw_packet, reconstruct_opts) +function conntrack_feed(dissect/raw_packet[, reconstruct_opts]) ``` "Feed" dissect or raw packet string to conntrack the way as if it was received from the network. @@ -2149,8 +2149,8 @@ Only "addr" field is always present. Others can be absent. #### rawsend ``` -function rawsend(raw_data, rawsend_opts) -function rawsend_dissect(dissect, rawsend_opts, reconstruct_opts) +function rawsend(raw_data[, rawsend_opts]) +function rawsend_dissect(dissect[, rawsend_opts[, reconstruct_opts]]) ``` - `rawsend` works with a raw string containing a fully assembled IPv4 or IPv6 packet. diff --git a/docs/manual.md b/docs/manual.md index b264bea..a0ffa0a 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -2192,7 +2192,7 @@ function dissect(raw_ip) #### reconstruct_dissect ``` -function reconstruct_dissect(dissect, reconstruct_opts) +function reconstruct_dissect(dissect[, reconstruct_opts]) ``` Возвращает raw_ip. Все чексуммы считаются автоматически. L4 чексуммы портятся, если задан badsum в reconstruct_opts. @@ -2217,7 +2217,7 @@ function reconstruct_tcphdr(tcp) function reconstruct_udphdr(udp) function reconstruct_icmphdr(icmp) function reconstruct_iphdr(ip) -function reconstruct_ip6hdr(ip6, reconstruct_opts) +function reconstruct_ip6hdr(ip6 [,reconstruct_opts]) ``` Реконструкция соответствующих raw заголовков из таблиц диссекта. Возвращает raw вариант заголовка. @@ -2246,7 +2246,7 @@ function csum_icmp_fix(raw_ip_header, raw_icmp_header, payload) ### conntrack ``` -function conntrack_feed(dissect/raw_packet, reconstruct_opts) +function conntrack_feed(dissect/raw_packet[, reconstruct_opts]) ``` "Скормить" conntrack пакет таким образом, как если бы он пришел из сети и был проанализирован. @@ -2307,8 +2307,8 @@ function get_ifaddrs() #### rawsend ``` -function rawsend(raw_data, rawsend_opts) -function rawsend_dissect(dissect, rawsend_opts, reconstruct_opts) +function rawsend(raw_data[, rawsend_opts]) +function rawsend_dissect(dissect[, rawsend_opts[, reconstruct_opts]]) ``` - rawsend работает с raw строкой, содержащий полностью собранный ipv4 или ipv6 пакет