Add manpages for all commands
Signed-off-by: Stephen Kitt <steve@sk2.org>
This commit is contained in:
21
software/healthcheck.1
Normal file
21
software/healthcheck.1
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
.\" Hey, EMACS: -*- nroff -*-
|
||||||
|
.TH HEALTHCHECK 1 "June 25 2018"
|
||||||
|
.\" Please adjust this date whenever revising the manpage.
|
||||||
|
.SH NAME
|
||||||
|
healthcheck \- health check
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B healthcheck
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.B healthcheck
|
||||||
|
performs a detailed health check on the values generated by the
|
||||||
|
system's random number generator.
|
||||||
|
.PP
|
||||||
|
It attempts to guess the next bit based on the bits read so far, and
|
||||||
|
adjusts the measured entropy based on the deviation from the guess.
|
||||||
|
.PP
|
||||||
|
Once enough data has been gathered, it outputs a detailed report
|
||||||
|
showing the results for each value seen in the stream.
|
||||||
|
.SH OPTIONS
|
||||||
|
This program has no options.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR infnoise (8).
|
||||||
74
software/infnoise.8
Normal file
74
software/infnoise.8
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
.\" Hey, EMACS: -*- nroff -*-
|
||||||
|
.TH INFNOISE 8 "June 25 2018"
|
||||||
|
.\" Please adjust this date whenever revising the manpage.
|
||||||
|
.SH NAME
|
||||||
|
infnoise \- Infinite Noise TRNG driver
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B infnoise \-\-help
|
||||||
|
.br
|
||||||
|
.B infnoise \-\-version
|
||||||
|
.br
|
||||||
|
.B infnoise \-\-list\-devices
|
||||||
|
.br
|
||||||
|
.B infnoise
|
||||||
|
.RB [ \-\-debug ]
|
||||||
|
.RB [ \-\-dev\-random ]
|
||||||
|
.RB [ \-\-raw ]
|
||||||
|
.RB [ \-\-multiplier
|
||||||
|
.RI < value >]
|
||||||
|
.RB [ \-\-no\-output ]
|
||||||
|
.RB [ \-\-pidfile
|
||||||
|
.RI < file >]
|
||||||
|
.RB [ \-\-daemon ]
|
||||||
|
.RB [ \-\-serial
|
||||||
|
.RI < serial >]
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.B infnoise
|
||||||
|
provides access to the Infinite Noise True Random Number Generator and
|
||||||
|
allows the data it generates to be fed into the system's random number
|
||||||
|
generator.
|
||||||
|
.PP
|
||||||
|
.B infnoise \-\-help
|
||||||
|
shows a short summary of the options.
|
||||||
|
.PP
|
||||||
|
.B infnoise \-\-version
|
||||||
|
displays the program's version information.
|
||||||
|
.PP
|
||||||
|
.B infnoise \-\-list\-devices
|
||||||
|
lists all the supported TRNG devices present on the system.
|
||||||
|
.PP
|
||||||
|
.B infnoise
|
||||||
|
reads random data from a TRNG and outputs filtered random data to its
|
||||||
|
standard output. The various options control the program's behaviour.
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
.B \-\-debug
|
||||||
|
measures the quality of the data obtained from the TRNG. It is
|
||||||
|
typically used with \-\-no\-output as a sanity test.
|
||||||
|
.TP
|
||||||
|
.B \-\-dev\-random
|
||||||
|
adds the filtered data to the system's entropy pool instead of sending
|
||||||
|
it to its standard output.
|
||||||
|
.TP
|
||||||
|
.B \-\-raw
|
||||||
|
disables output whitening.
|
||||||
|
.TP
|
||||||
|
.BR \-\-multiplier <\fIvalue\fP>
|
||||||
|
writes 256 bits ×
|
||||||
|
.I value
|
||||||
|
for every 512 bits written to the Keccak sponge; the default of 0
|
||||||
|
means to write all the available entropy, without multiplying it.
|
||||||
|
.TP
|
||||||
|
.B \-\-no\-output
|
||||||
|
disables output of random data.
|
||||||
|
.TP
|
||||||
|
.BR \-\-pidfile <\fIfile\fP>
|
||||||
|
stores the process' identifier in
|
||||||
|
.IR file .
|
||||||
|
.TP
|
||||||
|
.B \-\-daemon
|
||||||
|
starts the program as a daemon.
|
||||||
|
.TP
|
||||||
|
.BR \-\-serial <\fIserial\fP>
|
||||||
|
uses the device matching the specified
|
||||||
|
.IR serial .
|
||||||
23
software/init_scripts/infnoise.service.8
Normal file
23
software/init_scripts/infnoise.service.8
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
.\" Hey, EMACS: -*- nroff -*-
|
||||||
|
.TH INFNOISE.SERVICE 1 "June 25 2018"
|
||||||
|
.\" Please adjust this date whenever revising the manpage.
|
||||||
|
.SH NAME
|
||||||
|
infnoise.service \- systemd service for infnoise
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B systemctl
|
||||||
|
.BR start | status | restart | stop
|
||||||
|
.B infnoise
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.B infnoise.service
|
||||||
|
allows systemd to manage the
|
||||||
|
.B infnoise
|
||||||
|
daemon.
|
||||||
|
.SH FILES
|
||||||
|
.TP
|
||||||
|
.B /etc/infnoise.conf
|
||||||
|
service configuration file
|
||||||
|
.TP
|
||||||
|
.B /var/run/infnoise.pid
|
||||||
|
service process identifier
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR infnoise (8).
|
||||||
16
software/tools/bin2hex.1
Normal file
16
software/tools/bin2hex.1
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
.\" Hey, EMACS: -*- nroff -*-
|
||||||
|
.TH BIN2HEX 1 "June 22 2018"
|
||||||
|
.\" Please adjust this date whenever revising the manpage.
|
||||||
|
.SH NAME
|
||||||
|
bin2hex \- display binary content as hexadecimal
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B bin2hex
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.B bin2hex
|
||||||
|
reads from its standard input, and outputs the value of each byte it
|
||||||
|
reads as a hexadecimal pair.
|
||||||
|
.PP
|
||||||
|
.SH OPTIONS
|
||||||
|
This program has no options.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR infnoise (8).
|
||||||
29
software/tools/dice.1
Normal file
29
software/tools/dice.1
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
.\" Hey, EMACS: -*- nroff -*-
|
||||||
|
.TH DICE 1 "June 22 2018"
|
||||||
|
.\" Please adjust this date whenever revising the manpage.
|
||||||
|
.SH NAME
|
||||||
|
dice \- roll dice
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B dice
|
||||||
|
.RI < file >
|
||||||
|
.RI < dice >
|
||||||
|
.RI < sides >
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.B dice
|
||||||
|
simulates a dice roll, using data from
|
||||||
|
.I file
|
||||||
|
to roll
|
||||||
|
.I dice
|
||||||
|
dice with
|
||||||
|
.I sides
|
||||||
|
sides each.
|
||||||
|
.PP
|
||||||
|
A common value for
|
||||||
|
.I file
|
||||||
|
is
|
||||||
|
.BR /dev/random .
|
||||||
|
.PP
|
||||||
|
.SH OPTIONS
|
||||||
|
This program has no options.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR infnoise (8).
|
||||||
37
software/tools/entcheck.1
Normal file
37
software/tools/entcheck.1
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
.\" Hey, EMACS: -*- nroff -*-
|
||||||
|
.TH ENTCHECK 1 "June 22 2018"
|
||||||
|
.\" Please adjust this date whenever revising the manpage.
|
||||||
|
.SH NAME
|
||||||
|
entcheck \- estimates the entropy of a stream
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B entcheck
|
||||||
|
.RB [ \-N
|
||||||
|
.RI < bits >]
|
||||||
|
.RB [ \-s
|
||||||
|
.RI < streams >]
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.B entcheck
|
||||||
|
estimates the entropy of its standard input.
|
||||||
|
It uses the previous
|
||||||
|
.I bits
|
||||||
|
bits (16 by default) to predict the next bit, and estimates the
|
||||||
|
entropy based on the level of surprise, that is to say the base-2
|
||||||
|
logarithm of the probability of seeing the given string of bits.
|
||||||
|
.PP
|
||||||
|
In some scenarios, such as the output of an 8-bit DAC, some bits are
|
||||||
|
special: entropy then needs to be predicted per bit over the width of
|
||||||
|
the input data. The
|
||||||
|
.B \-s
|
||||||
|
option sets the width of the input data in this case.
|
||||||
|
.PP
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
.BR \-N " <\fIbits\fP>"
|
||||||
|
specifies the number of
|
||||||
|
.I bits
|
||||||
|
to use to predict the next bit.
|
||||||
|
.TP
|
||||||
|
.BR \-s " <\fIstreams\fP>"
|
||||||
|
specifies the number of streams to use.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR infnoise (8).
|
||||||
25
software/tools/findlongest.1
Normal file
25
software/tools/findlongest.1
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
.\" Hey, EMACS: -*- nroff -*-
|
||||||
|
.TH FINDLONGEST 1 "June 25 2018"
|
||||||
|
.\" Please adjust this date whenever revising the manpage.
|
||||||
|
.SH NAME
|
||||||
|
findlongest \- finds the longest repeating sequence
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B findlongest \-\-test
|
||||||
|
.br
|
||||||
|
.B findlongest
|
||||||
|
.RI < file >
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.B findlongest
|
||||||
|
finds the longest repeating sequence of bits in the given
|
||||||
|
.IR file ,
|
||||||
|
up to 34
|
||||||
|
bits in length.
|
||||||
|
.PP
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
.B \-\-test
|
||||||
|
generates random data (using
|
||||||
|
.BR rand (3))
|
||||||
|
instead of reading data from a file.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR infnoise (8).
|
||||||
19
software/tools/flipbits.1
Normal file
19
software/tools/flipbits.1
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
.\" Hey, EMACS: -*- nroff -*-
|
||||||
|
.TH FLIPBITS 1 "June 24 2018"
|
||||||
|
.\" Please adjust this date whenever revising the manpage.
|
||||||
|
.SH NAME
|
||||||
|
flipbits \- flip bits
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B flipbits
|
||||||
|
.RI [ width ]
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.B infnoise-flipbits
|
||||||
|
flips the bits in its input data (from standard input),
|
||||||
|
.I width
|
||||||
|
bits at a time (8 by default), and outputs the result to standard
|
||||||
|
output.
|
||||||
|
.PP
|
||||||
|
.SH OPTIONS
|
||||||
|
This program has no options.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR infnoise (8).
|
||||||
19
software/tools/hex2bin.1
Normal file
19
software/tools/hex2bin.1
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
.\" Hey, EMACS: -*- nroff -*-
|
||||||
|
.TH HEX2BIN 1 "June 22 2018"
|
||||||
|
.\" Please adjust this date whenever revising the manpage.
|
||||||
|
.SH NAME
|
||||||
|
hex2bin \- convert hexadecimal to the encoded values
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B hex2bin
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.B hex2bin
|
||||||
|
reads from its standard input, ignoring any byte which isn’t a valid
|
||||||
|
hexadecimal digit, and combines any two successive hexadecimal digits
|
||||||
|
into the corresponding byte, which it outputs to its standard output.
|
||||||
|
Only complete bytes are output, so an odd number of hexadecimal digits
|
||||||
|
as input will drop the last digit.
|
||||||
|
.PP
|
||||||
|
.SH OPTIONS
|
||||||
|
This program has no options.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR infnoise (8).
|
||||||
19
software/tools/passgen.1
Normal file
19
software/tools/passgen.1
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
.\" Hey, EMACS: -*- nroff -*-
|
||||||
|
.TH PASSGEN 1 "June 25 2018"
|
||||||
|
.\" Please adjust this date whenever revising the manpage.
|
||||||
|
.SH NAME
|
||||||
|
passgen \- generates passwords by rolling dice
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B passgen
|
||||||
|
.RI < file >
|
||||||
|
.RI < size >
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.B passgen
|
||||||
|
generates an alphabetic password by rolling a 26-sided die, fed from
|
||||||
|
.IR file ,
|
||||||
|
.I size
|
||||||
|
times.
|
||||||
|
.SH OPTIONS
|
||||||
|
This program has no options.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR infnoise (8).
|
||||||
Reference in New Issue
Block a user