Mercurial > libjeffpc

changeset 656:2434fbb76530

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
man: write a manpage for rand32 and rand64 Signed-off-by: Josef 'Jeff' Sipek <jeffpc@josefsipek.net>
author Josef 'Jeff' Sipek <jeffpc@josefsipek.net>
date Fri, 18 Jan 2019 10:50:18 -0500
parents 7ccff605427f
children f9ac9ae930d2
files man/rand.3
diffstat 1 files changed, 34 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/man/rand.3	Fri Jan 18 10:50:18 2019 -0500
@@ -0,0 +1,34 @@
+.Dd January 18, 2019
+.Dt RAND 3
+.Os
+.\"
+.Sh NAME
+.Nm rand32 ,
+.Nm rand64
+.Nd generate a random integer
+.\"
+.Sh SYNOPSIS
+.In jeffpc/rand.h
+.Ft uint32_t
+.Fn rand32 void
+.Ft uint64_t
+.Fn rand64 void
+.\"
+.Sh DESCRIPTION
+The
+.Fn rand32
+function generates a 32-bit pseudo-random integer.
+.sp
+The
+.Fn rand64
+function generates a 64-bit pseudo-random integer.
+.\"
+.Sh RETURN VALUES
+A random number in the range 0-UINT32_T_MAX or 0-UINT64_T_MAX.
+.\"
+.Sh ERRORS
+An error generating a pseudo-random integer will result in a panic.
+.\"
+.Sh SEE ALSO
+.Xr rand 3 ,
+.Xr rand_r 3