git.gag.com Git - fw/altos/blob - ao-tools/ao-chaosread/ao-chaosread.1

   1 .\"
   2 .\" Copyright © 2016 Keith Packard <keithp@keithp.com>
   3 .\"
   4 .\" This program is free software; you can redistribute it and/or modify
   5 .\" it under the terms of the GNU General Public License as published by
   6 .\" the Free Software Foundation; either version 2 of the License, or
   7 .\" (at your option) any later version.
   8 .\"
   9 .\" This program is distributed in the hope that it will be useful, but
  10 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
  11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 .\" General Public License for more details.
  13 .\"
  14 .\" You should have received a copy of the GNU General Public License along
  15 .\" with this program; if not, write to the Free Software Foundation, Inc.,
  16 .\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  17 .\"
  18 .\"
  19 .TH AO-LOAD 1 "ao-chaosread" ""
  20 .SH NAME
  21 ao-chaosread \- read raw noise source from chaoskey
  22 .SH SYNOPSIS
  23 .B "ao-chaosread"
  24 .SH DESCRIPTION
  25 .I ao-chaosread
  26 reads ADC values from the noise source on the attached ChaosKey device.
  27 .SH OPTIONS
  28 .TP
  29 \-s serial | --serial serial
  30 This selects a ChaosKey by serial number instead of using the first
  31 one found.
  32 .TP
  33 \-l length | --length length
  34 Set the amount of data to read. Suffixes 'k', 'M' and 'G' are
  35 supported. The default is 1k.
  36 .TP
  37 \-i | --infinite
  38 Read an unlimited amount of data.
  39 .TP
  40 \-b | --bytes
  41 For each 16-bit value read, output bits 1-8 as a byte, don't output
  42 bit 0 or bits 9-15 at all.
  43 .TP
  44 \-c | --cooked
  45 Read whitened data from the device. The default is to read raw data
  46 from the noise source.
  47 .TP
  48 \-r | --raw
  49 Read raw data from the noise source. This is the default.
  50 .TP
  51 \-f | --flash
  52 Read the contents of flash memory on the device. This loops through
  53 flash memory, so you can read the contents more than once, but there's
  54 no way to reset the pointer back to the start other than making sure
  55 you read the whole contents.
  56 .SH USAGE
  57 .I ao-chaosread
  58 reads noise data.
  59 .SH AUTHOR
  60 Keith Packard