Search
lxdream.org :: lxdream/lxdream.pod
lxdream 0.9.1
released Jun 29
Download Now
filename lxdream.pod
changeset 700:4650d0c7f6f9
next1170:9ffc8295b414
author nkeynes
date Fri Sep 17 20:08:50 2010 +1000 (13 years ago)
permissions -rw-r--r--
last change Refactor shader management to support multiple programs, which are all
defined in the shaders.glsl, rather than split up into one file per
fragment.
file annotate diff log raw
nkeynes@700
     1
=head1 NAME
nkeynes@700
     2
nkeynes@700
     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@700
    11
=head1 OPTIONS
nkeynes@700
    12
nkeynes@700
    13
=over
nkeynes@700
    14
nkeynes@700
    15
=item B<-A>, B<--audio>=I<audio-driver>
nkeynes@700
    16
nkeynes@700
    17
Set the preferred audio driver. If the specified audio driver cannot start, the system
nkeynes@700
    18
will try all other available drivers in the standard order. To see which drivers are 
nkeynes@700
    19
supported, run lxdream -A ?
nkeynes@700
    20
 
nkeynes@700
    21
=item B<-c>, B<--config>=F<config-filename>
nkeynes@700
    22
nkeynes@700
    23
Load configuration information from F<config-filename> instead of the system default
nkeynes@700
    24
nkeynes@700
    25
=item B<-d>, B<--debugger>
nkeynes@700
    26
nkeynes@700
    27
Launch the debugger on startup (GTK platforms only).
nkeynes@700
    28
nkeynes@700
    29
=item B<-h>, B<--help>
nkeynes@700
    30
nkeynes@700
    31
Print command line usage information
nkeynes@700
    32
nkeynes@700
    33
=item B<-H>, B<--headless>
nkeynes@700
    34
nkeynes@700
    35
Run in headless mode (no GUI or video output). This is mainly useful for testing CPU 
nkeynes@700
    36
functions and performance. Equivalent to -V null.
nkeynes@700
    37
nkeynes@700
    38
=item B<-l>, B<--log>=I<log-level>
nkeynes@700
    39
nkeynes@700
    40
Set the system log level to the specified level of verbosity, which must be one of the following options:
nkeynes@700
    41
FATAL, ERROR, WARN, INFO, DEBUG, TRACE (non-case-sensitive, and only the first letter is required). The
nkeynes@700
    42
default level is WARN.
nkeynes@700
    43
nkeynes@700
    44
=item B<-m> B<--multiplier>=I<scale>
nkeynes@700
    45
nkeynes@700
    46
Change the SH4 core clock speed using the supplied floating-point multiplier, where 1.0
nkeynes@700
    47
is full speed, 0.5 is half speed, and so on. The default is 0.5.
nkeynes@700
    48
nkeynes@700
    49
=item B<-n>
nkeynes@700
    50
nkeynes@700
    51
Don't start running on startup, even if a disc or program file was supplied. By default
nkeynes@700
    52
the system will start automatically if a disc or program was given on the command line.
nkeynes@700
    53
nkeynes@700
    54
=item B<-p>
nkeynes@700
    55
nkeynes@700
    56
Start running on startup, even if no disc or program file was supplied. By default
nkeynes@700
    57
the system will only start automatically if a disc or program was given on the command 
nkeynes@700
    58
line.
nkeynes@700
    59
nkeynes@700
    60
=item B<-t>, B<--run-time>=I<seconds>
nkeynes@700
    61
nkeynes@700
    62
Run the dreamcast for exactly the specified amount of time, and then terminate, ie 
nkeynes@700
    63
lxdream -pt 5.2  will exit after 5.2 seconds of emulated runtime. Useful for performance
nkeynes@700
    64
measurements of arbitrary sections of code.
nkeynes@700
    65
nkeynes@700
    66
=item B<-T>, B<--trace>=I<trace-list>
nkeynes@700
    67
nkeynes@700
    68
Activate I/O region tracing for the specified list of MMIO regions. This option is only
nkeynes@700
    69
available if lxdream was configured with --enable-trace. If enabled, trace-list may be
nkeynes@700
    70
a comma-separated list of 1 or more of the following: ALL, ASIC, AICA0, AICA1, AICA2, AICARTC,
nkeynes@700
    71
EXTDMA, PVR2, MMU, UBC, BSC, DMAC, CPG, RTC, INTC, TMU, SCI, and SCIF.
nkeynes@700
    72
nkeynes@700
    73
Warning: this option implicitly sets the verbosity level to 'trace', and will generate a huge
nkeynes@700
    74
amount of output.
nkeynes@700
    75
nkeynes@700
    76
=item B<-u>, B<--unsafe>
nkeynes@700
    77
nkeynes@700
    78
Allow unsafe dcload syscalls. Without this option, the only permitted calls are reads, writes, and
nkeynes@700
    79
seeks on stdin, stdout and stderr. If you're writing your own code that uses the other syscalls, you
nkeynes@700
    80
probably want to enable this. Otherwise it's safer to leave it off.
nkeynes@700
    81
nkeynes@700
    82
=item B<-v>, B<--version>
nkeynes@700
    83
nkeynes@700
    84
Print the lxdream version string.
nkeynes@700
    85
nkeynes@700
    86
=item B<-V> I<video-driver>
nkeynes@700
    87
nkeynes@700
    88
Set the preferred video driver. If the specified video driver cannot start, the system
nkeynes@700
    89
will exit with an error. To see the available video drivers, run lxdream -V ?
nkeynes@700
    90
nkeynes@700
    91
=item B<-x>
nkeynes@700
    92
nkeynes@700
    93
Disable the SH4 translator and run in pure emulation mode. Generally you only want to do this for testing
nkeynes@700
    94
purposes (ie if you think you've found a translator bug) as it's much slower this way.
nkeynes@700
    95
nkeynes@700
    96
=back
nkeynes@700
    97
nkeynes@700
    98
=head1 FILES
nkeynes@700
    99
nkeynes@700
   100
=over
nkeynes@700
   101
nkeynes@700
   102
=item B<$HOME/.lxdreamrc>
nkeynes@700
   103
nkeynes@700
   104
Default user configuration file. This will be created at startup if it doesn't 
nkeynes@700
   105
already exist, unless an alternative file is specified with -c.
nkeynes@700
   106
nkeynes@700
   107
=back
nkeynes@700
   108
nkeynes@700
   109
=head1 COPYRIGHT
nkeynes@700
   110
nkeynes@700
   111
Copyright 2005-2008 Nathan Keynes <nkeynes@lxdream.org>
nkeynes@700
   112
nkeynes@700
   113
This program is free software; you can redistribute it and/or modify
nkeynes@700
   114
it under the terms of the GNU General Public License as published by
nkeynes@700
   115
the Free Software Foundation; either version 2 of the License, or
nkeynes@700
   116
(at your option) any later version.
nkeynes@700
   117
nkeynes@700
   118
=cut
.