]> Cypherpunks.ru repositories - nncp.git/blob - doc/cmd/nncp-bundle.texi
Add various documentation indices
[nncp.git] / doc / cmd / nncp-bundle.texi
1 @node nncp-bundle
2 @pindex nncp-bundle
3 @section nncp-bundle
4
5 @example
6 $ nncp-bundle [options] -tx [-delete] NODE [NODE @dots{}] > ...
7 $ nncp-bundle [options] -rx -delete [-dryrun] [NODE @dots{}] < ...
8 $ nncp-bundle [options] -rx [-check] [-dryrun] [NODE @dots{}] < ...
9 @end example
10
11 With @option{-tx} option, this command creates @ref{Bundles, bundle} of
12 @ref{Encrypted, encrypted packets} from the spool directory and writes
13 it to @code{stdout}.
14
15 With @option{-rx} option, this command takes bundle from @code{stdin}
16 and copies all found packets for our node to the spool directory. Pay
17 attention that @strong{no} integrity checking is done by default. Modern
18 tape drives could easily provide too much throughput your CPU won't be
19 able to verify on the fly. So if you won't @ref{nncp-toss, toss}
20 received packets at the place, it is advisable either to run
21 @ref{nncp-check} utility for packets integrity verification, or to use
22 @option{-check} option to enable on the fly integrity check.
23
24 You can specify multiple @option{NODE} arguments, telling for what nodes
25 you want to create the stream, or take it from. If no nodes are
26 specified for @option{-rx} mode, then all packets aimed at us will be
27 processed.
28
29 When packets are sent through the stream, they are still kept in the
30 spool directory, because there is no assurance that they are transferred
31 to the media (media (CD-ROM, tape drive, raw hard drive) can end). If
32 you want to forcefully delete them (after they are successfully flushed
33 to @code{stdout}) anyway, use @option{-delete} option.
34
35 But you can verify produced stream after, by digesting it by yourself
36 with @option{-rx} and @option{-delete} options -- in that mode, stream
37 packets integrity will be checked and they will be deleted from the
38 spool if everything is good. So it is advisable to recheck your streams:
39
40 @example
41 $ nncp-bundle -tx ALICE BOB WHATEVER | cdrecord -tao -
42 $ dd if=/dev/cd0 bs=2048 | nncp-bundle -rx -delete
43 @end example
44
45 @option{-dryrun} option prevents any writes to the spool. This is
46 useful when you need to see what packets will pass by and possibly check
47 their integrity.