doc/cmd/index.texi

   1 @node Commands
   2 @cindex commands
   3 @unnumbered Commands
   4
   5 Nearly all commands have the following common options:
   6
   7 @table @option
   8 @vindex NNCPCFG
   9 @item -cfg
  10     Path to configuration file. May be overridden by @env{$NNCPCFG}
  11     environment variable. If file file is an encrypted @ref{EBlob,
  12     eblob}, then ask for passphrase to decrypt it first.
  13 @item -debug
  14     Print debug messages. Normally this option should not be used.
  15 @item -minsize
  16     @anchor{OptMinSize}
  17     Minimal required resulting packet size, in KiBs. For example if you
  18     send 2 KiB file and set @option{-minsize 4}, then resulting packet
  19     will be 4 KiB (containing file itself and some junk).
  20 @item -nice
  21     Set desired outgoing packet @ref{Niceness, niceness level}.
  22 @item -replynice
  23     Set desired reply packet @ref{Niceness, niceness level}. Only freq
  24     and exec packets look at that niceness level.
  25 @item -via
  26     Override @ref{CfgVia, via} configuration option for destination node.
  27     Specified nodes must be separated with comma: @verb{|NODE1,NODE2|}.
  28     With @verb{|-via -|} you can disable relaying at all.
  29 @vindex NNCPSPOOL
  30 @item -spool
  31     Override path to spool directory. May be specified by
  32     @env{$NNCPSPOOL} environment variable.
  33 @vindex NNCPLOG
  34 @item -log
  35     Override path to logfile. May be specified by @env{$NNCPLOG}
  36     environment variable.
  37 @item -quiet
  38     Print only errors, omit simple informational messages. In any case
  39     those messages are logged, so you can reread them using
  40     @command{@ref{nncp-log}} command.
  41 @item -progress, -noprogress
  42     Either force progress showing, or disable it.
  43 @item -version
  44     Print version information.
  45 @item -warranty
  46     Print warranty information (no warranty).
  47 @end table
  48
  49 @vindex TMPDIR
  50 All commands respect @env{$TMPDIR} environment variable.
  51
  52 @vindex NNCPNOSYNC
  53 If you set @env{$NNCPNOSYNC=1}, then all @code{fsync} operations will be
  54 skipped. That is dangerous option, but if there there are abilities to
  55 rollback possibly corrupted state to some stable snapshot, then disabled
  56 @code{fsync} can give considerable increase in performance.
  57
  58 @menu
  59 Configuration file commands
  60
  61 * nncp-cfgnew::
  62 * nncp-cfgmin::
  63 * nncp-cfgenc::
  64 * nncp-cfgdir::
  65
  66 Packets creation commands
  67
  68 * nncp-file::
  69 * nncp-exec::
  70 * nncp-freq::
  71 * nncp-trns::
  72 * nncp-ack::
  73
  74 Packets sharing commands
  75
  76 * nncp-xfer::
  77 * nncp-bundle::
  78
  79 Checking and tossing commands
  80
  81 * nncp-toss::
  82 * nncp-check::
  83 * nncp-reass::
  84
  85 Online synchronization protocol commands
  86
  87 * nncp-daemon::
  88 * nncp-call::
  89 * nncp-caller::
  90 * nncp-cronexpr::
  91
  92 Maintenance, monitoring and debugging commands:
  93
  94 * nncp-stat::
  95 * nncp-log::
  96 * nncp-rm::
  97 * nncp-pkt::
  98 * nncp-hash::
  99 @end menu
 100
 101 @include cmd/nncp-cfgnew.texi
 102 @include cmd/nncp-cfgmin.texi
 103 @include cmd/nncp-cfgenc.texi
 104 @include cmd/nncp-cfgdir.texi
 105 @include cmd/nncp-file.texi
 106 @include cmd/nncp-exec.texi
 107 @include cmd/nncp-freq.texi
 108 @include cmd/nncp-trns.texi
 109 @include cmd/nncp-ack.texi
 110 @include cmd/nncp-xfer.texi
 111 @include cmd/nncp-bundle.texi
 112 @include cmd/nncp-toss.texi
 113 @include cmd/nncp-check.texi
 114 @include cmd/nncp-reass.texi
 115 @include cmd/nncp-daemon.texi
 116 @include cmd/nncp-call.texi
 117 @include cmd/nncp-caller.texi
 118 @include cmd/nncp-cronexpr.texi
 119 @include cmd/nncp-stat.texi
 120 @include cmd/nncp-log.texi
 121 @include cmd/nncp-rm.texi
 122 @include cmd/nncp-pkt.texi
 123 @include cmd/nncp-hash.texi