shufx
Generate random permutations.
Mirrors GNU shuf. Run it as shufx, or as gnux shufx.
Synopsis
shufx [OPTION]... [FILE]GNU reference
Description
shufx writes a random permutation of its input lines to standard output. The input is the lines of FILE, or of standard input when FILE is absent or -; with -e, each ARG operand is an input line instead (shufx -e [OPTION]... [ARG]...); with -i LO-HI, the numbers LO through HI are (shufx -i LO-HI [OPTION]...). -n COUNT writes at most COUNT lines (given more than once, the smallest COUNT wins, as in GNU shuf). -r draws with replacement, so lines may repeat, and with no -n it writes forever until its reader goes away. -o FILE writes to FILE instead of standard output; it is opened only after the input has been read, so FILE may also be the input. --random-source=FILE takes the random bytes from FILE, so the same FILE always gives the same order; without it the order comes from a generator seeded by the operating system's random source. -z uses NUL rather than newline as the line delimiter. Differences from GNU shuf: the permutation drawn from a given --random-source differs from the one GNU shuf draws from the same bytes, though it is just as reproducible.
Permissions
Needs read permission on FILE and on the --random-source file, and search permission on the directories leading to them. With -o, needs write permission on the output file, or on its directory when it does not exist yet.
Use cases
- Putting the lines of a file in random order.
- Picking a random sample of N lines with
-n. - Choosing one item at random from a list of operands with
-e -n1. - Generating random numbers in a range with
-i, with or without repeats. - Shuffling a playlist, a deck or a
testorder. - Getting a reproducible shuffle in tests with
--random-source. - Producing an endless stream of random choices with
-r. - Splitting a data set into random training and
testportions.
Flags
-e, --echo treat each ARG as an input line
-n, --head-count COUNT output at most COUNT lines
--help display this help and exit
-i, --input-range LO-HI treat each number LO-HI as an input line
-o, --output FILE write result to FILE instead of standard output
--random-source FILE get random bytes from FILE
-r, --repeat output lines can be repeated
--version output version information and exit
-z, --zero-terminated line delimiter is NUL, not newlineExamples
Shuffle the lines of a file
shufx names.txtPick three random lines
shufx -n 3 names.txtPick one of several words
shufx -e -n 1 red green blueShuffle the numbers 1 to 10
shufx -i 1-10Roll a die five times (numbers may repeat)
shufx -i 1-6 -r -n 5Shuffle standard input
seqx 5 | shufxShuffle a file in place
shufx -o deck.txt deck.txtA reproducible order for tests
shufx --random-source=seed.bin cases.txtPick a random file from a NUL-separated list
find . -type f -print0 | shufx -z -n 1An endless stream of coin flips, cut short by headx
shufx -r -e heads tails | headx -n 4Sample 100 lines for a quick look at a large log
shufx -n 100 access.log > sample.logShuffle in the portable gnux shell
gnux shell -c 'lsx -1 | shufx -n 2'Options
Each option has a page of its own, with its usage and examples.
- -e, --echo: Treat each ARG as an input line.
- -n, --head-count: Output at most COUNT lines.
- -i, --input-range: Treat each number LO-HI as an input line.
- -o, --output: Write result to FILE instead of standard output.
- --random-source: Get random bytes from FILE.
- -r, --repeat: Output lines can be repeated.
- -z, --zero-terminated: Line delimiter is NUL, not newline.
Exit status
| Status | Meaning |
|---|---|
| 0 | success: every operand was processed |
| 1 | failure: an operand could not be processed (diagnosed on standard error), or a command-line mistake |
Help in the terminal
shufx --help # options, first examples, exit status
gnux help shufx # this page: the full manual
gnux help shufx --OPTION # one option in depth, with its examples