Search :: lxdream/lxdream.pod
lxdream 0.9.1
released Jun 29
Download Now
filename lxdream.pod
changeset 1170:9ffc8295b414
author nkeynes
date Fri Nov 25 09:02:13 2011 +1000 (8 years ago)
permissions -rw-r--r--
last change Fix built-source dependencies to include $(EXEEXT), for the sake of win32
view annotate diff log raw
     1 =head1 NAME
     3 lxdream - A Dreamcast emulator
     5 =head1 SYNOPSIS
     7 lxdream [options] [disc-image-file] [program-file]
     9 =head1 DESCRIPTION
    11 Emulates the Sega Dreamcast console. Lxdream can run games either from disc image files, from progam files or from CD-ROM discs.
    13 =head1 OPTIONS
    15 =over
    17 =item B<-a>, B<--aica>=I<PROGFILE>
    19 Run the AICA SPU only, with the supplied program.
    21 =item B<-A>, B<--audio>=I<DRIVER>
    23 Set the preferred audio driver. If the specified audio driver cannot start, the system
    24 will try all other available drivers in the standard order. To see which drivers are 
    25 supported, run lxdream -A ?
    27 =item B<-b>, B<--biosless>
    29 Do not load the BIOS rom on startup, even if one is configured. 
    31 =item B<-c>, B<--config>=I<CONFILE>
    33 Load configuration information from B<CONFILE> instead of the system default
    35 =item B<-d>, B<--debugger>
    37 Launch the debugger on startup (GTK platforms only).
    39 =item B<-f>, B<--fullscreen>
    41 Use this option to start the program in fullscreen mode.
    43 =item B<-g>, B<--gdb-sh4>=I<PORT>
    45 Start the GDB remote server on B<PORT> for SH4.
    47 =item B<-G>, B<--gdb-arm>=I<PORT>
    49 Start the GDB remote server on B<PORT> for ARM.
    51 =item B<-h>, B<--help>
    53 Print command line usage information
    55 =item B<-H>, B<--headless>
    57 Run in headless mode (no GUI or video output). This is mainly useful for testing CPU 
    58 functions and performance. Equivalent to -V null.
    60 =item B<-l>, B<--log>=I<LEVEL>
    62 Set the system log level to the specified level of verbosity, which must be one of the following options:
    63 FATAL, ERROR, WARN, INFO, DEBUG, TRACE (non-case-sensitive, and only the first letter is required). The
    64 default level is WARN.
    66 =item B<-m>, B<--multiplier>=I<SCALE>
    68 Change the SH4 core clock speed using the supplied floating-point multiplier, where 1.0
    69 is full speed, 0.5 is half speed, and so on. The default is 0.5.
    71 =item B<-n>
    73 Don't start running on startup, even if a disc or program file was supplied. By default
    74 the system will start automatically if a disc or program was given on the command line.
    76 =item B<-p>
    78 Start running on startup, even if no disc or program file was supplied. By default
    79 the system will only start automatically if a disc or program was given on the command 
    80 line.
    82 =item B<-t>, B<--run-time>=I<SECONDS>
    84 Run the dreamcast for exactly the specified amount of time, and then terminate, ie 
    85 lxdream -pt 5.2  will exit after 5.2 seconds of emulated runtime. Useful for performance
    86 measurements of arbitrary sections of code.
    88 =item B<-T>, B<--trace>=I<REGIONS>
    90 Activate I/O region tracing for the specified list of MMIO regions. This option is only
    91 available if lxdream was configured with --enable-trace. If enabled, trace-list may be
    92 a comma-separated list of 1 or more of the following: ALL, ASIC, AICA0, AICA1, AICA2, AICARTC,
    95 Warning: this option implicitly sets the verbosity level to 'trace', and will generate a huge
    96 amount of output.
    98 =item B<-u>, B<--unsafe>
   100 Allow unsafe dcload syscalls. Without this option, the only permitted calls are reads, writes, and
   101 seeks on stdin, stdout and stderr. If you're writing your own code that uses the other syscalls, you
   102 probably want to enable this. Otherwise it's safer to leave it off.
   104 =item B<-v>, B<--version>
   106 Print the lxdream version string.
   108 =item B<-V> B<DRIVER>
   110 Set the preferred video driver. If the specified video driver cannot start, the system
   111 will exit with an error. To see the available video drivers, run lxdream -V ?
   113 =item B<-x>
   115 Disable the SH4 translator and run in pure emulation mode. Generally you only want to do this for testing
   116 purposes (ie if you think you've found a translator bug) as it's much slower this way.
   118 =back
   120 =head1 FILES
   122 =over
   124 =item B<$HOME/.lxdreamrc>
   126 Default user configuration file. This will be created at startup if it doesn't 
   127 already exist, unless an alternative file is specified with -c.
   129 =back
   131 =head1 AUTHOR
   133 Nathan Keynes <>
   135 =head1 COPYRIGHT
   137 Copyright 2005-2011 Nathan Keynes <>
   139 This program is free software; you can redistribute it and/or modify
   140 it under the terms of the GNU General Public License as published by
   141 the Free Software Foundation; either version 2 of the License, or
   142 (at your option) any later version.
   144 =cut