aboutsummaryrefslogtreecommitdiffstats
path: root/info/krandom.texinfo
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2014-12-03 11:18:18 +0100
committerMattias Andrée <maandree@operamail.com>2014-12-03 11:18:18 +0100
commitd3fbede455b02915bf7bcf673ff18bcdcfb2b4c7 (patch)
treebd567662257683c5a633d28cb9ecfc40f9a37576 /info/krandom.texinfo
parentadd install and uninstall rules (diff)
downloadkrandom-d3fbede455b02915bf7bcf673ff18bcdcfb2b4c7.tar.gz
krandom-d3fbede455b02915bf7bcf673ff18bcdcfb2b4c7.tar.bz2
krandom-d3fbede455b02915bf7bcf673ff18bcdcfb2b4c7.tar.xz
info manual
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'info/krandom.texinfo')
-rw-r--r--info/krandom.texinfo59
1 files changed, 57 insertions, 2 deletions
diff --git a/info/krandom.texinfo b/info/krandom.texinfo
index aab77e6..add03ce 100644
--- a/info/krandom.texinfo
+++ b/info/krandom.texinfo
@@ -61,14 +61,69 @@ Texts. A copy of the license is included in the section entitled
@node Overview
@chapter Overview
-TODO
+@command{krandom} is a tunable userspace pseudorandom number generator
+based on the Keccak hash-algorithm.
+
+With @command{krandom} default parameters it is about twice as fast
+as Linux's @file{/dev/urandom}, but it's performance can be tuned
+both up and down.
+
+@command{krandom} creates a Keccak sponge and initialises its state
+@footnote{(25 @command{int_fast64_t}:s)} with random data from
+@file{/dev/urandom}. This simulate it absorption phase of Keccak
+from a random message. It then performance the squeezing phase
+continuously until the standard output pipe breaks, that is,
+when the program it pipes into exits or closes standard input.
+
+On a more technical level, @command{krandom} will pause automatically
+if the other program does not read its input, and resume when it does.
+This is because the pipe will become full and block writting for
+@command{krandom}.
@node Invoking
@chapter Invoking
-TODO
+@command{krandom} recognises the following options:
+
+@table @option
+@item -h
+@itemx --help
+Display a summary of options.
+
+@item -v
+@itemx --verbose
+Print extra information.
+
+@item -R
+@itemx --bitrate
+@itemx --rate RATE
+Change the rate.
+
+@item -C
+@itemx --capacity CAPACITY
+Change the capacity.
+
+@item -N
+@itemx -O
+@itemx --output-size
+@itemx --output SIZE
+Change the output size.
+This is the size of a squeezed block,
+the total output is unlimited.
+
+@item -S
+@itemx -B
+@itemx --state-size
+@itemx --state SIZE
+Change the state size.
+
+@item -W
+@itemx --word-size
+@itemx --word SIZE
+Change the word size.
+@end table