contrib/bind9/bin/tools/genrandom.docbook

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