.\" Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Arthur de Jong
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
.TH "rl" "1" "Jul 2008" "Version 0.2.7" "User Commands"
.nh
.SH NAME
rl \- Randomize Lines.
.SH SYNOPSIS
.B rl
.RI [ OPTION ]...
.RI [ FILE ]...

.SH DESCRIPTION
\fBrl\fP reads lines from a input file or stdin, randomizes the lines and outputs a specified number of lines.
It does this with only a single pass over the input while trying to use as little memory as possible.

.TP
.B \-c, \-\-count=N
Select the number of lines to be returned in the output.
If this argument is omitted all the lines in the file will be returned in random order.
If the input contains less lines than specified and the \-\-reselect option below is not specified a warning is printed and all lines are returned in random order.

.TP
.B \-r, \-\-reselect
When using this option a single line may be selected multiple times.
The default behaviour is that any input line will only be selected once.
This option makes it possible to specify a \-\-count option with more lines than the file actually holds.

.TP
.B \-o, \-\-output=FILE
Send randomized lines to FILE instead of stdout.

.TP
.B \-d, \-\-delimiter=DELIM
Use specified character as a "line" delimiter instead of the newline character.

.TP
.B \-0, \-\-null
Input lines are terminated by a null character.
This option is useful to process the output of the GNU find \-print0 option.

.TP
.B \-n, \-\-line-number
Output lines are numbered with the line number from the input file.

.TP
.B \-q, \-\-quiet, \-\-silent
Be quiet about any errors or warnings.

.TP
.B \-h, \-\-help
Show short summary of options.

.TP
.B \-v, \-\-version
Show version of program.

.SH "EXAMPLES"
Some simple demonstrations of how rl can help you do everyday tasks.

Play a random sound after 4 minutes (perfect for toast):
.ft B
    sleep 240 ; play \`find /sounds \-name \'*.au\' \-print | rl \-\-count=1\`
.ft R

Play the 15 most recent .mp3 files in random order.
.ft B
    ls \-c *.mp3 | head \-n 15 | rl  | xargs \-\-delimiter=\'\\n\' play
.ft R

Roll a dice:
.ft B
    seq 6 | rl \-\-count 2
.ft R

Roll a dice 1000 times and see which number comes up more often:
.ft B
    seq 6 | rl \-\-reselect \-\-count 1000 | sort | uniq \-c | sort \-n
.ft R

Shuffle the words of a sentence:
.ft B
    echo \-n "The rain in Spain stays mainly in the plain." \\
      | rl \-\-delimiter=\' \';echo
.ft R

Find all movies and play them in random order.
.ft B
    find . \-name \'*.avi\' \-print0 | rl \-0 | xargs \-n 1 \-0 mplayer
.ft R
.br
Because \-0 is used filenames with spaces (even newlines and other unusual characters) in them work.

.SH BUGS
The program currently does not have very smart memory management.
If you feed it huge files and expect it to fully randomize all lines it will completely read the file in memory. If you specify the \-\-count option it will only use the memory required for storing the specified number of lines.
Improvements on this area are on the TODO list.

The program uses the rand() system random function.
This function returns a number between 0 and RAND_MAX, which may not be very large on some systems.
This will result in non-random results for files containing more lines than RAND_MAX.

Note that if you specify multiple input files they are randomized per file.
This is a different result from when you cat all the files and pipe the result into rl.

.SH COPYRIGHT
Copyright \(co 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Arthur de Jong.
.br
This is free software; see the license for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.