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