will be 4 KiB (containing file itself and some junk).
@item -nice
Set desired outgoing packet @ref{Niceness, niceness level}.
- 1-255 values are allowed.
@item -replynice
Set desired reply packet @ref{Niceness, niceness level}. Only freq
- and exec packets look at that niceness level. 1-255 values are
- allowed.
-@item -node
- Process only single specified node.
+ and exec packets look at that niceness level.
@item -via
Override @ref{CfgVia, via} configuration option for destination node.
Specified nodes must be separated with comma: @verb{|NODE1,NODE2|}.
Print only errors, omit simple informational messages. In any case
those messages are logged, so you can reread them using
@ref{nncp-log} command.
+@item -progress, -noprogress
+ Either force progress showing, or disable it.
@item -version
Print version information.
@item -warranty
@node nncp-bundle
@section nncp-bundle
-@verbatim
-% nncp-bundle [options] -tx [-delete] NODE [NODE ...] > ...
-% nncp-bundle [options] -rx -delete [-dryrun] [NODE ...] < ...
-% nncp-bundle [options] -rx [-check] [-dryrun] [NODE ...] < ...
-@end verbatim
+@example
+$ nncp-bundle [options] -tx [-delete] NODE [NODE ...] > ...
+$ nncp-bundle [options] -rx -delete [-dryrun] [NODE ...] < ...
+$ nncp-bundle [options] -rx [-check] [-dryrun] [NODE ...] < ...
+@end example
With @option{-tx} option, this command creates @ref{Bundles, bundle} of
@ref{Encrypted, encrypted packets} from the spool directory and writes
packets integrity will be checked and they will be deleted from the
spool if everything is good. So it is advisable to recheck your streams:
-@verbatim
-% nncp-bundle -tx ALICE BOB WHATEVER | cdrecord -tao -
-% dd if=/dev/cd0 bs=2048 | nncp-bundle -rx -delete
-@end verbatim
+@example
+$ nncp-bundle -tx ALICE BOB WHATEVER | cdrecord -tao -
+$ dd if=/dev/cd0 bs=2048 | nncp-bundle -rx -delete
+@end example
@option{-dryrun} option prevents any writes to the spool. This is
useful when you need to see what packets will pass by and possibly check
@node nncp-call
@section nncp-call
-@verbatim
-% nncp-call [options]
+@example
+$ nncp-call [options]
[-onlinedeadline INT]
[-maxonlinetime INT]
[-rx|-tx]
+ [-list]
+ [-pkts PKT,PKT,...]
[-rxrate INT]
[-txrate INT]
NODE[:ADDR] [FORCEADDR]
-@end verbatim
+@end example
Call (connect to) specified @option{NODE} and run @ref{Sync,
synchronization} protocol with the @ref{nncp-daemon, daemon} on the
overrides @ref{CfgOnlineDeadline, @emph{onlinedeadline}}.
@option{-maxonlinetime} overrides @ref{CfgMaxOnlineTime,
@emph{maxonlinetime}}. @option{-rxrate}/@option{-txrate} override
-@ref{CfgXxRate, rxrate/txrate}.
-
-@node nncp-caller
-@section nncp-caller
-
-@verbatim
-% nncp-caller [options] [NODE ...]
-@end verbatim
-
-Croned daemon that calls remote nodes from time to time, according to
-their @ref{CfgCalls, @emph{calls}} configuration field.
-
-Optional number of @option{NODE}s tells to ignore other ones.
-Otherwise all nodes with specified @emph{calls} configuration
-field will be called.
+@ref{CfgXxRate, rxrate/txrate}. @option{-list} option allows you to list
+packets of remote node, without any transmission.
-@option{-onlinedeadline} overrides @ref{CfgOnlineDeadline,
-@emph{onlinedeadline}} configuration option.
+You can specify what packets your want to download, by specifying
+@option{-pkts} option with comma-separated list of packets identifiers.
Each @option{NODE} can contain several uniquely identified
@option{ADDR}esses in @ref{CfgAddrs, configuration} file. If you do
not specify the exact one, then all will be tried until the first
success. Optionally you can force @option{FORCEADDR} address usage,
-instead of addresses taken from configuration file.
+instead of addresses taken from configuration file. You can specify both
+@verb{|host:port|} and @verb{#|some command#} formats.
Pay attention that this command runs integrity check for each completely
received packet in the background. This can be time consuming.
@command{nncp-call} again, remote node will receive completion
notification.
+@node nncp-caller
+@section nncp-caller
+
+@example
+$ nncp-caller [options] [NODE ...]
+@end example
+
+Croned daemon that calls remote nodes from time to time, according to
+their @ref{CfgCalls, @emph{calls}} configuration field.
+
+Optional number of @option{NODE}s tells to ignore other ones.
+Otherwise all nodes with specified @emph{calls} configuration
+field will be called.
+
+Look @ref{nncp-call} for more information.
+
@node nncp-cfgenc
@section nncp-cfgenc
-@verbatim
-% nncp-cfgmin [options] [-s INT] [-t INT] [-p INT] cfg.yaml > cfg.yaml.eblob
-% nncp-cfgmin [options] -d cfg.yaml.eblob > cfg.yaml
-@end verbatim
+@example
+$ nncp-cfgmin [options] [-s INT] [-t INT] [-p INT] cfg.hjson > cfg.hjson.eblob
+$ nncp-cfgmin [options] -d cfg.hjson.eblob > cfg.hjson
+@end example
-This command allows you to encrypt provided @file{cfg.yaml} file with
+This command allows you to encrypt provided @file{cfg.hjson} file with
the passphrase, producing @ref{EBlob, eblob}, to safely keep your
configuration file with private keys. This utility was written for users
who do not want (or can not) to use either @url{https://gnupg.org/,
@option{-dump} options parses @file{eblob} and prints parameters used
during its creation. For example:
-@verbatim
-% nncp-cfgenc -dump /usr/local/etc/nncp.yaml.eblob
+@example
+$ nncp-cfgenc -dump /usr/local/etc/nncp.hjson.eblob
Strengthening function: Balloon with BLAKE2b-256
Memory space cost: 1048576 bytes
Number of rounds: 16
Number of parallel jobs: 2
Blob size: 2494
-@end verbatim
+@end example
@node nncp-cfgmin
@section nncp-cfgmin
-@verbatim
-% nncp-cfgmin [options] > stripped.yaml
-@end verbatim
+@example
+$ nncp-cfgmin [options] > stripped.hjson
+@end example
Print out stripped configuration version: only path to @ref{Spool,
spool}, path to log file, neighbours public keys are stayed. This is
@node nncp-cfgnew
@section nncp-cfgnew
-@verbatim
-% nncp-cfgnew [options] > new.yaml
-@end verbatim
+@example
+$ nncp-cfgnew [options] [-nocomments] > new.hjson
+@end example
Generate new node configuration: private keys, example configuration
file and print it to stdout. You must use this command when you setup
-the new node.
+the new node. @option{-nocomments} will create configuration file
+without descriptive huge comments -- useful for advanced users.
Pay attention that private keys generation consumes an entropy from your
operating system.
@node nncp-check
@section nncp-check
-@verbatim
-% nncp-check [options]
-@end verbatim
+@example
+$ nncp-check [options]
+@end example
Perform @ref{Spool, spool} directory integrity check. Read all files
that has Base32-encoded filenames and compare it with recalculated
@node nncp-daemon
@section nncp-daemon
-@verbatim
-% nncp-daemon [options] [-maxconn INT] [-bind ADDR]
-@end verbatim
+@example
+$ nncp-daemon [options] [-maxconn INT] [-bind ADDR] [-inetd]
+@end example
Start listening TCP daemon, wait for incoming connections and run
@ref{Sync, synchronization protocol} with each of them. You can run
can handle. @option{-bind} option specifies @option{addr:port} it must
bind to and listen.
-@node nncp-exec
-@section nncp-exec
+It could be run as @command{inetd} service, by specifying
+@option{-inetd} option. Pay attention that because it uses stdin/stdout,
+it can not effectively work with IO timeouts and connection closing can
+propagate up to 5 minutes in practice. Example inetd-entry:
@verbatim
-% nncp-exec [options] NODE HANDLE [ARG0 ARG1 ...]
+uucp stream tcp6 nowait nncpuser /usr/local/bin/nncp-daemon nncp-daemon -quiet -inetd
@end verbatim
+@node nncp-exec
+@section nncp-exec
+
+@example
+$ nncp-exec [options] NODE HANDLE [ARG0 ARG1 ...]
+@end example
+
Send execution command to @option{NODE} for specified @option{HANDLE}.
Body is read from stdin and compressed. After receiving, remote side
will execute specified @ref{CfgExec, handle} command with @option{ARG*}
node:
@verbatim
-exec:
+exec: {
sendmail: [/usr/sbin/sendmail, "-t"]
appender: ["/bin/sh", "-c", "cat >> /append"]
+}
@end verbatim
then executing @verb{|echo My message | nncp-exec -replynice 123 REMOTE
-sendmail root@localhost|} will lead to executing of:
+sendmail root@localhost|} will lead to execution of:
-@verbatim
+@example
echo My message |
NNCP_SELF=REMOTE \
NNCP_SENDER=OurNodeId \
NNCP_NICE=123 \
- /usr/sbin/sendmail -t root@localhost
-@end verbatim
+ /usr/sbin/sendmail -t root@@localhost
+@end example
+If @ref{CfgNotify, notification} is enabled on the remote side for exec
+handles, then it will sent simple letter after successful command
+execution with its output in message body.
@node nncp-file
@section nncp-file
-@verbatim
-% nncp-file [options] [-chunked INT] SRC NODE:[DST]
-@end verbatim
+@example
+$ nncp-file [options] [-chunked INT] SRC NODE:[DST]
+@end example
Send @file{SRC} file to remote @option{NODE}. @file{DST} specifies
destination file name in remote's @ref{CfgIncoming, incoming}
If @file{SRC} equals to @file{-}, then create an encrypted temporary
file and copy everything taken from stdin to it and use for outbound
packet creation. Pay attention that if you want to send 1 GiB of data
-taken from stdin, then you have to have 2 GiB of disk space for that
-temporary file and resulting encrypted packet. You can control where
-temporary file will be stored using @env{TMPDIR} environment variable.
-Encryption is performed with @url{https://cr.yp.to/chacha.html,
-ChaCha20} algorithm. Data is splitted on 128 KiB blocks. Each block is
-encrypted with increasing nonce counter.
+taken from stdin, then you have to have more than 2 GiB of disk space
+for that temporary file and resulting encrypted packet. You can control
+where temporary file will be stored using @env{TMPDIR} environment
+variable. Encryption is performed in AEAD mode with
+@url{https://cr.yp.to/chacha.html, ChaCha20}-@url{https://en.wikipedia.org/wiki/Poly1305, Poly1305}
+algorithms. Data is splitted on 128 KiB blocks. Each block is encrypted
+with increasing nonce counter.
+
+If @file{SRC} points to directory, then
+@url{https://pubs.opengroup.org/onlinepubs/9699919799/utilities/pax.html#tag_20_92_13_01, pax archive}
+will be created on the fly with directory contents and destination
+filename @file{.tar} appended. It @strong{won't} contain any entities
+metainformation, but modification time with the names. UID/GID are set
+to zero. Directories have 777 permissions, files have 666, for being
+friendly with @command{umask}. Also each entity will have comment like
+@verb{|Autogenerated by NNCP version X.Y.Z built with goXXX|}.
If @option{-chunked} is specified, then source file will be split
@ref{Chunked, on chunks}. @option{INT} is the desired chunk size in
KiBs. This mode is more CPU hungry. Pay attention that chunk is saved in
spool directory immediately and it is not deleted if any error occurs.
@option{-minsize} option is applied per each chunk. Do not forget about
-@ref{ChunkedZFS, possible} ZFS deduplication issues.
+@ref{ChunkedZFS, possible} ZFS deduplication issues. Zero
+@option{-chunked} disables chunked transmission.
If @ref{CfgNotify, notification} is enabled on the remote side for
file transmissions, then it will sent simple letter after successful
@node nncp-freq
@section nncp-freq
-@verbatim
-% nncp-freq [options] NODE:SRC [DST]
-@end verbatim
+@example
+$ nncp-freq [options] NODE:SRC [DST]
+@end example
Send file request to @option{NODE}, asking it to send its @file{SRC}
-file from @ref{CfgFreq, freq} directory to our node under @file{DST}
+file from @ref{CfgFreq, freq.path} directory to our node under @file{DST}
filename in our @ref{CfgIncoming, incoming} one. If @file{DST} is not
specified, then last element of @file{SRC} will be used.
@node nncp-log
@section nncp-log
-@verbatim
-% nncp-log [options]
-@end verbatim
+@example
+$ nncp-log [options]
+@end example
Parse @ref{Log, log} file and print out its records in human-readable form.
@node nncp-pkt
@section nncp-pkt
-@verbatim
-% nncp-pkt [options] < pkt
-% nncp-pkt [options] [-decompress] -dump < pkt > payload
-@end verbatim
+@example
+$ nncp-pkt [options] < pkt
+$ nncp-pkt [options] [-decompress] -dump < pkt > payload
+$ nncp-pkt -overheads
+@end example
Low level packet parser. Normally it should not be used, but can help in
debugging.
By default it will print packet's type, for example:
-@verbatim
+@example
Packet type: encrypted
Niceness: 64
Sender: 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ
-@end verbatim
+@end example
If you specify @option{-dump} option and provide an @ref{Encrypted,
encrypted} packet, then it will verify and decrypt it to stdout.
Encrypted packets contain @ref{Plain, plain} ones, that also can be fed
to @command{nncp-pkt}:
-@verbatim
+@example
Packet type: plain
Payload type: transitional
Path: VHMTRWDOXPLK7BR55ICZ5N32ZJUMRKZEMFNGGCEAXV66GG43PEBQ
Packet type: plain
Payload type: mail
-Path: stargrave@stargrave.org
-@end verbatim
+Path: stargrave@@stargrave.org
+@end example
And with the @option{-dump} option it will give you the actual payload
(the whole file, mail message, and so on). @option{-decompress} option
-tries to zlib-decompress the data from plain packet (useful for mail
+tries to zstd-decompress the data from plain packet (useful for mail
packets).
+@option{-overheads} options print encrypted, plain and size header overheads.
+
@node nncp-reass
@section nncp-reass
-@verbatim
-% nncp-reass [options] [-dryrun] [-keep] [-dump] [-stdout] FILE.nncp.meta
-% nncp-reass [options] [-dryrun] [-keep] {-all | -node NODE}
-@end verbatim
+@example
+$ nncp-reass [options] [-dryrun] [-keep] [-dump] [-stdout] FILE.nncp.meta
+$ nncp-reass [options] [-dryrun] [-keep] @{-all | -node NODE@}
+@end example
Reassemble @ref{Chunked, chunked file} after @ref{nncp-toss, tossing}.
@option{-dump} option prints meta-file contents in human-friendly form.
It is useful mainly for debugging purposes. For example:
-@verbatim
+@example
Original filename: testfile
File size: 3.8 MiB (3987795 bytes)
Chunk size: 1.0 MiB (1048576 bytes)
1: 013a07e659f2e353d0e4339c3375c96c7fffaa2fa00875635f440bbc4631052a
2: f4f883975a663f2252328707a30e71b2678f933b2f3103db8475b03293e4316e
3: 0e9e229501bf0ca42d4aa07393d19406d40b179f3922a3986ef12b41019b45a3
-@end verbatim
+@end example
Do not forget about @ref{ChunkedZFS, possible} ZFS deduplication issues.
@node nncp-rm
@section nncp-rm
-@verbatim
-% nncp-rm [options] -tmp
-% nncp-rm [options] -lock
-% nncp-rm [options] -node NODE -part
-% nncp-rm [options] -node NODE -seen
-% nncp-rm [options] -node NODE [-rx] [-tx]
-% nncp-rm [options] -node NODE -pkt PKT
-@end verbatim
+@example
+$ nncp-rm [options] -tmp
+$ nncp-rm [options] -lock
+$ nncp-rm [options] -node NODE -part
+$ nncp-rm [options] -node NODE -seen
+$ nncp-rm [options] -node NODE [-rx] [-tx]
+$ nncp-rm [options] -node NODE -pkt PKT
+@end example
This command is aimed to delete various files from your spool directory:
@node nncp-stat
@section nncp-stat
-@verbatim
-% nncp-stat [options]
-@end verbatim
+@example
+$ nncp-stat [options] [-pkt] [-node NODE]
+@end example
Print current @ref{Spool, spool} statistics about unsent and unprocessed
-packets. For each node and each niceness level there will be printed how
-many packets (with the total size) are in inbound (Rx) and outbound (Tx)
-queues.
+packets. For each node (unless @option{-node} specified) and each
+niceness level there will be printed how many packets (with the total
+size) are in inbound (Rx) and outbound (Tx) queues. @option{-pkt} option
+show information about each packet.
@node nncp-toss
@section nncp-toss
-@verbatim
-% nncp-toss [options]
+@example
+$ nncp-toss [options]
+ [-node NODE]
[-dryrun]
[-cycle INT]
[-seen]
[-nofile]
[-nofreq]
- [-nomail]
+ [-noexec]
[-notrns]
-@end verbatim
+@end example
Perform "tossing" operation on all inbound packets. This is the tool
that decrypts all packets and processes all payload packets in them:
running this command as a daemon.
@option{-seen} option creates empty @file{XXX.seen} file after
-successful tossing of @file{XXX} packet. @ref{nncp-xfer} and
-@ref{nncp-bundle} commands skip inbound packets that has been already
-seen, processed and tossed. This is helpful to defeat duplicates.
+successful tossing of @file{XXX} packet. @ref{nncp-xfer},
+@ref{nncp-bundle}, @ref{nncp-daemon} and @ref{nncp-call} commands skip
+inbound packets that has been already seen, processed and tossed. This
+is helpful to prevent duplicates.
-@option{-nofile}, @option{-nofreq}, @option{-nomail}, @option{-notrns}
+@option{-nofile}, @option{-nofreq}, @option{-noexec}, @option{-notrns}
options allow to disable any kind of packet types processing.
@node nncp-xfer
@section nncp-xfer
-@verbatim
-% nncp-xfer [options] [-mkdir] [-keep] [-rx|-tx] DIR
-@end verbatim
+@example
+$ nncp-xfer [options] [-node NODE] [-mkdir] [-keep] [-rx|-tx] DIR
+@end example
Search for directory in @file{DIR} containing inbound packets for us and
move them to local @ref{Spool, spool} directory. Also search for known