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 niceness level. 1-255 values are
18 allowed. Higher value means lower priority. In some commands that
19 means processing of packets that have equal or lower nice value.
20 That is used for controlling network QoS.
22 Process only single specified node.
24 Print only errors, omit simple informational messages. In any case
25 those messages are logged, so you can reread them using
26 @ref{nncp-log} command.
28 Print version information.
30 Print warranty information (no warranty).
37 % nncp-call [options] [-rx|-tx] 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 transmission
48 is performed. If @option{-tx} option is specified, then only outbound
49 transmission is performed.
51 Each @option{NODE} can contain several uniquely identified
52 @option{ADDR}esses in @ref{Configuration, configuration} file. If you do
53 not specify the exact one, then all will be tried until the first
54 success. Optionally you can force @option{FORCEADDR} address usage,
55 instead of addresses taken from configuration file.
57 Pay attention that this command run integrity check for each completely
58 received packet in the background. This can be time consuming and
59 connection could be lost during that check time and remote node won't be
60 notified that file is done. But after successful integrity check that
61 file will be renamed from @file{.part} one and when you rerun
62 @command{nncp-call} again, remote node will receive completion at once.
68 % nncp-check [options]
71 Perform @ref{Spool, spool} directory integrity check. Read all files
72 that has Base32-encoded filenames and compare it with recalculated
73 BLAKE2b hash output of their contents. This supplementary command are
74 not used often in practice, if ever.
80 % nncp-daemon [options] [-maxconn INT] [-bind ADDR]
83 Start listening TCP daemon, wait for incoming connections and run
84 @ref{Sync, synchronization protocol} with each of them. You can run
85 @ref{nncp-toss} utility in background to process inbound packets from
88 @option{-maxconn} option specifies how many simultaneous clients daemon
89 can handle. @option{-bind} option specifies @option{addr:port} it must
96 % nncp-file [options] SRC NODE:[DST]
99 Send @file{SRC} file to remote @option{NODE}. @file{DST} specifies
100 destination file name in remote's @ref{Configuration, incoming}
101 directory. If this file already exists there, then counter will be
104 This command queues file in @ref{Spool, spool} directory immediately
105 (through the temporary file of course) -- so pay attention that sending
106 2 GiB file will create 2 GiB outbound encrypted packet.
108 If @ref{Configuration, notification} is enabled on the remote side for
109 file transmissions, then it will sent simple letter after successful
116 % nncp-freq [options] NODE:SRC DST
119 Send file request to @option{NODE}, asking it to send its @file{SRC}
120 file from @ref{Configuration, freq} directory to our node under
121 @file{DST} filename in our @ref{Configuration, incoming} one.
123 If @ref{Configuration, notification} is enabled on the remote side for
124 file request, then it will sent simple letter after successful file
134 Parse @ref{Log, log} file and print out its records in human-readable form.
140 % nncp-mail [options] NODE USER ...
143 Send mail, that is read from stdin, to @option{NODE} and specified
144 @option{USER}s. Mail message will be compressed. After receiving, remote
145 side will execute specified @ref{Configuration, sendmail} command with
146 @option{USER}s appended as a command line argument and feed decompressed
147 mail body to that command's stdin.
150 @section nncp-newnode
153 % nncp-newnode [options] > mynewnode.yaml
156 Generate new node: private keys, example configuration file and print it
157 to stdout. You must use this command when you setup the new node.
159 Pay attention that private keys generation consumes an entropy from your
166 % nncp-pkt [options] < pkt
167 % nncp-pkt [options] -dump < pkt > payload
170 Low level packet parser. Normally it should not be used, but can help in
173 By default it will print packet's type, for example:
175 Packet type: encrypted
177 Sender: 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ
178 Payload size: 4.0 MiB (4162852 bytes)
181 If you specify @option{-dump} option and provide an @ref{Encrypted,
182 encrypted} packet, then it will verify and decrypt it to stdout.
183 Encrypted packets contain @ref{Plain, plain} ones, that also can be fed
184 to @command{nncp-pkt}:
188 Payload type: transitional
189 Path: VHMTRWDOXPLK7BR55ICZ5N32ZJUMRKZEMFNGGCEAXV66GG43PEBQ
193 Path: stargrave@stargrave.org
196 And with the @option{-dump} option it will give you the actual payload
197 (the whole file, mail message, and so on).
203 % nncp-stat [options]
206 Print current @ref{Spool, spool} statistics about unsent and unprocessed
207 packets. For each node and each niceness level there will be printed how
208 many packets (with the total size) are in inbound (Rx) and outbound (Tx)
215 % nncp-toss [options] [-dryrun]
218 Perform "tossing" operation on all inbound packets. This is the tool
219 that decrypts all packets and processes all payload packets in them:
220 copies files, sends mails, sends out file requests and relays transition
221 packets. It should be run after each online/offline exchange.
223 @option{-dryrun} option does not perform any writing and sending, just
224 tells what it will do.
230 % nncp-xfer [options] [-force] [-keep] [-rx|-tx] DIR
233 Search for directory in @file{DIR} containing inbound packets for us and
234 move them to local @ref{Spool, spool} directory. Also search for known
235 neighbours directories and move locally queued outbound packets to them.
236 This command is used for offline packets transmission.
238 If @option{-force} option is specified, then outbound neighbour(s)
239 directories will be created. This is useful for the first time usage,
240 when storage device does not have any directories tree.
242 If @option{-keep} option is specified, then keep copied files, do not
245 @option{-rx} option tells only to move inbound packets addressed to us.
246 @option{-tx} option tells exactly the opposite: move only outbound packets.
248 @file{DIR} directory has the following structure:
249 @file{RECIPIENT/SENDER/PACKET}, where @file{RECIPIENT} is Base32 encoded
250 destination node, @file{SENDER} is Base32 encoded sender node.