Aren
/
NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
NetBSD/games/worms/worms.6

127 lines
3.5 KiB
Groff
Raw Permalink Normal View History

Add a little optional colour, optionally distinguish worm heads, and optionally randomise worm lengths. Just exit instead of continuing with a nonsense display if the window shrinks (and for consistency if it grows). Most of the ideas and code from RVP. Bugs and man page mangling from me.
2023-04-27 01:58:09 +03:00
.\" $NetBSD: worms.6,v 1.18 2023/04/26 22:58:09 kre Exp $
rough cleanup of import. RCS Ids
1995-04-22 12:00:54 +04:00
.\"
.\" Copyright (c) 1989, 1993
.\" The Regents of the University of California. All rights reserved.
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22269, verified by myself.
2003-08-07 13:36:50 +04:00
.\" 3. Neither the name of the University nor the names of its contributors
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
rough cleanup of import. RCS Ids
1995-04-22 12:00:54 +04:00
.\" @(#)worms.6 8.1 (Berkeley) 5/31/93
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.\"
Add a little optional colour, optionally distinguish worm heads, and optionally randomise worm lengths. Just exit instead of continuing with a nonsense display if the window shrinks (and for consistency if it grows). Most of the ideas and code from RVP. Bugs and man page mangling from me.
2023-04-27 01:58:09 +03:00
.Dd April 26, 2023
un-munge import; it apparently didn't import properly.
1995-04-22 12:07:59 +04:00
.Dt WORMS 6
Fix preamble
2009-03-11 16:06:10 +03:00
.Os
Update to use new -mandoc macros.
1993-08-05 05:46:15 +04:00
.Sh NAME
.Nm worms
.Nd animate worms on a display terminal
.Sh SYNOPSIS
WARNSify
1997-10-12 06:12:45 +04:00
.Nm
Add a little optional colour, optionally distinguish worm heads, and optionally randomise worm lengths. Just exit instead of continuing with a nonsense display if the window shrinks (and for consistency if it grows). Most of the ideas and code from RVP. Bugs and man page mangling from me.
2023-04-27 01:58:09 +03:00
.Op Fl CfHrt
This patch converts worms(6) to use curses, thereby simplifying the code and improving its portability. It also adds a delay option from OpenBSD, to allow reasonable speed display on fast terminals, adds use of const, and fixes signal handling and use of errx() where appropriate. Patch supplied in PR 6661 by Joseph Myers <jsm28@cam.ac.uk>.
1999-07-30 06:23:27 +04:00
.Op Fl d Ar delay
un-munge import; it apparently didn't import properly.
1995-04-22 12:07:59 +04:00
.Op Fl l Ar length
.Op Fl n Ar number
Correct some unfortunate behaviour in extreme cases pointed out by RVP. (Very long worms in a smallish window could result in the max number of worms being 0...) While here (also suggested by RVP) seed the random number generator, also add a -S option to set the seed (note: while this is documented in the updated man page, it does not appear in the usage message in case of an error ... not likely to be used often enough to include there). Also some minor improvements suggested by RVP: delete the prototype for main() exit curses mode before abort() (which should not happen, but...) no need to return (->exit) after abort() as modern abort() can never return. In addition, check for extraneous (ignored) (non-option) args. Check for absurdly small or big screens (the worm placement algorithm doesn't work well for lines of columns < 3, and the abort() mentioned above actually happens if one of those is == 1). More flavours of worms added. Some minor man page wording improvements.
2023-04-18 18:02:22 +03:00
.Op Fl S Ar seed
Update to use new -mandoc macros.
1993-08-05 05:46:15 +04:00
.Sh DESCRIPTION
- improve wording - sort option list - add argument names in option list and descriptions and adjust table width - improve punctuation - bump date From Bug Hunting.
2012-08-12 21:30:03 +04:00
.Nm
is a
Change occurrences of "UNIX" to .Ux or .At as appropriate.
1998-04-28 10:00:51 +04:00
.Ux
This patch converts worms(6) to use curses, thereby simplifying the code and improving its portability. It also adds a delay option from OpenBSD, to allow reasonable speed display on fast terminals, adds use of const, and fixes signal handling and use of errx() where appropriate. Patch supplied in PR 6661 by Joseph Myers <jsm28@cam.ac.uk>.
1999-07-30 06:23:27 +04:00
version of the DEC-2136 program
.Dq worms .
Update to use new -mandoc macros.
1993-08-05 05:46:15 +04:00
.Pp
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
The options are as follows:
Add a little optional colour, optionally distinguish worm heads, and optionally randomise worm lengths. Just exit instead of continuing with a nonsense display if the window shrinks (and for consistency if it grows). Most of the ideas and code from RVP. Bugs and man page mangling from me.
2023-04-27 01:58:09 +03:00
.Bl -compact -tag -width Fl
.Pp
.It Fl C
Use colours, if available, to make the worms easier to distinguish.
.Pp
- improve wording - sort option list - add argument names in option list and descriptions and adjust table width - improve punctuation - bump date From Bug Hunting.
2012-08-12 21:30:03 +04:00
.It Fl d Ar delay
Correct some unfortunate behaviour in extreme cases pointed out by RVP. (Very long worms in a smallish window could result in the max number of worms being 0...) While here (also suggested by RVP) seed the random number generator, also add a -S option to set the seed (note: while this is documented in the updated man page, it does not appear in the usage message in case of an error ... not likely to be used often enough to include there). Also some minor improvements suggested by RVP: delete the prototype for main() exit curses mode before abort() (which should not happen, but...) no need to return (->exit) after abort() as modern abort() can never return. In addition, check for extraneous (ignored) (non-option) args. Check for absurdly small or big screens (the worm placement algorithm doesn't work well for lines of columns < 3, and the abort() mentioned above actually happens if one of those is == 1). More flavours of worms added. Some minor man page wording improvements.
2023-04-18 18:02:22 +03:00
Specifies a
.Ar delay ,
in milliseconds, between each update.
- improve wording - sort option list - add argument names in option list and descriptions and adjust table width - improve punctuation - bump date From Bug Hunting.
2012-08-12 21:30:03 +04:00
This is useful for fast terminals.
Reasonable values are around 20-200;
worms(6): Use a reasonable default delay for non-1980s terminals. This is still fast, but not unreasonably fast.
2020-10-14 10:32:53 +03:00
the default is 20.
Add a little optional colour, optionally distinguish worm heads, and optionally randomise worm lengths. Just exit instead of continuing with a nonsense display if the window shrinks (and for consistency if it grows). Most of the ideas and code from RVP. Bugs and man page mangling from me.
2023-04-27 01:58:09 +03:00
.Pp
Update to use new -mandoc macros.
1993-08-05 05:46:15 +04:00
.It Fl f
Whitespace and/or punctuation fixes.
2001-04-03 02:42:37 +04:00
Makes a
This patch converts worms(6) to use curses, thereby simplifying the code and improving its portability. It also adds a delay option from OpenBSD, to allow reasonable speed display on fast terminals, adds use of const, and fixes signal handling and use of errx() where appropriate. Patch supplied in PR 6661 by Joseph Myers <jsm28@cam.ac.uk>.
1999-07-30 06:23:27 +04:00
.Dq field
for the worm(s) to eat.
Add a little optional colour, optionally distinguish worm heads, and optionally randomise worm lengths. Just exit instead of continuing with a nonsense display if the window shrinks (and for consistency if it grows). Most of the ideas and code from RVP. Bugs and man page mangling from me.
2023-04-27 01:58:09 +03:00
.Pp
.It Fl H
Display the head of the worm differently than its body.
.Pp
- improve wording - sort option list - add argument names in option list and descriptions and adjust table width - improve punctuation - bump date From Bug Hunting.
2012-08-12 21:30:03 +04:00
.It Fl l Ar length
Add a little optional colour, optionally distinguish worm heads, and optionally randomise worm lengths. Just exit instead of continuing with a nonsense display if the window shrinks (and for consistency if it grows). Most of the ideas and code from RVP. Bugs and man page mangling from me.
2023-04-27 01:58:09 +03:00
.It Fl l Ar min Ns \(mi Ns Ar max
Correct some unfortunate behaviour in extreme cases pointed out by RVP. (Very long worms in a smallish window could result in the max number of worms being 0...) While here (also suggested by RVP) seed the random number generator, also add a -S option to set the seed (note: while this is documented in the updated man page, it does not appear in the usage message in case of an error ... not likely to be used often enough to include there). Also some minor improvements suggested by RVP: delete the prototype for main() exit curses mode before abort() (which should not happen, but...) no need to return (->exit) after abort() as modern abort() can never return. In addition, check for extraneous (ignored) (non-option) args. Check for absurdly small or big screens (the worm placement algorithm doesn't work well for lines of columns < 3, and the abort() mentioned above actually happens if one of those is == 1). More flavours of worms added. Some minor man page wording improvements.
2023-04-18 18:02:22 +03:00
Specifies the
- improve wording - sort option list - add argument names in option list and descriptions and adjust table width - improve punctuation - bump date From Bug Hunting.
2012-08-12 21:30:03 +04:00
.Ar length
Correct some unfortunate behaviour in extreme cases pointed out by RVP. (Very long worms in a smallish window could result in the max number of worms being 0...) While here (also suggested by RVP) seed the random number generator, also add a -S option to set the seed (note: while this is documented in the updated man page, it does not appear in the usage message in case of an error ... not likely to be used often enough to include there). Also some minor improvements suggested by RVP: delete the prototype for main() exit curses mode before abort() (which should not happen, but...) no need to return (->exit) after abort() as modern abort() can never return. In addition, check for extraneous (ignored) (non-option) args. Check for absurdly small or big screens (the worm placement algorithm doesn't work well for lines of columns < 3, and the abort() mentioned above actually happens if one of those is == 1). More flavours of worms added. Some minor man page wording improvements.
2023-04-18 18:02:22 +03:00
of each worm; the default is 16, the minimum is 2.
Add a little optional colour, optionally distinguish worm heads, and optionally randomise worm lengths. Just exit instead of continuing with a nonsense display if the window shrinks (and for consistency if it grows). Most of the ideas and code from RVP. Bugs and man page mangling from me.
2023-04-27 01:58:09 +03:00
In the second form, worm lengths are randomly chosen
between
.Ar min
.Pq which must be at least 2
and
.Ar max .
The
.Ar max
worm length will be reduced if required by the screen
size and the
.Ar number
of worms selected.
This option overrides any earlier
.Fl r .
.Pp
- improve wording - sort option list - add argument names in option list and descriptions and adjust table width - improve punctuation - bump date From Bug Hunting.
2012-08-12 21:30:03 +04:00
.It Fl n Ar number
Correct some unfortunate behaviour in extreme cases pointed out by RVP. (Very long worms in a smallish window could result in the max number of worms being 0...) While here (also suggested by RVP) seed the random number generator, also add a -S option to set the seed (note: while this is documented in the updated man page, it does not appear in the usage message in case of an error ... not likely to be used often enough to include there). Also some minor improvements suggested by RVP: delete the prototype for main() exit curses mode before abort() (which should not happen, but...) no need to return (->exit) after abort() as modern abort() can never return. In addition, check for extraneous (ignored) (non-option) args. Check for absurdly small or big screens (the worm placement algorithm doesn't work well for lines of columns < 3, and the abort() mentioned above actually happens if one of those is == 1). More flavours of worms added. Some minor man page wording improvements.
2023-04-18 18:02:22 +03:00
Specifies the
- improve wording - sort option list - add argument names in option list and descriptions and adjust table width - improve punctuation - bump date From Bug Hunting.
2012-08-12 21:30:03 +04:00
.Ar number
Correct some unfortunate behaviour in extreme cases pointed out by RVP. (Very long worms in a smallish window could result in the max number of worms being 0...) While here (also suggested by RVP) seed the random number generator, also add a -S option to set the seed (note: while this is documented in the updated man page, it does not appear in the usage message in case of an error ... not likely to be used often enough to include there). Also some minor improvements suggested by RVP: delete the prototype for main() exit curses mode before abort() (which should not happen, but...) no need to return (->exit) after abort() as modern abort() can never return. In addition, check for extraneous (ignored) (non-option) args. Check for absurdly small or big screens (the worm placement algorithm doesn't work well for lines of columns < 3, and the abort() mentioned above actually happens if one of those is == 1). More flavours of worms added. Some minor man page wording improvements.
2023-04-18 18:02:22 +03:00
of worms; the default is 3.
There must be at least one.
Add a little optional colour, optionally distinguish worm heads, and optionally randomise worm lengths. Just exit instead of continuing with a nonsense display if the window shrinks (and for consistency if it grows). Most of the ideas and code from RVP. Bugs and man page mangling from me.
2023-04-27 01:58:09 +03:00
.Pp
.It Fl r
Use random lengths for the worms, within a range of
sizes chosen to suit the screen size.
Note this option overrides any earlier
.Fl l .
.Pp
Correct some unfortunate behaviour in extreme cases pointed out by RVP. (Very long worms in a smallish window could result in the max number of worms being 0...) While here (also suggested by RVP) seed the random number generator, also add a -S option to set the seed (note: while this is documented in the updated man page, it does not appear in the usage message in case of an error ... not likely to be used often enough to include there). Also some minor improvements suggested by RVP: delete the prototype for main() exit curses mode before abort() (which should not happen, but...) no need to return (->exit) after abort() as modern abort() can never return. In addition, check for extraneous (ignored) (non-option) args. Check for absurdly small or big screens (the worm placement algorithm doesn't work well for lines of columns < 3, and the abort() mentioned above actually happens if one of those is == 1). More flavours of worms added. Some minor man page wording improvements.
2023-04-18 18:02:22 +03:00
.It Fl S Ar seed
Provide an integer
.Ar seed
for the random number generator.
Specifying zero (0, the default) causes a random seed to be used.
Add a little optional colour, optionally distinguish worm heads, and optionally randomise worm lengths. Just exit instead of continuing with a nonsense display if the window shrinks (and for consistency if it grows). Most of the ideas and code from RVP. Bugs and man page mangling from me.
2023-04-27 01:58:09 +03:00
.Pp
Update to use new -mandoc macros.
1993-08-05 05:46:15 +04:00
.It Fl t
rough cleanup of import. RCS Ids
1995-04-22 12:00:54 +04:00
Makes each worm leave a trail behind it.
Fix .Bl/.El imbalance.
1999-03-10 12:29:08 +03:00
.El
Correct some unfortunate behaviour in extreme cases pointed out by RVP. (Very long worms in a smallish window could result in the max number of worms being 0...) While here (also suggested by RVP) seed the random number generator, also add a -S option to set the seed (note: while this is documented in the updated man page, it does not appear in the usage message in case of an error ... not likely to be used often enough to include there). Also some minor improvements suggested by RVP: delete the prototype for main() exit curses mode before abort() (which should not happen, but...) no need to return (->exit) after abort() as modern abort() can never return. In addition, check for extraneous (ignored) (non-option) args. Check for absurdly small or big screens (the worm placement algorithm doesn't work well for lines of columns < 3, and the abort() mentioned above actually happens if one of those is == 1). More flavours of worms added. Some minor man page wording improvements.
2023-04-18 18:02:22 +03:00
.Pp
The maximum
.Ar length ,
and
.Ar number ,
of worms depends upon the screen size, though the
.Ar length
can never exceed 1024.
If the screen is particularly small, even the defaults
for those may be too large.
Screens with less than 3 rows or columns cannot be handled,
nor can ones with insufficient total space.