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