Return to dgamelaunch.8 CVS log

Up to [contributed] / dgamelaunch-openbsd

Annotation of dgamelaunch-openbsd/dgamelaunch.8, Revision 1.1.1.1

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