4 Nearly all commands have the following common options:
8 Path to configuration file. May be overrided by @env{NNCPCFG}
11 Print debug messages. Normally this option should not be used.
14 Minimal required resulting packet size, in bytes. For example if you
15 send 2 KiB file and set @option{-minsize 4096}, then resulting
16 packet will be 4 KiB (containing file itself and some junk).
18 Set desired outgoing packet @ref{Niceness, niceness level}.
19 1-255 values are allowed.
21 Process only single specified node.
23 Print only errors, omit simple informational messages. In any case
24 those messages are logged, so you can reread them using
25 @ref{nncp-log} command.
27 Print version information.
29 Print warranty information (no warranty).
36 % nncp-call [options] [-onlinedeadline INT] [-maxonlinetime INT] [-rx|-tx]
37 NODE[:ADDR] [FORCEADDR]
40 Call (connect to) specified @option{NODE} and run @ref{Sync,
41 synchronization} protocol with the @ref{nncp-daemon, daemon} on the
42 remote side. Normally this command could be run any time you wish to
43 either check for incoming packets, or to send out queued ones.
44 Synchronization protocol allows resuming and bidirectional packets
47 If @option{-rx} option is specified then only inbound packets
48 transmission is performed. If @option{-tx} option is specified, then
49 only outbound transmission is performed. @option{-onlinedeadline}
50 overrides @ref{CfgOnlineDeadline, @emph{onlinedeadline}}.
51 @option{-maxonlinetime} overrides @ref{CfgMaxOnlineTime,
52 @emph{maxonlinetime}}.
58 % nncp-caller [options] [NODE ...]
61 Croned daemon that calls remote nodes from time to time, according to
62 their @ref{CfgCalls, @emph{calls}} configuration field.
64 Optional number of @option{NODE}s tells to ignore other ones.
65 Otherwise all nodes with specified @emph{calls} configuration
68 @option{-onlinedeadline} overrides @ref{CfgOnlineDeadline,
69 @emph{onlinedeadline}} configuration option.
71 Each @option{NODE} can contain several uniquely identified
72 @option{ADDR}esses in @ref{CfgAddrs, configuration} file. If you do
73 not specify the exact one, then all will be tried until the first
74 success. Optionally you can force @option{FORCEADDR} address usage,
75 instead of addresses taken from configuration file.
77 Pay attention that this command runs integrity check for each completely
78 received packet in the background. This can be time consuming.
79 Connection could be lost during that check and remote node won't be
80 notified that file is done. But after successful integrity check that
81 file is renamed from @file{.part} one and when you rerun
82 @command{nncp-call} again, remote node will receive completion
89 % nncp-check [options]
92 Perform @ref{Spool, spool} directory integrity check. Read all files
93 that has Base32-encoded filenames and compare it with recalculated
94 BLAKE2b hash output of their contents. That supplementary command is
95 not used often in practice, if ever.
101 % nncp-daemon [options] [-maxconn INT] [-bind ADDR]
104 Start listening TCP daemon, wait for incoming connections and run
105 @ref{Sync, synchronization protocol} with each of them. You can run
106 @ref{nncp-toss} utility in background to process inbound packets from
109 @option{-maxconn} option specifies how many simultaneous clients daemon
110 can handle. @option{-bind} option specifies @option{addr:port} it must
117 % nncp-file [options] [-chunked INT] SRC NODE:[DST]
120 Send @file{SRC} file to remote @option{NODE}. @file{DST} specifies
121 destination file name in remote's @ref{CfgIncoming, incoming}
122 directory. If this file already exists there, then counter will be
125 This command queues file in @ref{Spool, spool} directory immediately
126 (through the temporary file of course) -- so pay attention that sending
127 2 GiB file will create 2 GiB outbound encrypted packet.
129 If @file{SRC} equals to @file{-}, then create an encrypted temporary
130 file and copy everything taken from stdin to it and use for outbound
131 packet creation. Pay attention that if you want to send 1 GiB of data
132 taken from stdin, then you have to have 2 GiB of disk space for that
133 temporary file and resulting encrypted packet. You can control where
134 temporary file will be stored using @env{TMPDIR} environment variable.
136 If @option{-chunked} is specified, then source file will be split
137 @ref{Chunked, on chunks}. @option{INT} is the desired chunk size in
138 KiBs. This mode is more CPU hungry. Pay attention that chunk is saved in
139 spool directory immediately and it is not deleted if any error occurs.
141 If @ref{CfgNotify, notification} is enabled on the remote side for
142 file transmissions, then it will sent simple letter after successful
149 % nncp-freq [options] NODE:SRC DST
152 Send file request to @option{NODE}, asking it to send its @file{SRC}
153 file from @ref{CfgFreq, freq} directory to our node under @file{DST}
154 filename in our @ref{CfgIncoming, incoming} one.
156 If @ref{CfgNotify, notification} is enabled on the remote side for
157 file request, then it will sent simple letter after successful file
167 Parse @ref{Log, log} file and print out its records in human-readable form.
173 % nncp-mail [options] NODE USER ...
176 Send mail, that is read from stdin, to @option{NODE} and specified
177 @option{USER}s. Mail message will be compressed. After receiving, remote
178 side will execute specified @ref{CfgSendmail, sendmail} command with
179 @option{USER}s appended as a command line argument and feed decompressed
180 mail body to that command's stdin.
186 % nncp-mincfg [options] > stripped.yaml
189 Print out stripped configuration version: only path to @ref{Spool,
190 spool}, path to log file, neighbours public keys are stayed. This is
191 useful mainly for usage with @ref{nncp-xfer} that has to know only
192 neighbours, without private keys involving.
198 % nncp-newcfg [options] > new.yaml
201 Generate new node configuration: private keys, example configuration
202 file and print it to stdout. You must use this command when you setup
205 Pay attention that private keys generation consumes an entropy from your
212 % nncp-pkt [options] < pkt
213 % nncp-pkt [options] [-decompress] -dump < pkt > payload
216 Low level packet parser. Normally it should not be used, but can help in
219 By default it will print packet's type, for example:
221 Packet type: encrypted
223 Sender: 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ
226 If you specify @option{-dump} option and provide an @ref{Encrypted,
227 encrypted} packet, then it will verify and decrypt it to stdout.
228 Encrypted packets contain @ref{Plain, plain} ones, that also can be fed
229 to @command{nncp-pkt}:
233 Payload type: transitional
234 Path: VHMTRWDOXPLK7BR55ICZ5N32ZJUMRKZEMFNGGCEAXV66GG43PEBQ
238 Path: stargrave@stargrave.org
241 And with the @option{-dump} option it will give you the actual payload
242 (the whole file, mail message, and so on). @option{-decompress} option
243 tries to zlib-decompress the data from plain packet (useful for mail
250 % nncp-reass [options] [-dryrun] [-keep] [-dump] [-stdout] FILE.nncp.meta
251 % nncp-reass [options] [-dryrun] [-keep] {-all | -node NODE}
254 Reassemble @ref{Chunked, chunked file} after @ref{nncp-toss, tossing}.
256 When called with @option{FILE} option, this command will reassemble only
257 it. When called with @option{-node} option, this command will try to
258 reassemble all @file{.nncp.meta} files found in @option{NODE}'s
259 @ref{CfgIncoming, incoming} directory. When called with @option{-all}
260 option, then cycle through all known nodes to do the same.
262 Reassembling process does the following:
265 @item Parses @ref{Chunked, @file{.nncp.meta}} file.
266 @item Checks existence and size of every @file{.nncp.chunkXXX}.
267 @item Verifies integrity of every chunk.
268 @item Concatenates all chunks, simultaneously removing them from filesystem.
271 That process reads the whole data twice. Be sure to have free disk
272 space for at least one chunk. Decrypted chunk files as a rule are saved
273 in pseudo-random order, so removing them during reassembly process will
274 likely lead to filesystem fragmentation. Reassembly process on
275 filesystems with deduplication capability should be rather lightweight.
277 If @option{-dryrun} option is specified, then only existence and
278 integrity checking are performed.
280 If @option{-keep} option is specified, then no
281 @file{.nncp.meta}/@file{.nncp.chunkXXX} files are deleted during
284 @option{-stdout} option outputs reassembled file to stdout, instead of
285 saving to temporary file with renaming after. This could be useful for
286 reassembling on separate filesystem to lower fragmentation effect,
287 and/or separate storage device for higher performance.
289 @option{-dump} option prints meta-file contents in human-friendly form.
290 It is useful mainly for debugging purposes. For example:
292 Original filename: testfile
293 File size: 3.8 MiB (3987795 bytes)
294 Chunk size: 1.0 MiB (1048576 bytes)
297 0: eac60d819edf40b8ecdacd0b9a5a8c62de2d15eef3c8ca719eafa0be9b894017
298 1: 013a07e659f2e353d0e4339c3375c96c7fffaa2fa00875635f440bbc4631052a
299 2: f4f883975a663f2252328707a30e71b2678f933b2f3103db8475b03293e4316e
300 3: 0e9e229501bf0ca42d4aa07393d19406d40b179f3922a3986ef12b41019b45a3
307 % nncp-rm [options] NODE PKT
310 Remove specified packet (Base32 name) in @option{NODE}'s queues. This
311 command is useful when you want to remove the packet that is failing to
318 % nncp-stat [options]
321 Print current @ref{Spool, spool} statistics about unsent and unprocessed
322 packets. For each node and each niceness level there will be printed how
323 many packets (with the total size) are in inbound (Rx) and outbound (Tx)
330 % nncp-toss [options] [-dryrun] [-cycle INT]
333 Perform "tossing" operation on all inbound packets. This is the tool
334 that decrypts all packets and processes all payload packets in them:
335 copies files, sends mails, sends out file requests and relays transition
336 packets. It should be run after each online/offline exchange.
338 @option{-dryrun} option does not perform any writing and sending, just
339 tells what it will do.
341 @option{-cycle} option tells not to quit, but to repeat tossing every
342 @option{INT} seconds in an infinite loop. That can be useful when
343 running this command as a daemon.
349 % nncp-xfer [options] [-force] [-keep] [-rx|-tx] DIR
352 Search for directory in @file{DIR} containing inbound packets for us and
353 move them to local @ref{Spool, spool} directory. Also search for known
354 neighbours directories and move locally queued outbound packets to them.
355 This command is used for offline packets transmission.
357 If @option{-force} option is specified, then outbound neighbour(s)
358 directories will be created. This is useful for the first time usage,
359 when storage device does not have any directories tree.
361 If @option{-keep} option is specified, then keep copied files, do not
364 @option{-rx} option tells only to move inbound packets addressed to us.
365 @option{-tx} option tells exactly the opposite: move only outbound packets.
367 @ref{nncp-mincfg} could be useful for creating stripped minimalistic
368 configuration file version without any private keys.
370 @file{DIR} directory has the following structure:
371 @file{RECIPIENT/SENDER/PACKET}, where @file{RECIPIENT} is Base32 encoded
372 destination node, @file{SENDER} is Base32 encoded sender node.