Import Upstream version 1.23
[debian-dgen.git] / dgen.1
blobf46c8b721fb1cd7a1bcff9cfcf5ac10c53c029f0
1 .Dd February 21, 2001
2 .Dt DGEN 1
3 .Sh NAME
4 .Nm dgen        
5 .Nd Sega Genesis/MegaDrive emulator
6 .Sh SYNOPSIS
7 .Nm dgen
8 .Op Fl PRfhjv
9 .Op Fl D Ar DEMONAME
10 .Op Fl d Ar DEMONAME
11 .Op Fl n Ar USEC
12 .Op Fl p Ar CODE,CODE...
13 .Op Fl r Ar RCFILE
14 .Op Fl X Ar XFACT
15 .Op Fl Y Ar YFACT
16 .Op Fl S Ar FACT
17 .Op Fl G Ar XxY
18 .Op Fl s Ar SLOT
19 .Ar romname
20 .Sh DESCRIPTION
21 The rom image in the file
22 .Ar romname
23 is executed, as emulated on a Sega Genesis or MegaDrive running in 60Hz NTSC
24 mode (unless the
25 .Fl P
26 option is specified, in which case 50Hz PAL mode is used).
27 .Ar romname
28 should be in raw binary or SMD format, and may be compressed with
29 .Xr gzip 1 ,
30 .Xr zip 1 , or
31 .Xr bzip2 1 .
32 .Pp
33 The options are as follows:
34 .Bl -tag -width Fl
35 .It Fl P
36 Emulate 50Hz PAL mode (as used in European models of the MegaDrive).
37 .It Fl R
38 If running with root priviledges, set priority to -20, so no other processes
39 interrupt (including the X server, which can be a Bad Thing).
40 .It Fl f 
41 Run fullscreen, if possible.
42 .It Fl h
43 Show a brief synopsis of all options.
44 .It Fl j
45 Use joystick, if running on Linux with joystick drivers >= 1.0.
46 .It Fl v
47 Show the version number, and exit.
48 .It Fl D Ar DEMONAME
49 Play back a demo recorded with the
50 .Fl d
51 option.
52 .It Fl d Ar DEMONAME
53 Record a demo of the program running, which can be later replayed with the
54 .Fl D
55 switch.
56 .It Fl n Ar USEC
57 Sleep for a number of microseconds after every frame, to give time to other
58 processes.
59 .It Fl p Ar CODE,CODE...
60 Modify the ROM image in memory, using Game Genie or Hex style codes. Game
61 Genie codes are of the form
62 .Ar ABCD-EFGH
63 and Hex codes are in the form
64 .Ar 123456:ABCD .
65 To specify more than one code, separate them with commas (do
66 .Ar not
67 use spaces).
68 .It Fl r Ar RCFILE
69 Parse another rc file after $HOME/.dgen/dgenrc. Values in the specified file
70 override those in the preceding files.
71 .It Fl X Ar XFACT
72 Scale the window XFACT times in the X direction. XFACT must be a positive
73 integer.
74 .It Fl Y Ar YFACT
75 Scale the window YFACT times in the Y direction. YFACT must be a positive
76 integer.
77 .It Fl S Ar FACT
78 Scale the window FACT times in both directions. FACT must be a positive integer.
79 .It Fl G Ar XxY
80 Use OpenGL to render the screen, if available. The parameter is the width
81 and height of the desired screen (e.g. 640x480, 800x600, etc.)
82 .It Fl s Ar SLOT
83 Load the saved state from the given slot at startup (0-9)
84 .El
85 .Sh FILES
86 .Bl -tag -width $HOME/.dgen/dgen/saves/* -compact
87 .It Pa $HOME/.dgen/dgenrc
88 Contains user settings for the emulator.
89 .It Pa $HOME/.dgen/saves/*
90 Save states generated by the emulator.
91 .It Pa $HOME/.dgen/ram/*
92 Battery-backup RAM images, generated by the emulator for ROMs with save RAM.
93 .El
94 .Sh SEE ALSO
95 .Xr gzip 1 ,
96 .Xr bzip2 1 ,
97 .Xr zip 1 ,
98 .Xr dgenrc 5
99 .Sh AUTHORS
100 This
101 manual page was written by
102 .An Joe Groff Aq joe@pknet.com .
103 .Sh BUGS
104 PAL mode does not work very well yet. Numerous buffer overruns
105 (think twice before making dgen setuid-root).
107 Send any bugs you find (and fixes too, please :) to
108 .An Joe Groff Aq joe@pknet.com .