fish-shell/doc_src/random.txt
Mark Griffiths c070a2aa3e Documentation update
Rework for Doxygen >1.8. Moved large parts of the documentation to a
simplified format, making use of Markdown enhancements and fixing bad
long options.
2014-08-01 03:37:32 +01:00

27 lines
742 B
Text

\section random random - generate random number
\subsection random-synopsis Synopsis
\fish{syn}
random [SEED]
\endfish
\subsection random-description Description
`random` outputs a random number from 0 to 32766, inclusive.
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