games/random/random.6

   1 .\" Copyright (c) 1994
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgment:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)random.6    8.2 (Berkeley) 3/31/94
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd February 8, 2003
  36 .Dt RANDOM 6
  37 .Os
  38 .Sh NAME
  39 .Nm random
  40 .Nd random lines from a file or random numbers
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl elrUuw
  44 .Op Fl f Ar filename
  45 .Op Ar denominator
  46 .Sh DESCRIPTION
  47 .Nm Random
  48 has two distinct modes of operations.
  49 The default is to read in lines
  50 from the standard input and randomly write them out
  51 to the standard output with a probability of
  52 1 /
  53 .Ar denominator .
  54 The default
  55 .Ar denominator
  56 for this mode of operation is 2, giving each line a 50/50 chance of
  57 being displayed.
  58 .Pp
  59 The second mode of operation is to read in a file from
  60 .Ar filename
  61 and randomize the contents of the file and send it back out to
  62 standard output.
  63 The contents can be randomized based off of newlines or based off of
  64 space characters as determined by
  65 .Xr isspace 3 .
  66 The default
  67 .Ar denominator
  68 for this mode of operation is 1, which gives each line a chance to be
  69 displayed, but in a
  70 .Xr random 3
  71 order.
  72 .Pp
  73 The options are as follows:
  74 .Bl -tag -width Ds
  75 .It Fl e
  76 If the
  77 .Fl e
  78 option is specified,
  79 .Nm
  80 does not read or write anything, and simply exits with a random
  81 exit value of 0 to
  82 .Ar denominator
  83 \&- 1, inclusive.
  84 .It Fl f Ar filename
  85 The
  86 .Fl f
  87 option is used to specify the
  88 .Ar filename
  89 to read from.
  90 Standard input is used if
  91 .Ar filename
  92 is set to
  93 .Sq Fl .
  94 .It Fl l
  95 Randomize the input via newlines (the default).
  96 .It Fl r
  97 The
  98 .Fl r
  99 option guarantees that the output is unbuffered.
 100 .It Fl U
 101 Tells
 102 .Xr random 6
 103 that it is okay for it to reuse any given line or word when creating a
 104 randomized output.
 105 .It Fl u
 106 Tells
 107 .Xr random 6
 108 not to select the same line or word from a file more than once (the
 109 default).
 110 This does not guarantee uniqueness if there are two of the
 111 same tokens from the input, but it does prevent selecting the same
 112 token more than once.
 113 .It Fl w
 114 Randomize words separated by
 115 .Xr isspace 3
 116 instead of newlines.
 117 .El
 118 .Sh SEE ALSO
 119 .Xr random 3 ,
 120 .Xr fortune 6
 121 .Sh HISTORY
 122 The
 123 functionality to randomizing lines and words was added in 2003 by
 124 .An "Sean Chittenden" Aq seanc@FreeBSD.org .
 125 .Sh BUGS
 126 No index is used when printing out tokens from the list which
 127 makes it rather slow for large files (10MB+).
 128 For smaller
 129 files, however, it should still be quite fast and efficient.