4 Nearly all commands have the following common options:
8 Path to configuration file. May be overridden by @env{NNCPCFG}
9 environment variable. If file file is an encrypted @ref{EBlob,
10 eblob}, then ask for passphrase to decrypt it first.
12 Print debug messages. Normally this option should not be used.
15 Minimal required resulting packet size, in KiBs. For example if you
16 send 2 KiB file and set @option{-minsize 4}, then resulting packet
17 will be 4 KiB (containing file itself and some junk).
19 Set desired outgoing packet @ref{Niceness, niceness level}.
21 Set desired reply packet @ref{Niceness, niceness level}. Only freq
22 and exec packets look at that niceness level.
24 Override @ref{CfgVia, via} configuration option for destination node.
25 Specified nodes must be separated with comma: @verb{|NODE1,NODE2|}.
26 With @verb{|-via -|} you can disable relaying at all.
28 Override path to spool directory. May be specified by
29 @env{NNCPSPOOL} environment variable.
31 Override path to logfile. May be specified by @env{NNCPLOG}
34 Print only errors, omit simple informational messages. In any case
35 those messages are logged, so you can reread them using
36 @ref{nncp-log} command.
37 @item -progress, -noprogress
38 Either force progress showing, or disable it.
40 Print version information.
42 Print warranty information (no warranty).
49 $ nncp-bundle [options] -tx [-delete] NODE [NODE ...] > ...
50 $ nncp-bundle [options] -rx -delete [-dryrun] [NODE ...] < ...
51 $ nncp-bundle [options] -rx [-check] [-dryrun] [NODE ...] < ...
54 With @option{-tx} option, this command creates @ref{Bundles, bundle} of
55 @ref{Encrypted, encrypted packets} from the spool directory and writes
58 With @option{-rx} option, this command takes bundle from stdin and
59 copies all found packets for our node to the spool directory. Pay
60 attention that @strong{no} integrity checking is done by default. Modern
61 tape drives could easily provide too much throughput your CPU won't be
62 able to verify on the fly. So if you won't @ref{nncp-toss, toss}
63 received packets at the place, it is advisable either to run
64 @ref{nncp-check} utility for packets integrity verification, or to use
65 @option{-check} option to enable on the fly integrity check.
67 You can specify multiple @option{NODE} arguments, telling for what nodes
68 you want to create the stream, or take it from. If no nodes are
69 specified for @option{-rx} mode, then all packets aimed at us will be
72 When packets are sent through the stream, they are still kept in the
73 spool directory, because there is no assurance that they are transferred
74 to the media (media (CD-ROM, tape drive, raw hard drive) can end). If
75 you want to forcefully delete them (after they are successfully flushed
76 to stdout) anyway, use @option{-delete} option.
78 But you can verify produced stream after, by digesting it by yourself
79 with @option{-rx} and @option{-delete} options -- in that mode, stream
80 packets integrity will be checked and they will be deleted from the
81 spool if everything is good. So it is advisable to recheck your streams:
84 $ nncp-bundle -tx ALICE BOB WHATEVER | cdrecord -tao -
85 $ dd if=/dev/cd0 bs=2048 | nncp-bundle -rx -delete
88 @option{-dryrun} option prevents any writes to the spool. This is
89 useful when you need to see what packets will pass by and possibly check
104 NODE[:ADDR] [FORCEADDR]
107 Call (connect to) specified @option{NODE} and run @ref{Sync,
108 synchronization} protocol with the @ref{nncp-daemon, daemon} on the
109 remote side. Normally this command could be run any time you wish to
110 either check for incoming packets, or to send out queued ones.
111 Synchronization protocol allows resuming and bidirectional packets
114 If @option{-rx} option is specified then only inbound packets
115 transmission is performed. If @option{-tx} option is specified, then
116 only outbound transmission is performed. @option{-onlinedeadline}
117 overrides @ref{CfgOnlineDeadline, @emph{onlinedeadline}}.
118 @option{-maxonlinetime} overrides @ref{CfgMaxOnlineTime,
119 @emph{maxonlinetime}}. @option{-rxrate}/@option{-txrate} override
120 @ref{CfgXxRate, rxrate/txrate}. @option{-list} option allows you to list
121 packets of remote node, without any transmission.
123 You can specify what packets your want to download, by specifying
124 @option{-pkts} option with comma-separated list of packets identifiers.
126 Each @option{NODE} can contain several uniquely identified
127 @option{ADDR}esses in @ref{CfgAddrs, configuration} file. If you do
128 not specify the exact one, then all will be tried until the first
129 success. Optionally you can force @option{FORCEADDR} address usage,
130 instead of addresses taken from configuration file. You can specify both
131 @verb{|host:port|} and @verb{#|some command#} formats.
133 Pay attention that this command runs integrity check for each completely
134 received packet in the background. This can be time consuming.
135 Connection could be lost during that check and remote node won't be
136 notified that file is done. But after successful integrity check that
137 file is renamed from @file{.part} one and when you rerun
138 @command{nncp-call} again, remote node will receive completion
145 $ nncp-caller [options] [NODE ...]
148 Croned daemon that calls remote nodes from time to time, according to
149 their @ref{CfgCalls, @emph{calls}} configuration field.
151 Optional number of @option{NODE}s tells to ignore other ones.
152 Otherwise all nodes with specified @emph{calls} configuration
153 field will be called.
155 Look at @ref{nncp-call} for more information.
161 $ nncp-cfgenc [options] [-s INT] [-t INT] [-p INT] cfg.hjson > cfg.hjson.eblob
162 $ nncp-cfgenc [options] -d cfg.hjson.eblob > cfg.hjson
165 This command allows you to encrypt provided @file{cfg.hjson} file with
166 the passphrase, producing @ref{EBlob, eblob}, to safely keep your
167 configuration file with private keys. This utility was written for users
168 who do not want (or can not) to use either @url{https://gnupg.org/,
169 GnuPG} or similar tools. That @file{eblob} file can be used directly in
170 @option{-cfg} option of nearly all commands.
172 @option{-s}, @option{-t}, @option{-p} are used to tune @file{eblob}'s
173 password strengthening function. Space memory cost (@option{-s}),
174 specified in number of BLAKE2b-256 blocks (32 bytes), tells how many
175 memory must be used for hashing -- bigger values are better, but slower.
176 Time cost (@option{-t}) tells how many rounds/iterations must be
177 performed -- bigger is better, but slower. Number of parallel jobs
178 (@option{-p}) tells how many computation processes will be run: this is
179 the same as running that number of independent hashers and then joining
180 their result together.
182 When invoked for encryption, passphrase is entered manually twice. When
183 invoked for decryption (@option{-d} option), it is asked once and exits
184 if passphrase can not decrypt @file{eblob}.
186 @option{-dump} options parses @file{eblob} and prints parameters used
187 during its creation. For example:
189 $ nncp-cfgenc -dump /usr/local/etc/nncp.hjson.eblob
190 Strengthening function: Balloon with BLAKE2b-256
191 Memory space cost: 1048576 bytes
193 Number of parallel jobs: 2
201 $ nncp-cfgmin [options] > stripped.hjson
204 Print out stripped configuration version: only path to @ref{Spool,
205 spool}, path to log file, neighbours public keys are stayed. This is
206 useful mainly for usage with @ref{nncp-xfer} that has to know only
207 neighbours, without private keys involving.
213 $ nncp-cfgnew [options] [-nocomments] > new.hjson
216 Generate new node configuration: private keys, example configuration
217 file and print it to stdout. You must use this command when you setup
218 the new node. @option{-nocomments} will create configuration file
219 without descriptive huge comments -- useful for advanced users.
221 Pay attention that private keys generation consumes an entropy from your
228 $ nncp-check [options]
231 Perform @ref{Spool, spool} directory integrity check. Read all files
232 that has Base32-encoded filenames and compare it with recalculated
233 BLAKE2b hash output of their contents. That supplementary command is
234 not used often in practice, if ever.
240 $ nncp-daemon [options] [-maxconn INT] [-bind ADDR] [-inetd]
243 Start listening TCP daemon, wait for incoming connections and run
244 @ref{Sync, synchronization protocol} with each of them. You can run
245 @ref{nncp-toss} utility in background to process inbound packets from
248 @option{-maxconn} option specifies how many simultaneous clients daemon
249 can handle. @option{-bind} option specifies @option{addr:port} it must
252 It could be run as @command{inetd} service, by specifying
253 @option{-inetd} option. Pay attention that because it uses stdin/stdout,
254 it can not effectively work with IO timeouts and connection closing can
255 propagate up to 5 minutes in practice. Example inetd-entry:
258 uucp stream tcp6 nowait nncpuser /usr/local/bin/nncp-daemon nncp-daemon -quiet -inetd
265 $ nncp-exec [options] NODE HANDLE [ARG0 ARG1 ...]
268 Send execution command to @option{NODE} for specified @option{HANDLE}.
269 Body is read from stdin and compressed. After receiving, remote side
270 will execute specified @ref{CfgExec, handle} command with @option{ARG*}
271 appended and decompressed body fed to command's stdin.
273 For example, if remote side has following configuration file for your
278 sendmail: [/usr/sbin/sendmail, "-t"]
279 appender: ["/bin/sh", "-c", "cat >> /append"]
283 then executing @verb{|echo My message | nncp-exec -replynice 123 REMOTE
284 sendmail root@localhost|} will lead to execution of:
289 NNCP_SENDER=OurNodeId \
291 /usr/sbin/sendmail -t root@@localhost
294 If @ref{CfgNotify, notification} is enabled on the remote side for exec
295 handles, then it will sent simple letter after successful command
296 execution with its output in message body.
298 @strong{Pay attention} that packet generated with this command can not
305 $ nncp-file [options] [-chunked INT] SRC NODE:[DST]
308 Send @file{SRC} file to remote @option{NODE}. @file{DST} specifies
309 destination file name in remote's @ref{CfgIncoming, incoming}
310 directory. If this file already exists there, then counter will be
313 This command queues file in @ref{Spool, spool} directory immediately
314 (through the temporary file of course) -- so pay attention that sending
315 2 GiB file will create 2 GiB outbound encrypted packet.
317 If @file{SRC} equals to @file{-}, then create an encrypted temporary
318 file and copy everything taken from stdin to it and use for outbound
319 packet creation. Pay attention that if you want to send 1 GiB of data
320 taken from stdin, then you have to have more than 2 GiB of disk space
321 for that temporary file and resulting encrypted packet. You can control
322 where temporary file will be stored using @env{TMPDIR} environment
323 variable. Encryption is performed in AEAD mode with
324 @url{https://cr.yp.to/chacha.html, ChaCha20}-@url{https://en.wikipedia.org/wiki/Poly1305, Poly1305}
325 algorithms. Data is splitted on 128 KiB blocks. Each block is encrypted
326 with increasing nonce counter.
328 If @file{SRC} points to directory, then
329 @url{https://pubs.opengroup.org/onlinepubs/9699919799/utilities/pax.html#tag_20_92_13_01, pax archive}
330 will be created on the fly with directory contents and destination
331 filename @file{.tar} appended. It @strong{won't} contain any entities
332 metainformation, but modification time with the names. UID/GID are set
333 to zero. Directories have 777 permissions, files have 666, for being
334 friendly with @command{umask}. Also each entity will have comment like
335 @verb{|Autogenerated by NNCP version X.Y.Z built with goXXX|}.
337 If @option{-chunked} is specified, then source file will be split
338 @ref{Chunked, on chunks}. @option{INT} is the desired chunk size in
339 KiBs. This mode is more CPU hungry. Pay attention that chunk is saved in
340 spool directory immediately and it is not deleted if any error occurs.
341 @option{-minsize} option is applied per each chunk. Do not forget about
342 @ref{ChunkedZFS, possible} ZFS deduplication issues. Zero
343 @option{-chunked} disables chunked transmission.
345 If @ref{CfgNotify, notification} is enabled on the remote side for
346 file transmissions, then it will sent simple letter after successful
353 $ nncp-freq [options] NODE:SRC [DST]
356 Send file request to @option{NODE}, asking it to send its @file{SRC}
357 file from @ref{CfgFreq, freq.path} directory to our node under @file{DST}
358 filename in our @ref{CfgIncoming, incoming} one. If @file{DST} is not
359 specified, then last element of @file{SRC} will be used.
361 If @ref{CfgNotify, notification} is enabled on the remote side for
362 file request, then it will sent simple letter after successful file
372 Parse @ref{Log, log} file and print out its records in human-readable form.
378 $ nncp-pkt [options] < pkt
379 $ nncp-pkt [options] [-decompress] -dump < pkt > payload
380 $ nncp-pkt -overheads
383 Low level packet parser. Normally it should not be used, but can help in
386 By default it will print packet's type, for example:
388 Packet type: encrypted
390 Sender: 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ
393 If you specify @option{-dump} option and provide an @ref{Encrypted,
394 encrypted} packet, then it will verify and decrypt it to stdout.
395 Encrypted packets contain @ref{Plain, plain} ones, that also can be fed
396 to @command{nncp-pkt}:
400 Payload type: transitional
401 Path: VHMTRWDOXPLK7BR55ICZ5N32ZJUMRKZEMFNGGCEAXV66GG43PEBQ
405 Path: stargrave@@stargrave.org
408 And with the @option{-dump} option it will give you the actual payload
409 (the whole file, mail message, and so on). @option{-decompress} option
410 tries to zstd-decompress the data from plain packet (useful for mail
413 @option{-overheads} options print encrypted, plain and size header overheads.
419 $ nncp-reass [options] [-dryrun] [-keep] [-dump] [-stdout] FILE.nncp.meta
420 $ nncp-reass [options] [-dryrun] [-keep] @{-all | -node NODE@}
423 Reassemble @ref{Chunked, chunked file} after @ref{nncp-toss, tossing}.
425 When called with @option{FILE} option, this command will reassemble only
426 it. When called with @option{-node} option, this command will try to
427 reassemble all @file{.nncp.meta} files found in @option{NODE}'s
428 @ref{CfgIncoming, incoming} directory. When called with @option{-all}
429 option, then cycle through all known nodes to do the same.
431 Reassembling process does the following:
434 @item Parses @ref{Chunked, @file{.nncp.meta}} file.
435 @item Checks existence and size of every @file{.nncp.chunkXXX}.
436 @item Verifies integrity of every chunk.
437 @item Concatenates all chunks, simultaneously removing them from filesystem.
440 That process reads the whole data twice. Be sure to have free disk
441 space for at least one chunk. Decrypted chunk files as a rule are saved
442 in pseudo-random order, so removing them during reassembly process will
443 likely lead to filesystem fragmentation. Reassembly process on
444 filesystems with deduplication capability should be rather lightweight.
446 If @option{-dryrun} option is specified, then only existence and
447 integrity checking are performed.
449 If @option{-keep} option is specified, then no
450 @file{.nncp.meta}/@file{.nncp.chunkXXX} files are deleted during
453 @option{-stdout} option outputs reassembled file to stdout, instead of
454 saving to temporary file with renaming after. This could be useful for
455 reassembling on separate filesystem to lower fragmentation effect,
456 and/or separate storage device for higher performance.
458 @option{-dump} option prints meta-file contents in human-friendly form.
459 It is useful mainly for debugging purposes. For example:
461 Original filename: testfile
462 File size: 3.8 MiB (3987795 bytes)
463 Chunk size: 1.0 MiB (1048576 bytes)
466 0: eac60d819edf40b8ecdacd0b9a5a8c62de2d15eef3c8ca719eafa0be9b894017
467 1: 013a07e659f2e353d0e4339c3375c96c7fffaa2fa00875635f440bbc4631052a
468 2: f4f883975a663f2252328707a30e71b2678f933b2f3103db8475b03293e4316e
469 3: 0e9e229501bf0ca42d4aa07393d19406d40b179f3922a3986ef12b41019b45a3
472 Do not forget about @ref{ChunkedZFS, possible} ZFS deduplication issues.
478 $ nncp-rm [options] -tmp
479 $ nncp-rm [options] -lock
480 $ nncp-rm [options] -node NODE -part
481 $ nncp-rm [options] -node NODE -seen
482 $ nncp-rm [options] -node NODE [-rx] [-tx]
483 $ nncp-rm [options] -node NODE -pkt PKT
486 This command is aimed to delete various files from your spool directory:
490 @item If @option{-tmp} option is specified, then it will delete all
491 temporary files in @file{spool/tmp} directory. Files may stay in it when
492 commands like @ref{nncp-file} fail for some reason.
494 @item If @option{-lock} option is specified, then all @file{.lock} files
495 will be deleted in your spool directory.
497 @item If @option{-pkt} option is specified, then @file{PKT} packet (its
498 Base32 name) will be deleted. This is useful when you see some packet
499 failing to be processed.
501 @item When either @option{-rx} or @option{-tx} options are specified
502 (maybe both of them), then delete all packets from that given queues. If
503 @option{-part} is given, then delete only @file{.part}ly downloaded
504 ones. If @option{-seen} option is specified, then delete only
507 @item @option{-dryrun} option just prints what will be deleted.
509 @item You can also select files that only have modification date older
510 than specified @option{-older} time units (@code{10s} (10 seconds),
511 @code{5m} (5 minutes), @code{12h} (12 hours), @code{2d} (2 days)).
519 $ nncp-stat [options] [-pkt] [-node NODE]
522 Print current @ref{Spool, spool} statistics about unsent and unprocessed
523 packets. For each node (unless @option{-node} specified) and each
524 niceness level there will be printed how many packets (with the total
525 size) are in inbound (Rx) and outbound (Tx) queues. @option{-pkt} option
526 show information about each packet.
532 $ nncp-toss [options]
543 Perform "tossing" operation on all inbound packets. This is the tool
544 that decrypts all packets and processes all payload packets in them:
545 copies files, sends mails, sends out file requests and relays transition
546 packets. It should be run after each online/offline exchange.
548 @option{-dryrun} option does not perform any writing and sending, just
549 tells what it will do.
551 @option{-cycle} option tells not to quit, but to repeat tossing every
552 @option{INT} seconds in an infinite loop. That can be useful when
553 running this command as a daemon.
555 @option{-seen} option creates empty @file{XXX.seen} file after
556 successful tossing of @file{XXX} packet. @ref{nncp-xfer},
557 @ref{nncp-bundle}, @ref{nncp-daemon} and @ref{nncp-call} commands skip
558 inbound packets that has been already seen, processed and tossed. This
559 is helpful to prevent duplicates.
561 @option{-nofile}, @option{-nofreq}, @option{-noexec}, @option{-notrns}
562 options allow to disable any kind of packet types processing.
568 $ nncp-xfer [options] [-node NODE] [-mkdir] [-keep] [-rx|-tx] DIR
571 Search for directory in @file{DIR} containing inbound packets for us and
572 move them to local @ref{Spool, spool} directory. Also search for known
573 neighbours directories and move locally queued outbound packets to them.
574 This command is used for offline packets transmission.
576 If @option{-mkdir} option is specified, then outbound neighbour(s)
577 directories will be created. This is useful for the first time usage,
578 when storage device does not have any directories tree.
580 If @option{-keep} option is specified, then keep copied files, do not
583 @option{-rx} option tells only to move inbound packets addressed to us.
584 @option{-tx} option tells exactly the opposite: move only outbound packets.
586 @ref{nncp-cfgmin} could be useful for creating stripped minimalistic
587 configuration file version without any private keys.
589 @file{DIR} directory has the following structure:
590 @file{RECIPIENT/SENDER/PACKET}, where @file{RECIPIENT} is Base32 encoded
591 destination node, @file{SENDER} is Base32 encoded sender node.
593 Also look for @ref{nncp-bundle}, especially if you deal with CD-ROM and