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] 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 @ref{CfgNotify, notification} is enabled on the remote side for
129 file transmissions, then it will sent simple letter after successful
136 % nncp-freq [options] NODE:SRC DST
139 Send file request to @option{NODE}, asking it to send its @file{SRC}
140 file from @ref{CfgFreq, freq} directory to our node under @file{DST}
141 filename in our @ref{CfgIncoming, incoming} one.
143 If @ref{CfgNotify, notification} is enabled on the remote side for
144 file request, then it will sent simple letter after successful file
154 Parse @ref{Log, log} file and print out its records in human-readable form.
160 % nncp-mail [options] NODE USER ...
163 Send mail, that is read from stdin, to @option{NODE} and specified
164 @option{USER}s. Mail message will be compressed. After receiving, remote
165 side will execute specified @ref{CfgSendmail, sendmail} command with
166 @option{USER}s appended as a command line argument and feed decompressed
167 mail body to that command's stdin.
170 @section nncp-newnode
173 % nncp-newnode [options] > mynewnode.yaml
176 Generate new node: private keys, example configuration file and print it
177 to stdout. You must use this command when you setup the new node.
179 Pay attention that private keys generation consumes an entropy from your
186 % nncp-pkt [options] < pkt
187 % nncp-pkt [options] [-decompress] -dump < pkt > payload
190 Low level packet parser. Normally it should not be used, but can help in
193 By default it will print packet's type, for example:
195 Packet type: encrypted
197 Sender: 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ
200 If you specify @option{-dump} option and provide an @ref{Encrypted,
201 encrypted} packet, then it will verify and decrypt it to stdout.
202 Encrypted packets contain @ref{Plain, plain} ones, that also can be fed
203 to @command{nncp-pkt}:
207 Payload type: transitional
208 Path: VHMTRWDOXPLK7BR55ICZ5N32ZJUMRKZEMFNGGCEAXV66GG43PEBQ
212 Path: stargrave@stargrave.org
215 And with the @option{-dump} option it will give you the actual payload
216 (the whole file, mail message, and so on). @option{-decompress} option
217 tries to zlib-decompress the data from plain packet (useful for mail
224 % nncp-stat [options]
227 Print current @ref{Spool, spool} statistics about unsent and unprocessed
228 packets. For each node and each niceness level there will be printed how
229 many packets (with the total size) are in inbound (Rx) and outbound (Tx)
236 % nncp-toss [options] [-dryrun] [-cycle INT]
239 Perform "tossing" operation on all inbound packets. This is the tool
240 that decrypts all packets and processes all payload packets in them:
241 copies files, sends mails, sends out file requests and relays transition
242 packets. It should be run after each online/offline exchange.
244 @option{-dryrun} option does not perform any writing and sending, just
245 tells what it will do.
247 @option{-cycle} option tells not to quit, but to repeat tossing every
248 @option{INT} seconds in an infinite loop. That can be useful when
249 running this command as a daemon.
255 % nncp-xfer [options] [-force] [-keep] [-rx|-tx] DIR
258 Search for directory in @file{DIR} containing inbound packets for us and
259 move them to local @ref{Spool, spool} directory. Also search for known
260 neighbours directories and move locally queued outbound packets to them.
261 This command is used for offline packets transmission.
263 If @option{-force} option is specified, then outbound neighbour(s)
264 directories will be created. This is useful for the first time usage,
265 when storage device does not have any directories tree.
267 If @option{-keep} option is specified, then keep copied files, do not
270 @option{-rx} option tells only to move inbound packets addressed to us.
271 @option{-tx} option tells exactly the opposite: move only outbound packets.
273 @file{DIR} directory has the following structure:
274 @file{RECIPIENT/SENDER/PACKET}, where @file{RECIPIENT} is Base32 encoded
275 destination node, @file{SENDER} is Base32 encoded sender node.