]> Cypherpunks.ru repositories - nncp.git/blob - doc/workflow.texi
Unify @ref and @command usage
[nncp.git] / doc / workflow.texi
1 @node Workflow
2 @cindex workflow
3 @unnumbered Workflow
4
5 NNCP consists of several utilities. As a rule you will have the
6 following workflow:
7
8 @enumerate
9
10 @item Run @command{@ref{nncp-cfgnew}} on each node to create an initial
11 @ref{Configuration, configuration} file.
12
13 @item Tune it up and set at least @ref{Spool, spool} and log paths.
14
15 @item Share your public keys and reachability addressees with your
16 neighbours. Add their keys to your configuration file and do any other
17 required configuration about their reachability, permissions of file or
18 freq transmission.
19
20 @item Use @command{@ref{nncp-file}}, @command{@ref{nncp-freq}},
21 @command{@ref{nncp-exec}} (look @ref{Postfix, how} Postfix and
22 @ref{Exim, how} Exim SMTP servers could be configured) commands to queue
23 file, freq and exec transmissions. Repeat as many times any time as you
24 wish.
25
26 @item Depending on connection methods, either:
27     @itemize
28     @item run @command{@ref{nncp-daemon}} to accept remotely initiated
29     connections to your node
30     @item run either @command{@ref{nncp-call}} or
31     @command{@ref{nncp-caller}} to initiate connection to required nodes
32     from time to time
33     @item use @command{@ref{nncp-xfer}} with removable storage devices
34     for copying packets to/from other nodes
35     @item use @command{@ref{nncp-bundle}} with either sequential storage
36     devices or broadcasting transmissions for copying packets
37     @end itemize
38
39 @item After successful packet exchanging (or just simply from time to
40 time), run @command{@ref{nncp-toss}} for tossing (decrypting and
41 processing) all inbound queues to receive exec messages, files, file
42 requests and relay transition packets to other nodes.
43
44 @end enumerate
45
46 @itemize
47 @item If you wish to encrypt your configuration file containing your
48 private keys, then use @command{@ref{nncp-cfgenc}} utility. You can
49 always use an encrypted config without decrypting it in temporary memory file.
50 @item If you wish to strip off any private keys from your config, then
51 use @command{@ref{nncp-cfgmin}} utility. It will be useful for transferring
52 messages with offline methods, but tossing them later on the machine
53 with private keys.
54 @end itemize