Unify @ref and @command usage

[nncp.git] / doc / cmd / nncp-call.texi

diff --git a/doc/cmd/nncp-call.texi b/doc/cmd/nncp-call.texi
index 54609fe489a638733436ff7dccd3da4b07342d03..043d7e22b856f1622e0581567e244772e8d87a8a 100644 (file)
--- a/doc/cmd/nncp-call.texi
+++ b/doc/cmd/nncp-call.texi
@@ -1,4 +1,5 @@
 @node nncp-call
 @node nncp-call

+@pindex nncp-call

 @section nncp-call
 
 @example
 @section nncp-call
 
 @example


@@ -13,6 +14,7 @@ $ nncp-call [options]
     [-autotoss*]
     [-nock]
     [-ucspi]
     [-autotoss*]
     [-nock]
     [-ucspi]

+    [-mcd-wait INT]

     NODE[:ADDR] [FORCEADDR]
 @end example
 
     NODE[:ADDR] [FORCEADDR]
 @end example
 


@@ -40,16 +42,21 @@ Each @option{NODE} can contain several uniquely identified
 @option{ADDR}esses in @ref{CfgAddrs, configuration} file. If you do
 not specify the exact one, then all will be tried until the first
 success. Optionally you can force @option{FORCEADDR} address usage,
 @option{ADDR}esses in @ref{CfgAddrs, configuration} file. If you do
 not specify the exact one, then all will be tried until the first
 success. Optionally you can force @option{FORCEADDR} address usage,

-instead of addresses taken from configuration file. You can specify both
-@verb{|host:port|} and @verb{#|some command#} formats.
+instead of addresses taken from configuration file. You can specify
+@verb{|host:port|}, @verb{#|some command#} and
+@verb{|yggdrasil:PUB;PRV;PEER[,...]|} formats.

 
 If you specify @option{-ucspi} option, then it is assumed that you run
 
 If you specify @option{-ucspi} option, then it is assumed that you run

-@command{nncp-call} command under some UCSPI-TCP compatible utility,
+@command{@ref{nncp-call}} command under some UCSPI-TCP compatible utility,

 that provides read/write channels through 6/7 file descriptors.
 
 that provides read/write channels through 6/7 file descriptors.
 

+@option{-mcd-wait} options tells to wait up to specified number of
+seconds for the @ref{MCD} packet from the specified @code{NODE}. When
+the packet is received, initiate a call.
+

 @option{-autotoss} option runs tosser on node's spool every second
 during the call. All @option{-autotoss-*} options is the same as in
 @option{-autotoss} option runs tosser on node's spool every second
 during the call. All @option{-autotoss-*} options is the same as in

-@ref{nncp-toss} command.
+@command{@ref{nncp-toss}} command.

 
 Partly downloaded packets are stored in @file{.part} files. By default
 all downloaded files are sequentially checksummed in the background,
 
 Partly downloaded packets are stored in @file{.part} files. By default
 all downloaded files are sequentially checksummed in the background,


@@ -58,8 +65,8 @@ option is set, then no checksumming is done, renaming fully downloaded
 files to @file{.nock} extension. Pay attention that checksumming can be
 time consuming and connection could be lost during that check, so remote
 node won't be notified that the file is finished. If you run
 files to @file{.nock} extension. Pay attention that checksumming can be
 time consuming and connection could be lost during that check, so remote
 node won't be notified that the file is finished. If you run

-@ref{nncp-check, @command{nncp-check -nock}}, that will checksum files
-and strip the @file{.nock} extension, then repeated call to remote node
-will notify about packet's completion. Also it will be notified if
-@ref{nncp-toss, tossing} created @file{.seen} file.
-Read @ref{CfgNoCK, more} about @option{-nock} option.
+@command{@ref{nncp-check} -nock}, that will checksum files and strip the
+@file{.nock} extension, then repeated call to remote node will notify about
+packet's completion. Also it will be notified if @ref{nncp-toss, tossing}
+created @file{seen/} file. Read @ref{CfgNoCK, more} about @option{-nock}
+option.