Patrick Welche <prlw1@cam.ac.uk>
[netbsd-mini2440.git] / games / dm / dm.conf.5
blob43ed57aa72b30aa47f946081b7758b862ae67e3d
1 .\"     $NetBSD: dm.conf.5,v 1.7 2002/09/26 18:32:00 wiz Exp $
2 .\"
3 .\" Copyright (c) 1988, 1991, 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     @(#)dm.conf.5   8.1 (Berkeley) 5/31/93
31 .\"
32 .Dd May 31, 1993
33 .Dt DM.CONF 5
34 .Os
35 .Sh NAME
36 .Nm dm.conf
37 .Nd dungeon master configuration file
38 .Sh DESCRIPTION
39 The
40 .Nm
41 file is the configuration file for the
42 .Xr dm 8
43 program.
44 It consists of lines beginning with one of three keywords,
45 .Em badtty ,
46 .Em game ,
47 and
48 .Em time .
49 All other lines are ignored.
50 .Pp
51 Any tty listed after the keyword
52 .Em badtty
53 may not have games played on it.
54 Entries consist of two white-space separated fields: the string
55 .Em badtty
56 and the ttyname as returned by
57 .Xr ttyname 3 .
58 For example, to keep the uucp dialout,
59 .Dq tty19 ,
60 from being used for games, the entry would be:
61 .Bd -literal -offset indent
62 badtty  /dev/tty19
63 .Ed
64 .Pp
65 Any day/hour combination listed after the keyword
66 .Em time
67 will disallow games during those hours.
68 Entries consist of four white-space separated fields: the string
69 .Em time ,
70 the unabbreviated day of the week and the beginning and ending time
71 of a period of the day when games may not be played.
72 The time fields are in a 0 based, 24-hour clock.
73 For example, the following entry allows games playing before 8AM
74 and after 5PM on Mondays:
75 .Bd -literal -offset indent
76 time    Monday  8       17
77 .Ed
78 .Pp
79 Any game listed after the keyword
80 .Em game
81 will set parameters for a specific game.
82 Entries consist of five white-space separated fields: the keyword
83 .Em game ,
84 the name of a game, the highest system load average at which the
85 game may be played, the maximum users allowed if the game is to be
86 played, and the priority at which the game is to be run.
87 Any of these fields may start with a non-numeric character, resulting
88 in no game limitation or priority based on that field.
89 .Pp
90 The game
91 .Em default
92 controls the settings for any game not otherwise listed, and must be the last
93 .Em game
94 entry in the file.
95 Priorities may not be negative.
96 For example, the following entries limits the game
97 .Dq hack
98 to running only when the system has 10 or less users and a load average of 5
99 or less; all other games may be run any time the system has 15 or less users.
100 .Bd -literal -offset indent
101 game    hack            5       10      *
102 game    default         *       15      *
104 .Sh FILES
105 .Bl -tag -width /etc/dm.conf -compact
106 .It Pa /etc/dm.conf
108 .Xr dm 8
109 configuration file.
111 .Sh SEE ALSO
112 .Xr setpriority 2 ,
113 .Xr ttyname 3 ,
114 .Xr dm 8