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