diff options
| -rw-r--r-- | Makefile | 3 | ||||
| -rw-r--r-- | README | 4 | ||||
| -rw-r--r-- | krandom.1 | 131 |
3 files changed, 137 insertions, 1 deletions
@@ -13,10 +13,13 @@ krandom.o: krandom.c arg.h install: krandom mkdir -p -- "$(DESTDIR)$(PREFIX)/bin" + mkdir -p -- "$(DESTDIR)$(MANPREFIX)/man1" cp -- krandom "$(DESTDIR)$(PREFIX)/bin/" + cp -- krandom.1 "$(DESTDIR)$(MANPREFIX)/man1/" uninstall: -rm -f -- "$(DESTDIR)$(PREFIX)/bin/krandom" + -rm -f -- "$(DESTDIR)$(MANPREFIX)/man1/krandom.1" clean: -rm -r -- krandom *.o @@ -18,6 +18,8 @@ DESCRIPTION as fast as Linux's /dev/urandom. And it's tunable! OPTIONS + The following options are supported: + -C capacity Select Keccak capacity. @@ -36,7 +38,7 @@ OPTIONS Select Keccak word size. -v - Print extra informatio. + Print extra information. NOTES krandom is a terrible entropy-generator. Good ways diff --git a/krandom.1 b/krandom.1 new file mode 100644 index 0000000..a30562a --- /dev/null +++ b/krandom.1 @@ -0,0 +1,131 @@ +.TH KRANDOM 1 krandom + +.SH NAME +krandom - Keccak-based userspace pseudorandom number generator + +.SH SYNOPSIS +.B krandom +[-C +.IR capacity ] +[-N +.IR output-size ] +[-R +.IR rate ] +[-S +.IR state-size ] +[-W +.IR word-size ] +[-v] + +.SH DESCRIPTION +.B krandom +create a Keccak sponge with a random state and continually +squeezes it to generate pseudorandom binary data. +.PP +Like +.BR yes (1), +.B krandom +will automatically pause soon after the other end of the +standard output pipe stops reading and will terminate with +no process reading at the other end of the standard output +pipe anymore. +.PP +With the default parameters, krandom is about twice +as fast as Linux's /dev/urandom. And it's tunable! + +.SH OPTIONS +The following options are supported: +.TP +.BI -C\ capacity +Select Keccak capacity. +.TP +.BI -R\ rate +Select Keccak rate. +.TP +.BI -N\ output-size +Select Keccak output size. This is the size of a squeezed +block, the total output is unlimited. +.TP +.BI -S\ state-size +Select Keccak state size. +.TP +.BI -W\ state-size +Select Keccak word size. +.TP +.B -v +Print extra information. + +.SH OPERANDS +No operands are supported. + +.SH STDIN +The +.B krandom +does not use the standard input. + +.SH INPUT FILES +None. + +.SH ENVIRONMENT VARIABLES +No environment variables affects the execution of +.BR krandom + +.SH ASYNCHRONOUS EVENTS +Default. + +.SH STDOUT +The +.B krandom +utility prints psuedorandom binary data to the standard output. + +.SH STDERR +The standard error is used for diagnostic messages. + +.SH OUTPUT FILES +None. + +.SH EXTENDED DESCRIPTION +None. + +.SH EXIT STATUS +If the +.B krandom +utility fails it will exit withone of the following statuses: +.TP +0 +Successful completion. +.TP +1 +User error. +.TP +2 +An error occurred. + +.SH CONSEQUENCES OF ERRORS +Default. + +.SH APPLICATION USAGE +None. + +.SH EXAMPLES +None. + +.SH RATIONALE +None. + +.SH NOTES +.B krandom +is a terrible entropy-generator. Good ways to generate entropy +include: typing randomly in the terminal, moving the rat pointer +around erratically, running ping, listening to music, and +watching videos. + +.SH BUGS +None. + +.SH FUTURE DIRECTIONS +None. + +.SH SEE ALSO +.BR random(4), +.BR getrandom(2) |