bin/tools/genrandom.docbook

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2009, 2010  Internet Systems Consortium, Inc. ("ISC")
   6  -
   7  - Permission to use, copy, modify, and/or distribute this software for any
   8  - purpose with or without fee is hereby granted, provided that the above
   9  - copyright notice and this permission notice appear in all copies.
  10  -
  11  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  12  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  13  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  14  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  15  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  16  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  17  - PERFORMANCE OF THIS SOFTWARE.
  18 -->
  19
  20 <!-- $Id: genrandom.docbook,v 1.6 2010/05/17 23:51:05 tbox Exp $ -->
  21 <refentry id="man.genrandom">
  22   <refentryinfo>
  23     <date>Feb 19, 2009</date>
  24   </refentryinfo>
  25
  26   <refmeta>
  27     <refentrytitle><application>genrandom</application></refentrytitle>
  28     <manvolnum>8</manvolnum>
  29     <refmiscinfo>BIND9</refmiscinfo>
  30   </refmeta>
  31
  32   <refnamediv>
  33     <refname><application>genrandom</application></refname>
  34     <refpurpose>generate a file containing random data</refpurpose>
  35   </refnamediv>
  36
  37   <docinfo>
  38     <copyright>
  39       <year>2009</year>
  40       <year>2010</year>
  41       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  42     </copyright>
  43   </docinfo>
  44
  45   <refsynopsisdiv>
  46     <cmdsynopsis>
  47       <command>genrandom</command>
  48       <arg><option>-n <replaceable class="parameter">number</replaceable></option></arg>
  49       <arg choice="req"><replaceable class="parameter">size</replaceable></arg>
  50       <arg choice="req"><replaceable class="parameter">filename</replaceable></arg>
  51     </cmdsynopsis>
  52   </refsynopsisdiv>
  53
  54   <refsect1>
  55     <title>DESCRIPTION</title>
  56     <para>
  57       <command>genrandom</command>
  58       generates a file or a set of files containing a specified quantity
  59       of pseudo-random data, which can be used as a source of entropy for
  60       other commands on systems with no random device.
  61     </para>
  62   </refsect1>
  63
  64   <refsect1>
  65     <title>ARGUMENTS</title>
  66     <variablelist>
  67       <varlistentry>
  68         <term>-n <replaceable class="parameter">number</replaceable></term>
  69         <listitem>
  70           <para>
  71             In place of generating one file, generates <option>number</option>
  72             (from 2 to 9) files, appending <option>number</option> to the name.
  73           </para>
  74         </listitem>
  75       </varlistentry>
  76
  77       <varlistentry>
  78         <term>size</term>
  79         <listitem>
  80           <para>
  81             The size of the file, in kilobytes, to generate.
  82           </para>
  83         </listitem>
  84       </varlistentry>
  85
  86       <varlistentry>
  87         <term>domain</term>
  88         <listitem>
  89           <para>
  90             The file name into which random data should be written.
  91           </para>
  92         </listitem>
  93       </varlistentry>
  94     </variablelist>
  95   </refsect1>
  96
  97   <refsect1>
  98     <title>SEE ALSO</title>
  99     <para>
 100       <citerefentry>
 101         <refentrytitle>rand</refentrytitle><manvolnum>3</manvolnum>
 102       </citerefentry>,
 103       <citerefentry>
 104         <refentrytitle>arc4random</refentrytitle><manvolnum>3</manvolnum>
 105       </citerefentry>
 106     </para>
 107   </refsect1>
 108
 109   <refsect1>
 110     <title>AUTHOR</title>
 111     <para><corpauthor>Internet Systems Consortium</corpauthor>
 112     </para>
 113   </refsect1>
 114
 115 </refentry><!--
 116  - Local variables:
 117  - mode: sgml
 118  - End:
 119 -->