X-Git-Url: https://notaz.gp2x.de/cgi-bin/gitweb.cgi?p=mupen64plus-pandora.git;a=blobdiff_plain;f=source%2Ffront-end%2Fdoc%2Fmupen64plus.6;fp=source%2Ffront-end%2Fdoc%2Fmupen64plus.6;h=64ded01bd8dc83f6989cd084abf0eba86c6c025e;hp=0000000000000000000000000000000000000000;hb=5288f5429f38c99c73856e285d35e7d0c4c779d0;hpb=48d77f736bea02afeb362cff05c81375752b3015

diff --git a/source/front-end/doc/mupen64plus.6 b/source/front-end/doc/mupen64plus.6
new file mode 100644
index 0000000..64ded01
--- /dev/null
+++ b/source/front-end/doc/mupen64plus.6
@@ -0,0 +1,217 @@
+.Dd September 20, 2013
+.Dt MUPEN64PLUS 6
+.Os
+.Sh NAME
+.Nm mupen64plus
+.Nd console front\(hyend for the Mupen64Plus N64 emulator
+.Sh SYNOPSIS
+.Nm
+.Op parameters
+.Ar romfile
+.Sh DESCRIPTION
+.Nm
+is a plugin\(hybased N64 emulator for Linux/Unix, OSX, and Windows which is capable of accurately playing many games.
+Included are four MIPS R4300 CPU emulators, with dynamic recompilers for 32\(hybit x86 and 64\(hybit amd64 systems, and necessary plugins for audio, graphical rendering (RDP), signal co\(hyprocessor (RSP), and input.
+There are several OpenGL video plugins available:
+.Bl -bullet
+.It
+Rice, included with the distribution
+.It
+Glide64Mk2, included with the distribution
+.It
+.Lk https://bitbucket.org/wahrhaft/mupen64plus-video-arachnoid Arachnoid
+.It
+.Lk https://bitbucket.org/wahrhaft/mupen64plus-video-glide64 Glide64
+(old)
+.It
+.Lk https://bitbucket.org/wahrhaft/mupen64plus-video-z64 Z64
+(must be used with the rsp-z64 plugin)
+.El
+.Pp
+The most current documentation can be found at the project's
+.Lk https://code.google.com/p/mupen64plus/ homepage .
+.Pp
+The options are as follows:
+.Bl -tag -width x
+.It Fl h , Fl -help
+Print help message.
+.It Fl -noosd
+Disable onscreen display.
+.It Fl -osd
+Enable onscreen display.
+.It Fl -fullscreen
+Run emulator in fullscreen display mode.
+.It Fl -windowed
+Run emulator in windowed display mode.
+.It Fl -resolution Ar res
+Display resolution (640\(mu480, 800\(mu600, 1024\(mu768, etc)
+.It Fl -nospeedlimit
+Disable core speed limiter.
+This should be used with the dummy audio plugin.
+.It Fl -cheats Ar cheat-spec
+Enable or list cheat codes for the given rom file.
+.It Fl -corelib Ar filepath
+Specifies a filename (optionally with a preceding directory path) to load a specific
+.Nm
+core library.
+.It Fl -configdir Ar directory
+Specifies a directory to look for the
+.Pa mupen64plus.cfg
+file.
+Default is
+.Pa ~/.config/mupen64plus/ .
+.It Fl -datadir Ar directory
+Specifies a directory to search for shared data files (fonts, cheat codes, .ini files).
+Default is
+.Pa ${PREFIX}/share/mupen64plus/ .
+.It Fl -plugindir Ar directory
+Specifies a directory to search for plugin files.
+Default is
+.Pa ${PREFIX}/lib/mupen64plus/ .
+.It Fl -sshotdir Ar directory
+Specifies a directory to save screenshots captured during gameplay.
+Default is
+.Pa ~/.local/share/mupen64plus/screenshot/ .
+.It Fl -gfx Ar plugin\(hyspec
+Specifies a
+.Ar plugin\(hyspec
+to select a graphics plugin for use during emulation.
+.It Fl -audio Ar plugin\(hyspec
+Specifies a
+.Ar plugin\(hyspec
+to select an audio plugin for use during emulation.
+.It Fl -input Ar plugin\(hyspec
+Specifies a
+.Ar plugin\(hyspec
+to select an input plugin for use during emulation.
+.It Fl -rsp Ar plugin\(hyspec
+Specifies a
+.Ar plugin\(hyspec
+to select an RSP plugin for use during emulation.
+.It Fl -emumode Ar mode
+Specifies which mode the emulator core should run in.
+.Ar mode
+should be set to one of the following numbers:
+.Bl -inset
+.It 0
+Pure Interpreter
+.It 1
+Cached Interpreter
+.It 2
+Dynamic Recompiler (DynaRec)
+.El
+.It Fl -testshots Ar list
+Take screenshots at frames given in the comma\(hyseparated
+.Ar list ,
+then quit.
+.It Fl -core-compare-send
+Use the core comparison debugging feature, in data sending mode.
+If the core was not compiled with support for the Core Comparison feature, then the emulator will exit with an error.
+.It Fl -core-compare-recv
+Use the core comparison debugging feature, in data receiving mode.
+If the core was not compiled with support for the Core Comparison feature, then the emulator will exit with an error.
+.It Fl -set Ar param\(hyspec
+Set the value of a
+.Nm
+configuration parameter.
+This option may be used multiple times.
+The format of
+.Ar param\(hyspec
+is
+.Dl Section\(hyName[Param\(hyName]=Value
+.It Fl -nosaveoptions
+Do not save the given command\(hyline options into the
+.Nm
+configuration file to use as defaults in the future.
+.It Fl -verbose
+Print lots of information.
+Useful for debugging but unnecessary for normal use.
+.El
+.Sh plugin\(hyspec
+.Bl -ohang
+.It (plugin\(hyname)
+Filename (without path) of plugin to use.
+Application will search through several directories to look for a matching plugin name.
+.It (plugin\(hypath)
+Full directory path and filename of plugin.
+.It Sq dummy
+Use the dummy plugin.
+.El
+.Sh cheat\(hyspec
+.Bl -ohang
+.It Sq list
+Show all of the available cheat codes.
+.It Sq all
+Enable all of the available cheat codes.
+.It (codelist)
+A comma separated list of cheat code numbers to enable.
+.El
+.Sh KEY COMMANDS
+The following shortcut keys can be used during emulation.
+These are the default key values; nearly all of them may be set to different keys by editing the
+.Nm
+configuration file.
+.Bl -tag -width Alt-Enter
+.It Escape
+Quit the emulator.
+.It 0\(en9
+Select virtual
+.Sq slot
+for save/load state.
+.It F5
+Save emulator state to current slot.
+.It F7
+Load emulator state from current slot.
+.It F9
+Reset emulator.
+.It F10
+Slow down emulator speed by 5 percent.
+.It F11
+Speed up emulator speed by 5 percent.
+.It F12
+Take screenshot.
+.It Alt\(hyEnter
+Toggle fullscreen mode.
+This is not supported on Windows.
+.It p or P
+Pause/continue emulation.
+.It m or M
+Mute/unmute sound.
+.It f or F
+Fast Forward (playback at 250% normal speed as long as key is pressed).
+.It g or G
+Press GameShark button (if cheats are enabled).
+.It / or \&?
+Advance one frame if paused.
+.It \(lB
+Decrease volume.
+.It \(rB
+Increase volume.
+.El
+.Sh FILES
+The default location for the
+.Nm
+configuration file is
+.Pa ~/.config/mupen64plus/ .
+The default location of the saved screenshots is
+.Pa ~/.local/share/mupen64plus/screenshot/ .
+The default location of the save states is
+.Pa ~/.local/share/mupen64plus/save/ .
+.Sh AUTHORS
+.Nm
+was originally started by Richard42 and nmn, and is based on Mupen64 (originally written by Hacktarux).
+.Pp
+This man page was written by ebenblues, and updated by Richard42 and bentley.
+.Sh COPYRIGHT
+Mupen64plus is \(co 2008\(en2013 The Mupen64plus Team
+.Pp
+License GPLv2+,
+.Lk https://gnu.org/licenses/gpl.html GNU GPL version 2 or later
+.Pp
+This is free software: you are free to change and redistribute it.
+There is
+.Em no warranty ,
+to the extent permitted by law.
+.Sh BUGS
+To report bugs or make feature requests, use the
+.Lk https://code.google.com/p/mupen64plus/issues/list "issue tracker"