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.
13 Minimal required resulting packet size. For example if you send 2
14 KiB file and set @option{-minsize 4096}, then resulting packet will
15 be 4 KiB (containing file itself and some junk).
17 Set desired outgoing packet @ref{Niceness, niceness level}.
18 1-255 values are allowed.
20 Process only single specified node.
22 Print only errors, omit simple informational messages. In any case
23 those messages are logged, so you can reread them using
24 @ref{nncp-log} command.
26 Print version information.
28 Print warranty information (no warranty).
35 % nncp-call [options] [-onlinedeadline INT] [-maxonlinetime INT] [-rx|-tx]
36 NODE[:ADDR] [FORCEADDR]
39 Call (connect to) specified @option{NODE} and run @ref{Sync,
40 synchronization} protocol with the @ref{nncp-daemon, daemon} on the
41 remote side. Normally this command could be run any time you wish to
42 either check for incoming packets, or to send out queued ones.
43 Synchronization protocol allows resuming and bidirectional packets
46 If @option{-rx} option is specified then only inbound packets
47 transmission is performed. If @option{-tx} option is specified, then
48 only outbound transmission is performed. @option{-onlinedeadline}
49 overrides @ref{CfgOnlineDeadline, @emph{onlinedeadline}}.
50 @option{-maxonlinetime} overrides @ref{CfgMaxOnlineTime,
51 @emph{maxonlinetime}}.
57 % nncp-caller [options] [NODE ...]
60 Croned daemon that calls remote nodes from time to time, according to
61 their @ref{CfgCalls, @emph{calls}} configuration field.
63 Optional number of @option{NODE}s tells to ignore other ones.
64 Otherwise all nodes with specified @emph{calls} configuration
67 @option{-onlinedeadline} overrides @ref{CfgOnlineDeadline,
68 @emph{onlinedeadline}} configuration option.
70 Each @option{NODE} can contain several uniquely identified
71 @option{ADDR}esses in @ref{CfgAddrs, configuration} file. If you do
72 not specify the exact one, then all will be tried until the first
73 success. Optionally you can force @option{FORCEADDR} address usage,
74 instead of addresses taken from configuration file.
76 Pay attention that this command runs integrity check for each completely
77 received packet in the background. This can be time consuming.
78 Connection could be lost during that check and remote node won't be
79 notified that file is done. But after successful integrity check that
80 file is renamed from @file{.part} one and when you rerun
81 @command{nncp-call} again, remote node will receive completion
88 % nncp-check [options]
91 Perform @ref{Spool, spool} directory integrity check. Read all files
92 that has Base32-encoded filenames and compare it with recalculated
93 BLAKE2b hash output of their contents. This supplementary command is
94 not used often in practice, if ever.
100 % nncp-daemon [options] [-maxconn INT] [-bind ADDR]
103 Start listening TCP daemon, wait for incoming connections and run
104 @ref{Sync, synchronization protocol} with each of them. You can run
105 @ref{nncp-toss} utility in background to process inbound packets from
108 @option{-maxconn} option specifies how many simultaneous clients daemon
109 can handle. @option{-bind} option specifies @option{addr:port} it must
116 % nncp-file [options] [-chunk INT] SRC NODE:[DST]
119 Send @file{SRC} file to remote @option{NODE}. @file{DST} specifies
120 destination file name in remote's @ref{CfgIncoming, incoming}
121 directory. If this file already exists there, then counter will be
124 This command queues file in @ref{Spool, spool} directory immediately
125 (through the temporary file of course) -- so pay attention that sending
126 2 GiB file will create 2 GiB outbound encrypted packet.
128 If @file{SRC} equals to @file{-}, then create an encrypted temporary
129 file and copy everything taken from stdin to it and use for outbound
130 packet creation. Pay attention that if you want to send 1 GiB of data
131 taken from stdin, then you have to have 2 GiB of disk space for that
132 temporary file and resulting encrypted packet.
134 If @option{-chunk} is specified, then source file will be split
135 @ref{Chunked, on chunks}. @option{INT} is the desired chunk size in
136 KiBs. This mode is more CPU hungry. Pay attention that chunk is saved in
137 spool directory immediately and it is not deleted if any error occurs.
139 If @ref{CfgNotify, notification} is enabled on the remote side for
140 file transmissions, then it will sent simple letter after successful
147 % nncp-freq [options] NODE:SRC DST
150 Send file request to @option{NODE}, asking it to send its @file{SRC}
151 file from @ref{CfgFreq, freq} directory to our node under @file{DST}
152 filename in our @ref{CfgIncoming, incoming} one.
154 If @ref{CfgNotify, notification} is enabled on the remote side for
155 file request, then it will sent simple letter after successful file
165 Parse @ref{Log, log} file and print out its records in human-readable form.
171 % nncp-mail [options] NODE USER ...
174 Send mail, that is read from stdin, to @option{NODE} and specified
175 @option{USER}s. Mail message will be compressed. After receiving, remote
176 side will execute specified @ref{CfgSendmail, sendmail} command with
177 @option{USER}s appended as a command line argument and feed decompressed
178 mail body to that command's stdin.
184 % nncp-mincfg [options] > stripped.yaml
187 Print out stripped configuration version: only path to @ref{Spool,
188 spool}, path to log file, neighbours public keys are stayed. This is
189 useful mainly for usage with @ref{nncp-xfer} that has to know only
190 neighbours, without private keys involving.
196 % nncp-newcfg [options] > new.yaml
199 Generate new node configuration: private keys, example configuration
200 file and print it to stdout. You must use this command when you setup
203 Pay attention that private keys generation consumes an entropy from your
210 % nncp-pkt [options] < pkt
211 % nncp-pkt [options] [-decompress] -dump < pkt > payload
214 Low level packet parser. Normally it should not be used, but can help in
217 By default it will print packet's type, for example:
219 Packet type: encrypted
221 Sender: 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ
224 If you specify @option{-dump} option and provide an @ref{Encrypted,
225 encrypted} packet, then it will verify and decrypt it to stdout.
226 Encrypted packets contain @ref{Plain, plain} ones, that also can be fed
227 to @command{nncp-pkt}:
231 Payload type: transitional
232 Path: VHMTRWDOXPLK7BR55ICZ5N32ZJUMRKZEMFNGGCEAXV66GG43PEBQ
236 Path: stargrave@stargrave.org
239 And with the @option{-dump} option it will give you the actual payload
240 (the whole file, mail message, and so on). @option{-decompress} option
241 tries to zlib-decompress the data from plain packet (useful for mail
248 % nncp-reass [options] [-dryrun] [-keep] [-dump] [-stdout] FILE.nncp.meta
249 % nncp-reass [options] [-dryrun] [-keep] {-all | -node NODE}
252 Reassemble @ref{Chunked, chunked file} after @ref{nncp-toss, tossing}.
254 When called with @option{FILE} option, this command will reassemble only
255 it. When called with @option{-node} option, this command will try to
256 reassemble all @file{.nncp.meta} files found in @option{NODE}'s
257 @ref{CfgIncoming, incoming} directory. When called with @option{-all}
258 option, then cycle through all known nodes to do the same.
260 Reassembling process does the following:
263 @item Parses @ref{Chunked, @file{.nncp.meta}} file.
264 @item Checks existence and size of every @file{.nncp.chunkXXX}.
265 @item Verifies integrity of every chunk.
266 @item Concatenates all chunks, simultaneously removing them from filesystem.
269 That process reads the whole data twice. Be sure to have free disk
270 space for at least one chunk. Decrypted chunk files as a rule are saved
271 in pseudo-random order, so removing them during reassembly process will
272 likely lead to filesystem fragmentation. Reassembly process on
273 filesystems with deduplication capability should be rather lightweight.
275 If @option{-dryrun} option is specified, then only existence and
276 integrity checking is performed.
278 If @option{-keep} option is specified, then no
279 @file{.nncp.meta}/@file{.nncp.chunkXXX} files are deleted during
282 @option{-stdout} option outputs reassembled file to stdout, instead of
283 saving to temporary file with renaming after. This could be useful for
284 reassembling on separate filesystem to lower fragmentation effect,
285 and/or separate storage device for higher performance.
287 @option{-dump} option prints meta-file contents in human-friendly form.
288 It is useful mainly for debugging purposes. For example:
290 Original filename: testfile
291 File size: 3.8 MiB (3987795 bytes)
292 Chunk size: 1.0 MiB (1048576 bytes)
295 0: eac60d819edf40b8ecdacd0b9a5a8c62de2d15eef3c8ca719eafa0be9b894017
296 1: 013a07e659f2e353d0e4339c3375c96c7fffaa2fa00875635f440bbc4631052a
297 2: f4f883975a663f2252328707a30e71b2678f933b2f3103db8475b03293e4316e
298 3: 0e9e229501bf0ca42d4aa07393d19406d40b179f3922a3986ef12b41019b45a3
305 % nncp-rm [options] NODE PKT
308 Remove specified packet (Base32 name) in @option{NODE}'s queues. This
309 command is useful when you want to remove the packet that is failing to
316 % nncp-stat [options]
319 Print current @ref{Spool, spool} statistics about unsent and unprocessed
320 packets. For each node and each niceness level there will be printed how
321 many packets (with the total size) are in inbound (Rx) and outbound (Tx)
328 % nncp-toss [options] [-dryrun] [-cycle INT]
331 Perform "tossing" operation on all inbound packets. This is the tool
332 that decrypts all packets and processes all payload packets in them:
333 copies files, sends mails, sends out file requests and relays transition
334 packets. It should be run after each online/offline exchange.
336 @option{-dryrun} option does not perform any writing and sending, just
337 tells what it will do.
339 @option{-cycle} option tells not to quit, but to repeat tossing every
340 @option{INT} seconds in an infinite loop. That can be useful when
341 running this command as a daemon.
347 % nncp-xfer [options] [-force] [-keep] [-rx|-tx] DIR
350 Search for directory in @file{DIR} containing inbound packets for us and
351 move them to local @ref{Spool, spool} directory. Also search for known
352 neighbours directories and move locally queued outbound packets to them.
353 This command is used for offline packets transmission.
355 If @option{-force} option is specified, then outbound neighbour(s)
356 directories will be created. This is useful for the first time usage,
357 when storage device does not have any directories tree.
359 If @option{-keep} option is specified, then keep copied files, do not
362 @option{-rx} option tells only to move inbound packets addressed to us.
363 @option{-tx} option tells exactly the opposite: move only outbound packets.
365 @ref{nncp-mincfg} could be useful for creating stripped minimalistic
366 configuration file version without any private keys.
368 @file{DIR} directory has the following structure:
369 @file{RECIPIENT/SENDER/PACKET}, where @file{RECIPIENT} is Base32 encoded
370 destination node, @file{SENDER} is Base32 encoded sender node.