]> Cypherpunks.ru repositories - nncp.git/blob - doc/cmd/nncp-call.texi
Multicast areas
[nncp.git] / doc / cmd / nncp-call.texi
1 @node nncp-call
2 @section nncp-call
3
4 @example
5 $ nncp-call [options]
6     [-onlinedeadline INT]
7     [-maxonlinetime INT]
8     [-rx|-tx]
9     [-list]
10     [-pkts PKT,PKT,...]
11     [-rxrate INT]
12     [-txrate INT]
13     [-autotoss*]
14     [-nock]
15     NODE[:ADDR] [FORCEADDR]
16 @end example
17
18 Call (connect to) specified @option{NODE} and run @ref{Sync,
19 synchronization} protocol with the @ref{nncp-daemon, daemon} on the
20 remote side. Normally this command could be run any time you wish to
21 either check for incoming packets, or to send out queued ones.
22 Synchronization protocol allows resuming and bidirectional packets
23 transfer.
24
25 If @option{-rx} option is specified then only inbound packets
26 transmission is performed. If @option{-tx} option is specified, then
27 only outbound transmission is performed.
28
29 @option{-onlinedeadline} overrides @ref{CfgOnlineDeadline, @emph{onlinedeadline}}.
30 @option{-maxonlinetime} overrides @ref{CfgMaxOnlineTime, @emph{maxonlinetime}}.
31 @option{-rxrate}/@option{-txrate} override @ref{CfgXxRate, rxrate/txrate}.
32
33 @option{-list} option allows you to list packets of remote node, without
34 any transmission. You can specify what packets your want to download, by
35 specifying @option{-pkts} option with comma-separated list of packets
36 identifiers.
37
38 Each @option{NODE} can contain several uniquely identified
39 @option{ADDR}esses in @ref{CfgAddrs, configuration} file. If you do
40 not specify the exact one, then all will be tried until the first
41 success. Optionally you can force @option{FORCEADDR} address usage,
42 instead of addresses taken from configuration file. You can specify both
43 @verb{|host:port|} and @verb{#|some command#} formats.
44
45 @option{-autotoss} option runs tosser on node's spool every second
46 during the call. All @option{-autotoss-*} options is the same as in
47 @ref{nncp-toss} command.
48
49 Partly downloaded packets are stored in @file{.part} files. By default
50 all downloaded files are sequentially checksummed in the background,
51 stripping @file{.part} extension if is successful. If @option{-nock}
52 option is set, then no checksumming is done, renaming fully downloaded
53 files to @file{.nock} extension. Pay attention that checksumming can be
54 time consuming and connection could be lost during that check, so remote
55 node won't be notified that the file is finished. If you run
56 @ref{nncp-check, @command{nncp-check -nock}}, that will checksum files
57 and strip the @file{.nock} extension, then repeated call to remote node
58 will notify about packet's completion. Also it will be notified if
59 @ref{nncp-toss, tossing} created @file{.seen} file.
60 Read @ref{CfgNoCK, more} about @option{-nock} option.