X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=doc%2Fcmds.texi;h=8ead3417a802ad2ba5d3797422f6ed02419d97b7;hb=4c17993ce76c6f1883e6854d826eafd4c33c1594;hp=2fb0374cbf235eb3ceb04febf7d162834f6f50c3;hpb=57ad1181a80e569791e2e495f5765f3762fd024d;p=nncp.git diff --git a/doc/cmds.texi b/doc/cmds.texi index 2fb0374..8ead341 100644 --- a/doc/cmds.texi +++ b/doc/cmds.texi @@ -53,10 +53,10 @@ $ nncp-bundle [options] -rx [-check] [-dryrun] [NODE ...] < ... With @option{-tx} option, this command creates @ref{Bundles, bundle} of @ref{Encrypted, encrypted packets} from the spool directory and writes -it to stdout. +it to @code{stdout}. -With @option{-rx} option, this command takes bundle from stdin and -copies all found packets for our node to the spool directory. Pay +With @option{-rx} option, this command takes bundle from @code{stdin} +and copies all found packets for our node to the spool directory. Pay attention that @strong{no} integrity checking is done by default. Modern tape drives could easily provide too much throughput your CPU won't be able to verify on the fly. So if you won't @ref{nncp-toss, toss} @@ -73,7 +73,7 @@ When packets are sent through the stream, they are still kept in the spool directory, because there is no assurance that they are transferred to the media (media (CD-ROM, tape drive, raw hard drive) can end). If you want to forcefully delete them (after they are successfully flushed -to stdout) anyway, use @option{-delete} option. +to @code{stdout}) anyway, use @option{-delete} option. But you can verify produced stream after, by digesting it by yourself with @option{-rx} and @option{-delete} options -- in that mode, stream @@ -101,6 +101,7 @@ $ nncp-call [options] [-pkts PKT,PKT,...] [-rxrate INT] [-txrate INT] + [-autotoss*] NODE[:ADDR] [FORCEADDR] @end example @@ -138,6 +139,10 @@ file is renamed from @file{.part} one and when you rerun @command{nncp-call} again, remote node will receive completion notification. +@option{-autotoss} options runs tosser on node's spool after call +is finished. All @option{-autotoss-*} options is the same as in +@ref{nncp-toss} command. + @node nncp-caller @section nncp-caller @@ -214,8 +219,8 @@ $ nncp-cfgnew [options] [-nocomments] > new.hjson @end example Generate new node configuration: private keys, example configuration -file and print it to stdout. You must use this command when you setup -the new node. @option{-nocomments} will create configuration file +file and print it to @code{stdout}. You must use this command when you +setup the new node. @option{-nocomments} will create configuration file without descriptive huge comments -- useful for advanced users. Pay attention that private keys generation consumes an entropy from your @@ -237,7 +242,7 @@ not used often in practice, if ever. @section nncp-daemon @example -$ nncp-daemon [options] [-maxconn INT] [-bind ADDR] [-inetd] +$ nncp-daemon [options] [-maxconn INT] [-bind ADDR] [-inetd] [-autotoss*] @end example Start listening TCP daemon, wait for incoming connections and run @@ -250,24 +255,31 @@ can handle. @option{-bind} option specifies @option{addr:port} it must bind to and listen. It could be run as @command{inetd} service, by specifying -@option{-inetd} option. Pay attention that because it uses stdin/stdout, -it can not effectively work with IO timeouts and connection closing can -propagate up to 5 minutes in practice. Example inetd-entry: +@option{-inetd} option. Pay attention that because it uses +@code{stdin}/@code{stdout}, it can not effectively work with IO timeouts +and connection closing can propagate up to 5 minutes in practice. +Example inetd-entry: @verbatim uucp stream tcp6 nowait nncpuser /usr/local/bin/nncp-daemon nncp-daemon -quiet -inetd @end verbatim +@option{-autotoss} options runs tosser on node's spool after call +is finished. All @option{-autotoss-*} options is the same as in +@ref{nncp-toss} command. + @node nncp-exec @section nncp-exec @example -$ nncp-exec [options] NODE HANDLE [ARG0 ARG1 ...] +$ nncp-exec [options] [-use-tmp] [-nocompress] NODE HANDLE [ARG0 ARG1 ...] @end example Send execution command to @option{NODE} for specified @option{HANDLE}. -Body is read from stdin and compressed. After receiving, remote side -will execute specified @ref{CfgExec, handle} command with @option{ARG*} +Body is read from stdin (either into memory, or into encrypted temporary +file if @option{-use-tmp} is specified) and compressed (unless +@option{-nocompress} is specified). After receiving, remote side will +execute specified @ref{CfgExec, handle} command with @option{ARG*} appended and decompressed body fed to command's stdin. For example, if remote side has following configuration file for your @@ -295,7 +307,7 @@ If @ref{CfgNotify, notification} is enabled on the remote side for exec handles, then it will sent simple letter after successful command execution with its output in message body. -@strong{Pay attention} that packet generated with this command can not +@strong{Pay attention} that packet generated with this command won't be be chunked. @node nncp-file @@ -315,9 +327,9 @@ This command queues file in @ref{Spool, spool} directory immediately 2 GiB file will create 2 GiB outbound encrypted packet. If @file{SRC} equals to @file{-}, then create an encrypted temporary -file and copy everything taken from stdin to it and use for outbound +file and copy everything taken from @code{stdin} to it and use for outbound packet creation. Pay attention that if you want to send 1 GiB of data -taken from stdin, then you have to have more than 2 GiB of disk space +taken from @code{stdin}, then you have to have more than 2 GiB of disk space for that temporary file and resulting encrypted packet. You can control where temporary file will be stored using @env{TMPDIR} environment variable. Encryption is performed in AEAD mode with @@ -391,7 +403,7 @@ Sender: 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ @end example If you specify @option{-dump} option and provide an @ref{Encrypted, -encrypted} packet, then it will verify and decrypt it to stdout. +encrypted} packet, then it will verify and decrypt it to @code{stdout}. Encrypted packets contain @ref{Plain, plain} ones, that also can be fed to @command{nncp-pkt}: @@ -450,10 +462,10 @@ If @option{-keep} option is specified, then no @file{.nncp.meta}/@file{.nncp.chunkXXX} files are deleted during reassembly process. -@option{-stdout} option outputs reassembled file to stdout, instead of -saving to temporary file with renaming after. This could be useful for -reassembling on separate filesystem to lower fragmentation effect, -and/or separate storage device for higher performance. +@option{-stdout} option outputs reassembled file to @code{stdout}, +instead of saving to temporary file with renaming after. This could be +useful for reassembling on separate filesystem to lower fragmentation +effect, and/or separate storage device for higher performance. @option{-dump} option prints meta-file contents in human-friendly form. It is useful mainly for debugging purposes. For example: