]> Cypherpunks.ru repositories - nncp.git/blob - doc/cmd/nncp-pkt.texi
Add various documentation indices
[nncp.git] / doc / cmd / nncp-pkt.texi
1 @node nncp-pkt
2 @pindex nncp-pkt
3 @section nncp-pkt
4
5 @example
6 $ nncp-pkt [options] < pkt
7 $ nncp-pkt [options] [-decompress] -dump < pkt > payload
8 $ nncp-pkt -overheads
9 @end example
10
11 Low level packet parser. Can be useful for debugging. There are two
12 types of packets: @ref{Plain, plain} and @ref{Encrypted, encrypted}. By
13 default it will print packet's header, for example:
14
15 @example
16 Packet type: encrypted
17 Niceness: B (224)
18 Sender: 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ (self)
19 @end example
20
21 @option{-dump} option outputs plain packet's payload (if it is file
22 transmission, then it will be the file itself as an example). If it is
23 an encrypted packet, then it will be decrypted first, outputing the
24 included plain packet, that can be fed to @command{nncp-pkt} again:
25
26 @example
27 Packet type: plain
28 Payload type: transitional
29 Niceness: B (224)
30 Path: VHMTRWDOXPLK7BR55ICZ5N32ZJUMRKZEMFNGGCEAXV66GG43PEBQ (name-of-node)
31
32 Packet type: plain
33 Payload type: exec compressed
34 Niceness: P (96)
35 Path: stargrave@@stargrave.org
36 @end example
37
38 @option{-decompress} option tries to zstd-decompress data from plain
39 packet (useful with @verb{|exec compressed|} types of packets).
40
41 @option{-overheads} options print encrypted, plain and size header overheads.
42
43 This command automatically determines if an encrypted packet belongs to
44 @ref{Multicast, multicast} area and will try to decrypt it with its
45 corresponding key.