#LyX 2.0 created this file. For more info see http://www.lyx.org/ \lyxformat 413 \begin_document \begin_header \textclass article \use_default_options true \maintain_unincluded_children false \language finnish \language_package default \inputencoding auto \fontencoding global \font_roman default \font_sans default \font_typewriter default \font_default_family default \use_non_tex_fonts false \font_sc false \font_osf false \font_sf_scale 100 \font_tt_scale 100 \graphics default \default_output_format default \output_sync 0 \bibtex_command default \index_command default \paperfontsize default \use_hyperref false \papersize default \use_geometry false \use_amsmath 1 \use_esint 1 \use_mhchem 1 \use_mathdots 1 \cite_engine basic \use_bibtopic false \use_indices false \paperorientation portrait \suppress_date false \use_refstyle 1 \index Hakusana \shortcut idx \color #008000 \end_index \secnumdepth 3 \tocdepth 3 \paragraph_separation indent \paragraph_indentation default \quotes_language english \papercolumns 1 \papersides 1 \paperpagestyle default \tracking_changes false \output_changes false \html_math_output 0 \html_css_as_file 0 \html_be_strict false \end_header \begin_body \begin_layout Section Introduction \end_layout \begin_layout Standard lsnes is SNES rerecording emulator based on bsnes core. \end_layout \begin_layout Section Dependencies \end_layout \begin_layout Enumerate bsnes libsnes \end_layout \begin_deeper \begin_layout Enumerate v084 or 085 \end_layout \begin_layout Enumerate accuracy or compatiblity core. \end_layout \begin_layout Enumerate Patched version (using included 6 patches) \end_layout \end_deeper \begin_layout Enumerate Zlib \end_layout \begin_layout Enumerate boost_iostreams \end_layout \begin_layout Enumerate boost_filesystem \end_layout \begin_layout Enumerate boost_thread \end_layout \begin_layout Enumerate libsdl (SDL only) \end_layout \begin_layout Enumerate sdlmain (SDL only, part of SDL) \end_layout \begin_layout Enumerate boost_conversion (this is header-only library) \end_layout \begin_layout Enumerate libswscale (wxwidgets graphics only) \end_layout \begin_layout Enumerate Portaudio (portaudio sound only) \end_layout \begin_layout Enumerate std::thread and co (for threaded dumper only, not needed if std::thread is available) \end_layout \begin_layout Enumerate Lua (if Lua support is needed). \end_layout \begin_layout Itemize Version 5.1.X or 5.2X. \end_layout \begin_layout Section Building \end_layout \begin_layout Standard Building is via makefile, the following options are available: \end_layout \begin_layout Itemize CROSS_PREFIX= \end_layout \begin_deeper \begin_layout Itemize Prefix to apply to commands when building executables / object files for the target architecture. \end_layout \begin_layout Itemize Default is blank. \end_layout \end_deeper \begin_layout Itemize CC= \end_layout \begin_deeper \begin_layout Itemize Name of C++ compiler. \end_layout \begin_layout Itemize CROSS_PREFIX is prepended if compiling for target architecture. \end_layout \begin_layout Itemize This needs to be at least GCC 4.6. \end_layout \begin_layout Itemize Set to 'g++-mp-4.6' if compiling on Mac OS X using GCC 4.6 from Macports. \end_layout \begin_layout Itemize Default is 'g++'. \end_layout \end_deeper \begin_layout Itemize HOSTCC= \end_layout \begin_deeper \begin_layout Itemize Name of host C++ compiler. \end_layout \begin_layout Itemize Default is value of 'CC' option. \end_layout \end_deeper \begin_layout Itemize USER_HOSTCCFLAGS=: \end_layout \begin_deeper \begin_layout Itemize Compiler flags to pass when compiling/linking for host architecture. \end_layout \begin_layout Itemize Default is blank. \end_layout \end_deeper \begin_layout Itemize USER_CFLAGS= \end_layout \begin_deeper \begin_layout Itemize Extra flags to pass when compiling for target architecture \end_layout \begin_layout Itemize Default is blank. \end_layout \end_deeper \begin_layout Itemize USER_LDFLAGS=: \end_layout \begin_deeper \begin_layout Itemize Extra flags to pass when linking for target architecture. \end_layout \begin_layout Itemize Default is blank. \end_layout \end_deeper \begin_layout Itemize USER_PLATFORM_CFLAGS= \end_layout \begin_deeper \begin_layout Itemize Extra flags to pass when compiling files using platform-dependent code for target architecture. \end_layout \begin_layout Itemize Default is blank. \end_layout \end_deeper \begin_layout Itemize USER_PLATFORM_LDFLAGS= \end_layout \begin_deeper \begin_layout Itemize Extra flags to pass when linking files using platform-dependent code for target architecture. \end_layout \begin_layout Itemize Default is blank. \end_layout \end_deeper \begin_layout Itemize FONT_SRC= \end_layout \begin_deeper \begin_layout Itemize Set the font file to use. \end_layout \begin_layout Itemize Currently the valid values are: \end_layout \begin_deeper \begin_layout Itemize cp437.hex: Standard VGA font (256 characters). \end_layout \begin_layout Itemize unifontfull-5.1.20080820.hex: GNU unifont (covers most of Unicode BMP) \end_layout \end_deeper \begin_layout Itemize Default is 'unifontfull-5.1.20080820.hex' \end_layout \end_deeper \begin_layout Itemize LUA= \end_layout \begin_deeper \begin_layout Itemize Package to use for Lua support. \end_layout \begin_layout Itemize Usually valid value is 'lua' or 'lua5.1'. \end_layout \begin_layout Itemize Default is not to build Lua support. \end_layout \end_deeper \begin_layout Itemize THREADS= \end_layout \begin_deeper \begin_layout Itemize Override platform default for dumper threading support. \end_layout \begin_layout Itemize Threading is default on Linux. \end_layout \begin_layout Itemize 'YES' tries to use threading (std::thread). \end_layout \begin_layout Itemize 'BOOST' tries to use threading (boost::thread). \end_layout \begin_layout Itemize 'NO' disables threading. \end_layout \begin_layout Itemize Note: This has absolutely nothing to do with platform threading. \end_layout \end_deeper \begin_layout Itemize BSNES_IS_COMPAT= \end_layout \begin_deeper \begin_layout Itemize Signals that BSNES core used is compatiblity core, not accuracy core. \end_layout \begin_layout Itemize Default is to assume accuracy core. \end_layout \end_deeper \begin_layout Itemize JOYSTICK= \end_layout \begin_deeper \begin_layout Itemize Set joystick implementation. Valid values are: \end_layout \begin_deeper \begin_layout Itemize SDL: Use SDL for joystick (requires SDL graphics) \end_layout \begin_layout Itemize EVDEV: Use EVDEV for joystick (Linux only). \end_layout \begin_layout Itemize DUMMY: Disable joystick support. \end_layout \end_deeper \begin_layout Itemize Default is SDL. \end_layout \end_deeper \begin_layout Itemize SOUND= \end_layout \begin_deeper \begin_layout Itemize Set sound implementation. Valid values are: \end_layout \begin_deeper \begin_layout Itemize SDL: Use SDL for sound (requires SDL graphics) \end_layout \begin_layout Itemize PORTAUDIO: Use Portaudio for sound. \end_layout \begin_layout Itemize DUMMY: Disable sound support \end_layout \end_deeper \begin_layout Itemize Default is SDL. \end_layout \end_deeper \begin_layout Itemize GRAPHICS= \end_layout \begin_deeper \begin_layout Itemize Set windowing library to use. Valid values are: \end_layout \begin_deeper \begin_layout Itemize SDL: Use SDL for graphics \end_layout \begin_layout Itemize WXWIDGETS: Use wxWidgets for graphics. \end_layout \end_deeper \begin_layout Itemize Default is SDL. \end_layout \end_deeper \begin_layout Section Command line options \end_layout \begin_layout Subsection ROM options \end_layout \begin_layout Standard in the following can be one of: \end_layout \begin_layout Itemize rom: Cartridge ROM (BIOS for special carts). This is required. \end_layout \begin_layout Itemize bsx: BS-X (non-slotted) Game flash ROM. \end_layout \begin_layout Itemize bsxslotted: BS-X (slotted) Game flash ROM. \end_layout \begin_layout Itemize dmg: DMG game ROM \end_layout \begin_layout Itemize slot-a: Sufami Turbo Slot A ROM \end_layout \begin_layout Itemize slot-b: Sufami Turbo Slot B ROM \end_layout \begin_layout Subsubsection --= (lsnes/SDL, lsnes-avidump) \end_layout \begin_layout Standard Load as specified ROM (SFC/BS/DMG/ST file format). \end_layout \begin_layout Subsubsection --headered-= (lsnes/SDL, lsnes-avidump) \end_layout \begin_layout Standard Load as specified ROM, stripping first 512 bytes. Handy for loading SMC / FIG and such files. \end_layout \begin_layout Subsubsection ---xml= (lsnes/SDL, lsnes-avidump) \end_layout \begin_layout Standard Override hardware detection for ROM, reading the values from (BSNES XML format). \end_layout \begin_layout Subsubsection --ips-= (lsnes/SDL, lsnes-avidump) \end_layout \begin_layout Standard Apply BPS/IPS patch to ROM . If specified multiple times, the patches are applied in order. \end_layout \begin_layout Subsubsection --ips--xml= (lsnes/SDL, lsnes-avidump) \end_layout \begin_layout Standard Apply BPS/IPS patch to XML of ROM . If specified multiple times, the patches are applied in order. \end_layout \begin_layout Subsubsection --ips-offset= (lsnes/SDL, lsnes-avidump) \end_layout \begin_layout Standard Set offset to apply to IPS patches. May be negative. Handy for applying headered IPS patches (use offset of -512 for this). The offset must be 0 for BPS patches. \end_layout \begin_layout Subsubsection --pal \end_layout \begin_layout Standard Force ROM to be considered PAL-only. \end_layout \begin_layout Itemize Only works on SNES and SGB ROMs (not BS-X or Sufami Turbo). \end_layout \begin_layout Itemize Attempting to load NTSC movie file will error out. \end_layout \begin_layout Subsubsection --ntsc \end_layout \begin_layout Standard Force ROM to be considered NTSC-only. \end_layout \begin_layout Itemize Attempting to load PAL movie file will error out. \end_layout \begin_layout Subsection Session options \end_layout \begin_layout Subsubsection (lsnes/SDL, lsnes-avidump, movieinfo) \end_layout \begin_layout Standard Load as movie or savestate file. All other session options are ignored. \end_layout \begin_layout Subsubsection --port1= (lsnes/SDL) \end_layout \begin_layout Standard Set type of port1. Valid values are: \end_layout \begin_layout Itemize none: No device connected \end_layout \begin_layout Itemize gamepad: One gamepad (the default) \end_layout \begin_layout Itemize multitap: Four gamepads (warning: makes most games refuse to start) \end_layout \begin_layout Itemize mouse: Mouse. \end_layout \begin_layout Subsubsection --port2= (lsnes/SDL) \end_layout \begin_layout Standard Set type of port2. Valid values are: \end_layout \begin_layout Itemize none: No device connected (the default) \end_layout \begin_layout Itemize gamepad: One gamepad \end_layout \begin_layout Itemize multitap: Four gamepads. \end_layout \begin_layout Itemize mouse: Mouse \end_layout \begin_layout Itemize superscope: Super Scope \end_layout \begin_layout Itemize justifier: One justifier \end_layout \begin_layout Itemize justifiers: Two justifiers \end_layout \begin_layout Subsubsection --gamename= (lsnes/SDL) \end_layout \begin_layout Standard Set the name of game to . Default is blank. \end_layout \begin_layout Subsubsection --author= (lsnes/SDL) \end_layout \begin_layout Standard Add author with full name of (no nickname). \end_layout \begin_layout Subsubsection --author=| (lsnes/SDL) \end_layout \begin_layout Standard Add author with nickname of (no full name). \end_layout \begin_layout Subsubsection --author=| (lsnes/SDL) \end_layout \begin_layout Standard Add author with full name of and nickname of . \end_layout \begin_layout Subsubsection --rtc-second= (lsnes/SDL) \end_layout \begin_layout Standard Set RTC second (0 is 1st January 1970 00:00:00Z). Default is 1,000,000,000. \end_layout \begin_layout Subsubsection --rtc-subsecond= (lsnes/SDL) \end_layout \begin_layout Standard Set RTC subsecond. Range is 0-. Unit is CPU cycle. Default is 0. \end_layout \begin_layout Subsection Misc. options: \end_layout \begin_layout Subsubsection --run= (lsnes/SDL) \end_layout \begin_layout Standard After running main RC file, run this file. If multiple are specified, these execute in order specified. \end_layout \begin_layout Subsection dump options (lsnes-dumpavi only) \end_layout \begin_layout Subsubsection --prefix= \end_layout \begin_layout Standard Set dump prefix. Default is \begin_inset Quotes eld \end_inset avidump \begin_inset Quotes erd \end_inset . \end_layout \begin_layout Subsubsection --level= \end_layout \begin_layout Standard Set compression level (0-18). Default is 7. \end_layout \begin_layout Subsubsection --length= \end_layout \begin_layout Standard Set number of frames to dump. Mandatory. \end_layout \begin_layout Subsubsection --lua=