| blob | 079a10606db4b4efb6065b84f2caaaa6c61084b0 |
1 .Dd July 26, 2014
2 .Dt DGEN 1
3 .Os
4 .Sh NAME
5 .Nm dgen
6 .Nd Sega Genesis/Mega Drive emulator
7 .Sh SYNOPSIS
8 .Nm dgen
9 .Op Fl Pfhmv
10 .Op Fl R Ar (J|U|E)
11 .Op Fl H Ar HZ
12 .Op Fl D Ar DEMONAME
13 .Op Fl d Ar DEMONAME
14 .Op Fl n Ar USEC
15 .Op Fl p Ar CODE,CODE...
16 .Op Fl r Ar RCFILE
17 .Op Fl X Ar XFACT
18 .Op Fl Y Ar YFACT
19 .Op Fl S Ar FACT
20 .Op Fl g Ar (0|1)
21 .Op Fl G Ar XxY
22 .Op Fl s Ar SLOT
23 .Ar [romname [...]]
24 .Sh DESCRIPTION
25 The ROM image in the file
26 .Ar romname
27 is executed, as emulated on a Sega Genesis or Mega Drive running in 60Hz NTSC
28 mode (unless the
29 .Fl P
30 option is specified, in which case 50Hz PAL mode is used).
31 .Ar romname
32 should be in raw binary or SMD format, and may be compressed with
33 .Xr gzip 1 ,
34 .Xr zip 1 , or
35 .Xr bzip2 1 .
36 .Pp
37 When
38 .Ar romname
39 isn't specified, DGen starts without a ROM. It can be loaded later from the
40 prompt. When more than a single
41 .Ar romname
42 is specified, they are executed sequentially.
43 .Pp
44 The options are as follows:
45 .Bl -tag -width Fl
46 .It Fl H Ar HZ
47 Use a custom frame rate, can be used to accelerate or slow down emulation.
48 .It Fl P
49 Emulate 50Hz PAL mode (as used in European models of the Mega Drive).
50 .It Fl R Ar (J|U|E)
51 Emulator region. Without this option, DGen uses the first region mentioned in
52 the ROM header. It should be combined with
53 .Fl P
54 for PAL mode. See below.
55 .Bl -tag -width Fl
56 .It (none)
57 Autodetect (NTSC, 60Hz)
58 .It Fl P
59 Autodetect (PAL, 50Hz)
60 .It Fl R Ar J
61 Japan (NTSC, 60Hz)
62 .It Fl R Ar J Fl P
63 Japan (PAL, 50Hz)
64 .It Fl R Ar E
65 Europe (NTSC, 60Hz, music will certainly play too fast)
66 .It Fl R Ar E Fl P
67 Europe (PAL, 50Hz)
68 .It Fl R Ar U
69 America (NTSC, 60Hz)
70 .It Fl R Ar U Fl P
71 Same as
72 .Fl R Ar E Fl P
73 .El
74 .It Fl f
75 Run fullscreen, if possible.
76 .It Fl h
77 Show a brief synopsis of all options.
78 .It Fl m
79 MinGW only. This option prevents DGen from detaching from its control console.
80 .It Fl v
81 Show the version number, and exit.
82 .It Fl D Ar DEMONAME
83 Play back a demo recorded with the
84 .Fl d
85 option.
86 .It Fl d Ar DEMONAME
87 Record a demo of the program running, which can be later replayed with the
88 .Fl D
89 switch.
90 .It Fl n Ar USEC
91 Sleep for a number of microseconds after every frame, to give time to other
92 processes.
93 .It Fl p Ar CODE,CODE...
94 Modify the ROM image in memory, using Game Genie or Hex style codes. Game
95 Genie codes are of the form
96 .Ar ABCD-EFGH
97 and Hex codes are in the form
98 .Ar 123456:ABCD .
99 To specify more than one code, separate them with commas (do
100 .Ar not
101 use spaces).
102 .It Fl r Ar RCFILE
103 Parse another rc file after $HOME/.dgen/dgenrc. Values in the specified file
104 override those in the preceding files.
105 .It Fl X Ar XFACT
106 Scale the window XFACT times in the X direction. XFACT must be a positive
107 integer.
108 .It Fl Y Ar YFACT
109 Scale the window YFACT times in the Y direction. YFACT must be a positive
110 integer.
111 .It Fl S Ar FACT
112 Scale the window FACT times in both directions. FACT must be a positive integer.
113 .It Fl g Ar (0|1)
114 Enable/disable OpenGL (if compiled-in).
115 .It Fl G Ar XxY
116 Desired window size (e.g. 640x480, 800x600, etc.)
117 .It Fl s Ar SLOT
118 Load the saved state from the given slot at startup (0-9)
119 .El
120 .Sh INTERACTIVE PROMPT
121 A minimalist interactive prompt inspired from
122 .Xr vi 1
123 can be used to perform various operations described below. It is triggered by
124 pressing colon (:), the default key. Command-line editing, history and
125 completion are supported.
126 .Ss Commands
127 .Bl -tag -width xxxx
128 .It {quit, exit, q}
129 Quit, or load the next
130 .Ar romname
131 from command-line, if any.
132 .It {load, open, plug, o} Ar filename
133 Load a given ROM
134 .Ar filename .
135 .It {unload, close, unplug}
136 Unload the current ROM.
137 .It config_load Ar filename
138 Load configuration from file
139 .Ar filename .
140 .It config_save Ar filename
141 Save current configuration to file
142 .Ar filename .
143 .It reset
144 Genesis reset.
145 .It {ctv_push, ctv_pop, ctv_none}
146 Manage the stack of Crap TV filters (if compiled-in).
147 .It calibrate Ar number
148 Interactive calibration of the specified gamepad (1 or 2). If
149 .Ar number
150 isn't specified, default to 1.
151 .It unbind Ar binding [...]
152 Remove specified bindings (variables prefixed with "bind_").
153 See
154 .Xr dgenrc 5
155 for more information about them.
156 .It vgmdump start Ar filename
157 .It vgmdump stop
158 Manages VGM dumping/logging. If the second argument is
159 .Ar start
160 VGM dumping will be started at the path specified by the third argument.
161 If the second argument is
162 .Ar stop
163 VGM dumping will be stopped and the dump finalized.
164 .El
165 .Ss Variables
166 All configuration variables from
167 .Xr dgenrc 5
168 can be displayed and modified interactively, with immediate effect.
169 .Bl -tag -width xxxx
170 .It {int_name, bool_name, key_name, joy_name, ...} {value}
171 Affect
172 .Ar value
173 to variable
174 .Ar name .
175 .It {int_name, bool_name, key_name, joy_name, ...}
176 Display current value for variable
177 .Ar name .
178 .El
179 .Sh FILES
180 .Bl -tag -width $HOME/.dgen/dgen/saves/* -compact
181 .It Pa $HOME/.dgen/dgenrc
182 Contains user settings for the emulator.
183 .It Pa $HOME/.dgen/dgenrc.auto
184 Generated file containing saved user settings.
185 .It Pa $HOME/.dgen/saves/*
186 Save states generated by the emulator.
187 .It Pa $HOME/.dgen/ram/*
188 Battery-backup RAM images, generated by the emulator for ROMs with save RAM.
189 .It Pa $HOME/.dgen/screenshots/*
190 Screenshots are generated there.
191 .It Pa $HOME/.dgen/roms/*
192 ROMs default search path.
193 .It Pa $HOME/.dgen/demos/*
194 Demos default search path.
195 .El
196 .Sh SEE ALSO
197 .Xr gzip 1 ,
198 .Xr bzip2 1 ,
199 .Xr zip 1 ,
200 .Xr dgenrc 5
201 .Sh AUTHORS
202 This manual page was written by
203 .An Joe Groff Aq joe@pknet.com .
204 .An Updated by zamaz Aq zamaz@users.sourceforge.net .
205 .Sh BUGS
206 There are known emulation bugs, see BUGS in DGen source package.
207 .Pp
208 .An Report bugs to Aq http://sourceforge.net/projects/dgen/ .