Search :: lxdream/lxdream.pod
lxdream 0.9.1
released Jun 29
Download Now
filename lxdream.pod
changeset 700:4650d0c7f6f9
author nkeynes
date Thu Mar 05 21:42:35 2009 +0000 (14 years ago)
permissions -rw-r--r--
last change Cleanup ABI headers - most of the content made consistent between versions, and moved into proper
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 =head1 OPTIONS
    13 =over
    15 =item B<-A>, B<--audio>=I<audio-driver>
    17 Set the preferred audio driver. If the specified audio driver cannot start, the system
    18 will try all other available drivers in the standard order. To see which drivers are 
    19 supported, run lxdream -A ?
    21 =item B<-c>, B<--config>=F<config-filename>
    23 Load configuration information from F<config-filename> instead of the system default
    25 =item B<-d>, B<--debugger>
    27 Launch the debugger on startup (GTK platforms only).
    29 =item B<-h>, B<--help>
    31 Print command line usage information
    33 =item B<-H>, B<--headless>
    35 Run in headless mode (no GUI or video output). This is mainly useful for testing CPU 
    36 functions and performance. Equivalent to -V null.
    38 =item B<-l>, B<--log>=I<log-level>
    40 Set the system log level to the specified level of verbosity, which must be one of the following options:
    41 FATAL, ERROR, WARN, INFO, DEBUG, TRACE (non-case-sensitive, and only the first letter is required). The
    42 default level is WARN.
    44 =item B<-m> B<--multiplier>=I<scale>
    46 Change the SH4 core clock speed using the supplied floating-point multiplier, where 1.0
    47 is full speed, 0.5 is half speed, and so on. The default is 0.5.
    49 =item B<-n>
    51 Don't start running on startup, even if a disc or program file was supplied. By default
    52 the system will start automatically if a disc or program was given on the command line.
    54 =item B<-p>
    56 Start running on startup, even if no disc or program file was supplied. By default
    57 the system will only start automatically if a disc or program was given on the command 
    58 line.
    60 =item B<-t>, B<--run-time>=I<seconds>
    62 Run the dreamcast for exactly the specified amount of time, and then terminate, ie 
    63 lxdream -pt 5.2  will exit after 5.2 seconds of emulated runtime. Useful for performance
    64 measurements of arbitrary sections of code.
    66 =item B<-T>, B<--trace>=I<trace-list>
    68 Activate I/O region tracing for the specified list of MMIO regions. This option is only
    69 available if lxdream was configured with --enable-trace. If enabled, trace-list may be
    70 a comma-separated list of 1 or more of the following: ALL, ASIC, AICA0, AICA1, AICA2, AICARTC,
    73 Warning: this option implicitly sets the verbosity level to 'trace', and will generate a huge
    74 amount of output.
    76 =item B<-u>, B<--unsafe>
    78 Allow unsafe dcload syscalls. Without this option, the only permitted calls are reads, writes, and
    79 seeks on stdin, stdout and stderr. If you're writing your own code that uses the other syscalls, you
    80 probably want to enable this. Otherwise it's safer to leave it off.
    82 =item B<-v>, B<--version>
    84 Print the lxdream version string.
    86 =item B<-V> I<video-driver>
    88 Set the preferred video driver. If the specified video driver cannot start, the system
    89 will exit with an error. To see the available video drivers, run lxdream -V ?
    91 =item B<-x>
    93 Disable the SH4 translator and run in pure emulation mode. Generally you only want to do this for testing
    94 purposes (ie if you think you've found a translator bug) as it's much slower this way.
    96 =back
    98 =head1 FILES
   100 =over
   102 =item B<$HOME/.lxdreamrc>
   104 Default user configuration file. This will be created at startup if it doesn't 
   105 already exist, unless an alternative file is specified with -c.
   107 =back
   109 =head1 COPYRIGHT
   111 Copyright 2005-2008 Nathan Keynes <>
   113 This program is free software; you can redistribute it and/or modify
   114 it under the terms of the GNU General Public License as published by
   115 the Free Software Foundation; either version 2 of the License, or
   116 (at your option) any later version.
   118 =cut