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