filename | lxdream.pod |
changeset | 1170:9ffc8295b414 |
prev | 700:4650d0c7f6f9 |
author | nkeynes |
date | Mon Feb 13 20:00:27 2012 +1000 (12 years ago) |
permissions | -rw-r--r-- |
last change | Fix MMU on non-translated platforms - reintroduce old VMA translation functions (slightly modified) - modify shadow processing to work on post-translated memory ops |
file | annotate | diff | log | raw |
nkeynes@700 | 1 | =head1 NAME |
nkeynes@700 | 2 | |
nkeynes@1170 | 3 | lxdream - A Dreamcast emulator |
nkeynes@700 | 4 | |
nkeynes@700 | 5 | =head1 SYNOPSIS |
nkeynes@700 | 6 | |
nkeynes@700 | 7 | lxdream [options] [disc-image-file] [program-file] |
nkeynes@700 | 8 | |
nkeynes@700 | 9 | =head1 DESCRIPTION |
nkeynes@700 | 10 | |
nkeynes@1170 | 11 | Emulates the Sega Dreamcast console. Lxdream can run games either from disc image files, from progam files or from CD-ROM discs. |
nkeynes@1170 | 12 | |
nkeynes@700 | 13 | =head1 OPTIONS |
nkeynes@700 | 14 | |
nkeynes@700 | 15 | =over |
nkeynes@700 | 16 | |
nkeynes@1170 | 17 | =item B<-a>, B<--aica>=I<PROGFILE> |
nkeynes@1170 | 18 | |
nkeynes@1170 | 19 | Run the AICA SPU only, with the supplied program. |
nkeynes@1170 | 20 | |
nkeynes@1170 | 21 | =item B<-A>, B<--audio>=I<DRIVER> |
nkeynes@700 | 22 | |
nkeynes@700 | 23 | Set the preferred audio driver. If the specified audio driver cannot start, the system |
nkeynes@700 | 24 | will try all other available drivers in the standard order. To see which drivers are |
nkeynes@700 | 25 | supported, run lxdream -A ? |
nkeynes@700 | 26 | |
nkeynes@1170 | 27 | =item B<-b>, B<--biosless> |
nkeynes@1170 | 28 | |
nkeynes@1170 | 29 | Do not load the BIOS rom on startup, even if one is configured. |
nkeynes@1170 | 30 | |
nkeynes@1170 | 31 | =item B<-c>, B<--config>=I<CONFILE> |
nkeynes@1170 | 32 | |
nkeynes@1170 | 33 | Load configuration information from B<CONFILE> instead of the system default |
nkeynes@700 | 34 | |
nkeynes@700 | 35 | =item B<-d>, B<--debugger> |
nkeynes@700 | 36 | |
nkeynes@700 | 37 | Launch the debugger on startup (GTK platforms only). |
nkeynes@700 | 38 | |
nkeynes@1170 | 39 | =item B<-f>, B<--fullscreen> |
nkeynes@1170 | 40 | |
nkeynes@1170 | 41 | Use this option to start the program in fullscreen mode. |
nkeynes@1170 | 42 | |
nkeynes@1170 | 43 | =item B<-g>, B<--gdb-sh4>=I<PORT> |
nkeynes@1170 | 44 | |
nkeynes@1170 | 45 | Start the GDB remote server on B<PORT> for SH4. |
nkeynes@1170 | 46 | |
nkeynes@1170 | 47 | =item B<-G>, B<--gdb-arm>=I<PORT> |
nkeynes@1170 | 48 | |
nkeynes@1170 | 49 | Start the GDB remote server on B<PORT> for ARM. |
nkeynes@1170 | 50 | |
nkeynes@700 | 51 | =item B<-h>, B<--help> |
nkeynes@700 | 52 | |
nkeynes@700 | 53 | Print command line usage information |
nkeynes@700 | 54 | |
nkeynes@700 | 55 | =item B<-H>, B<--headless> |
nkeynes@700 | 56 | |
nkeynes@700 | 57 | Run in headless mode (no GUI or video output). This is mainly useful for testing CPU |
nkeynes@700 | 58 | functions and performance. Equivalent to -V null. |
nkeynes@700 | 59 | |
nkeynes@1170 | 60 | =item B<-l>, B<--log>=I<LEVEL> |
nkeynes@700 | 61 | |
nkeynes@700 | 62 | Set the system log level to the specified level of verbosity, which must be one of the following options: |
nkeynes@700 | 63 | FATAL, ERROR, WARN, INFO, DEBUG, TRACE (non-case-sensitive, and only the first letter is required). The |
nkeynes@700 | 64 | default level is WARN. |
nkeynes@700 | 65 | |
nkeynes@1170 | 66 | =item B<-m>, B<--multiplier>=I<SCALE> |
nkeynes@700 | 67 | |
nkeynes@700 | 68 | Change the SH4 core clock speed using the supplied floating-point multiplier, where 1.0 |
nkeynes@700 | 69 | is full speed, 0.5 is half speed, and so on. The default is 0.5. |
nkeynes@700 | 70 | |
nkeynes@700 | 71 | =item B<-n> |
nkeynes@700 | 72 | |
nkeynes@700 | 73 | Don't start running on startup, even if a disc or program file was supplied. By default |
nkeynes@700 | 74 | the system will start automatically if a disc or program was given on the command line. |
nkeynes@700 | 75 | |
nkeynes@700 | 76 | =item B<-p> |
nkeynes@700 | 77 | |
nkeynes@700 | 78 | Start running on startup, even if no disc or program file was supplied. By default |
nkeynes@700 | 79 | the system will only start automatically if a disc or program was given on the command |
nkeynes@700 | 80 | line. |
nkeynes@700 | 81 | |
nkeynes@1170 | 82 | =item B<-t>, B<--run-time>=I<SECONDS> |
nkeynes@700 | 83 | |
nkeynes@700 | 84 | Run the dreamcast for exactly the specified amount of time, and then terminate, ie |
nkeynes@700 | 85 | lxdream -pt 5.2 will exit after 5.2 seconds of emulated runtime. Useful for performance |
nkeynes@700 | 86 | measurements of arbitrary sections of code. |
nkeynes@700 | 87 | |
nkeynes@1170 | 88 | =item B<-T>, B<--trace>=I<REGIONS> |
nkeynes@700 | 89 | |
nkeynes@700 | 90 | Activate I/O region tracing for the specified list of MMIO regions. This option is only |
nkeynes@700 | 91 | available if lxdream was configured with --enable-trace. If enabled, trace-list may be |
nkeynes@700 | 92 | a comma-separated list of 1 or more of the following: ALL, ASIC, AICA0, AICA1, AICA2, AICARTC, |
nkeynes@700 | 93 | EXTDMA, PVR2, MMU, UBC, BSC, DMAC, CPG, RTC, INTC, TMU, SCI, and SCIF. |
nkeynes@700 | 94 | |
nkeynes@700 | 95 | Warning: this option implicitly sets the verbosity level to 'trace', and will generate a huge |
nkeynes@700 | 96 | amount of output. |
nkeynes@700 | 97 | |
nkeynes@700 | 98 | =item B<-u>, B<--unsafe> |
nkeynes@700 | 99 | |
nkeynes@700 | 100 | Allow unsafe dcload syscalls. Without this option, the only permitted calls are reads, writes, and |
nkeynes@700 | 101 | seeks on stdin, stdout and stderr. If you're writing your own code that uses the other syscalls, you |
nkeynes@700 | 102 | probably want to enable this. Otherwise it's safer to leave it off. |
nkeynes@700 | 103 | |
nkeynes@700 | 104 | =item B<-v>, B<--version> |
nkeynes@700 | 105 | |
nkeynes@700 | 106 | Print the lxdream version string. |
nkeynes@700 | 107 | |
nkeynes@1170 | 108 | =item B<-V> B<DRIVER> |
nkeynes@700 | 109 | |
nkeynes@700 | 110 | Set the preferred video driver. If the specified video driver cannot start, the system |
nkeynes@700 | 111 | will exit with an error. To see the available video drivers, run lxdream -V ? |
nkeynes@700 | 112 | |
nkeynes@700 | 113 | =item B<-x> |
nkeynes@700 | 114 | |
nkeynes@700 | 115 | Disable the SH4 translator and run in pure emulation mode. Generally you only want to do this for testing |
nkeynes@700 | 116 | purposes (ie if you think you've found a translator bug) as it's much slower this way. |
nkeynes@700 | 117 | |
nkeynes@700 | 118 | =back |
nkeynes@700 | 119 | |
nkeynes@700 | 120 | =head1 FILES |
nkeynes@700 | 121 | |
nkeynes@700 | 122 | =over |
nkeynes@700 | 123 | |
nkeynes@700 | 124 | =item B<$HOME/.lxdreamrc> |
nkeynes@700 | 125 | |
nkeynes@700 | 126 | Default user configuration file. This will be created at startup if it doesn't |
nkeynes@700 | 127 | already exist, unless an alternative file is specified with -c. |
nkeynes@700 | 128 | |
nkeynes@700 | 129 | =back |
nkeynes@700 | 130 | |
nkeynes@1170 | 131 | =head1 AUTHOR |
nkeynes@1170 | 132 | |
nkeynes@1170 | 133 | Nathan Keynes <nkeynes@lxdream.org> |
nkeynes@1170 | 134 | |
nkeynes@700 | 135 | =head1 COPYRIGHT |
nkeynes@700 | 136 | |
nkeynes@1170 | 137 | Copyright 2005-2011 Nathan Keynes <nkeynes@lxdream.org> |
nkeynes@700 | 138 | |
nkeynes@700 | 139 | This program is free software; you can redistribute it and/or modify |
nkeynes@700 | 140 | it under the terms of the GNU General Public License as published by |
nkeynes@700 | 141 | the Free Software Foundation; either version 2 of the License, or |
nkeynes@700 | 142 | (at your option) any later version. |
nkeynes@700 | 143 | |
nkeynes@700 | 144 | =cut |
.