fish-shell/doc_src/random.txt
2016-01-07 20:57:34 -08:00

33 lines
1.0 KiB
Plaintext

\section random random - generate random number
\subsection random-synopsis Synopsis
\fish{synopsis}
random [SEED]
\endfish
\subsection random-description Description
`random` outputs a psuedo-random number from 0 to 32767, inclusive.
Even ignoring the very narrow range of values you should not assume
this produces truly random values within that range. Do not use the
value for any cryptographic purposes, and take care to handle collisions:
the same random number appearing more than once in a given fish instance.
If a `SEED` value is provided, it is used to seed the random number
generator, and no output will be produced. This can be useful for debugging
purposes, where it can be desirable to get the same random number sequence
multiple times. If the random number generator is called without first
seeding it, the current time will be used as the seed.
\subsection random-example Example
The following code will count down from a random number to 1:
\fish
for i in (seq (random) -1 1)
echo $i
sleep
end
\endfish