fish-common 2.4.0-1 / usr / share / fish / man / man1 / random.1

.TH "random" 1 "Sun Dec 11 2016" "Version 2.4.0" "fish" \" -*- nroff -*-
.ad l
.nh
.SH NAME
\fBrandom\fP -- generate random number 

.PP
.SS "Synopsis"
.PP
.nf

\fBrandom\fP [SEED]
.fi
.PP
.SS "Description"
\fCrandom\fP 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\&.
.PP
If a \fCSEED\fP 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\&.
.SS "Example"
The following code will count down from a random number to 1:
.PP
.PP
.nf

\fBfor\fP i \fBin\fP (\fBseq\fP (\fBrandom\fP) -1 1)
    \fBecho\fP $i
    \fBsleep\fP
\fBend\fP
.fi
.PP