]> Cypherpunks.ru repositories - nncp.git/blobdiff - doc/bundles.texi
Unify onion word usage
[nncp.git] / doc / bundles.texi
index a70e0235f2a1181f47b01e5222fa551668bf9fbd..7bbc85a274d7480156383c87f18c5546475d9f07 100644 (file)
@@ -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
@@ -17,30 +17,30 @@ sequentially streamed for recording and digested back.
 
 @item They do not require intermediate storage before recording on
 either CD-ROM or tape drive.
-@verbatim
-% nncp-bundle -tx SOMENODE | cdrecord -tao -       # record directly to CD
-% nncp-bundle -tx SOMENODE | dd of=/dev/sa0 bs=512 # record directly to tape
+@example
+$ nncp-bundle -tx SOMENODE | cdrecord -tao -         # record directly to CD
+$ nncp-bundle -tx SOMENODE | dd of=/dev/sa0 bs=10240 # record directly to tape
 
-% dd if=/dev/cd0 bs=2048 | nncp-bundle -rx # read directly from CD
-% dd if=/dev/sa0 bs=512 | nncp-bundle -rx  # read directly from tape
-@end verbatim
+$ dd if=/dev/cd0 bs=2048 | nncp-bundle -rx  # read directly from CD
+$ dd if=/dev/sa0 bs=10240 | nncp-bundle -rx # read directly from tape
+@end example
 
 @item They do not require filesystem existence to deal with, simplifying
 administration when operating in heterogeneous systems with varying
 filesystems. No @command{mount}/@command{umount}, @command{zpool
 import}/@command{zpool export} and struggling with file permissions.
-@verbatim
-% nncp-bundle -tx SOMENODE | dd of=/dev/da0 bs=1M # record directly to
+@example
+$ nncp-bundle -tx SOMENODE | dd of=/dev/da0 bs=1M # record directly to
                                                   # hard/flash drive
-% dd if=/dev/da0 bs=1M | nncp-bundle -rx # read directly from drive
-@end verbatim
+$ dd if=/dev/da0 bs=1M | nncp-bundle -rx # read directly from drive
+@end example
 
 @item This is the fastest way to record outbound packets for offline
 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
@@ -48,8 +48,8 @@ can contain mix of various recipients.
 
 @end itemize
 
-Technically bundle is valid POSIX.1
-@url{http://www.freebsd.org/cgi/man.cgi?query=tar&sektion=5, tar archive},
+Technically bundle is valid POSIX.1-2001
+@url{https://pubs.opengroup.org/onlinepubs/9699919799/utilities/pax.html#tag_20_92_13_01, pax 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}: @file{NNCP/RECIPIENT/SENDER/PACKET}. So bundle can also
+be created by manual tar-ing of @command{nncp-xfer} resulting directory.