From 6942e7cfaacc951055282110e55c99f206444459 Mon Sep 17 00:00:00 2001 From: Sergey Matveev Date: Sun, 19 Nov 2017 16:52:28 +0300 Subject: [PATCH] Various documentation updates --- README | 6 +++--- README.RU | 3 ++- doc/about.ru.texi | 5 ++++- doc/about.texi | 9 ++++++--- doc/bundles.texi | 12 ++++++------ doc/cmds.texi | 6 +++--- doc/news.texi | 4 ++-- doc/spool.texi | 2 +- makedist.sh | 9 +++++---- ports/nncp/pkg-descr | 6 +++--- 10 files changed, 35 insertions(+), 27 deletions(-) diff --git a/README b/README index 3445eee..dab1ca8 100644 --- a/README +++ b/README @@ -9,9 +9,9 @@ encrypted (E2EE), explicitly authenticated by known participants public keys. Onion encryption is applied to relayed packets. Each node acts both as a client and server, can use push and poll behaviour model. -Out-of-box offline sneakernet/floppynet, dead drops and air-gapped -computers support. But online TCP daemon with full-duplex resumable data -transmission exists. +Out-of-box offline sneakernet/floppynet, dead drops, sequential and +append-only CD-ROM/tape storages, air-gapped computers support. But +online TCP daemon with full-duplex resumable data transmission exists. NNCP is copylefted free software: see the file COPYING for copying conditions. It should work on all POSIX-compatible systems. Easy diff --git a/README.RU b/README.RU index ad26251..eccba53 100644 --- a/README.RU +++ b/README.RU @@ -13,7 +13,8 @@ NNCP (Node to Node copy) это набор утилит упрощающий б поведения. Поддержка из коробки offline флоппинета, тайников для сброса информации -(dead drop) и компьютеров с "воздушным зазором" (air-gap). Но также +(dead drop), последовательных и не перезаписываемых CD-ROM/ленточных +хранилищ, компьютеров с "воздушным зазором" (air-gap). Но также существует и online TCP демон с полнодуплексной возобновляемой передачей данных. diff --git a/doc/about.ru.texi b/doc/about.ru.texi index c285e16..727402c 100644 --- a/doc/about.ru.texi +++ b/doc/about.ru.texi @@ -22,7 +22,10 @@ NNCP (Node to Node copy) это набор утилит упрощающий б @url{https://ru.wikipedia.org/wiki/%D0%A4%D0%BB%D0%BE%D0%BF%D0%BF%D0%B8%D0%BD%D0%B5%D1%82, флоппинета}, @url{https://ru.wikipedia.org/wiki/%D0%A2%D0%B0%D0%B9%D0%BD%D0%B8%D0%BA, -тайников} для сброса информации (dead drop) и компьютеров с +тайников} для сброса информации (dead drop), последовательных и не +перезаписываемых @url{https://ru.wikipedia.org/wiki/CD-ROM, +CD-ROM}/@url{https://ru.wikipedia.org/wiki/%D0%A1%D1%82%D1%80%D0%B8%D0%BC%D0%B5%D1%80, +ленточных} хранилищ, компьютеров с @url{https://ru.wikipedia.org/wiki/%D0%92%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D1%8B%D0%B9_%D0%B7%D0%B0%D0%B7%D0%BE%D1%80_(%D1%81%D0%B5%D1%82%D0%B8_%D0%BF%D0%B5%D1%80%D0%B5%D0%B4%D0%B0%D1%87%D0%B8_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85), воздушным зазором} (air-gap). Но также существует и online TCP демон с полнодуплексной возобновляемой передачей данных. diff --git a/doc/about.texi b/doc/about.texi index cfd5321..ffe4be0 100644 --- a/doc/about.texi +++ b/doc/about.texi @@ -17,9 +17,12 @@ can use push and poll behaviour model. Out-of-box offline @url{https://en.wikipedia.org/wiki/Sneakernet, sneakernet/floppynet}, @url{https://en.wikipedia.org/wiki/Dead_drop, -dead drops} and @url{https://en.wikipedia.org/wiki/Air_gap_(networking), -air-gapped} computers support. But online TCP daemon with full-duplex -resumable data transmission exists. +dead drops}, sequential and append-only +@url{https://en.wikipedia.org/wiki/CD-ROM, +CD-ROM}/@url{https://en.wikipedia.org/wiki/Tape_drive, tape} storages, +@url{https://en.wikipedia.org/wiki/Air_gap_(networking), air-gapped} +computers support. But online TCP daemon with full-duplex resumable data +transmission exists. Look for possible @ref{Use cases, use cases}! diff --git a/doc/bundles.texi b/doc/bundles.texi index a70e023..9b2f8fc 100644 --- a/doc/bundles.texi +++ b/doc/bundles.texi @@ -5,8 +5,8 @@ Usual @ref{nncp-xfer} command requires filesystem it can operate on. That presumes random access media storage usage, like hard drives, USB flash drives and similar. But media like CD-ROM and especially tape drives are sequential by nature. You can prepare intermediate directory -for recording to CD-ROM disc, but that requires additional storage and -is inconvenient. Tape drive will require intermediate extract step too. +for recording to CD-ROM disc/tape, but that requires additional storage +and is inconvenient. Bundles, created with @ref{nncp-bundle} command are convenient alternative to ordinary @command{nncp-xfer}. Bundle is just a collection @@ -39,8 +39,8 @@ import}/@command{zpool export} and struggling with file permissions. transmission -- sequential write is always faster, when no metainformation needs to be updated. -@item This is convenient to use with write-only/append-only storages, -just sending/appending new bundles. +@item This is convenient to use with append-only storages, just +sending/appending new bundles. @item Bundles could be repeatedly broadcasted in one-way transmission. @ref{Sync, Sync protocol} requires interactive connection, but bundles @@ -51,5 +51,5 @@ can contain mix of various recipients. Technically bundle is valid POSIX.1 @url{http://www.freebsd.org/cgi/man.cgi?query=tar&sektion=5, tar archive}, with directory/files hierarchy identical to that is used in -@ref{nncp-xfer}. So bundle can be created by manual tar-ing of -@command{nncp-xfer} resulting directory too. +@ref{nncp-xfer}. So bundle can also be created by manual tar-ing of +@command{nncp-xfer} resulting directory. diff --git a/doc/cmds.texi b/doc/cmds.texi index b5db1c0..a954013 100644 --- a/doc/cmds.texi +++ b/doc/cmds.texi @@ -48,9 +48,9 @@ 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} -received packets at the place, it is advised to run @ref{nncp-check} -utility for packets integrity verification, or use @option{-check} -option to enable on the fly integrity check. +received packets at the place, it is advisable either to run +@ref{nncp-check} utility for packets integrity verification, or to use +@option{-check} option to enable on the fly integrity check. You can specify multiple @option{NODE} arguments, telling for what nodes you want to create the stream, or take it from. If no nodes are diff --git a/doc/news.texi b/doc/news.texi index aa89c7d..2191269 100644 --- a/doc/news.texi +++ b/doc/news.texi @@ -3,8 +3,8 @@ See also this page @ref{Новости, on russian}. -@node Release 0.13 -@section Release 0.13 +@node Release 1.0 +@section Release 1.0 @itemize @item @strong{Incompatible} encrypted packet format changes. Older versions diff --git a/doc/spool.texi b/doc/spool.texi index a5db2dc..8a4ce6c 100644 --- a/doc/spool.texi +++ b/doc/spool.texi @@ -34,7 +34,7 @@ can not contain partly written files -- they are moved atomically from When @ref{nncp-toss} utility is called with @option{-seen} option, it will create empty @file{XXX.seen} files, telling that some kind of -packet already was tossed sometime. +packet was already tossed sometime. Only one process can work with @file{rx}/@file{tx} directories at once, so there are corresponding lock files. diff --git a/makedist.sh b/makedist.sh index fafb226..03870da 100755 --- a/makedist.sh +++ b/makedist.sh @@ -112,9 +112,9 @@ encrypted (E2EE), explicitly authenticated by known participants public keys. Onion encryption is applied to relayed packets. Each node acts both as a client and server, can use push and poll behaviour model. -Out-of-box offline sneakernet/floppynet, dead drops and air-gapped -computers support. But online TCP daemon with full-duplex resumable data -transmission exists. +Out-of-box offline sneakernet/floppynet, dead drops, sequential and +append-only CD-ROM/tape storages, air-gapped computers support. But +online TCP daemon with full-duplex resumable data transmission exists. ------------------------ >8 ------------------------ @@ -161,7 +161,8 @@ NNCP (Node to Node copy) это набор утилит упрощающий б поведения. Поддержка из коробки offline флоппинета, тайников для сброса информации -(dead drop) и компьютеров с "воздушным зазором" (air-gap). Но также +(dead drop), последовательных и только-для-записи CD-ROM/ленточных +хранилищ, компьютеров с "воздушным зазором" (air-gap). Но также существует и online TCP демон с полнодуплексной возобновляемой передачей данных. diff --git a/ports/nncp/pkg-descr b/ports/nncp/pkg-descr index d33b292..37b7091 100644 --- a/ports/nncp/pkg-descr +++ b/ports/nncp/pkg-descr @@ -9,8 +9,8 @@ encrypted (E2EE), explicitly authenticated by known participants public keys. Onion encryption is applied to relayed packets. Each node acts both as a client and server, can use push and poll behaviour model. -Out-of-box offline sneakernet/floppynet, dead drops and air-gapped -computers support. But online TCP daemon with full-duplex resumable data -transmission exists. +Out-of-box offline sneakernet/floppynet, dead drops, sequential and +append-only CD-ROM/tape storages, air-gapped computers support. But +online TCP daemon with full-duplex resumable data transmission exists. WWW: http://www.nncpgo.org/ -- 2.44.0