1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/lxdream.pod	Fri Sep 17 20:08:50 2010 +1000
     1.3 @@ -0,0 +1,118 @@
     1.4 +=head1 NAME
     1.5 +
     1.6 +lxdream - A dreamcast emulator
     1.7 +
     1.8 +=head1 SYNOPSIS
     1.9 +
    1.10 +lxdream [options] [disc-image-file] [program-file]
    1.11 +
    1.12 +=head1 DESCRIPTION
    1.13 +
    1.14 +=head1 OPTIONS
    1.15 +
    1.16 +=over
    1.17 +
    1.18 +=item B<-A>, B<--audio>=I<audio-driver>
    1.19 +
    1.20 +Set the preferred audio driver. If the specified audio driver cannot start, the system
    1.21 +will try all other available drivers in the standard order. To see which drivers are 
    1.22 +supported, run lxdream -A ?
    1.23 + 
    1.24 +=item B<-c>, B<--config>=F<config-filename>
    1.25 +
    1.26 +Load configuration information from F<config-filename> instead of the system default
    1.27 +
    1.28 +=item B<-d>, B<--debugger>
    1.29 +
    1.30 +Launch the debugger on startup (GTK platforms only).
    1.31 +
    1.32 +=item B<-h>, B<--help>
    1.33 +
    1.34 +Print command line usage information
    1.35 +
    1.36 +=item B<-H>, B<--headless>
    1.37 +
    1.38 +Run in headless mode (no GUI or video output). This is mainly useful for testing CPU 
    1.39 +functions and performance. Equivalent to -V null.
    1.40 +
    1.41 +=item B<-l>, B<--log>=I<log-level>
    1.42 +
    1.43 +Set the system log level to the specified level of verbosity, which must be one of the following options:
    1.44 +FATAL, ERROR, WARN, INFO, DEBUG, TRACE (non-case-sensitive, and only the first letter is required). The
    1.45 +default level is WARN.
    1.46 +
    1.47 +=item B<-m> B<--multiplier>=I<scale>
    1.48 +
    1.49 +Change the SH4 core clock speed using the supplied floating-point multiplier, where 1.0
    1.50 +is full speed, 0.5 is half speed, and so on. The default is 0.5.
    1.51 +
    1.52 +=item B<-n>
    1.53 +
    1.54 +Don't start running on startup, even if a disc or program file was supplied. By default
    1.55 +the system will start automatically if a disc or program was given on the command line.
    1.56 +
    1.57 +=item B<-p>
    1.58 +
    1.59 +Start running on startup, even if no disc or program file was supplied. By default
    1.60 +the system will only start automatically if a disc or program was given on the command 
    1.61 +line.
    1.62 +
    1.63 +=item B<-t>, B<--run-time>=I<seconds>
    1.64 +
    1.65 +Run the dreamcast for exactly the specified amount of time, and then terminate, ie 
    1.66 +lxdream -pt 5.2  will exit after 5.2 seconds of emulated runtime. Useful for performance
    1.67 +measurements of arbitrary sections of code.
    1.68 +
    1.69 +=item B<-T>, B<--trace>=I<trace-list>
    1.70 +
    1.71 +Activate I/O region tracing for the specified list of MMIO regions. This option is only
    1.72 +available if lxdream was configured with --enable-trace. If enabled, trace-list may be
    1.73 +a comma-separated list of 1 or more of the following: ALL, ASIC, AICA0, AICA1, AICA2, AICARTC,
    1.74 +EXTDMA, PVR2, MMU, UBC, BSC, DMAC, CPG, RTC, INTC, TMU, SCI, and SCIF.
    1.75 +
    1.76 +Warning: this option implicitly sets the verbosity level to 'trace', and will generate a huge
    1.77 +amount of output.
    1.78 +
    1.79 +=item B<-u>, B<--unsafe>
    1.80 +
    1.81 +Allow unsafe dcload syscalls. Without this option, the only permitted calls are reads, writes, and
    1.82 +seeks on stdin, stdout and stderr. If you're writing your own code that uses the other syscalls, you
    1.83 +probably want to enable this. Otherwise it's safer to leave it off.
    1.84 +
    1.85 +=item B<-v>, B<--version>
    1.86 +
    1.87 +Print the lxdream version string.
    1.88 +
    1.89 +=item B<-V> I<video-driver>
    1.90 +
    1.91 +Set the preferred video driver. If the specified video driver cannot start, the system
    1.92 +will exit with an error. To see the available video drivers, run lxdream -V ?
    1.93 +
    1.94 +=item B<-x>
    1.95 +
    1.96 +Disable the SH4 translator and run in pure emulation mode. Generally you only want to do this for testing
    1.97 +purposes (ie if you think you've found a translator bug) as it's much slower this way.
    1.98 +
    1.99 +=back
   1.100 +
   1.101 +=head1 FILES
   1.102 +
   1.103 +=over
   1.104 +
   1.105 +=item B<$HOME/.lxdreamrc>
   1.106 +
   1.107 +Default user configuration file. This will be created at startup if it doesn't 
   1.108 +already exist, unless an alternative file is specified with -c.
   1.109 +
   1.110 +=back
   1.111 +
   1.112 +=head1 COPYRIGHT
   1.113 +
   1.114 +Copyright 2005-2008 Nathan Keynes <nkeynes@lxdream.org>
   1.115 +
   1.116 +This program is free software; you can redistribute it and/or modify
   1.117 +it under the terms of the GNU General Public License as published by
   1.118 +the Free Software Foundation; either version 2 of the License, or
   1.119 +(at your option) any later version.
   1.120 +
   1.121 +=cut