forked from paxed/dgamelaunch
-
Notifications
You must be signed in to change notification settings - Fork 0
/
dgamelaunch.8
152 lines (150 loc) · 3.25 KB
/
dgamelaunch.8
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
.TH DGAMELAUNCH 8 "17 March 2004" "joshk et al" "System Manager's Manual"
.SH NAME
dgamelaunch \- Network console game launcher
.SH SYNOPSIS
.na
.hy 0
.B dgamelaunch
[
.B \-h
.I hostname
]
[
.B \-f
.I config
]
[
.B \-q
]
[
.B \-p
]
[
.B \-a
]
[
.B \-e
]
.ad
.hy 14
.SH DESCRIPTION
.PP
.I dgamelaunch
is a network-based game shell where anyone can sign up for an
account and start playing any game which suits your fancy - currently
it supports NetHack and Slash'Em.
The user is presented with a curses-based menu to watch other games, edit the
options or play the game.
.SH OPTIONS
.TP
.B
-f config
Specify the location of the configuration file.
.TP
.B
-q
Don't print errors pertaining to the server configuration.
.TP
.B
-a
Enter user authentication mode.
.I
dgamelaunch
will read user name and password from stdin, check them, check whether the
user doesn't have a game in progress already, then write the inprogress lock.
Returns 0 if everything was successful.
.TP
.B
-e
Start game server to handle incoming NhExt connection.
.I
dgamelaunch
will execute /bin/nethack --proxy after chroot and shedding privs.
.TP
.B
-p
Ignored; solely for compatibility with
.B
login(1)
.TP
.B
-h hostname
Ignored; solely for compatibility with
.B
login(1)
.SH "CRASH RECOVERY"
.PP
If a user somehow disconnects in an unclean way,
.I
dgamelaunch
will usually send nethack the SIGHUP signal, which causes nethack to save
the game.
.PP
If a user tries to play while he already has a game in progress (for example
because nethack hung),
.I
dgamelaunch
will warn the user and send nethack the SIGHUP signal if the user agrees. If
nethack does not shut down within 10 seconds,
.I
dgamelaunch
will ask the user for permission to send it the SIGTERM signal, which causes
nethack to terminate quickly (without leaving a savefile usually).
.PP
In some cases (e.g. at "Restoring save file...--More--") nethack doesn't leave
a savefile if sent SIGHUP. To avoid loss of games,
.I
dgamelaunch
can backup the savefile. A human must then restore the backup if necessary.
This must be configured with the
.B
savefilefmt
option in the configuration file.
.SH AUTHORS
.PP
M. Drew Streib wrote the original version.
.PP
Later, Joshua Kwan, Brett Carrington and Jilles Tjoelker added many new
features.
.PP
NhExt support was written by J. Ali Harlow.
.SH FILES
.DT
.ta \w'dgldir/ttyrec/<login>/*.ttyrec\ \ \ 'u
/etc/dgamelaunch.conf Default configuration file (can
be changed at compile time).
.br
.PP
All other files are in the chroot as defined in the configuration file. Most
of these filenames can be changed in the configuration file.
.PP
.DT
.ta \w'dgldir/ttyrec/<login>/*.ttyrec\ \ \ 'u
dgl-login Login names, passwords and email
addresses.
.br
dgl-lock Lockfile for dgl-login, locked
with fcntl(2).
.br
dgl-banner Text shown on the screen.
.br
dgl-default-rcfile Options file for new accounts.
.br
bin/nethack The NetHack binary.
.br
dgldir/inprogress/* A file for each game in progress;
the file is locked (with fcntl(2))
when the dgamelaunch process
is still alive.
.br
dgldir/rcfiles/* Options files.
.br
dgldir/ttyrec/<login>/*.ttyrec Recorded games, this may get
very big very quickly.
.\".SH ENVIRONMENT
.SH "SEE ALSO"
.PP
nethack(6), slashem(6), telnetd(8), login(1), curses(3), fcntl(2)
.SH BUGS
.PP
None known.