]> Cypherpunks.ru repositories - nncp.git/blobdiff - doc/cmd/nncp-file.texi
Add various documentation indices
[nncp.git] / doc / cmd / nncp-file.texi
index 29f061af29b9f666cc3d9f02e6e7d1b51525125a..078a6bab1ff5d3626c8175de6e88b22614c8ce21 100644 (file)
@@ -1,4 +1,5 @@
 @node nncp-file
+@pindex nncp-file
 @section nncp-file
 
 @example
@@ -11,32 +12,23 @@ destination file name in remote's @ref{CfgIncoming, incoming}
 directory. If this file already exists there, then counter will be
 appended to it.
 
-This command queues file in @ref{Spool, spool} directory immediately
-(through the temporary file of course) -- so pay attention that sending
-2 GiB file will create 2 GiB outbound encrypted packet.
-
-@anchor{StdinTmpFile}
-If @file{SRC} equals to @file{-}, then create an encrypted temporary
-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 @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
-temporary file location directory with @env{TMPDIR} environment
-variable. Encryption is performed in AEAD mode with
-@url{https://cr.yp.to/chacha.html, ChaCha20}-@url{https://en.wikipedia.org/wiki/Poly1305, Poly1305}
-algorithms. Data is divided on 128 KiB blocks. Each block is encrypted
-with increasing nonce counter. File is deletes immediately after
-creation, so even if program crashes -- disk space will be reclaimed, no
-need in cleaning it up later.
+This command queues file in @ref{Spool, spool} directory immediately --
+so pay attention that sending 2 GiB file will create 2 GiB outbound
+encrypted packet.
+
+If @file{SRC} equals to @file{-}, to data is read from @code{stdin}.
 
 If @file{SRC} points to directory, then
-@url{https://pubs.opengroup.org/onlinepubs/9699919799/utilities/pax.html#tag_20_92_13_01, pax archive}
-will be created on the fly with directory contents and destination
-filename @file{.tar} appended. It @strong{won't} contain any entities
-metainformation, but modification time with the names. UID/GID are set
-to zero. Directories have 777 permissions, files have 666, for being
-friendly with @command{umask}. Also each entity will have comment like
-@verb{|Autogenerated by NNCP version X.Y.Z built with goXXX|}.
+@url{https://pubs.opengroup.org/onlinepubs/9699919799/utilities/pax.html#tag_20_92_13_01,
+pax archive} will be created on the fly with directory contents and
+destination filename @file{.tar} appended. It @strong{won't} contain any
+entities metainformation, except for modification time with the names.
+UID/GID are set to zero. Directories have 777 permissions, files have
+666, for being friendly with @command{umask}. Everything except
+directories and regulars files is skipped. Also each entity will have
+comment like @verb{|Autogenerated by NNCP version X.Y.Z built with goXXX|}.
+For more precise metainformation and various file objects storage use
+external @command{tar} command piped in.
 
 If @option{-chunked} is specified, then source file will be split
 @ref{Chunked, on chunks}. @option{INT} is the desired chunk size in