xref: /openbsd-src/games/rain/rain.6 (revision 12bc606974c905e41cd828804759a212d331fea1)
1*12bc6069Sschwarze.\"	$OpenBSD: rain.6,v 1.18 2015/01/15 19:06:31 schwarze Exp $
2df930be7Sderaadt.\"
3df930be7Sderaadt.\" Copyright (c) 1989, 1993
4df930be7Sderaadt.\"	The Regents of the University of California.  All rights reserved.
5df930be7Sderaadt.\"
6df930be7Sderaadt.\" Redistribution and use in source and binary forms, with or without
7df930be7Sderaadt.\" modification, are permitted provided that the following conditions
8df930be7Sderaadt.\" are met:
9df930be7Sderaadt.\" 1. Redistributions of source code must retain the above copyright
10df930be7Sderaadt.\"    notice, this list of conditions and the following disclaimer.
11df930be7Sderaadt.\" 2. Redistributions in binary form must reproduce the above copyright
12df930be7Sderaadt.\"    notice, this list of conditions and the following disclaimer in the
13df930be7Sderaadt.\"    documentation and/or other materials provided with the distribution.
147a09557bSmillert.\" 3. Neither the name of the University nor the names of its contributors
15df930be7Sderaadt.\"    may be used to endorse or promote products derived from this software
16df930be7Sderaadt.\"    without specific prior written permission.
17df930be7Sderaadt.\"
18df930be7Sderaadt.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19df930be7Sderaadt.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20df930be7Sderaadt.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21df930be7Sderaadt.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22df930be7Sderaadt.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23df930be7Sderaadt.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24df930be7Sderaadt.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25df930be7Sderaadt.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26df930be7Sderaadt.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27df930be7Sderaadt.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28df930be7Sderaadt.\" SUCH DAMAGE.
29df930be7Sderaadt.\"
30df930be7Sderaadt.\"	@(#)rain.6	8.1 (Berkeley) 5/31/93
31df930be7Sderaadt.\"
32*12bc6069Sschwarze.Dd $Mdocdate: January 15 2015 $
33df930be7Sderaadt.Dt RAIN 6
34df930be7Sderaadt.Os
35df930be7Sderaadt.Sh NAME
36df930be7Sderaadt.Nm rain
37df930be7Sderaadt.Nd animated raindrops display
38df930be7Sderaadt.Sh SYNOPSIS
39a702fa09Spjanzen.Nm rain
401ed0e75dSpjanzen.Op Fl d Ar delay
41df930be7Sderaadt.Sh DESCRIPTION
423897dfeeSpjanzen.Nm
43*12bc6069Sschwarzeis modeled after the VAX/VMS program of the same name.
44a6ef357fSsthen.Pp
45a6ef357fSsthenTo obtain the proper effect, the
461ed0e75dSpjanzen.Fl d
47a6ef357fSsthenoption may be used to specify a delay in milliseconds between each update.
48a6ef357fSsthenReasonable values are around 20\(en200.
49a6ef357fSsthenThe default is based on the terminal speed, computed via the following formula:
50a6ef357fSsthen.Pp
51d082738bSjmc.Dl delay = speed / 9600 \- 1
52df930be7Sderaadt.Pp
532b76410aSpjanzenAs with any
542b76410aSpjanzen.Xr curses 3
552b76410aSpjanzenprogram, the
56df930be7Sderaadt.Ev TERM
57df930be7Sderaadtenvironment variable must be set (and exported) to the type of the
58df930be7Sderaadtterminal being used.
591f2e2e45Spjanzen.Sh AUTHORS
6027e95970Sschwarze.An Eric P. Scott
61