]> Cypherpunks.ru repositories - nncp.git/commitdiff
stdin/stdout formatting
authorSergey Matveev <stargrave@stargrave.org>
Sun, 17 Jan 2021 14:31:06 +0000 (17:31 +0300)
committerSergey Matveev <stargrave@stargrave.org>
Sun, 17 Jan 2021 14:31:06 +0000 (17:31 +0300)
doc/cfg.texi
doc/cmds.texi
doc/comparison.texi
doc/integration.texi
doc/news.ru.texi
doc/news.texi
ports/nncp/Makefile

index f918385be8ed9e95555d3e8da69a5ab4eef0b2d5..3e0b882b0582f7c16792b9ed057e18d1b4c46d07 100644 (file)
@@ -142,7 +142,7 @@ Dictionary consisting of handles and corresponding command line
 arguments. In example above there are @command{sendmail} handles,
 @command{warcer}, @command{wgeter} and @command{flag} one. Remote node
 can queue some handle execution with providing additional command line
-arguments and the body fed to command's stdin.
+arguments and the body fed to command's @code{stdin}.
 
 @verb{|sendmail: ["/usr/sbin/sendmail", "-t"]|} handle, when called by
 @verb{|echo hello world | nncp-exec OURNODE sendmail ARG0 ARG1 ARG2|}
@@ -190,9 +190,9 @@ human-readable name of the address. For direct TCP connections use
 @verb{|host:port|} format, pointing to @ref{nncp-daemon}'s listening
 instance. Also you can pipe connection through the external command
 using @verb{#|some command#} format. @code{/bin/sh -c "some command"}
-will start and its stdin/stdout used as a connection. May be omitted if
-either no direct connection exists, or @ref{nncp-call} is used with
-forced address specifying.
+will start and its @code{stdin}/@code{stdout} used as a connection. May
+be omitted if either no direct connection exists, or @ref{nncp-call} is
+used with forced address specifying.
 
 @anchor{CfgXxRate}
 @item rxrate/txrate
index 575807af676e230feda3fd1de28c02383f9088d3..8ead3417a802ad2ba5d3797422f6ed02419d97b7 100644 (file)
@@ -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
@@ -219,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
@@ -255,9 +255,10 @@ 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
@@ -326,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
@@ -402,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}:
 
@@ -461,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:
index 1cb366448c26a8063b5dc8184eab707234f842f2..7bf4e53d84401651ab246602fa076475deeff6cc 100644 (file)
@@ -120,7 +120,7 @@ comparable commands of UUCP and NNCP, just for the interest:
 @item Receive connection (pipe, daemon, etc)
     @tab @command{uucico} (@option{-l} or similar)
     @tab @command{nncp-daemon}
-@item Request remote execution, stdin piped in
+@item Request remote execution, @code{stdin} piped in
     @tab @command{uux}
     @tab @command{nncp-exec}
 @item Copy file to remote machine
index c9b3a71e0f9f95475a223d31d3374dad5399be00..3359a3a72b25534eaf7e419a169128928433d908 100644 (file)
@@ -243,7 +243,7 @@ exec: @{
 @}
 @end example
 
-The -bS option is what tells Exim to receive BSMTP on stdin.
+The -bS option is what tells Exim to receive BSMTP on @code{stdin}.
 
 Now, you need to tell Exim that nncp is a trusted user (able to set From
 headers arbitrarily). Assuming you are running NNCP as the nncp user,
index c4ce41d4a408ead9657f51239e8142b8c15aec68..111645ef0f5bdf5b4cd7decea4565e6bde4f2127 100644 (file)
@@ -446,9 +446,10 @@ HKDF-BLAKE2b-256 KDF алгоритм заменён на BLAKE2Xb XOF. Ещё 
 
 @item
 @command{nncp-bundle} команда может создавать потоки зашифрованных
-пакетов или потреблять их. Это полезно когда речь идёт о stdin/stdout
-методах передачи (например запись на CD-ROM без создания промежуточного
-подготовленного ISO образа или работа с ленточными накопителями).
+пакетов или потреблять их. Это полезно когда речь идёт о
+@code{stdin}/@code{stdout} методах передачи (например запись на CD-ROM
+без создания промежуточного подготовленного ISO образа или работа с
+ленточными накопителями).
 
 @item
 @command{nncp-toss} команда может создавать @file{.seen} файлы,
index a24704fe104f9fbe27eefe4f30d56a3b46dbe8c5..e8744e40e0be12fcbb51079e3b9df87462943994 100644 (file)
@@ -435,9 +435,10 @@ are not supported.
 
 @item
 @command{nncp-bundle} command can either create stream of encrypted
-packets, or digest it. It is useful when dealing with stdin/stdout based
-transmission methods (like writing to CD-ROM without intermediate
-prepared ISO image and working with tape drives).
+packets, or digest it. It is useful when dealing with
+@code{stdin}/@code{stdout} based transmission methods (like writing to
+CD-ROM without intermediate prepared ISO image and working with tape
+drives).
 
 @item
 @command{nncp-toss} is able to create @file{.seen} files preventing
@@ -499,8 +500,8 @@ option for unchunked transfer was not in KiBs, but in bytes.
 @itemize
 
 @item
-Ability to feed @command{nncp-file} from stdin, that uses an encrypted
-temporary file for that.
+Ability to feed @command{nncp-file} from @code{stdin}, that uses an
+encrypted temporary file for that.
 
 @item
 Chunked files transmission appeared with corresponding
index 792703f1aa2e34589d3a66c08af7c1b74e449c8e..b846f49bc4ace307aadfaf62075f6425e2f65747 100644 (file)
@@ -1,7 +1,7 @@
 # $FreeBSD: $
 
 PORTNAME=      nncp
-DISTVERSION=   5.4.0
+DISTVERSION=   5.5.1
 CATEGORIES=    net
 MASTER_SITES=  http://www.nncpgo.org/download/
 
@@ -16,6 +16,7 @@ USES=         go:no_targets tar:xz
 USE_RC_SUBR=   nncp-caller nncp-daemon nncp-toss
 
 MAKE_ARGS=     INFODIR=${STAGEDIR}${PREFIX}/${INFO_PATH}
+MAKE_ENV=      ${GO_ENV}
 INSTALL_TARGET=        install-strip
 
 SUB_FILES=     pkg-message pkg-install pkg-deinstall